Package panamagl.canvas

Interface GLCanvas

public interface GLCanvas

A canvas able to perform OpenGL calls through the GLEventListener interface.

Author:

Martin Pernollet

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	GLCanvas.Flip

Method Summary

Modifier and Type	Method	Description
default void	addPixelScaleListener(PixelScaleListener listener)	Register a listener notified when getPixelScale() changes.
void	display()	Trigger display.
GLContext	getContext()	Return the GL context.
GLCanvas.Flip	getFlip()
GL	getGL()	Return the GL instance allowing to invoke OpenGL.
GLEventListener	getGLEventListener()	Return the event listener handling init, drawing and resize requests.
int	getHeight()
RenderCounter	getMonitoring()	Return the performance information about this panel.
OffscreenRenderer	getOffscreenRenderer()
default int	getPhysicalHeight()	Height of the rendering surface (FBO) in physical pixels.
default int	getPhysicalWidth()	Width of the rendering surface (FBO) in physical pixels.
default PixelScale	getPixelScale()	Return the current pixel scale (ratio between physical pixels and logical pixels).
Image<?>	getScreenshot()
int	getWidth()
default boolean	isHiDPIEnabled()	Whether HiDPI rendering is enabled.
boolean	isInitialized()	Return true if the panel has initialized GL ressource and is ready for display.
boolean	isRendering()	Return true if a frame rendering has started and not yet finished.
boolean	isVisible()	Return true if the component is visible on screen (depend on windowing toolkit implementation, e.g.
default void	removePixelScaleListener(PixelScaleListener listener)	Remove a previously registered PixelScaleListener.
void	repaint()
void	setFlip(GLCanvas.Flip flip)
void	setGLEventListener(GLEventListener listener)	Set the event listener handling init, drawing and resize requests.
default void	setHiDPIEnabled(boolean enabled)	Toggle HiDPI rendering.
void	setOffscreenRenderer(OffscreenRenderer offscreen)
void	setScreenshot(Image<?> image)

Method Details

display

void display()

Trigger display. The component is responsible for routing the request to the appropriate threads.

isRendering

boolean isRendering()

Return true if a frame rendering has started and not yet finished.

getGLEventListener

GLEventListener getGLEventListener()

Return the event listener handling init, drawing and resize requests.

setGLEventListener

void setGLEventListener(GLEventListener listener)

Set the event listener handling init, drawing and resize requests.

isInitialized

boolean isInitialized()

Return true if the panel has initialized GL ressource and is ready for display.

isVisible

boolean isVisible()

Return true if the component is visible on screen (depend on windowing toolkit implementation, e.g. Component.isVisible()).

getContext

GLContext getContext()

Return the GL context.

getGL

GL getGL()

Return the GL instance allowing to invoke OpenGL.

getMonitoring

RenderCounter getMonitoring()

Return the performance information about this panel.

getWidth

int getWidth()

getHeight

int getHeight()

repaint

void repaint()

setScreenshot

void setScreenshot(Image<?> image)

getScreenshot

Image<?> getScreenshot()

getOffscreenRenderer

OffscreenRenderer getOffscreenRenderer()

setOffscreenRenderer

void setOffscreenRenderer(OffscreenRenderer offscreen)

setFlip

void setFlip(GLCanvas.Flip flip)

getFlip

GLCanvas.Flip getFlip()

getPixelScale

default PixelScale getPixelScale()

Return the current pixel scale (ratio between physical pixels and logical pixels).

Returns PixelScale.IDENTITY for canvases that have not been displayed yet, or for implementations that do not yet support HiDPI detection.

getPhysicalWidth

default int getPhysicalWidth()

Width of the rendering surface (FBO) in physical pixels.

When HiDPI is enabled, this is getWidth() * pixelScale.x(); otherwise it equals getWidth().

getPhysicalHeight

default int getPhysicalHeight()

Height of the rendering surface (FBO) in physical pixels.

See Also:

• getPhysicalWidth()

addPixelScaleListener

default void addPixelScaleListener(PixelScaleListener listener)

Register a listener notified when getPixelScale() changes.

Default implementation is a no-op for canvases that do not yet support HiDPI events.

removePixelScaleListener

default void removePixelScaleListener(PixelScaleListener listener)

Remove a previously registered PixelScaleListener.

isHiDPIEnabled

default boolean isHiDPIEnabled()

Whether HiDPI rendering is enabled.

When true (the default), the FBO is dimensioned in physical pixels — sharp rendering on Retina/HiDPI displays at the cost of more pixels to fill.

When false, the FBO is dimensioned in logical pixels — equivalent to setting a pixel scale of (1, 1): faster but the image is upscaled by the toolkit on HiDPI displays. Mirrors Jzy3D's Quality.preserveViewportSize=true.

setHiDPIEnabled

default void setHiDPIEnabled(boolean enabled)

Toggle HiDPI rendering. @see #isHiDPIEnabled()