Package panamagl.canvas

Class GLCanvasAWT

java.lang.Object

java.awt.Component

java.awt.Container

java.awt.Panel

panamagl.canvas.GLCanvasAWT

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, panamagl.canvas.GLCanvas

public class GLCanvasAWT
extends Panel
implements panamagl.canvas.GLCanvas

This panel push to the screen an OpenGL image rendered offscreen by an OffscreenRenderer. The panel mainly deals with

• OpenGL context initialization, after the panel is added to a parent, and before it is made visible.
• repaint and resize events that are propagated to the OpenGL application through a GLEventListener, which must be provided by the user of this panel through setGLEventListener(GLEventListener).
• measuring performance, that is evaluating the time required to trigger offscreen image rendering and image painting onscreen.

Threading

The panel is also responsible for triggering OpenGL initialization and rendering in the appropriate threads, which may depend on the running operating system.

Threading on macOS

Debugging

Hint : to debug this class, invoke a program using it with flag -Dpanamagl.GLPanel

Author:

Martin Pernollet

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	GLCanvasAWT.ResizeHandler	The GLCanvasAWT.ResizeHandler will trigger rendering on the main macOS thread and then trigger repaint through invalid @link {@link SwingUtilities.invokeLater() }.

Nested classes/interfaces inherited from class java.awt.Panel

Panel.AccessibleAWTPanel

Nested classes/interfaces inherited from class java.awt.Container

Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Nested classes/interfaces inherited from interface panamagl.canvas.GLCanvas

panamagl.canvas.GLCanvas.Flip

Field Summary

Fields

Modifier and Type	Field	Description
protected panamagl.performance.RenderCounter	counter
protected boolean	debug
protected boolean	debugPerf
protected panamagl.canvas.GLCanvas.Flip	flip
protected boolean	hiDPIEnabled
protected panamagl.GLEventListener	listener
protected panamagl.offscreen.OffscreenRenderer	offscreen
protected BufferedImage	out
protected PerformanceOverlay_AWT	overlay
protected PixelScaleSupportAWT	pixelScaleSupport
protected AtomicBoolean	rendering

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor	Description
GLCanvasAWT(panamagl.factory.PanamaGLFactory factory)	Initialize a panel able to render OpenGL through a GLEventListener and related GL interface.

Method Summary

Modifier and Type	Method	Description
void	addNotify()	Called after the JPanel has been added to the Swing hierarchy but before it is made visible.
void	addPixelScaleListener(panamagl.canvas.PixelScaleListener l)
void	display()	If the panel initialization has achieved, this triggers an offscreen rendering, maybe on a separated thread (macOS case), from which an asynchronous repaint will be triggered.
panamagl.opengl.GLContext	getContext()
panamagl.offscreen.FBO	getFBO()
panamagl.canvas.GLCanvas.Flip	getFlip()
panamagl.opengl.GL	getGL()
panamagl.GLEventListener	getGLEventListener()
panamagl.performance.RenderCounter	getMonitoring()
panamagl.offscreen.OffscreenRenderer	getOffscreenRenderer()
int	getPhysicalHeight()
int	getPhysicalWidth()
panamagl.canvas.PixelScale	getPixelScale()
PixelScaleSupportAWT	getPixelScaleSupport()	Test/diagnostics access to the pixel-scale support.
panamagl.Image<?>	getScreenshot()	Return a copy of the last rendered image, oriented as displayed by this canvas (see getFlip()).
boolean	isHiDPIEnabled()
boolean	isInitialized()	Return true if the offscreen renderer has been initialized, which means that this panel has been added to a parent component.
boolean	isRendering()	Return true if display has started but has not yet finished
boolean	isShowRenderingTime()
protected void	onPixelScaleChanged()	Invoked when the pixel scale changes — re-resize the FBO with the new physical dimensions.
protected void	overlayPerformance(Graphics g)	Show performance in a 2D text overlay.
void	paint(Graphics g)	Invoked only for redraw query that are not coalesced with other redraw queries by the AWT Event Queue.
void	removeNotify()	Called before the JPanel is removed from the Swing hierarchy.
void	removePixelScaleListener(panamagl.canvas.PixelScaleListener l)
void	setFBO(panamagl.offscreen.FBO fbo)
void	setFlip(panamagl.canvas.GLCanvas.Flip flip)
void	setGLEventListener(panamagl.GLEventListener glEvents)
void	setHiDPIEnabled(boolean enabled)
void	setMonitoring(panamagl.performance.RenderCounter counter)
void	setOffscreenRenderer(panamagl.offscreen.OffscreenRenderer offscreen)
protected void	setRendering(boolean status)
void	setScreenshot(panamagl.Image<?> image)
void	setShowRenderingTime(boolean status)
void	update(Graphics g)	Invoked each time redraw should be performed, even if the redraw query is coalesced with other redraw queries by the AWT Event Queue.

Methods inherited from class java.awt.Panel

getAccessibleContext

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, isValidateRoot, layout, list, list, locate, minimumSize, paintComponents, paramString, preferredSize, print, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, revalidate, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setMixingCutoutShape, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface panamagl.canvas.GLCanvas

getHeight, getWidth, isVisible, repaint

Field Details

listener

protected panamagl.GLEventListener listener

offscreen

protected panamagl.offscreen.OffscreenRenderer offscreen

out

protected BufferedImage out

rendering

protected AtomicBoolean rendering

counter

protected panamagl.performance.RenderCounter counter

overlay

protected PerformanceOverlay_AWT overlay

debug

protected boolean debug

debugPerf

protected boolean debugPerf

flip

protected panamagl.canvas.GLCanvas.Flip flip

pixelScaleSupport

protected PixelScaleSupportAWT pixelScaleSupport

hiDPIEnabled

protected volatile boolean hiDPIEnabled

Constructor Details

GLCanvasAWT

public GLCanvasAWT(panamagl.factory.PanamaGLFactory factory)

Initialize a panel able to render OpenGL through a GLEventListener and related GL interface.

Method Details

onPixelScaleChanged

protected void onPixelScaleChanged()

Invoked when the pixel scale changes — re-resize the FBO with the new physical dimensions.

addNotify

public void addNotify()

Called after the JPanel has been added to the Swing hierarchy but before it is made visible. Initialization may occur in other threads and not be completed when this method returns. To ensure the component is initialized, call

invalid reference

invalid input: ''

Overrides:

addNotify in class Panel

removeNotify

public void removeNotify()

Called before the JPanel is removed from the Swing hierarchy.

Overrides:

removeNotify in class Container

update

public void update(Graphics g)

Invoked each time redraw should be performed, even if the redraw query is coalesced with other redraw queries by the AWT Event Queue.

Overrides:

update in class Container

paint

public void paint(Graphics g)

Invoked only for redraw query that are not coalesced with other redraw queries by the AWT Event Queue. Render GL image and stop counting elapsed time for rendering (started at display())

Overrides:

paint in class Container

display

public void display()

If the panel initialization has achieved, this triggers an offscreen rendering, maybe on a separated thread (macOS case), from which an asynchronous repaint will be triggered.

Specified by:

display in interface panamagl.canvas.GLCanvas

isInitialized

public boolean isInitialized()

Return true if the offscreen renderer has been initialized, which means that this panel has been added to a parent component.

Specified by:

isInitialized in interface panamagl.canvas.GLCanvas

isRendering

public boolean isRendering()

Return true if display has started but has not yet finished

Specified by:

isRendering in interface panamagl.canvas.GLCanvas

setRendering

protected void setRendering(boolean status)

overlayPerformance

protected void overlayPerformance(Graphics g)

Show performance in a 2D text overlay.

getGLEventListener

public panamagl.GLEventListener getGLEventListener()

Specified by:

getGLEventListener in interface panamagl.canvas.GLCanvas

setGLEventListener

public void setGLEventListener(panamagl.GLEventListener glEvents)

Specified by:

setGLEventListener in interface panamagl.canvas.GLCanvas

getGL

public panamagl.opengl.GL getGL()

Specified by:

getGL in interface panamagl.canvas.GLCanvas

getContext

public panamagl.opengl.GLContext getContext()

Specified by:

getContext in interface panamagl.canvas.GLCanvas

getScreenshot

public panamagl.Image<?> getScreenshot()

Return a copy of the last rendered image, oriented as displayed by this canvas (see getFlip()).

Specified by:

getScreenshot in interface panamagl.canvas.GLCanvas

setScreenshot

public void setScreenshot(panamagl.Image<?> image)

Specified by:

setScreenshot in interface panamagl.canvas.GLCanvas

getFBO

public panamagl.offscreen.FBO getFBO()

setFBO

public void setFBO(panamagl.offscreen.FBO fbo)

getMonitoring

public panamagl.performance.RenderCounter getMonitoring()

Specified by:

getMonitoring in interface panamagl.canvas.GLCanvas

setMonitoring

public void setMonitoring(panamagl.performance.RenderCounter counter)

getOffscreenRenderer

public panamagl.offscreen.OffscreenRenderer getOffscreenRenderer()

Specified by:

getOffscreenRenderer in interface panamagl.canvas.GLCanvas

setOffscreenRenderer

public void setOffscreenRenderer(panamagl.offscreen.OffscreenRenderer offscreen)

Specified by:

setOffscreenRenderer in interface panamagl.canvas.GLCanvas

setFlip

public void setFlip(panamagl.canvas.GLCanvas.Flip flip)

Specified by:

setFlip in interface panamagl.canvas.GLCanvas

getFlip

public panamagl.canvas.GLCanvas.Flip getFlip()

Specified by:

getFlip in interface panamagl.canvas.GLCanvas

isShowRenderingTime

public boolean isShowRenderingTime()

setShowRenderingTime

public void setShowRenderingTime(boolean status)

getPixelScale

public panamagl.canvas.PixelScale getPixelScale()

Specified by:

getPixelScale in interface panamagl.canvas.GLCanvas

getPhysicalWidth

public int getPhysicalWidth()

Specified by:

getPhysicalWidth in interface panamagl.canvas.GLCanvas

getPhysicalHeight

public int getPhysicalHeight()

Specified by:

getPhysicalHeight in interface panamagl.canvas.GLCanvas

addPixelScaleListener

public void addPixelScaleListener(panamagl.canvas.PixelScaleListener l)

Specified by:

addPixelScaleListener in interface panamagl.canvas.GLCanvas

removePixelScaleListener

public void removePixelScaleListener(panamagl.canvas.PixelScaleListener l)

Specified by:

removePixelScaleListener in interface panamagl.canvas.GLCanvas

isHiDPIEnabled

public boolean isHiDPIEnabled()

Specified by:

isHiDPIEnabled in interface panamagl.canvas.GLCanvas

setHiDPIEnabled

public void setHiDPIEnabled(boolean enabled)

Specified by:

setHiDPIEnabled in interface panamagl.canvas.GLCanvas

getPixelScaleSupport

public PixelScaleSupportAWT getPixelScaleSupport()

Test/diagnostics access to the pixel-scale support.