org.distorted.library.main

Class DistortedFramebuffer

java.lang.Object

org.distorted.library.main.InternalOutputSurface

org.distorted.library.main.DistortedFramebuffer

All Implemented Interfaces:

InternalChildrenList.Parent

Direct Known Subclasses:

DistortedScreen

public class DistortedFramebuffer
extends org.distorted.library.main.InternalOutputSurface

Class which represents a OpenGL Framebuffer object.

User is able to create offscreen FBOs and both a) render to them b) use their COLOR0 attachment as an input texture. Attaching Depths and/or Stencils is also possible.

Field Summary

Fields inherited from class org.distorted.library.main.InternalOutputSurface

BOTH_DEPTH_STENCIL, DEPTH_NO_STENCIL, NO_DEPTH_NO_STENCIL

Constructor Summary

Constructors

Constructor and Description
DistortedFramebuffer(int width, int height, int numcolors, int depthStencil) Create new offscreen Framebuffer with configurable number of COLOR, DEPTH and STENCIL attachments.

Method Summary

Methods

Modifier and Type	Method and Description
void	bindForOutput(int texture) Attach the texture'th Texture to COLOR0 attachment.
void	enableDepthStencil(int depthStencil) Enable.disable DEPTH and STENCIL buffers.
long	getID() Return unique ID of this Object.
int	getTextureID() Return the ID of the Texture (COLOR attachment 0) that's backing this FBO.
void	markForDeletion() Mark the underlying OpenGL object for deletion.
boolean	setAsInput(int texture) Bind the underlying rectangle of pixels as a OpenGL Texture.

Methods inherited from class org.distorted.library.main.InternalOutputSurface

attach, attach, detach, detach, detachAll, getFOV, getHeight, getNear, getWidth, glClear, glClearColor, glClearDepthf, glClearStencil, hasDepth, hasStencil, render, render, resize, setAsOutput, setMipmap, setOrderIndependentTransparency, setOrderIndependentTransparency, setProjection

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.distorted.library.main.InternalChildrenList.Parent

adjustIsomorphism

Constructor Detail

DistortedFramebuffer

public DistortedFramebuffer(int width,
                    int height,
                    int numcolors,
                    int depthStencil)

Create new offscreen Framebuffer with configurable number of COLOR, DEPTH and STENCIL attachments.

Parameters:

width - Width of all the COLOR attachments.

height - Height of all the COLOR attachments.

numcolors - How many COLOR attachments to create?

depthStencil - Add DEPTH or STENCIL attachment? Valid values: NO_DEPTH_NO_STENCIL, DEPTH_NO_STENCIL, BOTH_DEPTH_STENCIL.

Method Detail

setAsInput

public boolean setAsInput(int texture)

Bind the underlying rectangle of pixels as a OpenGL Texture.

Parameters:

texture - The Texture number to bind (and thus read from).

Returns:

true if successful.

bindForOutput

public void bindForOutput(int texture)

Attach the texture'th Texture to COLOR0 attachment.

Parameters:

texture - The Texture number to attach (and subsequently use to render to)

enableDepthStencil

public void enableDepthStencil(int depthStencil)

Enable.disable DEPTH and STENCIL buffers.

Parameters:

depthStencil - Valid values: NO_DEPTH_NO_STENCIL, DEPTH_NO_STENCIL, BOTH_DEPTH_STENCIL.

getTextureID

public int getTextureID()

Return the ID of the Texture (COLOR attachment 0) that's backing this FBO.

Catch: this will only work if the library has had time to actually create the texture. Remember that the texture gets created only on first render, thus creating a Texture object and immediately calling this method will return an invalid (negative) result.

Returns:

If there was not a single render between creation of the Object and calling this method on it, return a negative value. Otherwise, return ID of COLOR attachment 0.

markForDeletion

public void markForDeletion()

Mark the underlying OpenGL object for deletion. Actual deletion will take place on the next render.

getID

public long getID()

Return unique ID of this Object.