MImageFileInfo Class Reference

#include <MImageFileInfo.h>

Class Description

Image manipulation.

This class provides methods for reading file images stored on disk.

MImageFileInfo is a utility class used to describe the characteristics of an image file, such as dimensions, channel count, and pixel format. This class is used in MPxImageFile.

Examples:

Public Types
enum	MHwTextureType {   kHwTextureUnknown, kHwTexture1D, kHwTexture2D, kHwTexture3D,   kHwTextureRectangle, kHwTextureCubeMap }
	Hardware texture types. More...
enum	MImageType { kImageTypeUnknown, kImageTypeColor, kImageTypeNormal, kImageTypeBump }
	Image types. More...

Public Member Functions
	MImageFileInfo ()
	The default class constructor. More...
void	width (unsigned int value)
	Set the width in pixels of this image file. More...
void	height (unsigned int value)
	Set the height in pixels of this image file. More...
void	channels (unsigned int value)
	Set the number of channels per pixels in this image file. More...
void	numberOfImages (unsigned int value)
	Set the total number of images in this image file. More...
void	pixelType (MImage::MPixelType value)
	Set the native pixel format of this image file. More...
void	imageType (MImageType value)
	Set the type of information stored in this image file (e.g. More...
void	hardwareType (MHwTextureType value)
	Set the hardware texture type of this image file, configuring whether this image contains a 2D texture, a cubemap, etc. More...
void	hasAlpha (bool value)
	Set whether or not this image file contains alpha. More...
void	hasMipMaps (bool value)
	Set whether or not this image file contains or can generate mipmaps. More...
unsigned int	width () const
	Get the width in pixels of this image file. More...
unsigned int	height () const
	Get the height in pixels of this image file. More...
unsigned int	channels () const
	Get the number of channels in this image file. More...
unsigned int	numberOfImages () const
	Get the number of images in this image file. More...
MImage::MPixelType	pixelType () const
	Get the native pixel format of this image file. More...
MImageType	imageType () const
	Query the type of information in this image file (e.g. More...
MHwTextureType	hardwareType () const
	Get the hardware texture type of this image file, describing whether this image contains a 2D texture, a cubemap, etc. More...
bool	hasAlpha () const
	Query whether this image contains alpha information. More...
bool	hasMipMaps () const
	Query whether this image contains or can generate mipmap information. More...

Member Enumeration Documentation

enum MHwTextureType

Hardware texture types.

Enumerator
kHwTextureUnknown
kHwTexture1D
kHwTexture2D
kHwTexture3D
kHwTextureRectangle
kHwTextureCubeMap

enum MImageType

Image types.

Enumerator
kImageTypeUnknown
kImageTypeColor
kImageTypeNormal
kImageTypeBump

Constructor & Destructor Documentation

MImageFileInfo

(

)

The default class constructor.

Initialize the image information structure.

Member Function Documentation

void width

(

unsigned int

value

)

Set the width in pixels of this image file.

Parameters

[in]

value

the width in pixels

Examples:

void height

(

unsigned int

value

)

Set the height in pixels of this image file.

Parameters

[in]

value

the height in pixels

Examples:

void channels

(

unsigned int

value

)

Set the number of channels per pixels in this image file.

Parameters

[in]

value

the number of channels per pixel

Examples:

void numberOfImages

(

unsigned int

value

)

Set the total number of images in this image file.

Parameters

[in]

value

the number of images

Examples:

void pixelType

(

MImage::MPixelType

value

)

Set the native pixel format of this image file.

Parameters

[in]

value

the native pixel format of this image file

Examples:

void imageType

(

MImageType

value

)

Set the type of information stored in this image file (e.g.

the image contains a color map, a bump map, etc). This is an optional call as most image file formats do not describe the semantic use of the pixels they contains. In such cases it is safe to leave this as the default value of kImageTypeUnknown.

Parameters

[in]

value

the type of information in this image file

Examples:

void hardwareType

(

MHwTextureType

value

)

Set the hardware texture type of this image file, configuring whether this image contains a 2D texture, a cubemap, etc.

Parameters

[in]

value

the hardware texture type of this image file

Examples:

void hasAlpha

(

bool

value

)

Set whether or not this image file contains alpha.

Parameters

[in]

value

true if the image contains alpha, false otherwise.

Examples:

void hasMipMaps

(

bool

value

)

Set whether or not this image file contains or can generate mipmaps.

Parameters

[in]

value

true if the image contains or can generate mipmaps, false otherwise.

Examples:

unsigned int width

(

)

const

Get the width in pixels of this image file.

Returns

The width in pixels

unsigned int height

(

)

const

Get the height in pixels of this image file.

Returns

The height in pixels

unsigned int channels

(

)

const

Get the number of channels in this image file.

Returns

The number of channels in this image file

unsigned int numberOfImages

(

)

const

Get the number of images in this image file.

Returns

The number of images in this image file

MImage::MPixelType pixelType

(

)

const

Get the native pixel format of this image file.

Returns

The image file's native pixel format

MImageFileInfo::MImageType imageType

(

)

const

Query the type of information in this image file (e.g.

is it a color map, a normal map, etc). Most image file formats do not contain this information, meaning this will be left as kImageTypeUnknown.

Returns

The type of information stored in this image file

MImageFileInfo::MHwTextureType hardwareType

(

)

const

Get the hardware texture type of this image file, describing whether this image contains a 2D texture, a cubemap, etc.

Returns

The image file's hardware texture type

bool hasAlpha

(

)

const

Query whether this image contains alpha information.

Returns

true if this image contains alpha, false otherwise

bool hasMipMaps

(

)

const

Query whether this image contains or can generate mipmap information.

Returns

true if this image contains or can generate mipmaps, false otherwise

---

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

• MImageFileInfo.h
• MImageFileInfo.cpp