class MRenderingInfo

Jump to documentation

public members:

unsigned int	originX () const Origin (x) of region to render to in pixels
unsigned int	originY () const Origin (y) of region to render to in pixels
unsigned int	width () const Width of region to render in pixels
unsigned int	height () const Height of region to render in pixels
MViewportRenderer::RenderingAPI	renderingAPI () const Native target rendering API
float	renderingVersion () const Native target rendering version
const MDagPath &	cameraPath () const Current camera being used to render with
const MRenderTarget &	renderTarget () const Current render target
const MMatrix &	viewMatrix () const Current view matrix
const MMatrix &	projectionMatrix () const Current projection matrix

Documentation

Description

MRenderingInfo is a class which holds information about rendering into hardware render targets.

Functions

unsigned int MRenderingInfo:: originX () const

Description

Return the x coordinate in pixels of the origin of the region to render.

Arguments

• None

Return Value

• X value

unsigned int MRenderingInfo:: originY () const

Description

Return the y coordinate in pixels of the origin of the region to render.

Arguments

• None

Return Value

• Y value

unsigned int MRenderingInfo:: width () const

Description

Return the width in pixels of the region to render.

Arguments

• None

Return Value

• width value

unsigned int MRenderingInfo:: height () const

Description

Return the width in pixels of the region to render

Arguments

• None

Return Value

• height value

MViewportRenderer::RenderingAPI MRenderingInfo:: renderingAPI () const

Description

Return the native rendering API used for a render target. See MViewportRender::RenderingAPI for a list of possible api values that can be returned.

Arguments

• None

Return Value

• Rendering API

float MRenderingInfo:: renderingVersion () const

Description

Return the native rendering API version used for a render target.

Arguments

• None

Return Value

• Rendering version

const MDagPath & MRenderingInfo:: cameraPath () const

Description

Return the dag path of the current camera being used for rendering. Information about the camera itself can be extracted via MFnCamera.

Arguments

• None

Return Value

• Dag path to camera.

const MMatrix & MRenderingInfo:: viewMatrix () const

Description

Return the current view matrix being used for rendering.

Arguments

• None

Return Value

• View matrix.

const MMatrix & MRenderingInfo:: projectionMatrix () const

Description

Return the current projection matrix being used for rendering. The projection matrix will be appropriate regardless of whether the caller is rendering into a OpenGL or a DirectX context, as each drawing API interprets projection matrices differently.

Arguments

• None

Return Value

• Dag path to camera.

const MRenderTarget & MRenderingInfo:: renderTarget () const

Description

Return the current render target being used for rendering.

Arguments

• None

Return Value

• Reference to render target.

This class has no child classes.