OpenMayaRender.MRenderTarget Class Reference

Inheritance diagram for OpenMayaRender.MRenderTarget:

Public Member Functions
def	__init__ ()
def	rawData ()
def	resourceHandle ()
def	targetDescription ()
def	updateDescription ()

Static Public Member Functions
def	__new__ ()
def	freeRawData ()

Detailed Description

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

Constructor & Destructor Documentation

def OpenMayaRender.MRenderTarget.__init__

(

)

Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

def OpenMayaRender.MRenderTarget.__new__ ( )

static

Create and return a new object.  See help(type) for accurate signature.

def OpenMayaRender.MRenderTarget.freeRawData ( )

static

freeRawData(long) -> None

Deallocate system memory - retrieved from rawData().

def OpenMayaRender.MRenderTarget.rawData

(

)

rawData() -> [long, rowPitch, slicePitch]

Get a copy of the raw data mapped to the target.
The caller must deallocate the system memory (using freeRawData()) as the target itself does not keep any references to it.

* rowPitch [OUT] (int) - The row pitch of the data. It represents the number of bytes of one line of the target data.
* slicePitch [OUT] (int) - The slice pitch of the data. It represents the number of bytes of the whole target data.

def OpenMayaRender.MRenderTarget.resourceHandle

(

)

resourceHandle() -> long

Returns a long containing a C++ 'void' pointer which points to the draw API dependent handle for a render target.
For OpenGL, a pointer to an OpenGL texture identifier is returned.
For DirectX, a reference to a Direct3D "view" of a target is returned.

def OpenMayaRender.MRenderTarget.targetDescription

(

)

targetDescription() -> MRenderTargetDescription

Get target description.

def OpenMayaRender.MRenderTarget.updateDescription

(

)

updateDescription(MRenderTargetDescription) -> self

Change the description of a render target.