This reference page is linked to from the following overview topics: Rendering Overrides, Transition Guide, Devkit Samples.

Detailed Description

Class which defines a rendering operation.

#include <MViewport2Renderer.h>

Inheritance diagram for MRenderOperation:

[legend]

Public Types
enum	MRenderOperationType { kClear, kSceneRender, kQuadRender, kUserDefined, kHUDRender, kPresentTarget }
	Supported render operation types. More...
Public Member Functions
virtual MRenderTarget **	targetOverrideList (unsigned int &listSize)
	Return a list of pointers to render target which will be used as the target overrides for the operation.
virtual const MFloatPoint *	viewportRectangleOverride ()
	Query for a viewport rectangle override.
virtual const MString &	name () const
	Query the name of a render operator.
MRenderOperationType	operationType () const
	Query the type (MRenderOperationType) of a render operator.

Member Enumeration Documentation

Supported render operation types.

Enumerator:

kClear	Clear background operation. Search for all occurrences
kSceneRender	Render a 3d scene. Search for all occurrences
kQuadRender	Render a 2d quad. Search for all occurrences
kUserDefined	User defined operation. Search for all occurrences
kHUDRender	2D HUD draw operation Search for all occurrences
kPresentTarget	Present target for viewing. Search for all occurrences

MRenderTarget ** targetOverrideList ( unsigned int & listSize ) [virtual]

Return a list of pointers to render target which will be used as the target overrides for the operation.

Parameters:

[out] listSize Number of targets returned. By default a value of 0 is returned.

Returns:: Pointer to an array of render targets. By default NULL is returned.

const MFloatPoint * viewportRectangleOverride ( ) [virtual]

Query for a viewport rectangle override.

An override is specified using 4 float values. All values are are represented as relative percentages of the output target dimensions.

The two values are the x and y values of the origin of the rectangle with respect to the origin of the render target. The origin of the render target is the lower left corner.
The next two values represent the width and height respectively.

Examples :

0,0,1,1 would be mean 0 percentage from the origin and 100 percent of the target size.
0.2, 0.3, 0.35, 0.4 would mean 20 percent to the left and 30 % up from the target origin, with a size which is 35 percent of the width and 40 percent of the height of the target.

Returns:: Reference to the viewport rectangle. NULL if there is no override.

const MString & name ( ) const [virtual]

Query the name of a render operator.

Reimplemented in MHUDRender.

MRenderOperation::MRenderOperationType operationType ( ) const

Query the type (MRenderOperationType) of a render operator.