MImageFileInfo Class Reference
[OpenMaya - API module for common classes]

#include <MImageFileInfo.h>

List of all members.


Detailed 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:

ddsFloatReader.cpp, OpenEXR.cpp, simpleImageFile.cpp, and tiffFloatReader.cpp.


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 ()
void width (unsigned int value)
void height (unsigned int value)
void channels (unsigned int value)
void numberOfImages (unsigned int value)
void pixelType (MImage::MPixelType value)
void imageType (MImageType value)
void hardwareType (MHwTextureType value)
void hasAlpha (bool value)
void hasMipMaps (bool value)
unsigned int width () const
unsigned int height () const
unsigned int channels () const
unsigned int numberOfImages () const
MImage::MPixelType pixelType () const
MImageType imageType () const
MHwTextureType hardwareType () const
bool hasAlpha () const
bool hasMipMaps () const

Member Enumeration Documentation

Hardware texture types.

Enumerator:
kHwTextureUnknown   
kHwTexture1D   
kHwTexture2D   
kHwTexture3D   
kHwTextureRectangle   
kHwTextureCubeMap   

Image types.

Enumerator:
kImageTypeUnknown   
kImageTypeColor   
kImageTypeNormal   
kImageTypeBump   


Constructor & Destructor Documentation

MImageFileInfo::MImageFileInfo (  ) 

The default class constructor. Initialize the image information structure.


Member Function Documentation

void MImageFileInfo::width ( unsigned int  value  ) 

Set the width in pixels of this image file.

Parameters:
[in] value the width in pixels
Examples:

void MImageFileInfo::height ( unsigned int  value  ) 

Set the height in pixels of this image file.

Parameters:
[in] value the height in pixels
Examples:

void MImageFileInfo::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 MImageFileInfo::numberOfImages ( unsigned int  value  ) 

Set the total number of images in this image file.

Parameters:
[in] value the number of images
Examples:

void MImageFileInfo::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 MImageFileInfo::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 MImageFileInfo::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 MImageFileInfo::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 MImageFileInfo::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 MImageFileInfo::width (  )  const

Get the width in pixels of this image file.

Returns:
The width in pixels

unsigned int MImageFileInfo::height (  )  const

Get the height in pixels of this image file.

Returns:
The height in pixels

unsigned int MImageFileInfo::channels (  )  const

Get the number of channels in this image file.

Returns:
The number of channels in this image file

unsigned int MImageFileInfo::numberOfImages (  )  const

Get the number of images in this image file.

Returns:
The number of images in this image file

MImage::MPixelType MImageFileInfo::pixelType (  )  const

Get the native pixel format of this image file.

Returns:
The image file's native pixel format

MImageFileInfo::MImageType MImageFileInfo::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 MImageFileInfo::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 MImageFileInfo::hasAlpha (  )  const

Query whether this image contains alpha information.

Returns:
true if this image contains alpha, false otherwise

bool MImageFileInfo::hasMipMaps (  )  const

Query whether this image contains or can generate mipmap information.

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


Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6