MFnRenderPass Class Reference
[OpenMayaRender - API module for rendering, FunctionSet classes]

#include
<MFnRenderPass.h>

Inheritance diagram for MFnRenderPass:

[legend]

Collaboration diagram for MFnRenderPass:

[legend]

List of all members.

Detailed Description

Function set for render passes.

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 & Destructor Documentation

MFnRenderPass::MFnRenderPass	(	MObject &	object,
		MStatus *	ReturnStatus = `NULL`
	)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:

`[in]`	object	The MObject to attach the function set to
`[out]`	ReturnStatus	the return status

Status Codes:

MS::kSuccess if the function set is successfully attached
MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnRenderPass::MFnRenderPass	(	const MObject &	object,
		MStatus *	ReturnStatus = `NULL`
	)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:

`[in]`	object	The MObject to attach the function set to
`[out]`	ReturnStatus	the return status

Status Codes:

MS::kSuccess if the function set is successfully attached
MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

Member Function Documentation

MFn::Type MFnRenderPass::type ( ) const [virtual]

Function set type.

Return the class type : MFn::kRenderPass

Reimplemented from MFnDependencyNode.

const char * MFnRenderPass::className ( ) const [protected, virtual]

Class name.

Return the class name : "MFnRenderPass"

Reimplemented from MFnDependencyNode.

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

Parameters:

`[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.

Returns:: A pointer to the render implementation object.

Status Codes:

MS::kSuccess The method was successful.
MS::kFailure An object error has occurred.

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.

Parameters: