KudanAR - Android
Public Member Functions | Protected Attributes
ARRenderTarget Class Reference
+ Inheritance diagram for ARRenderTarget:

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 ( )
inline

Initialises an ARRenderTarget and adds it to the ARRenderer.

Member Function Documentation

void addViewPort ( ARViewPort  viewPort)
inline

Add an ARViewPort to the list of ARRenderTargets ARViewPorts.

Parameters
viewPort
void bind ( )
inline

Bind ARRenderTarget in OpenGL.

void clear ( )
inline

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

void create ( )
inline

Create ARRenderTarget.

void draw ( )
inline

Draw ARRenderTarget.

ARCamera getCamera ( )
inline

Return the ARRenderTarget's camera.

Returns
ARCamera.
int getPriority ( )
inline

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.
boolean getShouldClear ( )
inline

Return whether the colour buffer should be cleared.

Returns
boolean
boolean getShouldClearDepth ( )
inline

Return whether the depth buffer should be cleared.

Returns
boolean
List<ARViewPort> getViewPorts ( )
inline

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.
Bitmap screenshot ( int  width,
int  height 
)
inline

Take a screenshot.

Parameters
widthWidth of the screenshot.
heightHeight of the screenshot.
Returns
Bitmap
void setCamera ( ARCamera  camera)
inline

Set ARRenderTarget's camera.

Parameters
camera
void setPriority ( int  priority)
inline

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

Parameters
priority
void setShouldClear ( boolean  shouldClear)
inline

Sets whether the colour buffer should be cleared.

Parameters
shouldClear
void setShouldClearDepth ( boolean  shouldClearDepth)
inline

Set whether the depth buffer should be cleared.

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