ImagePlane

struct ImagePlane {
  UInt32 Width, Height;
  UPInt Pitch;
  UPInt DataSize;
  UByte* pData;
};

Description

ImagePlane describes one addressable data plane of an image in memory. The included DataSize field describes the size of pData buffer in bytes. Although for a typical image, DataSize == Height * Pitch, this is not so for the following two cases:

a) For image with multiple consecutive mip-levels, DataSize will be larger as it includes all mip-levels.

b) For a hardware format image, Pitch may be 0, while DataSize describes the size of hardware-format image data pointer pointed to by pData.

Data Members

Data Member	Description
DataSize	Specifies size of buffer at pData in bytes.
Height	Specifies height of the image data in pixels.
pData	A pointer to the first byte of image data in memory.
Pitch	Specifies size of one image scan-line in bytes; does not apply to DXT formats.
Width	Specifies width of the image data in pixels.

Methods

Method	Description
GetMipLevel	Obtains an ImagePlane for the specified mipmap level.
GetScanline	Access the scanline of the image.
GetSize	Retrieves the size of the image.
ImagePlane	ImagePlane constructor.
MatchSizes	Compares the size of the current ImagePlane with another one.
SetData	Assigns data for the data plane of an image.
SetNextMipSize	Calculates the size of the next mipmap level of the image.
SetSize	Sets the size of the image.

Operators

Operator	Description
=	Assigns the value of the passed ImagePlane to the current ImagePlane.

File

Render_Image.h