com.bonzaiengine.app

Class ApplicationSettings

java.lang.Object

com.bonzaiengine.app.ApplicationSettings

public final class ApplicationSettings
extends java.lang.Object

Settings to create and load an IGLApplication.

See Also:

IApplication

Constructor Summary

Constructors

Constructor and Description
ApplicationSettings(GLApiName openGLApi)
ApplicationSettings(GLApiName glApiName, DisplayCapabilities capabilities, IGLApi gLContextShared)

Method Summary

Modifier and Type	Method and Description
IApplication	createApp() Create the IApplication
IApplication	createAppOffscreen() Create the IApplication for offscreen rendering
ISceneTarget	createSceneTarget(IApplication glApp, boolean hasAppOrAppGui)
java.lang.Class<? extends ApplicationGui>	getApplicationGui()
DisplayCapabilities	getDisplayCapabilities()
DisplaySettings	getDisplaySettings()
IGLApi	getGLContextShared()
GLApiName	getOpenGLApi()
java.lang.Class<? extends IScene>	getScene()
Size	getSceneSize()
IApplication	initApp(IApplication glApp)
boolean	isGLApiReadOnly()
boolean	isUseMultipleContext()
ApplicationSettings	setApplicationGui(java.lang.Class<? extends ApplicationGui> applicationGui)
ApplicationSettings	setDisplaySettings(DisplaySettings displaySettings)
ApplicationSettings	setGLApiReadOnly(boolean readOnly)
void	setOpenGLApi(GLApiName openGLApi)
ApplicationSettings	setScene(java.lang.Class<? extends IScene> scene)
ApplicationSettings	setSceneSize(Size sceneSize)
ApplicationSettings	setUseMultipleContext(boolean useMultipleContext)
void	showDialog() Show the settings dialog to let user choose resolution, fullscreen etc

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationSettings

public ApplicationSettings(GLApiName openGLApi)

ApplicationSettings

public ApplicationSettings(GLApiName glApiName,
                           DisplayCapabilities capabilities,
                           IGLApi gLContextShared)

Parameters:

glApiName - OpenGL API to use

capabilities - OpenGL capabilities. Optional, can be null

gLContextShared - OpenGL context shared with. Optional, can be null

Method Detail

getOpenGLApi

public GLApiName getOpenGLApi()

setOpenGLApi

public void setOpenGLApi(GLApiName openGLApi)

setGLApiReadOnly

public ApplicationSettings setGLApiReadOnly(boolean readOnly)

Parameters:

readOnly - true to force the use of getOpenGLApi(), in that case there will be no attempt to use any other api

Returns:

this

isGLApiReadOnly

public boolean isGLApiReadOnly()

setApplicationGui

public ApplicationSettings setApplicationGui(java.lang.Class<? extends ApplicationGui> applicationGui)

Parameters:

applicationGui - ApplicationGui class to use

Returns:

this

getApplicationGui

public java.lang.Class<? extends ApplicationGui> getApplicationGui()

setScene

public ApplicationSettings setScene(java.lang.Class<? extends IScene> scene)

Parameters:

scene - IScene to use, this is required

Returns:

this

getScene

public java.lang.Class<? extends IScene> getScene()

setSceneSize

public ApplicationSettings setSceneSize(Size sceneSize)

Parameters:

sceneSize - IScene scene, optional

Returns:

this

getSceneSize

public Size getSceneSize()

setUseMultipleContext

public ApplicationSettings setUseMultipleContext(boolean useMultipleContext)

Parameters:

useMultipleContext - true to let the api know that you would use multiple open context

Returns:

this

isUseMultipleContext

public boolean isUseMultipleContext()

setDisplaySettings

public ApplicationSettings setDisplaySettings(DisplaySettings displaySettings)

Returns:

the DisplaySettings specified in the constructor

getDisplaySettings

public DisplaySettings getDisplaySettings()

getDisplayCapabilities

public DisplayCapabilities getDisplayCapabilities()

Returns:

the DisplayCapabilities specified in the constructor

getGLContextShared

public IGLApi getGLContextShared()

Returns:

the IGLApi specified in the constructor for OpenGL Context sharing.

showDialog

public final void showDialog()

Show the settings dialog to let user choose resolution, fullscreen etc

createApp

public final IApplication createApp()

Create the IApplication

initApp

public final IApplication initApp(IApplication glApp)

createAppOffscreen

public final IApplication createAppOffscreen()

Create the IApplication for offscreen rendering

createSceneTarget

public final ISceneTarget createSceneTarget(IApplication glApp,
                                            boolean hasAppOrAppGui)
                                     throws java.lang.Exception

Throws:

java.lang.Exception