vtfpp: rename particle sheet accessors to match image/thumbnail accessors, sanity check offset/dims

Author: craftablescience

include/vtfpp/SHT.h

@@ -15,10 +15,10 @@ class SHT {
 	struct Sequence {
 		struct Frame {
 			struct Bounds {
-				float left;
-				float top;
-				float right;
-				float bottom;
+				float x1;
+				float y1;
+				float x2;
+				float y2;
 			};
 
 			float duration;

include/vtfpp/VTF.h

@@ -303,13 +303,13 @@ class VTF {
 	[[nodiscard]] const Resource* getResource(Resource::Type type) const;
 
 	/// This is a convenience function. You're best off uploading the bounds to the GPU and scaling the UV there if trying to render a particle
-	[[nodiscard]] std::vector<std::byte> getParticleSheetFrameRaw(uint16_t& spriteWidth, uint16_t& spriteHeight, uint32_t shtSequenceID, uint32_t shtFrame, uint8_t shtBounds = 0, uint8_t mip = 0, uint16_t frame = 0, uint8_t face = 0, uint16_t slice = 0) const;
+	[[nodiscard]] std::vector<std::byte> getParticleSheetFrameDataRaw(uint16_t& spriteWidth, uint16_t& spriteHeight, uint32_t shtSequenceID, uint32_t shtFrame, uint8_t shtBounds = 0, uint8_t mip = 0, uint16_t frame = 0, uint8_t face = 0, uint16_t slice = 0) const;
 
 	/// This is a convenience function. You're best off uploading the bounds to the GPU and scaling the UV there if trying to render a particle
-	[[nodiscard]] std::vector<std::byte> getParticleSheetFrameAs(ImageFormat newFormat, uint16_t& spriteWidth, uint16_t& spriteHeight, uint32_t shtSequenceID, uint32_t shtFrame, uint8_t shtBounds = 0, uint8_t mip = 0, uint16_t frame = 0, uint8_t face = 0, uint16_t slice = 0) const;
+	[[nodiscard]] std::vector<std::byte> getParticleSheetFrameDataAs(ImageFormat newFormat, uint16_t& spriteWidth, uint16_t& spriteHeight, uint32_t shtSequenceID, uint32_t shtFrame, uint8_t shtBounds = 0, uint8_t mip = 0, uint16_t frame = 0, uint8_t face = 0, uint16_t slice = 0) const;
 
 	/// This is a convenience function. You're best off uploading the bounds to the GPU and scaling the UV there if trying to render a particle
-	[[nodiscard]] std::vector<std::byte> getParticleSheetFrameAsRGBA8888(uint16_t& spriteWidth, uint16_t& spriteHeight, uint32_t shtSequenceID, uint32_t shtFrame, uint8_t shtBounds = 0, uint8_t mip = 0, uint16_t frame = 0, uint8_t face = 0, uint16_t slice = 0) const;
+	[[nodiscard]] std::vector<std::byte> getParticleSheetFrameDataAsRGBA8888(uint16_t& spriteWidth, uint16_t& spriteHeight, uint32_t shtSequenceID, uint32_t shtFrame, uint8_t shtBounds = 0, uint8_t mip = 0, uint16_t frame = 0, uint8_t face = 0, uint16_t slice = 0) const;
 
 	void setParticleSheetResource(const SHT& value);
 

src/vtfpp/SHT.cpp

@@ -25,7 +25,7 @@ SHT::SHT(std::span<const std::byte> shtData) {
             frame.duration = stream.read<float>();
             for (uint8_t i = 0; i < this->getFrameBoundsCount(); i++) {
                 auto& bounds = frame.bounds[i];
-	            stream >> bounds.left >> bounds.top >> bounds.right >> bounds.bottom;
+	            stream >> bounds.x1 >> bounds.y1 >> bounds.x2 >> bounds.y2;
             }
         }
     }
@@ -105,7 +105,7 @@ std::vector<std::byte> SHT::bake() const {
 
             for (uint8_t i = 0; i < this->getFrameBoundsCount(); i++) {
 	            auto& bounds = frame.bounds[i];
-                stream << bounds.left << bounds.top << bounds.right << bounds.bottom;
+                stream << bounds.x1 << bounds.y1 << bounds.x2 << bounds.y2;
             }
         }
     }

src/vtfpp/VTF.cpp

@@ -3,6 +3,7 @@
 #include <algorithm>
 #include <cstring>
 #include <unordered_map>
+#include <utility>
 
 #ifdef SOURCEPP_BUILD_WITH_THREADS
 #include <future>
@@ -949,7 +950,7 @@ void VTF::regenerateImageData(ImageFormat newFormat, uint16_t newWidth, uint16_t
 	this->setResourceInternal(Resource::TYPE_IMAGE_DATA, newImageData);
 }
 
-std::vector<std::byte> VTF::getParticleSheetFrameRaw(uint16_t& spriteWidth, uint16_t& spriteHeight, uint32_t shtSequenceID, uint32_t shtFrame, uint8_t shtBounds, uint8_t mip, uint16_t frame, uint8_t face, uint16_t slice) const {
+std::vector<std::byte> VTF::getParticleSheetFrameDataRaw(uint16_t& spriteWidth, uint16_t& spriteHeight, uint32_t shtSequenceID, uint32_t shtFrame, uint8_t shtBounds, uint8_t mip, uint16_t frame, uint8_t face, uint16_t slice) const {
 	spriteWidth = 0;
 	spriteHeight = 0;
 
@@ -969,28 +970,34 @@ std::vector<std::byte> VTF::getParticleSheetFrameRaw(uint16_t& spriteWidth, uint
 	// This will also break if any of the bounds are above 1 or below 0, but that
 	// hasn't been observed in official textures
 	const auto& bounds = sequence->frames[shtFrame].bounds[shtBounds];
-	uint16_t left = std::floor(bounds.left * static_cast<float>(this->getWidth(mip)));
-	uint16_t bottom = std::ceil(bounds.bottom * static_cast<float>(this->getHeight(mip)));
-	uint16_t right = std::ceil(bounds.right * static_cast<float>(this->getWidth(mip)));
-	uint16_t top = std::floor(bounds.top * static_cast<float>(this->getHeight(mip)));
+	uint16_t x1 = std::clamp<uint16_t>(std::floor(bounds.x1 * static_cast<float>(this->getWidth(mip))),  0, this->getWidth(mip));
+	uint16_t y1 = std::clamp<uint16_t>(std::ceil( bounds.y1 * static_cast<float>(this->getHeight(mip))), 0, this->getHeight(mip));
+	uint16_t x2 = std::clamp<uint16_t>(std::ceil( bounds.x2 * static_cast<float>(this->getWidth(mip))),  0, this->getHeight(mip));
+	uint16_t y2 = std::clamp<uint16_t>(std::floor(bounds.y2 * static_cast<float>(this->getHeight(mip))), 0, this->getWidth(mip));
 
-	spriteWidth = (right - left);
-	spriteHeight = (bottom - top);
+	if (x1 > x2) [[unlikely]] {
+		std::swap(x1, x2);
+	}
+	if (y1 > y2) [[unlikely]] {
+		std::swap(y1, y2);
+	}
+	spriteWidth = x2 - x1;
+	spriteWidth = y2 - y1;
 
-	const auto out = ImageConversion::cropImageData(this->getImageDataRaw(mip, frame, face, slice), this->getFormat(), this->getWidth(mip), spriteWidth, left, this->getHeight(mip), spriteHeight, top);
+	const auto out = ImageConversion::cropImageData(this->getImageDataRaw(mip, frame, face, slice), this->getFormat(), this->getWidth(mip), spriteWidth, x1, this->getHeight(mip), spriteHeight, y1);
 	if (out.empty()) {
 		spriteWidth = 0;
 		spriteHeight = 0;
 	}
 	return out;
 }
 
-std::vector<std::byte> VTF::getParticleSheetFrameAs(ImageFormat newFormat, uint16_t& spriteWidth, uint16_t& spriteHeight, uint32_t shtSequenceID, uint32_t shtFrame, uint8_t shtBounds, uint8_t mip, uint16_t frame, uint8_t face, uint16_t slice) const {
-	return ImageConversion::convertImageDataToFormat(this->getParticleSheetFrameRaw(spriteWidth, spriteHeight, shtSequenceID, shtFrame, shtBounds, mip, frame, face, slice), this->getFormat(), newFormat, spriteWidth, spriteHeight);
+std::vector<std::byte> VTF::getParticleSheetFrameDataAs(ImageFormat newFormat, uint16_t& spriteWidth, uint16_t& spriteHeight, uint32_t shtSequenceID, uint32_t shtFrame, uint8_t shtBounds, uint8_t mip, uint16_t frame, uint8_t face, uint16_t slice) const {
+	return ImageConversion::convertImageDataToFormat(this->getParticleSheetFrameDataRaw(spriteWidth, spriteHeight, shtSequenceID, shtFrame, shtBounds, mip, frame, face, slice), this->getFormat(), newFormat, spriteWidth, spriteHeight);
 }
 
-std::vector<std::byte> VTF::getParticleSheetFrameAsRGBA8888(uint16_t& spriteWidth, uint16_t& spriteHeight, uint32_t shtSequenceID, uint32_t shtFrame, uint8_t shtBounds, uint8_t mip, uint16_t frame, uint8_t face, uint16_t slice) const {
-	return this->getParticleSheetFrameAs(ImageFormat::RGBA8888, spriteWidth, spriteHeight, shtSequenceID, shtFrame, shtBounds, mip, frame, face, slice);
+std::vector<std::byte> VTF::getParticleSheetFrameDataAsRGBA8888(uint16_t& spriteWidth, uint16_t& spriteHeight, uint32_t shtSequenceID, uint32_t shtFrame, uint8_t shtBounds, uint8_t mip, uint16_t frame, uint8_t face, uint16_t slice) const {
+	return this->getParticleSheetFrameDataAs(ImageFormat::RGBA8888, spriteWidth, spriteHeight, shtSequenceID, shtFrame, shtBounds, mip, frame, face, slice);
 }
 
 void VTF::setParticleSheetResource(const SHT& value) {