Package panamagl.offscreen

Class AFBO

java.lang.Object

panamagl.offscreen.AFBO

All Implemented Interfaces:

FBO

public abstract class AFBO
extends Object
implements FBO

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	auto
protected boolean	debug
protected int	format
protected MemorySegment	frameBufferIds
protected int	height	height of the canvas using this FBO for rendering
protected int	idFrameBuffer	id of the frame buffer returned by the GPU
protected int	idRenderBuffer	if of the render buffer returned by the GPU
protected int	idTexture	id of the texture returned by the GPU
protected int	internalFormat
protected MemorySegment	pixelBuffer
protected MemorySegment	pixels
protected boolean	prepared	indicates that dimensions have changed and that buffers must be resized.
protected Arena	renderArena	Data arena to create buffers shared with GPU.
protected MemorySegment	renderBufferIds
protected MemorySegment	textureBufferIds
protected int	textureType
protected int	width	width of the canvas using this FBO for rendering

Constructor Summary

Constructors

Constructor	Description
AFBO()

Method Summary

Modifier and Type	Method	Description
void	bind(GL gl)	Bind this FBO so that the following GL commands target it, e.g.
protected abstract void	bindFramebuffer(int id)	Bind the framebuffer having the given id, or the default framebuffer if the id is 0.
protected void	diagnoseError(GL gl, String item)	Print error in console
int	getHeight()
int	getWidth()
boolean	isPrepared()
protected void	prepareRenderArena()	Prepare the memory manager for offscreen rendering by the GPU.
protected void	releaseRenderArena()	Release all memory used to manage offscreen rendering by the GPU.
void	resize(int width, int height)	Set dimensions and reset 'prepared' state if the dimensions actually changed.
void	unbind(GL gl)	Bind back the default framebuffer, so that the following GL commands do not target this FBO anymore.

Methods inherited from class java.lang.Object

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

Methods inherited from interface panamagl.offscreen.FBO

prepare, readPixels, release

Field Details

debug

protected boolean debug

format

protected int format

internalFormat

protected int internalFormat

textureType

protected int textureType

width

protected int width

width of the canvas using this FBO for rendering

height

protected int height

height of the canvas using this FBO for rendering

prepared

protected boolean prepared

indicates that dimensions have changed and that buffers must be resized.

idTexture

protected int idTexture

id of the texture returned by the GPU

idFrameBuffer

protected int idFrameBuffer

id of the frame buffer returned by the GPU

idRenderBuffer

protected int idRenderBuffer

if of the render buffer returned by the GPU

renderArena

protected Arena renderArena

Data arena to create buffers shared with GPU. Will live until the buffers are necessary anymore (e.g. when the FBO is resized and pixel number changes).

frameBufferIds

protected MemorySegment frameBufferIds

renderBufferIds

protected MemorySegment renderBufferIds

textureBufferIds

protected MemorySegment textureBufferIds

pixelBuffer

protected MemorySegment pixelBuffer

pixels

protected MemorySegment pixels

auto

protected boolean auto

Constructor Details

AFBO

public AFBO()

Method Details

prepareRenderArena

protected void prepareRenderArena()

Prepare the memory manager for offscreen rendering by the GPU.

releaseRenderArena

protected void releaseRenderArena()

Release all memory used to manage offscreen rendering by the GPU.

bindFramebuffer

protected abstract void bindFramebuffer(int id)

Bind the framebuffer having the given id, or the default framebuffer if the id is 0. The GL context must be current on the calling thread.

bind

public void bind(GL gl)

Description copied from interface: FBO

Bind this FBO so that the following GL commands target it, e.g. to perform GL work out of the rendering of a canvas such as picking from a mouse event. The FBO is prepared if it is not already, otherwise it is bound as is, i.e. without being recreated nor cleared. The GL context of the canvas must be current on the calling thread. Out of a GLEventListener method, the work must therefore be performed with the ThreadRedirect of the canvas renderer, which may run it later (see doc/Multithreading.md) :

 
 OffscreenRenderer renderer = canvas.getOffscreenRenderer();
 
 renderer.getThreadRedirect().run(() -> {
   GL gl = renderer.getGL();
   renderer.getFBO().bind(gl);
   // GL work targeting the canvas framebuffer
   renderer.getFBO().unbind(gl);
 });
 
 

Specified by:

bind in interface FBO

See Also:

• FBO.unbind(GL)

unbind

public void unbind(GL gl)

Description copied from interface: FBO

Bind back the default framebuffer, so that the following GL commands do not target this FBO anymore. Same thread requirement as FBO.bind(GL).

Specified by:

unbind in interface FBO

diagnoseError

protected void diagnoseError(GL gl,
 String item)

Print error in console

resize

public void resize(int width,
 int height)

Set dimensions and reset 'prepared' state if the dimensions actually changed.

Specified by:

resize in interface FBO

getWidth

public int getWidth()

Specified by:

getWidth in interface FBO

getHeight

public int getHeight()

Specified by:

getHeight in interface FBO

isPrepared

public boolean isPrepared()

Specified by:

isPrepared in interface FBO