#include <MFnRenderPass.h>
Provide functionalities for working with render passes such as retrieving renderer-specific implementations.
Public Member Functions | |
virtual MFn::Type | type () const |
Function set type. | |
virtual | ~MFnRenderPass () |
Destructor. | |
MFnRenderPass () | |
Default constructor. | |
MFnRenderPass (MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. | |
MPxRenderPassImpl * | setImplementation (const MString &renderer, MStatus *ReturnStatus=NULL) |
MPxRenderPassImpl * | getImplementation () const |
MPxRenderPassImpl::PassTypeBit | frameBufferType (MStatus *ReturnStatus=NULL) const |
unsigned int | frameBufferChannels (MStatus *ReturnStatus=NULL) const |
bool | usesFiltering (MStatus *ReturnStatus=NULL) const |
MString | passID (MStatus *ReturnStatus=NULL) const |
MString | customTokenString (MStatus *ReturnStatus=NULL) const |
MFnRenderPass (const MObject &object, MStatus *ReturnStatus=NULL) | |
Constructor. | |
Protected Member Functions | |
virtual const char * | className () const |
Class name. |
Constructor.
Class constructor that initializes the function set to the given MObject.
[in] | object | The MObject to attach the function set to |
[out] | ReturnStatus | the return status |
Constructor.
Class constructor that initializes the function set to the given MObject.
[in] | object | The MObject to attach the function set to |
[out] | ReturnStatus | the return status |
MFn::Type MFnRenderPass::type | ( | ) | const [virtual] |
const char * MFnRenderPass::className | ( | ) | const [protected, virtual] |
MPxRenderPassImpl * MFnRenderPass::setImplementation | ( | const MString & | renderer, | |
MStatus * | ReturnStatus = NULL | |||
) |
Returns the first render pass implementation compatible with the specified renderer and that supports the currently selected frame buffer data type and the selected number of channels.
This function should be called by the renderer plug-in once for each render pass at the beginning of the rendering process. The result of this query is cached for convenience and may be retrieved at any time without repeating the registry lookup by calling the getImplementation() method
[in] | renderer | string that identifies the the render and its version. The format of this string is specified by renderer plug-in. |
[out] | ReturnStatus | Status code. |
MPxRenderPassImpl * MFnRenderPass::getImplementation | ( | ) | const |
Returns the render pass implementation that was resolved by the previous call to setImplementation.
MPxRenderPassImpl::PassTypeBit MFnRenderPass::frameBufferType | ( | MStatus * | ReturnStatus = NULL |
) | const |
Returns the data type of the frame buffer associated with the render pass.
[out] | ReturnStatus | Status code. |
unsigned int MFnRenderPass::frameBufferChannels | ( | MStatus * | ReturnStatus = NULL |
) | const |
Returns the number of channels of the frame buffer associated with the render pass.
[out] | ReturnStatus | Status code. |
bool MFnRenderPass::usesFiltering | ( | MStatus * | ReturnStatus = NULL |
) | const |
Returns true if frame buffer filtering is requested. This setting may be ignored in the cases of frame buffer types and frame buffer semantics that do not allow interpolation.
[out] | ReturnStatus | Status code. |
Returns the passID string that uniquely identifies the renderpass definition associated with the pass
[out] | ReturnStatus | Status code. |
Returns a custom token string that can be passed to MCommonRenderSettingsData::getImageName() to generate a file name for the pass.
[out] | ReturnStatus | Status code. |
Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. | Generated with 1.5.6 |