MRenderingInfo Class Reference
#include <MRenderingInfo.h>
Class Description
Information to perform rendering into a hardware render target.
MRenderingInfo is a class which holds information about rendering into hardware render targets.
Examples:
Public Member Functions | |
| unsigned int | originX () const |
| Origin (x) of region to render to in pixels. More... | |
| unsigned int | originY () const |
| Origin (y) of region to render to in pixels. More... | |
| unsigned int | width () const |
| Width of region to render in pixels. More... | |
| unsigned int | height () const |
| Height of region to render in pixels. More... | |
| MViewportRenderer::RenderingAPI | renderingAPI () const |
| Native target rendering API. More... | |
| float | renderingVersion () const |
| Native target rendering version. More... | |
| const MDagPath & | cameraPath () const |
| Current camera being used to render with. More... | |
| const MRenderTargetLegacy & | renderTarget () const |
| Current render target. More... | |
| const MMatrix & | viewMatrix () const |
| Current view matrix. More... | |
| const MMatrix & | projectionMatrix () const |
| Current projection matrix. More... | |
Friends | |
| class | MViewportRenderer |
| class | MHardwareRenderer |
Member Function Documentation
| OPENMAYA_MAJOR_NAMESPACE_OPEN unsigned int originX | ( | ) | const |
Origin (x) of region to render to in pixels.
Return the x coordinate in pixels of the origin of the region to render.
- Returns
- X value.
| unsigned int originY | ( | ) | const |
Origin (y) of region to render to in pixels.
Return the y coordinate in pixels of the origin of the region to render.
- Returns
- Y value.
| unsigned int width | ( | ) | const |
Width of region to render in pixels.
Return the width in pixels of the region to render.
- Returns
- Width value.
| unsigned int height | ( | ) | const |
Height of region to render in pixels.
Return the width in pixels of the region to render.
- Returns
- Height value.
| MViewportRenderer::RenderingAPI renderingAPI | ( | ) | const |
Native target rendering API.
Return the native rendering API used for a render target.
See MViewportRender::RenderingAPI for a list of possible api values that can be returned.
- Returns
- Rendering API.
- Examples:
| float renderingVersion | ( | ) | const |
Native target rendering version.
Return the native rendering API version used for a render target.
- Returns
- Rendering version.
| const MDagPath & cameraPath | ( | ) | const |
Current camera being used to render with.
Return the dag path of the current camera being used for rendering.
Information about the camera itself can be extracted via MFnCamera.
- Returns
- Dag path to camera.
- Examples:
| const MRenderTargetLegacy & renderTarget | ( | ) | const |
Current render target.
Return the current render target being used for rendering.
- Returns
- Reference to render target.
- Examples:
| const MMatrix & viewMatrix | ( | ) | const |
Current view matrix.
Return the current view matrix being used for rendering.
- Returns
- View matrix.
- Examples:
| const MMatrix & projectionMatrix | ( | ) | const |
Current projection matrix.
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.
- Returns
- Projection matrix.
- Examples:
The documentation for this class was generated from the following files:
- MRenderingInfo.h
- MRenderingInfo.cpp