---

GAUGE3D::GImage::FormatDesc Struct Reference

GImage::FormatDesc describes the format of raw image data obtained from a GImage. More...

#include <gauge3d/graphics/image.h>

List of all members.

Public Attributes
int	mWidth
	Width of the image, in pixels.
int	mHeight
	Height of the image, in pixels.
int	mNumChannels
	Number of color channels in the image.
int	mBitsPerChannel
	Number of bits per element per channel.
bool	mHasMipmaps
	True if the image has built-in mipmaps.
GString	mEncoding
	The encoding/compression used to store the image. (JPEG, FXT1, etc.).

---

Detailed Description

GImage::FormatDesc describes the format of raw image data obtained from a GImage.

mNumChannels stores the number of channels in the image. This should be a number between 1 and 4, inclusive. A typical RGB image has three channels (red, green, and blue) while RGBA has four and grayscale has one.

mBitsPerChannel can 4 (for 16-bit images), 8 (for 32-bit images), or 5. In the case of 5, the image is 16-bits-per-pixel, and must contain three or four channels. If it contains three channels, the last bit of each 16 is ignored. If it contains four channels, the last bit of each 16 is interpreted as the fourth channel (a one-bit channel).

---

The documentation for this struct was generated from the following file:

• gauge3d/graphics/image.h

---