Add more warning notes

This commit is contained in:
Dale Glass 2024-06-07 00:45:58 +02:00 committed by HifiExperiments
parent f96ca65812
commit 548a41171d

View file

@ -53,6 +53,14 @@ struct GPUKTXPayload {
TextureUsageType _usageType; TextureUsageType _usageType;
glm::ivec2 _originalSize { 0, 0 }; glm::ivec2 _originalSize { 0, 0 };
/**
* @brief Serialize the KTX payload
*
* @warning Be careful modifying this code, as it influences baked assets.
* Backwards compatibility must be maintained.
*
* @param ser Destination serializer
*/
void serialize(DataSerializer &ser) { void serialize(DataSerializer &ser) {
ser << CURRENT_VERSION; ser << CURRENT_VERSION;
@ -72,6 +80,16 @@ struct GPUKTXPayload {
assert(ser.length() == GPUKTXPayload::SIZE); assert(ser.length() == GPUKTXPayload::SIZE);
} }
/**
* @brief Deserialize the KTX payload
*
* @warning Be careful modifying this code, as it influences baked assets.
* Backwards compatibility must be maintained.
*
* @param dsr Deserializer object
* @return true Successful
* @return false Version check failed
*/
bool unserialize(DataDeserializer &dsr) { bool unserialize(DataDeserializer &dsr) {
Version version = 0; Version version = 0;
uint32_t usageData = 0; uint32_t usageData = 0;