---

GAUGE3D::GImage Class Reference

Base class for image plugins. More...

#include <gauge3d/graphics/image.h>

Inherits GAUGE3D::GObject.

List of all members.

Public Methods
virtual	~GImage ()
virtual FormatDesc	Format ()=0
	Get the image format.
virtual GArray<uint8>	Data (int mipmapLevel=0)=0
	Gets the raw image data in the format given by GetFormat(). More...
virtual GArray<uint8>	EncodedData (int mipmapLevel=0)=0
	Gets the encoded image data. More...

---

Detailed Description

Base class for image plugins.

GImage describes simple images in an abstract way. Plugins that support specific image formats (like GIF or JPEG) are derived from this.

---

Member Function Documentation

GArray< uint8 > GAUGE3D::GImage::Data ( int mipmapLevel = 0 ) [pure virtual]

Gets the raw image data in the format given by GetFormat(). Parameters: mipmapLevel   The mip map to return. For example, for a 64x64 image, level 0 is 64x64, 1 is 32x32, 2 is 16x16, etc. Images that don't provide mip maps should ignore this. Returns: The raw image data in the given format.

GArray< uint8 > GAUGE3D::GImage::EncodedData ( int mipmapLevel = 0 ) [pure virtual]

Gets the encoded image data. Parameters: mipmapLevel   The mip map to return. For example, for a 64x64 image, level 0 is 64x64, 1 is 32x32, 2 is 16x16, etc. Images that don't provide mip maps and images encodings whing encode multiple mipmap levels together should ignore this. Returns: The image, encoded in whatever format the image file was in. So, it may be jpeg compressed, or FXT1, or whatever.

---

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

• gauge3d/graphics/image.h

---