Class OGLCanvas<G extends OGLGraphics>

java.lang.Object

java.awt.Component

java.awt.Canvas

com.blackrook.gloop.opengl.OGLCanvas<G>

Type Parameters:

G - the OGLGraphics type.

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

public class OGLCanvas<G extends OGLGraphics>
extends Canvas

A common OpenGL Canvas.

Author:

Matthew Tropiano

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class Canvas

Canvas.AccessibleAWTCanvas

Nested classes/interfaces inherited from class Component

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

Field Summary

Fields

Modifier and Type	Field	Description
protected GLCapabilities	caps
protected long	context
protected final com.blackrook.gloop.glfw.GLFWWindowHints	hints

Fields inherited from class Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface ImageObserver

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

Constructor Summary

Constructors

Constructor	Description
OGLCanvas(com.blackrook.gloop.glfw.GLFWWindowHints hints, OGLSystem<G> system)	Creates a new canvas suitable for rendering to.

Method Summary

Modifier and Type	Method	Description
void	dispose()	Destroys this canvas.
protected void	finalize()
final com.blackrook.gloop.glfw.GLFWWindowHints	getHints()
OGLSystem<G>	getSystem()	Gets a reference to this canvas's underlying system.
final void	paint(Graphics g)
protected void	renderSystem(int width, int height)	Called when the rendering surface is secured so that rendering can be done to via a rendering system.
final void	update(Graphics g)

Methods inherited from class Canvas

addNotify, createBufferStrategy, createBufferStrategy, getAccessibleContext, getBufferStrategy

Methods inherited from class Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paramString, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, 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, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setMixingCutoutShape, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, validate

Methods inherited from class Object

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

Field Details

hints

protected final com.blackrook.gloop.glfw.GLFWWindowHints hints

caps

protected GLCapabilities caps

context

protected long context

Constructor Details

OGLCanvas

public OGLCanvas(com.blackrook.gloop.glfw.GLFWWindowHints hints,
 OGLSystem<G> system)

Creates a new canvas suitable for rendering to.

Parameters:

hints - the hints for this context's creation. Note that some hints for creating the window itself will have no effect, here.

system - the rendering system to use for rendering content.

Throws:

UnsupportedOperationException - if this canvas can't be created for this platform.

Method Details

getHints

public final com.blackrook.gloop.glfw.GLFWWindowHints getHints()

Returns:

the GLFWWindowHints used to make this canvas.

update

public final void update(Graphics g)

Overrides:

update in class Canvas

paint

public final void paint(Graphics g)

Overrides:

paint in class Canvas

getSystem

public OGLSystem<G> getSystem()

Gets a reference to this canvas's underlying system.

Returns:

the system reference.

renderSystem

protected void renderSystem(int width,
 int height)

Called when the rendering surface is secured so that rendering can be done to via a rendering system.

Parameters:

width - the width of the framebuffer.

height - the height of the framebuffer.

dispose

public void dispose()

Destroys this canvas.

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable