Added virtual functions IsMipmapped, IsCubemap, GetLayers, and GetCubemapLayers to tBaseImage. This will allow simplification of client code that can now be unaware of the exact tImage type.

bluescan · bluescan · commit 8ea66e53db59 · 2024-08-05T14:29:42.000-07:00
diff --git a/Modules/Image/Inc/Image/tBaseImage.h b/Modules/Image/Inc/Image/tBaseImage.h
@@ -20,6 +20,33 @@
 namespace tImage
 {
 class tPicture;
+class tLayer;
+
+
+// These are hany for all image types that may contain cubemaps.
+enum tFaceIndex				: uint32
+{
+	tFaceIndex_Default,
+	tFaceIndex_PosX			= tFaceIndex_Default,
+	tFaceIndex_NegX,
+	tFaceIndex_PosY,
+	tFaceIndex_NegY,
+	tFaceIndex_PosZ,
+	tFaceIndex_NegZ,
+	tFaceIndex_NumFaces
+};
+
+// Faces are always specified using a left-handed coord system even when using the OpenGL functions.
+enum tFaceFlag				: uint32
+{
+	tFaceFlag_PosX			= 1 << tFaceIndex_PosX,
+	tFaceFlag_NegX			= 1 << tFaceIndex_NegX,
+	tFaceFlag_PosY			= 1 << tFaceIndex_PosY,
+	tFaceFlag_NegY			= 1 << tFaceIndex_NegY,
+	tFaceFlag_PosZ			= 1 << tFaceIndex_PosZ,
+	tFaceFlag_NegZ			= 1 << tFaceIndex_NegZ,
+	tFaceFlag_All			= 0xFFFFFFFF
+};
 
 
 // Abstract base class for all tImage types. At a minumum all tImageEXTs need to be able to be set from a single tFrame
@@ -83,23 +110,16 @@ class tBaseImage
 	virtual tAlphaMode GetAlphaMode() const																				{ return tAlphaMode::Unspecified; }
 	virtual tChannelType GetChannelType() const																			{ return tChannelType::Unspecified; }
 
-// @wip
-#if 0
 	// Not all derived classes need to support these next four functions.
-	virtual bool IsMipmapped() const;
-	virtual bool IsCubemap() const;
-
-	// Gets the layers but you're not allowed to delete them, they're not yours. Make sure the list you supply doesn't
-	// delete them when it's destructed. Returns the number of items appended to the list.
-	virtual int GetLayers(tList<tLayer>&) const;
+	virtual bool IsMipmapped() const																					{ return false; }
+	virtual bool IsCubemap() const																						{ return false; }
 
 	// Gets the layers but you're not allowed to delete them, they're not yours. Make sure the list you supply doesn't
 	// delete them when it's destructed. Returns the number of items appended to the list.
-	virtual int GetCubemapLayers(tList<tLayer> layers[tFaceIndex_NumFaces], uint32 faceFlags = tFaceFlag_All) const;
-#endif
+	virtual int GetLayers(tList<tLayer>&) const																			{ return 0; }
+	virtual int GetCubemapLayers(tList<tLayer> layers[tFaceIndex_NumFaces], uint32 faceFlags = tFaceFlag_All) const		{ return 0; }
 
 protected:
-
 	// Pretty sure all tImageXXX classes will find these useful.
 	tPixelFormat PixelFormatSrc														= tPixelFormat::Unspecified;
 	tPixelFormat PixelFormat														= tPixelFormat::Unspecified;
@@ -108,30 +128,4 @@ class tBaseImage
 };
 
 
-// These are hany for all image types that may contain cubemaps.
-enum tFaceIndex				: uint32
-{
-	tFaceIndex_Default,
-	tFaceIndex_PosX			= tFaceIndex_Default,
-	tFaceIndex_NegX,
-	tFaceIndex_PosY,
-	tFaceIndex_NegY,
-	tFaceIndex_PosZ,
-	tFaceIndex_NegZ,
-	tFaceIndex_NumFaces
-};
-
-// Faces are always specified using a left-handed coord system even when using the OpenGL functions.
-enum tFaceFlag				: uint32
-{
-	tFaceFlag_PosX			= 1 << tFaceIndex_PosX,
-	tFaceFlag_NegX			= 1 << tFaceIndex_NegX,
-	tFaceFlag_PosY			= 1 << tFaceIndex_PosY,
-	tFaceFlag_NegY			= 1 << tFaceIndex_NegY,
-	tFaceFlag_PosZ			= 1 << tFaceIndex_PosZ,
-	tFaceFlag_NegZ			= 1 << tFaceIndex_NegZ,
-	tFaceFlag_All			= 0xFFFFFFFF
-};
-
-
 }
diff --git a/Modules/Image/Inc/Image/tImageDDS.h b/Modules/Image/Inc/Image/tImageDDS.h
@@ -170,8 +170,8 @@ class tImageDDS : public tBaseImage
 	bool IsStateSet(StateBit state) const																				{ return (States & (1<<int(state))); }
 	static const char* GetStateDesc(StateBit);
 
-	bool IsMipmapped() const																							{ return (NumMipmapLayers > 1) ? true : false; }
-	bool IsCubemap() const																								{ return IsCubeMap; }
+	bool IsMipmapped() const override																					{ return (NumMipmapLayers > 1) ? true : false; }
+	bool IsCubemap() const override																						{ return IsCubeMap; }
 
 	// Returns true if the loaded dds was a 'modern' dds file and contained the DX10 FourCC in the header. Essentially
 	// modern means the newer DXGI pixel formats were specified in the dds, Returns false for legacy dds files.
@@ -199,10 +199,9 @@ class tImageDDS : public tBaseImage
 	bool StealLayers(tList<tLayer>&);
 	tFrame* GetFrame(bool steal = true) override;
 
-	// @wip
 	// Gets the layers but you're not allowed to delete them, they're not yours. Make sure the list you supply doesn't
 	// delete them when it's destructed. Returns the number of items appended to the list.
-	bool GetLayers(tList<tLayer>&) const;
+	int GetLayers(tList<tLayer>&) const override;
 
 	// Similar to StealLayers except it steals up to 6 layer-lists if the object is a cubemap. If the tImageDDS
 	// is not a cubemap this function returns 0 and leaves the object (and list) unmodified. If you only steal a single
@@ -213,7 +212,7 @@ class tImageDDS : public tBaseImage
 
 	// Alternative to StealCubemapLayers. Gets the layers but you're not allowed to delete them, they're not yours. Make
 	// sure the list you supply doesn't delete them when it's destructed.
-	int GetCubemapLayers(tList<tLayer> layers[tFaceIndex_NumFaces], uint32 faceFlags = tFaceFlag_All) const;
+	int GetCubemapLayers(tList<tLayer> layers[tFaceIndex_NumFaces], uint32 faceFlags = tFaceFlag_All) const override;
 
 	// You do not own the returned pointer.
 	tLayer* GetLayer(int layerNum, int imageNum) const																	{ return Layers[layerNum][imageNum]; }
diff --git a/Modules/Image/Inc/Image/tImageKTX.h b/Modules/Image/Inc/Image/tImageKTX.h
@@ -167,8 +167,8 @@ class tImageKTX : public tBaseImage
 	bool IsStateSet(StateBit state) const																				{ return (States & (1<<int(state))); }
 	static const char* GetStateDesc(StateBit);
 
-	bool IsMipmapped() const																							{ return (NumMipmapLayers > 1) ? true : false; }
-	bool IsCubemap() const																								{ return IsCubeMap; }
+	bool IsMipmapped() const override																					{ return (NumMipmapLayers > 1) ? true : false; }
+	bool IsCubemap() const override																						{ return IsCubeMap; }
 	bool RowsReversed() const																							{ return RowReversalOperationPerformed; }
 
 	// The number of mipmap levels per image is always the same if there is more than one image in the direct texture
@@ -192,9 +192,9 @@ class tImageKTX : public tBaseImage
 	bool StealLayers(tList<tLayer>&);
 	tFrame* GetFrame(bool steal = true) override;
 
-	// Alternative to StealLayers. Gets the layers but you're not allowed to delete them, they're not yours. Make
-	// sure the list you supply doesn't delete them when it's destructed.
-	bool GetLayers(tList<tLayer>&) const;
+	// Gets the layers but you're not allowed to delete them, they're not yours. Make sure the list you supply doesn't
+	// delete them when it's destructed. Returns the number of items appended to the list.
+	int GetLayers(tList<tLayer>&) const override;
 
 	// Similar to StealLayers except it steals up to 6 layer-lists if the object is a cubemap. If the tImageKTX
 	// is not a cubemap this function returns 0 and leaves the object (and list) unmodified. If you only steal a single
@@ -203,9 +203,9 @@ class tImageKTX : public tBaseImage
 	// were populated.
 	int StealCubemapLayers(tList<tLayer> layers[tFaceIndex_NumFaces], uint32 faceFlags = tFaceFlag_All);
 
-	// Alternative to StealCubemapLayers. Gets the layers but you're not allowed to delete them, they're not yours. Make
-	// sure the list you supply doesn't delete them when it's destructed.
-	int GetCubemapLayers(tList<tLayer> layers[tFaceIndex_NumFaces], uint32 faceFlags = tFaceFlag_All) const;
+	// Gets the layers but you're not allowed to delete them, they're not yours. Make sure the list you supply doesn't
+	// delete them when it's destructed. Returns the number of items appended to the list.
+	int GetCubemapLayers(tList<tLayer> layers[tFaceIndex_NumFaces], uint32 faceFlags = tFaceFlag_All) const override;
 
 	// You do not own the returned pointer.
 	tLayer* GetLayer(int layerNum, int imageNum) const																	{ return Layers[layerNum][imageNum]; }
diff --git a/Modules/Image/Inc/Image/tImagePVR.h b/Modules/Image/Inc/Image/tImagePVR.h
@@ -172,8 +172,8 @@ class tImagePVR : public tBaseImage
 	bool IsStateSet(StateBit state) const																				{ return (States & (1<<int(state))); }
 	static const char* GetStateDesc(StateBit);
 
-	bool IsMipmapped() const																							{ return (NumMipmaps > 1) ? true : false; }
-	bool IsCubemap() const																								{ return (NumFaces == 6); }
+	bool IsMipmapped() const override																					{ return (NumMipmaps > 1) ? true : false; }
+	bool IsCubemap() const override																						{ return (NumFaces == 6); }
 
 	// Returns the pvr container format version. If the tImagePVR is not valid -1 is returned. If the tImagePVR is valid
 	// but was not loaded from a .pvr file, 0 is returned. Otherwise 1 is returned for V1, 2 is returned for V2, and 3
@@ -203,9 +203,9 @@ class tImagePVR : public tBaseImage
 	bool StealLayers(tList<tLayer>&);
 	tFrame* GetFrame(bool steal = true) override;
 
-	// Alternative to StealLayers. Gets the layers but you're not allowed to delete them, they're not yours. Make
-	// sure the list you supply doesn't delete them when it's destructed. Same rules regarding cubemaps.
-	bool GetLayers(tList<tLayer>&) const;
+	// Gets the layers but you're not allowed to delete them, they're not yours. Make sure the list you supply doesn't
+	// delete them when it's destructed. Returns the number of items appended to the list.
+	int GetLayers(tList<tLayer>&) const override;
 
 	// Similar to StealLayers except it steals up to 6 layer-lists if the object is a cubemap. If the tImagePVR
 	// is not a cubemap this function returns 0 and leaves the object (and list) unmodified. If you only steal a single
@@ -214,9 +214,9 @@ class tImagePVR : public tBaseImage
 	// were populated.
 	int StealCubemapLayers(tList<tLayer> layers[tFaceIndex_NumFaces], uint32 faceFlags = tFaceFlag_All);
 
-	// Alternative to StealCubemapLayers. Gets the layers but you're not allowed to delete them, they're not yours. Make
-	// sure the list you supply doesn't delete them when it's destructed.
-	int GetCubemapLayers(tList<tLayer> layers[tFaceIndex_NumFaces], uint32 faceFlags = tFaceFlag_All) const;
+	// Gets the layers but you're not allowed to delete them, they're not yours. Make sure the list you supply doesn't
+	// delete them when it's destructed. Returns the number of items appended to the list.
+	int GetCubemapLayers(tList<tLayer> layers[tFaceIndex_NumFaces], uint32 faceFlags = tFaceFlag_All) const override;
 
 	// You do not own the returned pointer.
 	tLayer* GetLayer(int layerNum, int imageNum) const;
diff --git a/Modules/Image/Src/tImageDDS.cpp b/Modules/Image/Src/tImageDDS.cpp
@@ -1017,15 +1017,15 @@ bool tImageDDS::StealLayers(tList<tLayer>& layers)
 }
 
 
-bool tImageDDS::GetLayers(tList<tLayer>& layers) const
+int tImageDDS::GetLayers(tList<tLayer>& layers) const
 {
 	if (!IsValid() || IsCubemap() || (NumImages <= 0))
-		return false;
+		return 0;
 
 	for (int mip = 0; mip < NumMipmapLayers; mip++)
 		layers.Append(Layers[mip][0]);
 
-	return true;
+	return NumMipmapLayers;
 }
 
 
diff --git a/Modules/Image/Src/tImageKTX.cpp b/Modules/Image/Src/tImageKTX.cpp
@@ -676,15 +676,15 @@ bool tImageKTX::StealLayers(tList<tLayer>& layers)
 }
 
 
-bool tImageKTX::GetLayers(tList<tLayer>& layers) const
+int tImageKTX::GetLayers(tList<tLayer>& layers) const
 {
 	if (!IsValid() || IsCubemap() || (NumImages <= 0))
-		return false;
+		return 0;
 
 	for (int mip = 0; mip < NumMipmapLayers; mip++)
 		layers.Append(Layers[mip][0]);
 
-	return true;
+	return NumMipmapLayers;
 }
 
 
diff --git a/Modules/Image/Src/tImagePVR.cpp b/Modules/Image/Src/tImagePVR.cpp
@@ -1325,15 +1325,15 @@ bool tImagePVR::StealLayers(tList<tLayer>& layers)
 }
 
 
-bool tImagePVR::GetLayers(tList<tLayer>& layers) const
+int tImagePVR::GetLayers(tList<tLayer>& layers) const
 {
 	if (!IsValid() || IsCubemap())
-		return false;
+		return 0;
 
 	for (int layer = 0; layer < NumLayers; layer++)
 		layers.Append(Layers[layer]);
 
-	return true;
+	return NumLayers;
 }
 
 

Original file line number	Diff line number	Diff line change
`@@ -1017,15 +1017,15 @@ bool tImageDDS::StealLayers(tList<tLayer>& layers)`
`1017`	`1017`	`}`
`1018`	`1018`
`1019`	`1019`
`1020`		`-bool tImageDDS::GetLayers(tList<tLayer>& layers) const`
	`1020`	`+int tImageDDS::GetLayers(tList<tLayer>& layers) const`
`1021`	`1021`	`{`
`1022`	`1022`	`if (!IsValid() \|\| IsCubemap() \|\| (NumImages <= 0))`
`1023`		`- return false;`
	`1023`	`+ return 0;`
`1024`	`1024`
`1025`	`1025`	`for (int mip = 0; mip < NumMipmapLayers; mip++)`
`1026`	`1026`	`layers.Append(Layers[mip][0]);`
`1027`	`1027`
`1028`		`- return true;`
	`1028`	`+ return NumMipmapLayers;`
`1029`	`1029`	`}`
`1030`	`1030`
`1031`	`1031`
Original file line number	Diff line number	Diff line change
`@@ -676,15 +676,15 @@ bool tImageKTX::StealLayers(tList<tLayer>& layers)`
`676`	`676`	`}`
`677`	`677`
`678`	`678`
`679`		`-bool tImageKTX::GetLayers(tList<tLayer>& layers) const`
	`679`	`+int tImageKTX::GetLayers(tList<tLayer>& layers) const`
`680`	`680`	`{`
`681`	`681`	`if (!IsValid() \|\| IsCubemap() \|\| (NumImages <= 0))`
`682`		`- return false;`
	`682`	`+ return 0;`
`683`	`683`
`684`	`684`	`for (int mip = 0; mip < NumMipmapLayers; mip++)`
`685`	`685`	`layers.Append(Layers[mip][0]);`
`686`	`686`
`687`		`- return true;`
	`687`	`+ return NumMipmapLayers;`
`688`	`688`	`}`
`689`	`689`
`690`	`690`
Original file line number	Diff line number	Diff line change
`@@ -1325,15 +1325,15 @@ bool tImagePVR::StealLayers(tList<tLayer>& layers)`
`1325`	`1325`	`}`
`1326`	`1326`
`1327`	`1327`
`1328`		`-bool tImagePVR::GetLayers(tList<tLayer>& layers) const`
	`1328`	`+int tImagePVR::GetLayers(tList<tLayer>& layers) const`
`1329`	`1329`	`{`
`1330`	`1330`	`if (!IsValid() \|\| IsCubemap())`
`1331`		`- return false;`
	`1331`	`+ return 0;`
`1332`	`1332`
`1333`	`1333`	`for (int layer = 0; layer < NumLayers; layer++)`
`1334`	`1334`	`layers.Append(Layers[layer]);`
`1335`	`1335`
`1336`		`- return true;`
	`1336`	`+ return NumLayers;`
`1337`	`1337`	`}`
`1338`	`1338`
`1339`	`1339`