MRenderTargetLegacy Class Reference

MRenderTargetLegacy is a class contains information about a given hardware render target. More...

#include <MRenderTarget.h>

Public Member Functions
unsigned int	width () const
	Width of render target in pixels. More...
unsigned int	height () const
	Height of render target in pixels. More...
void	makeTargetCurrent () const
	Make the render target current for rendering.
MStatus	writeColorBuffer (const MImage &image, signed short x=0, signed short y=0, bool writeDepth=false) const
	Write a 2d image directly to the color buffer, without any transformation. More...

Detailed Description

MRenderTargetLegacy is a class contains information about a given hardware render target.

Member Function Documentation

OPENMAYA_MAJOR_NAMESPACE_OPEN unsigned int width

(

)

const

Width of render target in pixels.

Return the width in pixels of the render target.

Returns

Width value.

unsigned int height

(

)

const

Height of render target in pixels.

Return the height in pixels of the render target.

Returns

Height value.

MStatus writeColorBuffer	(	const MImage &	image,
		signed short	x = 0,
		signed short	y = 0,
		bool	writeDepth = false
	)		const

Write a 2d image directly to the color buffer, without any transformation.

Method will make the context current if it is not already.

If a depth component in the image also exists, then depth values can also be written to.

Parameters

[in]	image	an MImage 2d image
[in]	x	lower left corner x position in the target to place the image. Default value is 0.
[in]	y	lower left corner y position in the target to place the image Default value is 0.
[in]	writeDepth	write the depth component of the incoming image to the depth component of the render target. If image does not contain any depth component then nothing will be written. Default value is false.

Returns

MStatus::kSuccess if successful.

---

The documentation for this class was generated from the following files:

• MRenderTarget.h
• MRenderTarget.cpp