Python API 2.0 Reference
OpenMayaRender.MColorManagementUtilities Class Reference
+ Inheritance diagram for OpenMayaRender.MColorManagementUtilities:

Static Public Member Functions

def getColorTransformCacheIdForInputSpace ()
 
def getColorTransformCacheIdForOutputTransform ()
 
def getColorTransformData ()
 
def isColorManagementAvailable ()
 
def isColorManagementEnabled ()
 

Detailed Description

Utilities class for color management

Member Function Documentation

def OpenMayaRender.MColorManagementUtilities.getColorTransformCacheIdForInputSpace ( )
static
getColorTransformCacheIdForInputSpace(inputSpaceName) -> transformId

Utility function to retrieve the id of a color transform
based on the input color space name provided.

The color transform id corresponds to a color transform that
converts colors from the input color space specified to the scene
rendering space

For example, given the name of the input color space of a node,
this function retrieves the id of the color transform to be used
for mapping colors from input space to rendering space.  For nodes
that have such a color space attribute, the transform id is meant
to be written by a file translator plug-in to a renderer file
alongside the node information. This id corresponds to a color
transform contained in the color transform data retrieved by
MRenderUtilities::getColorTransformData.

* inputSpaceName (string) - Name of the color space of the node.

Returns identifier of the color transform required to be 
applied to the node.
def OpenMayaRender.MColorManagementUtilities.getColorTransformCacheIdForOutputTransform ( )
static
getColorTransformCacheIdForOutputTransform() -> transformId

Utility function to retrieve the id of the color transform to be applied on the final output.

The color transform id corresponds to a color transform that
converts colors of the rendered image to a target color space.

This id corresponds to a color transform contained in the color
transform data retrieved by the MColorTransformData class.

Returns identifier of the color transform required to be 
applied on the rendered image
def OpenMayaRender.MColorManagementUtilities.getColorTransformData ( )
static
getColorTransformData() -> (size, data)

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

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

Returns the color transform data block info (bytearray).
def OpenMayaRender.MColorManagementUtilities.isColorManagementAvailable ( )
static
isColorManagementAvailable() -> Boolean

Returns whether color management is available for the current scene.

True if color management is enabled.
def OpenMayaRender.MColorManagementUtilities.isColorManagementEnabled ( )
static
isColorManagementEnabled() -> Boolean

Returns whether color management is enabled for the current scene.

True if color management is enabled.