Package com.jme3.system.lwjgl

Class LwjglCanvas

java.lang.Object

com.jme3.system.lwjgl.LwjglContext

com.jme3.system.lwjgl.LwjglWindow

com.jme3.system.lwjgl.LwjglCanvas

All Implemented Interfaces:

JmeCanvasContext, JmeContext, Runnable

public class LwjglCanvas
extends LwjglWindow
implements JmeCanvasContext, Runnable

Class LwjglCanvas that integrates LWJGLX which allows using AWT-Swing components.

If LwjglCanvas throws an exception due to configuration problems, we can debug as follows:
- In AppSettings, set this property to enable a debug that displays the effective data for the context.

 ....
  AppSettings settings = new AppSettings(true);
  settings.putBoolean("GLDataEffectiveDebug", true);
 ...
 

NOTE: If running LwjglCanvas on older machines, the SRGB | Gamma Correction option will raise an exception, so it should be disabled.

 ....
  AppSettings settings = new AppSettings(true);
  settings.setGammaCorrection(false);
 ...
 

Nested Class Summary

Nested classes/interfaces inherited from interface com.jme3.system.JmeContext

JmeContext.Type

Field Summary

Fields inherited from class com.jme3.system.lwjgl.LwjglWindow

allowSwapBuffers, autoFlush, needClose, needRestart, wasActive

Fields inherited from class com.jme3.system.lwjgl.LwjglContext

CL_GL_SHARING_POSSIBLE, clContext, created, createdLock, joyInput, listener, renderable, renderer, settings, timer

Constructor Summary

Constructors

Constructor	Description
LwjglCanvas()	Generate a new OpenGL context (LwjglCanvas) to integrate AWT/Swing with JME3 in your desktop applications.

Method Summary

Modifier and Type	Method	Description
boolean	checkVisibilityState()	Check if the canvas is displayed, that is, if it has a parent that has set it up.
void	create(boolean waitFor)	(non-Javadoc)
protected void	createContext(AppSettings settings)	(non-Javadoc)
void	destroy(boolean waitFor)	(non-Javadoc)
protected void	destroyContext()	(non-Javadoc)
Canvas	getCanvas()	Returns the AWT component where it is drawn (canvas).
int	getFramebufferHeight()	(non-Javadoc)
int	getFramebufferWidth()	(non-Javadoc)
KeyInput	getKeyInput()	(non-Javadoc)
MouseInput	getMouseInput()	(non-Javadoc)
protected String	getPrintContextInitInfo(org.lwjgl.opengl.awt.GLData glData)	Returns a string with the information obtained from GLData so that it can be displayed.
protected void	printContextInitInfo()	(non-Javadoc)
protected void	runLoop()	(non-Javadoc)
void	setTitle(String title)	(non-Javadoc)
protected void	setWindowIcon(AppSettings settings)	(non-Javadoc)
protected void	showWindow()	(non-Javadoc)

Methods inherited from class com.jme3.system.lwjgl.LwjglWindow

deinitInThread, getDisplays, getJoyInput, getPrimaryDisplay, getTouchInput, getType, getWindowContentScale, getWindowHandle, getWindowXPosition, getWindowYPosition, initInThread, registerWindowSizeListener, removeWindowSizeListener, restart, run, setAutoFlushFrames

Methods inherited from class com.jme3.system.lwjgl.LwjglContext

create, destroy, determineMaxSamples, getNumSamplesToUse, getOpenCLContext, getRenderer, getSettings, getSystemListener, getTimer, initContextFirstTime, initOpenCL, internalCreate, internalDestroy, isCreated, isRenderable, reinitContext, setSettings, setSystemListener, waitFor

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.jme3.system.JmeContext

getDisplays, getJoyInput, getOpenCLContext, getPrimaryDisplay, getRenderer, getSettings, getSystemListener, getTimer, getTouchInput, getType, getWindowXPosition, getWindowYPosition, isCreated, isRenderable, restart, setAutoFlushFrames, setSettings, setSystemListener

Methods inherited from interface java.lang.Runnable

run

Constructor Details

LwjglCanvas

public LwjglCanvas()

Generate a new OpenGL context (LwjglCanvas) to integrate AWT/Swing with JME3 in your desktop applications.

Method Details

destroy

public void destroy(boolean waitFor)

(non-Javadoc)

Specified by:

destroy in interface JmeContext

Overrides:

destroy in class LwjglWindow

Parameters:

waitFor - boolean

See Also:

• JmeContext.destroy(boolean)

create

public void create(boolean waitFor)

(non-Javadoc)

Specified by:

create in interface JmeContext

Overrides:

create in class LwjglWindow

Parameters:

waitFor - boolean

See Also:

• JmeContext.create(boolean)

createContext

protected void createContext(AppSettings settings)

(non-Javadoc)

Overrides:

createContext in class LwjglWindow

Parameters:

settings - A AppSettings object

See Also:

• LwjglWindow.createContext(com.jme3.system.AppSettings)

getCanvas

public Canvas getCanvas()

Returns the AWT component where it is drawn (canvas).

Specified by:

getCanvas in interface JmeCanvasContext

Returns:

Canvas

showWindow

protected void showWindow()

(non-Javadoc)

Overrides:

showWindow in class LwjglWindow

setWindowIcon

protected void setWindowIcon(AppSettings settings)

(non-Javadoc)

Overrides:

setWindowIcon in class LwjglWindow

Parameters:

settings - settings for getting the icons

setTitle

public void setTitle(String title)

(non-Javadoc)

Specified by:

setTitle in interface JmeContext

Overrides:

setTitle in class LwjglWindow

Parameters:

title - the title to set

getKeyInput

public KeyInput getKeyInput()

(non-Javadoc)

Specified by:

getKeyInput in interface JmeContext

Overrides:

getKeyInput in class LwjglWindow

Returns:

returns a AwtKeyInput object

See Also:

• LwjglWindow.getKeyInput()

getMouseInput

public MouseInput getMouseInput()

(non-Javadoc)

Specified by:

getMouseInput in interface JmeContext

Overrides:

getMouseInput in class LwjglWindow

Returns:

returns a AwtMouseInput object

See Also:

• LwjglWindow.getMouseInput()

checkVisibilityState

public boolean checkVisibilityState()

Check if the canvas is displayed, that is, if it has a parent that has set it up.

It is very important that this verification be done so that LWJGL3-AWT works correctly.

Returns:

returns true if the canvas is ready to draw; otherwise returns false

destroyContext

protected void destroyContext()

(non-Javadoc)

Overrides:

destroyContext in class LwjglWindow

See Also:

• LwjglWindow.destroyContext()

runLoop

protected void runLoop()

(non-Javadoc)

Overrides:

runLoop in class LwjglWindow

See Also:

• LwjglWindow.runLoop()

printContextInitInfo

protected void printContextInitInfo()

(non-Javadoc)

Overrides:

printContextInitInfo in class LwjglContext

See Also:

• LwjglContext.printContextInitInfo()

getPrintContextInitInfo

protected String getPrintContextInitInfo(org.lwjgl.opengl.awt.GLData glData)

Returns a string with the information obtained from GLData so that it can be displayed.

Parameters:

glData - context information

Returns:

String

getFramebufferHeight

public int getFramebufferHeight()

(non-Javadoc)

Specified by:

getFramebufferHeight in interface JmeContext

Overrides:

getFramebufferHeight in class LwjglWindow

Returns:

int

See Also:

• LwjglWindow.getFramebufferHeight()

getFramebufferWidth

public int getFramebufferWidth()

(non-Javadoc)

Specified by:

getFramebufferWidth in interface JmeContext

Overrides:

getFramebufferWidth in class LwjglWindow

Returns:

int

See Also:

• LwjglWindow.getFramebufferWidth()