Public Member Functions | Static Public Member Functions | Friends

MRenderPassDef Class Reference

Search for all occurrences

Detailed Description

Render pass information.

This class provides a means to access information about a specific render pass. Initialize by passing to MRenderPassRegistry::getRenderPassDefinition(), or by calling create() to generate and register a new pass.

#include <MRenderPassDef.h>

List of all members.

Public Member Functions

virtual ~MRenderPassDef ()
 Destructor.
MPxRenderPassImplgetImplementation (const MString &renderer, MPxRenderPassImpl::PassTypeBit fbType, unsigned int numChannels, MStatus *ReturnStatus=NULL)
 Retrieve an implementation of this render pass for the given renderer.
MPxRenderPassImplgetImplementation (const MString &renderer, MStatus *ReturnStatus=NULL)
 Retrieve an implementation of this render pass for the given renderer.
MString getID (MStatus *ReturnStatus=NULL) const
 Retrieve the pass ID for this pass.
MString getName (MStatus *ReturnStatus=NULL) const
 Retrieve the pass name for this pass.
MString getGroup (MStatus *ReturnStatus=NULL) const
 Retrieve the pass group for this pass.
MString getDescription (MStatus *ReturnStatus=NULL) const
 Retrieve the description for this pass.
MString getAttributeType (const MString &attributeName, MStatus *ReturnStatus=NULL) const
 Retrieve the type of a given render pass attribute.
MStatus addFloatParameter (const MString &longName, const MString &shortName, const MString &UIName, const float &minValue, const float &maxValue, const float &defaultValue)
 Define a single-precision floating-point parameter for the pass.
MStatus addDoubleParameter (const MString &longName, const MString &shortName, const MString &UIName, const double &minValue, const double &maxValue, const double &defaultValue)
 Define a double-precision floating-point parameter for the pass.
MStatus addIntParameter (const MString &longName, const MString &shortName, const MString &UIName, const int &minValue, const int &maxValue, const int &defaultValue)
 Define an integer parameter for the pass.

Static Public Member Functions

static const char * className ()
 Returns the name of this class.

Friends

class MRenderPassRegistry
class MFnPlugin

Member Function Documentation

MPxRenderPassImpl * getImplementation ( const MString renderer,
MPxRenderPassImpl::PassTypeBit  fbType,
unsigned int  numChannels,
MStatus ReturnStatus = NULL 
)

Retrieve an implementation of this render pass for the given renderer.

That supports the specified data type and the specified number of channels.

Parameters:
[in]rendererThe renderer
[in]fbTypeThe base data type of the frame buffer
[in]numChannelsThe number of components per pixel in the frame buffer
[out]ReturnStatusStatus code
Returns:
A pointer to the pass implementation or null if no definition exists
Status Codes:
MPxRenderPassImpl * getImplementation ( const MString renderer,
MStatus ReturnStatus = NULL 
)

Retrieve an implementation of this render pass for the given renderer.

Parameters:
[in]rendererThe renderer
[out]ReturnStatusStatus code
Returns:
A pointer to the pass implementation or null if no definition exists
Status Codes:
MString getID ( MStatus ReturnStatus = NULL) const

Retrieve the pass ID for this pass.

Parameters:
[out]ReturnStatusStatus code
Returns:
The pass ID
Status Codes:
MString getName ( MStatus ReturnStatus = NULL) const

Retrieve the pass name for this pass.

Parameters:
[out]ReturnStatusStatus code
Returns:
The pass name
Status Codes:
MString getGroup ( MStatus ReturnStatus = NULL) const

Retrieve the pass group for this pass.

Parameters:
[out]ReturnStatusStatus code
Returns:
The pass group
Status Codes:
MString getDescription ( MStatus ReturnStatus = NULL) const

Retrieve the description for this pass.

Parameters:
[out]ReturnStatusStatus code
Returns:
The description
Status Codes:
MString getAttributeType ( const MString attributeName,
MStatus ReturnStatus = NULL 
) const

Retrieve the type of a given render pass attribute.

Parameters:
[in]attributeNameThe name of the render pass attribute to query.
[out]ReturnStatusStatus code.
Returns:
The type of the given attribute.
Status Codes:
MStatus addFloatParameter ( const MString longName,
const MString shortName,
const MString UIName,
const float &  minValue,
const float &  maxValue,
const float &  defaultValue 
)

Define a single-precision floating-point parameter for the pass.

Parameters:
[in]longNameThe full name of the parameter
[in]shortNameThe short name of the parameter
[in]UINameName to display in UI for the parameter
[in]minValueThe minimum value of the parameter
[in]maxValueThe maximum value of the parameter
[in]defaultValueThe default value of the parameter
Returns:
Status code
Status Codes:
MStatus addDoubleParameter ( const MString longName,
const MString shortName,
const MString UIName,
const double &  minValue,
const double &  maxValue,
const double &  defaultValue 
)

Define a double-precision floating-point parameter for the pass.

Parameters:
[in]longNameThe full name of the parameter
[in]shortNameThe short name of the parameter
[in]UINameName to display in UI for the parameter
[in]minValueThe minimum value of the parameter
[in]maxValueThe maximum value of the parameter
[in]defaultValueThe default value of the parameter
Returns:
Status
Status Codes:
MStatus addIntParameter ( const MString longName,
const MString shortName,
const MString UIName,
const int &  minValue,
const int &  maxValue,
const int &  defaultValue 
)

Define an integer parameter for the pass.

Parameters:
[in]longNameThe full name of the parameter
[in]shortNameThe short name of the parameter
[in]UINameName to display in UI for the parameter
[in]minValueThe minimum value of the parameter
[in]maxValueThe maximum value of the parameter
[in]defaultValueThe default value of the parameter
Returns:
Status
Status Codes:
const char * className ( ) [static]

Returns the name of this class.

Returns:
The name of this class.

MRenderPassDef MRenderPassDef MRenderPassDef MRenderPassDef MRenderPassDef MRenderPassDef MRenderPassDef MRenderPassDef MRenderPassDef MRenderPassDef
MRenderPassDef MRenderPassDef MRenderPassDef MRenderPassDef MRenderPassDef MRenderPassDef MRenderPassDef MRenderPassDef MRenderPassDef MRenderPassDef