Aviatrix3D
2.1.0

org.j3d.aviatrix3d.rendering
Interface OffscreenRenderTargetRenderable

All Superinterfaces:
java.lang.Comparable, Renderable
All Known Subinterfaces:
OffscreenBufferRenderable
All Known Implementing Classes:
MRTOffscreenTexture2D, MRTTexture2D, OffscreenTexture2D

public interface OffscreenRenderTargetRenderable
extends Renderable

A renderable that represents a separate rendering space to an offscreen buffer, rather than to the main buffer.

This class encapsulates both pbuffer and frame buffer object renderable capabilities.

Assumptions and Requirements

Version:
$Revision: 2.2 $
Author:
Justin Couch

Method Summary
 OffscreenBufferDescriptor getBuffer(java.lang.Object obj)
          Get the currently registered pBuffer for the given key object.
 BufferSetupData getBufferSetup()
          Get the requested buffer setup that describes this offscreen buffer.
 int getHeight()
          Get the height of the buffer in pixels.
 int getWidth()
          Get the width of the buffer in pixels.
 boolean isChildRenderTarget()
          Check to see if this is a child render target of a parent multiple render target offscreen buffer.
 void registerBuffer(java.lang.Object obj, OffscreenBufferDescriptor buffer)
          Register a pBuffer for a given key object.
 void unregisterBuffer(java.lang.Object obj)
          Remove an already registered pBuffer for a given key object.
 
Methods inherited from interface org.j3d.aviatrix3d.rendering.Renderable
equals
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getHeight

int getHeight()
Get the height of the buffer in pixels. If no size is set, this returns -1.

Returns:
a number >= -1

getWidth

int getWidth()
Get the width of the buffer in pixels. If no size is set, this returns -1.

Returns:
a number >= -1

isChildRenderTarget

boolean isChildRenderTarget()
Check to see if this is a child render target of a parent multiple render target offscreen buffer. Returns true if it is.

Returns:
true if this is a child, false if the parent

getBufferSetup

BufferSetupData getBufferSetup()
Get the requested buffer setup that describes this offscreen buffer. Only called once when the buffer is first constructed.

Returns:
The requested capabilities of the buffer that needs to be created

getBuffer

OffscreenBufferDescriptor getBuffer(java.lang.Object obj)
Get the currently registered pBuffer for the given key object. If there is no buffer registered for the current context, return null.

Parameters:
obj - The key used to register the buffer with
Returns:
buffer The buffer instance to use here.

registerBuffer

void registerBuffer(java.lang.Object obj,
                    OffscreenBufferDescriptor buffer)
Register a pBuffer for a given key object.

Parameters:
obj - The key used to register the buffer with
buffer - The buffer instance to use here.

unregisterBuffer

void unregisterBuffer(java.lang.Object obj)
Remove an already registered pBuffer for a given key object.

Parameters:
obj - The key used to register the buffer with

Aviatrix3D
2.1.0

Latest Info from http://aviatrix3d.j3d.org/
Copyright © 2003 - 2009 j3d.org