- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Examples

- Class List
- Class Hierarchy
- Class Members

Public Member Functions | Static Public Member Functions

# MRenderTarget Class Reference
OpenMayaRender - API module for rendering

This reference page is linked to from the following overview topics: Extension for Autodesk Maya 2013, 2.4 Texture creation and texture manager, 2.5 Render Targets and Render Target Manager.

Search for all occurrences

## Detailed Description

An instance of a render target that may be used with Viewport 2.0.

This class represents a render target that may be used with the MRenderOperation class for rendering in Viewport 2.0.

`#include <MRenderTargetManager.h>`

List of all members.

## Public Member Functions
MStatus | updateDescription (const MRenderTargetDescription &targetDescription)
| Change the description of a render target.
void | targetDescription (MRenderTargetDescription &desc) const
| Get target description.
void * | resourceHandle () const
| This method allows access to the draw API dependent handle for a render target.
void * | rawData (int &rowPitch, int &slicePitch)
| Get a copy of the raw data mapped to the target.
## Static Public Member Functions
static const char * | className ()
| Returns the name of this class.

## Member Function Documentation

MStatus updateDescription | ( | const MRenderTargetDescription & | targetDescription | ) |

Search for all occurrences

Change the description of a render target.

This will mean a reallocation of the targets internal representation.

A common situation requiring this method to be called is to resize a render target.

Parameters:

  [in] | targetDescription | Description to update the target to.

Returns:
  Status code

Status Codes:
  - MStatus::kSuccess The operation executed successfully.
  - MStatus::kFailure The operation failed.

void targetDescription | ( | MRenderTargetDescription & | desc | ) | const

Search for all occurrences

Get target description.

Parameters:

  [out] | desc | The target description

const char * className | ( |  | ) | `[static]`

Search for all occurrences

Returns the name of this class.

Returns:
  Name of this class.

void * resourceHandle | ( |  | ) | const

Search for all occurrences

This method allows access to the draw API dependent handle for a render target.

This handle is owned by the MRendertarget and is provided to allow access to use a target as a read-only object.

Modifications should never be performed on this target handle.

Any modifications may result in unpredictable stability as the MRenderTarget no longer has knowledge of the target contents.

For OpenGL, a pointer to an OpenGL texture identifier is returned.

For DirectX 10 and higher, a reference to a Direct3D "view" of a target is returned. If the render target is a color target then a "render target view" will be returned. If it is a depth-stencil target then a "depth stencil view" will be returned.

Returns:
  A pointer (handle) to the target if successful, otherwise NULL.

void * rawData | ( | int & | rowPitch,
|  | int & | slicePitch
| ) |  |

Search for all occurrences

Get a copy of the raw data mapped to the target.

The caller must deallocate the system memory as the target itself does not keep any references to it.

Parameters:

  [out] | rowPitch | The row pitch of the data. It represents the number of bytes of one line of the target data.
  [out] | slicePitch | The slice pitch of the data. It represents the number of bytes of the whole target data.

Returns:
  A pointer to the data, or NULL on failure

MRenderTarget MRenderTarget MRenderTarget MRenderTarget MRenderTarget MRenderTarget MRenderTarget MRenderTarget MRenderTarget MRenderTarget
MRenderTarget MRenderTarget MRenderTarget MRenderTarget MRenderTarget MRenderTarget MRenderTarget MRenderTarget MRenderTarget MRenderTarget