MImageFileInfo Class Reference
#include <MImageFileInfo.h>
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 .
Hardware texture types.
Enumerator kHwTextureUnknown
kHwTexture1D
kHwTexture2D
kHwTexture3D
kHwTextureRectangle
kHwTextureCubeMap
Image types.
Enumerator kImageTypeUnknown
kImageTypeColor
kImageTypeNormal
kImageTypeBump
The default class constructor.
Initialize the image information structure.
void width
(
unsigned int
value )
Set the width in pixels of this image file.
Parameters
[in] value the width in pixels
void height
(
unsigned int
value )
Set the height in pixels of this image file.
Parameters
[in] value the height in pixels
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
void numberOfImages
(
unsigned int
value )
Set the total number of images in this image file.
Parameters
[in] value the number of images
Set the native pixel format of this image file.
Parameters
[in] value the native pixel format of this image file
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
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
void hasAlpha
(
bool
value )
Set whether or not this image file contains alpha.
Parameters
[in] value true if the image contains alpha, false otherwise.
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.
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
Get the native pixel format of this image file.
Returns The image file's native pixel format
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
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
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