MRenderPassDef Class Reference
#include <MRenderPassDef.h>
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.
virtual ~MRenderPassDef ()
Destructor.
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. More...
MPxRenderPassImpl * getImplementation (const MString &renderer, MStatus *ReturnStatus=NULL)
Retrieve an implementation of this render pass for the given renderer. More...
MString getID (MStatus *ReturnStatus=NULL) const
Retrieve the pass ID for this pass. More...
MString getName (MStatus *ReturnStatus=NULL) const
Retrieve the pass name for this pass. More...
MString getGroup (MStatus *ReturnStatus=NULL) const
Retrieve the pass group for this pass. More...
MString getDescription (MStatus *ReturnStatus=NULL) const
Retrieve the description for this pass. More...
MString getAttributeType (const MString &attributeName, MStatus *ReturnStatus=NULL) const
Retrieve the type of a given render pass attribute. More...
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. More...
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. More...
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. More...
class MRenderPassRegistry
class MFnPlugin
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] renderer The renderer
[in] fbType The base data type of the frame buffer
[in] numChannels The number of components per pixel in the frame buffer
[out] ReturnStatus Status code
Returns A pointer to the pass implementation or null if no definition exists
Status Codes:
MS::kSuccess The implementation was retrieved
MS::kFailure An object error has occured
Retrieve an implementation of this render pass for the given renderer.
Parameters
[in] renderer The renderer
[out] ReturnStatus Status code
Returns A pointer to the pass implementation or null if no definition exists
Status Codes:
MS::kSuccess The implementation was retrieved
MS::kFailure An object error has occured
Retrieve the pass ID for this pass.
Parameters
[out] ReturnStatus Status code
Returns The pass ID
Status Codes:
MS::kSuccess The method was successful
MS::kFailure An object error has occured
Retrieve the pass name for this pass.
Parameters
[out] ReturnStatus Status code
Returns The pass name
Status Codes:
MS::kSuccess The method was successful
MS::kFailure An object error has occured
Retrieve the pass group for this pass.
Parameters
[out] ReturnStatus Status code
Returns The pass group
Status Codes:
MS::kSuccess The method was successful
MS::kFailure An object error has occured
Retrieve the description for this pass.
Parameters
[out] ReturnStatus Status code
Returns The description
Status Codes:
MS::kSuccess The method was successful
MS::kFailure An object error has occured
Retrieve the type of a given render pass attribute.
Parameters
[in] attributeName The name of the render pass attribute to query.
[out] ReturnStatus Status code.
Returns The type of the given attribute.
Status Codes:
MS::kSuccess The method was successful
MS::kFailure An object error has occured
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] longName The full name of the parameter
[in] shortName The short name of the parameter
[in] UIName Name to display in UI for the parameter
[in] minValue The minimum value of the parameter
[in] maxValue The maximum value of the parameter
[in] defaultValue The default value of the parameter
Returns Status code
Status Codes:
MS::kSuccess The method was successful
MS::kFailure An object error has occured
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] longName The full name of the parameter
[in] shortName The short name of the parameter
[in] UIName Name to display in UI for the parameter
[in] minValue The minimum value of the parameter
[in] maxValue The maximum value of the parameter
[in] defaultValue The default value of the parameter
Returns Status
Status Codes:
MS::kSuccess The method was successful
MS::kFailure An object error has occured
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] longName The full name of the parameter
[in] shortName The short name of the parameter
[in] UIName Name to display in UI for the parameter
[in] minValue The minimum value of the parameter
[in] maxValue The maximum value of the parameter
[in] defaultValue The default value of the parameter
Returns Status
Status Codes:
MS::kSuccess The method was successful
MS::kFailure An object error has occured
const char * className
(
)
static
Returns the name of this class.
Returns The name of this class.
The documentation for this class was generated from the following files:
MRenderPassDef.h
MRenderPassDef.cpp