MColorManagementUtilities::MColorTransformData Class Reference

MColorManagementUtilities::MColorTransformData Class Reference

#include <MColorManagementUtilities.h>

Class Description

Utility class that retrieves the opaque data containing the color transform information needed to render the scene.

This class manages internally a buffer that contains data about color transformation used in the scene. The buffer managed herein whose pointer is returned by the 'getData' method is only valid during the lifetime of this object's instance.

+ Examples:

Public Member Functions

 MColorTransformData ()
 MColorTransformData constructor. More...
 
 ~MColorTransformData ()
 MColorTransformData destructor. More...
 
const unsigned getSize () const
 Obtain the size of the opaque data block containing the color transform information needed to render the scene. More...
 
const void * getData () const
 Obtain a reference to the opaque data block containing the color transform information needed to render the scene. More...
 

Constructor & Destructor Documentation

MColorTransformData constructor.

This constructor creates the opaque data block containing the color transform information needed to render the scene.

Note
The memory allocated for the data block is only valid during the lifetime of the MColorTransformData instance.

MColorTransformData destructor.

This destructor frees the memory that contains color transform data block. Once called, the pointer address that was obtained by the getData method is no longer valid.

Member Function Documentation

const unsigned getSize ( ) const

Obtain the size of the opaque data block containing the color transform information needed to render the scene.

Returns
the size in bytes of the data block retured by MColorManagementUtilities::MColorTransformData::getData().
+ Examples:
const void * getData ( ) const

Obtain a reference to the opaque data block containing the color transform information needed to render the scene.

This block of data is meant to be writen by a file translator plug-in to a renderer file. With the help of the SynColor SDK and this block of data, the extenal renderer can reproduce the same color transformations as in Maya.

Note
The pointer returned by this method is only valid during the lifetime of the MColorTransformData instance.
Returns
a pointer to an opaque block of data.
+ Examples:

The documentation for this class was generated from the following files:
  • MColorManagementUtilities.h
  • MColorManagementUtilities.cpp