ARRenderTarget Class Reference

Inherited by ARRenderTargetTexture, and ARTextureRenderTarget.

Public Member Functions
	ARRenderTarget ()
void	setPriority (int priority)
int	getPriority ()
void	setShouldClear (boolean shouldClear)
boolean	getShouldClear ()
void	setShouldClearDepth (boolean shouldClearDepth)
boolean	getShouldClearDepth ()
void	clear ()
void	setCamera (ARCamera camera)
ARCamera	getCamera ()
void	create ()
void	bind ()
void	draw ()
List< ARViewPort >	getViewPorts ()
void	addViewPort (ARViewPort viewPort)
Bitmap	screenshot (int width, int height)

Protected Attributes
int	mFramebufferID

Detailed Description

An ARRenderTarget represents a target buffer for rendering content offscreen.

Constructor & Destructor Documentation

ARRenderTarget()

ARRenderTarget.ARRenderTarget

(

)

Initialises an ARRenderTarget and adds it to the ARRenderer.

Member Function Documentation

addViewPort()

void ARRenderTarget.addViewPort

(

ARViewPort

viewPort

)

Add an ARViewPort to the list of ARRenderTargets ARViewPorts.

Parameters

viewPort

bind()

void ARRenderTarget.bind

(

)

Bind ARRenderTarget in OpenGL.

Reimplemented in ARRenderTargetTexture, and ARTextureRenderTarget.

clear()

void ARRenderTarget.clear

(

)

Clear depth/colour buffer if it is set to be cleared.

create()

void ARRenderTarget.create

(

)

Create ARRenderTarget.

Reimplemented in ARRenderTargetTexture, and ARTextureRenderTarget.

draw()

void ARRenderTarget.draw

(

)

Draw ARRenderTarget.

Reimplemented in ARRenderTargetTexture.

getCamera()

ARCamera ARRenderTarget.getCamera

(

)

Return the ARRenderTarget's camera.

Returns

ARCamera.

getPriority()

int ARRenderTarget.getPriority

(

)

Returns the priority of this render target relative to other render targets. Any value is fine. Lower is rendered first.

Returns

The priority of this render target relative to other render targets.

getShouldClear()

boolean ARRenderTarget.getShouldClear

(

)

Return whether the colour buffer should be cleared.

Returns

boolean

getShouldClearDepth()

boolean ARRenderTarget.getShouldClearDepth

(

)

Return whether the depth buffer should be cleared.

Returns

boolean

getViewPorts()

List<ARViewPort> ARRenderTarget.getViewPorts

(

)

Returns the list of ARViewPort objects that this render target contains. These are rendered based on viewport z-order.

Returns

The list of ARViewPorts this ARRenderTarget contains.

screenshot()

Bitmap ARRenderTarget.screenshot	(	int	width,
		int	height
	)

Take a screenshot.

Parameters

width	Width of the screenshot.
height	Height of the screenshot.

Returns

Bitmap

setCamera()

void ARRenderTarget.setCamera

(

ARCamera

camera

)

Set ARRenderTarget's camera.

Parameters

camera

setPriority()

void ARRenderTarget.setPriority

(

int

priority

)

Sets the priority of the ARRRenderTarget the lower values are rendered first.

Parameters

priority

setShouldClear()

void ARRenderTarget.setShouldClear

(

boolean

shouldClear

)

Sets whether the colour buffer should be cleared.

Parameters

shouldClear

setShouldClearDepth()

void ARRenderTarget.setShouldClearDepth

(

boolean

shouldClearDepth

)

Set whether the depth buffer should be cleared.

Parameters

shouldClearDepth

---

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

• ARRenderTarget.java