com.bonzaiengine.renderer.deferred

Class Framebuffer

java.lang.Object

com.bonzaiengine.renderer.deferred.Framebuffer

All Implemented Interfaces:

IDestroyable

public final class Framebuffer
extends java.lang.Object
implements IDestroyable

See Also:

RenderTarget

Constructor Summary

Constructors

Constructor and Description
Framebuffer()

Method Summary

Modifier and Type	Method and Description
void	addRenderTarget(RenderTarget renderTarget, GLEnums.Attachment attachment) Add the specified RenderTarget to this Framebuffer at the specified attachment.
RenderTarget	attach(IGL gl, RenderTarget renderTarget, GLEnums.Attachment attachment) Attach the specified RenderTarget to this Framebuffer at the specified attachment.
void	destroy(IGL gl) Destroy this Framebuffer and all attached RenderTarget
RenderTarget	dettach(IGL gl, GLEnums.Attachment attachment) Dettach a RenderTarget from this Framebuffer
void	end(IGL gl) Unbind this Framebuffer
java.util.Set<GLEnums.Attachment>	getAttachments()
int	getHeight()
int	getMemoryUsage()
RenderTarget	getRenderTarget(GLEnums.Attachment attachment)
int	getWidth()
boolean	init(IGL gl, int width, int height) Init or resize this Framebuffer
boolean	isValid(IGL gl)
void	setMRTAttachments(GLEnums.Attachment[] mrtAttachments)
void	start(IGL gl) Bind this Framebuffer

Methods inherited from class java.lang.Object

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

Constructor Detail

Framebuffer

public Framebuffer()

Method Detail

attach

public RenderTarget attach(IGL gl,
                           RenderTarget renderTarget,
                           GLEnums.Attachment attachment)

Attach the specified RenderTarget to this Framebuffer at the specified attachment.
isValid(IGL) or init(IGL, int, int) must be called prior binding again this Framebuffer

Parameters:

gl - OpenGL context

renderTarget - RenderTarget to attach to this Framebuffer

attachment - attachment id

Returns:

previous RenderTarget attached to specified attachment

See Also:

IGL.GL_COLOR_ATTACHMENT0, IGL.GL_DEPTH_ATTACHMENT, IGL.GL_STENCIL_ATTACHMENT, #dettach(IGL, int), isValid(IGL)

dettach

public RenderTarget dettach(IGL gl,
                            GLEnums.Attachment attachment)

Dettach a RenderTarget from this Framebuffer

Parameters:

gl - OpenGL context

attachment - attachment id

Returns:

the RenderTarget dettached from this Framebuffer

setMRTAttachments

public void setMRTAttachments(GLEnums.Attachment[] mrtAttachments)

Parameters:

mrtAttachments - list of attachments for Multiple Render Targets

init

public boolean init(IGL gl,
                    int width,
                    int height)

Init or resize this Framebuffer

Parameters:

gl - OpenGL context

width - width in pixels

height - height in pixels

See Also:

isValid(IGL)

isValid

public boolean isValid(IGL gl)

Parameters:

gl - OpenGL context

Returns:

true if this Framebuffer is complete according to OpenGL completeness specification

getWidth

public int getWidth()

Returns:

this Framebuffer width

getHeight

public int getHeight()

Returns:

this Framebuffer height

start

public void start(IGL gl)

Bind this Framebuffer

Parameters:

gl - OpenGL context

end

public void end(IGL gl)

Unbind this Framebuffer

Parameters:

gl - OpenGL context

addRenderTarget

public void addRenderTarget(RenderTarget renderTarget,
                            GLEnums.Attachment attachment)

Add the specified RenderTarget to this Framebuffer at the specified attachment.

Parameters:

renderTarget - RenderTarget to add to this Framebuffer

attachment - attachment id

Throws:

java.lang.IllegalStateException - if this Framebuffer already contains

See Also:

IGL.GL_COLOR_ATTACHMENT0, IGL.GL_DEPTH_ATTACHMENT, IGL.GL_STENCIL_ATTACHMENT

getRenderTarget

public final RenderTarget getRenderTarget(GLEnums.Attachment attachment)

Parameters:

attachment -

Returns:

the RenderTarget attached to the specified attachment, if any

getAttachments

public final java.util.Set<GLEnums.Attachment> getAttachments()

destroy

public void destroy(IGL gl)

Destroy this Framebuffer and all attached RenderTarget

Specified by:

destroy in interface IDestroyable

Parameters:

gl - OpenGL context

getMemoryUsage

public final int getMemoryUsage()