MRenderPassRegistry Class Reference
[OpenMayaRender - API module for rendering]

#include <MRenderPassRegistry.h>

List of all members.


Detailed Description

Access the render pass registry.

This class provides a means to register custom render pass definitions with Maya's internal render pass registry. It can also be used to query pass definitions.


Static Public Member Functions

static MRenderPassDef  getRenderPassDefinition (const MString &passID, MStatus *ReturnStatus=NULL)
static MRenderPassDef  registerRenderPassDefinition (const MString &passID, const MString &passName, const MString &passGroup, const MString &description, bool overload=false, MStatus *ReturnStatus=NULL)

Member Function Documentation

MRenderPassDef MRenderPassRegistry::getRenderPassDefinition ( const MString passID,
MStatus ReturnStatus = NULL  
) [static]

Retrieve the definition of the specified render pass

Parameters:
[out]  ReturnStatus  Storage for status code
Returns:
The render pass definition if successful
Status Codes:

MRenderPassDef MRenderPassRegistry::registerRenderPassDefinition ( const MString passID,
const MString passName,
const MString passGroup,
const MString description,
bool  overload = false,
MStatus ReturnStatus = NULL  
) [static]

Creates a new render pass definition and registers it with the internal render pass registry. Returns the definition.

Parameters:
[in]  passID  The ID of the pass
[in]  passName  The name of the new pass
[in]  passGroup  The classification of the new pass
[in]  description  A description of the new pass
[in]  overload  If true, override any existing pass with the same passID with this pass definiton
[out]  ReturnStatus  Storage for status code
Returns:
The render pass definition if successful
Status Codes:

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