Package panamagl.offscreen

Class AOffscreenRenderer

java.lang.Object

panamagl.offscreen.AOffscreenRenderer

All Implemented Interfaces:

OffscreenRenderer

public class AOffscreenRenderer
extends Object
implements OffscreenRenderer

Base class for offscreen rendering, handling most of the coordination between a canvas and the GPU.

Field Summary

Fields

Modifier and Type	Field	Description
protected GLContext	context
protected boolean	debug
protected String	debugFile
protected ExecutorService	exec	Only used to export debug images if a debug file is given
protected PanamaGLFactory	factory
protected FBO	fbo
protected GL	gl
protected static final int	INIT_FBO_HEIGHT
protected static final int	INIT_FBO_WIDTH
protected boolean	initialized
protected FBOReader	reader
protected ThreadRedirect	threadRedirect

Constructor Summary

Constructors

Constructor	Description
AOffscreenRenderer(PanamaGLFactory factory, FBOReader reader)

Method Summary

Modifier and Type	Method	Description
protected void	destroyContext(GLCanvas drawable, GLEventListener listener)
GLContext	getContext()
String	getDebugFile()
FBO	getFBO()
GL	getGL()
protected Runnable	getTask_destroyContext(GLCanvas drawable, GLEventListener listener)
protected Runnable	getTask_initContext(GLCanvas drawable, GLEventListener listener)
protected Runnable	getTask_renderGLToImage(GLCanvas drawable, GLEventListener listener)
protected Runnable	getTask_renderGLToImage(GLCanvas drawable, GLEventListener listener, int width, int height)
ThreadRedirect	getThreadRedirect()
protected void	initContext(GLCanvas drawable, GLEventListener listener)	In general, you should initialize any resources that are needed for rendering or other functionality in the JPanel after the JPanel has been added to the Swing hierarchy, but before it is made visible.
boolean	isInitialized()	Indicates if the renderer has already been initialized.
void	onDestroy(GLCanvas drawable, GLEventListener listener)
void	onDisplay(GLCanvas drawable, GLEventListener listener)
void	onInit(GLCanvas drawable, GLEventListener listener)
void	onResize(GLCanvas drawable, GLEventListener listener, int x, int y, int width, int height)
protected void	readImageAndPaintInCanvas(GLCanvas canvas)
protected void	renderGLToImage(GLCanvas canvas, GLEventListener listener)	This method will render in FBO and then query a component repaint to ensure it is repainted ONCE the image is available.
protected void	renderGLToImage(GLCanvas canvas, GLEventListener listener, int width, int height)	This method will resize the FBO and then update the component
void	setDebugFile(String debugFile)	If not null, the input pattern will be used to save offscreen generated image to disk.
void	setFBO(FBO fbo)
void	setThreadRedirect(ThreadRedirect threadRedirect)

Methods inherited from class java.lang.Object

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

Field Details

INIT_FBO_WIDTH

protected static final int INIT_FBO_WIDTH

See Also:

• Constant Field Values

INIT_FBO_HEIGHT

protected static final int INIT_FBO_HEIGHT

See Also:

• Constant Field Values

debug

protected boolean debug

factory

protected PanamaGLFactory factory

gl

protected GL gl

context

protected GLContext context

fbo

protected FBO fbo

reader

protected FBOReader reader

threadRedirect

protected ThreadRedirect threadRedirect

initialized

protected boolean initialized

debugFile

protected String debugFile

exec

protected ExecutorService exec

Only used to export debug images if a debug file is given

Constructor Details

AOffscreenRenderer

public AOffscreenRenderer(PanamaGLFactory factory,
 FBOReader reader)

Method Details

onInit

public void onInit(GLCanvas drawable,
 GLEventListener listener)

Specified by:

onInit in interface OffscreenRenderer

onDisplay

public void onDisplay(GLCanvas drawable,
 GLEventListener listener)

Specified by:

onDisplay in interface OffscreenRenderer

onResize

public void onResize(GLCanvas drawable,
 GLEventListener listener,
 int x,
 int y,
 int width,
 int height)

Specified by:

onResize in interface OffscreenRenderer

onDestroy

public void onDestroy(GLCanvas drawable,
 GLEventListener listener)

Specified by:

onDestroy in interface OffscreenRenderer

initContext

protected void initContext(GLCanvas drawable,
 GLEventListener listener)

In general, you should initialize any resources that are needed for rendering or other functionality in the JPanel after the JPanel has been added to the Swing hierarchy, but before it is made visible. This ensures that the JPanel has a valid parent container and can be properly displayed on the screen. On macOS, this should be performed in the main thread

• By using -XstartOnMainThread (but warning with Swing and JavaFX that may be hanging)
• By having the context initialization performed by the AWT thread (through the GLPanel+GLEventListener)

destroyContext

protected void destroyContext(GLCanvas drawable,
 GLEventListener listener)

renderGLToImage

protected void renderGLToImage(GLCanvas canvas,
 GLEventListener listener,
 int width,
 int height)

This method will resize the FBO and then update the component

renderGLToImage

protected void renderGLToImage(GLCanvas canvas,
 GLEventListener listener)

This method will render in FBO and then query a component repaint to ensure it is repainted ONCE the image is available. This method can potentially execute in a separate thread (namely the main macOS thread).

readImageAndPaintInCanvas

protected void readImageAndPaintInCanvas(GLCanvas canvas)

getFBO

public FBO getFBO()

Specified by:

getFBO in interface OffscreenRenderer

setFBO

public void setFBO(FBO fbo)

Specified by:

setFBO in interface OffscreenRenderer

getDebugFile

public String getDebugFile()

Specified by:

getDebugFile in interface OffscreenRenderer

isInitialized

public boolean isInitialized()

Indicates if the renderer has already been initialized.

Specified by:

isInitialized in interface OffscreenRenderer

getGL

public GL getGL()

Specified by:

getGL in interface OffscreenRenderer

getContext

public GLContext getContext()

Specified by:

getContext in interface OffscreenRenderer

getThreadRedirect

public ThreadRedirect getThreadRedirect()

Specified by:

getThreadRedirect in interface OffscreenRenderer

setThreadRedirect

public void setThreadRedirect(ThreadRedirect threadRedirect)

Specified by:

setThreadRedirect in interface OffscreenRenderer

setDebugFile

public void setDebugFile(String debugFile)

If not null, the input pattern will be used to save offscreen generated image to disk. Example setDebugFile("target/glpanel"); Creates images in target/ folder under anme glpanel-1.png, glpanel-2.png, etc.

Specified by:

setDebugFile in interface OffscreenRenderer

getTask_renderGLToImage

protected Runnable getTask_renderGLToImage(GLCanvas drawable,
 GLEventListener listener,
 int width,
 int height)

getTask_renderGLToImage

protected Runnable getTask_renderGLToImage(GLCanvas drawable,
 GLEventListener listener)

getTask_initContext

protected Runnable getTask_initContext(GLCanvas drawable,
 GLEventListener listener)

getTask_destroyContext

protected Runnable getTask_destroyContext(GLCanvas drawable,
 GLEventListener listener)