com.jme3.system.AppSettings Maven / Gradle / Ivy
Show all versions of jme3-core Show documentation
/*
* Copyright (c) 2009-2021 jMonkeyEngine
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* * Neither the name of 'jMonkeyEngine' nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.jme3.system;
import com.jme3.opencl.DefaultPlatformChooser;
import com.jme3.opencl.PlatformChooser;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import java.util.prefs.BackingStoreException;
import java.util.prefs.Preferences;
/**
* AppSettings provides a store of configuration
* to be used by the application.
*
* By default only the {@link JmeContext context} uses the configuration,
* however the user may set and retrieve the settings as well.
* The settings can be stored either in the Java preferences
* (using {@link #save(java.lang.String) }) or
* a .properties file (using {@link #save(java.io.OutputStream) }).
*
* @author Kirill Vainer
*/
public final class AppSettings extends HashMap {
private static final long serialVersionUID = 1L;
private static final AppSettings defaults = new AppSettings(false);
/**
* Use LWJGL as the display system and force using the OpenGL2.0 renderer.
*
* If the underlying system does not support OpenGL2.0, then the context
* initialization will throw an exception.
*
* @see AppSettings#setRenderer(java.lang.String)
*/
public static final String LWJGL_OPENGL2 = "LWJGL-OpenGL2";
/**
* Use LWJGL as the display system and force using the core OpenGL3.2 renderer.
*
* If the underlying system does not support OpenGL3.2, then the context
* initialization will throw an exception. Note that currently jMonkeyEngine
* does not have any shaders that support OpenGL3.2 therefore this
* option is not useful.
*
* Note: OpenGL 3.2 is used to give 3.x support to Mac users.
*
* @deprecated Previously meant 3.2, use LWJGL_OPENGL32 or LWJGL_OPENGL30
* @see AppSettings#setRenderer(java.lang.String)
*/
@Deprecated
public static final String LWJGL_OPENGL3 = "LWJGL-OpenGL3";
/**
* Use LWJGL as the display system and force using the core OpenGL3.0 renderer.
*
* If the underlying system does not support OpenGL3.0, then the context
* initialization will throw an exception. Note that currently jMonkeyEngine
* does not have any shaders that support OpenGL3.0 therefore this
* option is not useful.
*
*
* @see AppSettings#setRenderer(java.lang.String)
*/
public static final String LWJGL_OPENGL30 = "LWJGL-OpenGL30";
/**
* Use LWJGL as the display system and force using the core OpenGL3.1 renderer.
*
* If the underlying system does not support OpenGL3.1, then the context
* initialization will throw an exception. Note that currently jMonkeyEngine
* does not have any shaders that support OpenGL3.0 therefore this
* option is not useful.
*
*
* @see AppSettings#setRenderer(java.lang.String)
*/
public static final String LWJGL_OPENGL31 = "LWJGL-OpenGL31";
/**
* Use LWJGL as the display system and force using the core OpenGL3.2 renderer.
*
* If the underlying system does not support OpenGL3.2, then the context
* initialization will throw an exception. Note that currently jMonkeyEngine
* does not have any shaders that support OpenGL3.2 therefore this
* option is not useful.
*
* Note: OpenGL 3.2 is used to give 3.x support to Mac users.
*
* @see AppSettings#setRenderer(java.lang.String)
*/
public static final String LWJGL_OPENGL32 = LWJGL_OPENGL3;
/**
* Use LWJGL as the display system and force using the OpenGL3.3 renderer.
*
* If the underlying system does not support OpenGL3.3, then the context
* initialization will throw an exception.
*
* @see AppSettings#setRenderer(java.lang.String)
*/
public static final String LWJGL_OPENGL33 = "LWJGL-OpenGL33";
/**
* Use LWJGL as the display system and force using the OpenGL4.0 renderer.
*
* If the underlying system does not support OpenGL4.0, then the context
* initialization will throw an exception.
*
* @deprecated Use LWJGL_OPENGL40
* @see AppSettings#setRenderer(java.lang.String)
*/
@Deprecated
public static final String LWJGL_OPENGL4 = "LWJGL-OpenGL4";
/**
* Use LWJGL as the display system and force using the OpenGL4.0 renderer.
*
* If the underlying system does not support OpenGL4.0, then the context
* initialization will throw an exception.
*
* @see AppSettings#setRenderer(java.lang.String)
*/
public static final String LWJGL_OPENGL40 = LWJGL_OPENGL4;
/**
* Use LWJGL as the display system and force using the OpenGL4.1 renderer.
*
* If the underlying system does not support OpenGL4.1, then the context
* initialization will throw an exception.
*
* @see AppSettings#setRenderer(java.lang.String)
*/
public static final String LWJGL_OPENGL41 = "LWJGL-OpenGL41";
/**
* Use LWJGL as the display system and force using the OpenGL4.2 renderer.
*
* If the underlying system does not support OpenGL4.2, then the context
* initialization will throw an exception.
*
* @see AppSettings#setRenderer(java.lang.String)
*/
public static final String LWJGL_OPENGL42 = "LWJGL-OpenGL42";
/**
* Use LWJGL as the display system and force using the OpenGL4.3 renderer.
*
* If the underlying system does not support OpenGL4.3, then the context
* initialization will throw an exception.
*
* @see AppSettings#setRenderer(java.lang.String)
*/
public static final String LWJGL_OPENGL43 = "LWJGL-OpenGL43";
/**
* Use LWJGL as the display system and force using the OpenGL4.4 renderer.
*
* If the underlying system does not support OpenGL4.4, then the context
* initialization will throw an exception.
*
* @see AppSettings#setRenderer(java.lang.String)
*/
public static final String LWJGL_OPENGL44 = "LWJGL-OpenGL44";
/**
* Use LWJGL as the display system and force using the OpenGL4.5 renderer.
*
* If the underlying system does not support OpenGL4.5, then the context
* initialization will throw an exception.
*
* @see AppSettings#setRenderer(java.lang.String)
*/
public static final String LWJGL_OPENGL45 = "LWJGL-OpenGL45";
/**
* Use the LWJGL OpenAL based renderer for audio capabilities.
*
* @see AppSettings#setAudioRenderer(java.lang.String)
*/
public static final String LWJGL_OPENAL = "LWJGL";
/**
* Use the Android MediaPlayer / SoundPool based renderer for Android audio capabilities.
*
* NOTE: Supports Android 2.2+ platforms.
*
* @see AppSettings#setAudioRenderer(java.lang.String)
* @deprecated This audio renderer has too many limitations.
* use {@link #ANDROID_OPENAL_SOFT} instead.
*/
@Deprecated
public static final String ANDROID_MEDIAPLAYER = "MediaPlayer";
/**
* Use the OpenAL Soft based renderer for Android audio capabilities.
*
* This is the current default for Android platforms.
* NOTE: Only to be used on Android 2.3+ platforms due to using OpenSL.
*
* @see AppSettings#setAudioRenderer(java.lang.String)
*/
public static final String ANDROID_OPENAL_SOFT = "OpenAL_SOFT";
/**
* Use JogAmp's JOGL as the display system, with the OpenGL forward compatible profile
*
* N.B: This backend is EXPERIMENTAL
*
* @see AppSettings#setRenderer(java.lang.String)
*/
public static final String JOGL_OPENGL_FORWARD_COMPATIBLE = "JOGL_OPENGL_FORWARD_COMPATIBLE";
/**
* Use JogAmp's JOGL as the display system, with the backward compatible profile
*
* N.B: This backend is EXPERIMENTAL
*
* @see AppSettings#setRenderer(java.lang.String)
*/
public static final String JOGL_OPENGL_BACKWARD_COMPATIBLE = "JOGL_OPENGL_BACKWARD_COMPATIBLE";
/**
* Use JogAmp's JOAL as the audio renderer.
*
* N.B: This backend is EXPERIMENTAL
*
* @see AppSettings#setAudioRenderer(java.lang.String)
*/
public static final String JOAL = "JOAL";
static {
defaults.put("CenterWindow", true);
defaults.put("Width", 640);
defaults.put("Height", 480);
defaults.put("BitsPerPixel", 24);
defaults.put("Frequency", 60);
defaults.put("DepthBits", 24);
defaults.put("StencilBits", 0);
defaults.put("Samples", 0);
defaults.put("Fullscreen", false);
defaults.put("Title", JmeVersion.FULL_NAME);
defaults.put("Renderer", LWJGL_OPENGL2);
defaults.put("AudioRenderer", LWJGL_OPENAL);
defaults.put("DisableJoysticks", true);
defaults.put("UseInput", true);
defaults.put("VSync", true);
defaults.put("FrameRate", -1);
defaults.put("SettingsDialogImage", "/com/jme3/app/Monkey.png");
defaults.put("MinHeight", 0);
defaults.put("MinWidth", 0);
defaults.put("GammaCorrection", true);
defaults.put("Resizable", false);
defaults.put("SwapBuffers", true);
defaults.put("OpenCL", false);
defaults.put("OpenCLPlatformChooser", DefaultPlatformChooser.class.getName());
defaults.put("UseRetinaFrameBuffer", false);
defaults.put("WindowYPosition", 0);
defaults.put("WindowXPosition", 0);
// defaults.put("Icons", null);
}
/**
* Create a new instance of AppSettings.
*
* If loadDefaults is true, then the default settings
* will be set on the AppSettings.
* Use false if you want to change some settings but you would like the
* application to load settings from previous launches.
*
* @param loadDefaults If default settings are to be loaded.
*/
public AppSettings(boolean loadDefaults) {
if (loadDefaults) {
putAll(defaults);
}
}
/**
* Copies all settings from other to this
* AppSettings.
*
* Any settings that are specified in other will overwrite settings
* set on this AppSettings.
*
* @param other The AppSettings to copy the settings from
*/
public void copyFrom(AppSettings other) {
this.putAll(other);
}
/**
* Same as {@link #copyFrom(com.jme3.system.AppSettings) }, except
* doesn't overwrite settings that are already set.
*
* @param other The AppSettings to merge the settings from
*/
public void mergeFrom(AppSettings other) {
for (String key : other.keySet()) {
if (!this.containsKey(key)) {
put(key, other.get(key));
}
}
}
/**
* Loads the settings from the given properties input stream.
*
* @param in The InputStream to load from
* @throws IOException If an IOException occurs
*
* @see #save(java.io.OutputStream)
*/
public void load(InputStream in) throws IOException {
Properties props = new Properties();
props.load(in);
for (Map.Entry entry : props.entrySet()) {
String key = (String) entry.getKey();
String val = (String) entry.getValue();
if (val != null) {
val = val.trim();
}
if (key.endsWith("(int)")) {
key = key.substring(0, key.length() - 5);
int iVal = Integer.parseInt(val);
putInteger(key, iVal);
} else if (key.endsWith("(string)")) {
putString(key.substring(0, key.length() - 8), val);
} else if (key.endsWith("(bool)")) {
boolean bVal = Boolean.parseBoolean(val);
putBoolean(key.substring(0, key.length() - 6), bVal);
} else if (key.endsWith("(float)")) {
float fVal = Float.parseFloat(val);
putFloat(key.substring(0, key.length() - 7), fVal);
} else {
throw new IOException("Cannot parse key: " + key);
}
}
}
/**
* Saves all settings to the given properties output stream.
*
* @param out The OutputStream to write to
* @throws IOException If an IOException occurs
*
* @see #load(java.io.InputStream)
*/
public void save(OutputStream out) throws IOException {
Properties props = new Properties();
for (Map.Entry entry : entrySet()) {
Object val = entry.getValue();
String type;
if (val instanceof Integer) {
type = "(int)";
} else if (val instanceof String) {
type = "(string)";
} else if (val instanceof Boolean) {
type = "(bool)";
} else if (val instanceof Float) {
type = "(float)";
} else {
// See the note in the AppSettings.save(String)
// method regarding object type settings.
continue;
}
props.setProperty(entry.getKey() + type, val.toString());
}
props.store(out, "jME3 AppSettings");
}
/**
* Loads settings previously saved in the Java preferences.
*
* @param preferencesKey The preferencesKey previously used to save the settings.
* @throws BackingStoreException If an exception occurs with the preferences
*
* @see #save(java.lang.String)
*/
public void load(String preferencesKey) throws BackingStoreException {
Preferences prefs = Preferences.userRoot().node(preferencesKey);
String[] keys = prefs.keys();
if (keys != null) {
for (String key : keys) {
if (key.charAt(1) == '_') {
// Try loading using new method
switch (key.charAt(0)) {
case 'I':
put(key.substring(2), prefs.getInt(key, 0));
break;
case 'F':
put(key.substring(2), prefs.getFloat(key, 0f));
break;
case 'S':
put(key.substring(2), prefs.get(key, null));
break;
case 'B':
put(key.substring(2), prefs.getBoolean(key, false));
break;
default:
throw new UnsupportedOperationException("Undefined setting type: " + key.charAt(0));
}
} else {
// Use old method for compatibility with older preferences
// TODO: Remove when no longer necessary
Object defaultValue = defaults.get(key);
if (defaultValue instanceof Integer) {
put(key, prefs.getInt(key, (Integer) defaultValue));
} else if (defaultValue instanceof String) {
put(key, prefs.get(key, (String) defaultValue));
} else if (defaultValue instanceof Boolean) {
put(key, prefs.getBoolean(key, (Boolean) defaultValue));
}
}
}
}
}
/**
* Saves settings into the Java preferences.
*
* On the Windows operating system, the preferences are saved in the registry
* at the following key:
* HKEY_CURRENT_USER\Software\JavaSoft\Prefs\[preferencesKey]
*
* @param preferencesKey The preferences key to save at. Generally the
* application's unique name.
*
* @throws BackingStoreException If an exception occurs with the preferences
*/
public void save(String preferencesKey) throws BackingStoreException {
Preferences prefs = Preferences.userRoot().node(preferencesKey);
// Clear any previous settings set before saving, this will
// purge any other parameters set in older versions of the app, so
// that they don't leak onto the AppSettings of newer versions.
prefs.clear();
for (String key : keySet()) {
Object val = get(key);
if (val instanceof Integer) {
prefs.putInt("I_" + key, (Integer) val);
} else if (val instanceof Float) {
prefs.putFloat("F_" + key, (Float) val);
} else if (val instanceof String) {
prefs.put("S_" + key, (String) val);
} else if (val instanceof Boolean) {
prefs.putBoolean("B_" + key, (Boolean) val);
}
// NOTE: Ignore any parameters of unsupported types instead
// of throwing exception. This is specifically for handling
// BufferedImage which is used in setIcons(), as you do not
// want to export such data in the preferences.
}
// Ensure the data is properly written into preferences before
// continuing.
prefs.sync();
}
/**
* Get an integer from the settings.
*
* If the key is not set, then 0 is returned.
*
* @param key the key of an integer setting
* @return the corresponding value, or 0 if not set
*/
public int getInteger(String key) {
Integer i = (Integer) get(key);
if (i == null) {
return 0;
}
return i.intValue();
}
/**
* Get a boolean from the settings.
*
* If the key is not set, then false is returned.
*
* @param key the key of a boolean setting
* @return the corresponding value, or false if not set
*/
public boolean getBoolean(String key) {
Boolean b = (Boolean) get(key);
if (b == null) {
return false;
}
return b.booleanValue();
}
/**
* Get a string from the settings.
*
* If the key is not set, then null is returned.
*
* @param key the key of a string setting
* @return the corresponding value, or null if not set
*/
public String getString(String key) {
String s = (String) get(key);
if (s == null) {
return null;
}
return s;
}
/**
* Get a float from the settings.
*
* If the key is not set, then 0.0 is returned.
*
* @param key the key of a float setting
* @return the corresponding value, or 0 if not set
*/
public float getFloat(String key) {
Float f = (Float) get(key);
if (f == null) {
return 0f;
}
return f.floatValue();
}
/**
* Set an integer on the settings.
*
* @param key the desired key
* @param value the desired integer value
*/
public void putInteger(String key, int value) {
put(key, Integer.valueOf(value));
}
/**
* Set a boolean on the settings.
*
* @param key the desired key
* @param value the desired boolean value
*/
public void putBoolean(String key, boolean value) {
put(key, Boolean.valueOf(value));
}
/**
* Set a string on the settings.
*
* @param key the desired key
* @param value the desired string value
*/
public void putString(String key, String value) {
put(key, value);
}
/**
* Set a float on the settings.
*
* @param key the desired key
* @param value the desired float value
*/
public void putFloat(String key, float value) {
put(key, Float.valueOf(value));
}
/**
* Enable or disable mouse emulation on touchscreen based devices.
* This will convert taps on the touchscreen or movement of finger
* over touchscreen (only the first) into the appropriate mouse events.
*
* @param emulateMouse If mouse emulation should be enabled.
*/
public void setEmulateMouse(boolean emulateMouse) {
putBoolean("TouchEmulateMouse", emulateMouse);
}
/**
* Returns true if mouse emulation is enabled, false otherwise.
*
* @return Mouse emulation mode.
*/
public boolean isEmulateMouse() {
return getBoolean("TouchEmulateMouse");
}
/**
* Specify if the X or Y (or both) axes should be flipped for emulated mouse.
*
* @param flipX Set to flip X axis
* @param flipY Set to flip Y axis
*
* @see #setEmulateMouse(boolean)
*/
public void setEmulateMouseFlipAxis(boolean flipX, boolean flipY) {
putBoolean("TouchEmulateMouseFlipX", flipX);
putBoolean("TouchEmulateMouseFlipY", flipY);
}
public boolean isEmulateMouseFlipX() {
return getBoolean("TouchEmulateMouseFlipX");
}
public boolean isEmulateMouseFlipY() {
return getBoolean("TouchEmulateMouseFlipY");
}
/**
* Enable or disable keyboard emulation on touchscreen based devices.
* This will convert soft keyboard key presses on the touchscreen
* into the appropriate key events.
*
* @param emulateKeyboard If soft keyboard emulation should be enabled.
*/
public void setEmulateKeyboard(boolean emulateKeyboard) {
putBoolean("TouchEmulateKeyboard", emulateKeyboard);
}
/**
* Returns true if keyboard emulation is enabled, false otherwise.
*
* @return Soft keyboard emulation mode.
*/
public boolean isEmulateKeyboard() {
return getBoolean("TouchEmulateKeyboard");
}
/**
* @param frameRate The frame-rate is the upper limit on how high
* the application's frames-per-second can go.
* (Default: -1 no frame rate limit imposed)
*/
public void setFrameRate(int frameRate) {
putInteger("FrameRate", frameRate);
}
/**
* @param use If true, the application will initialize and use input.
* Set to false for headless applications that do not require keyboard
* or mouse input.
* (Default: true)
*/
public void setUseInput(boolean use) {
putBoolean("UseInput", use);
}
/**
* @param use If true, the application will initialize and use joystick
* input. Set to false if no joystick input is desired.
* (Default: false)
*/
public void setUseJoysticks(boolean use) {
putBoolean("DisableJoysticks", !use);
}
/**
* Set the graphics renderer to use, one of:
*
* - AppSettings.LWJGL_OPENGL1 - Force OpenGL1.1 compatability
* - AppSettings.LWJGL_OPENGL2 - Force OpenGL2 compatability
* - AppSettings.LWJGL_OPENGL3 - Force OpenGL3.3 compatability
* - AppSettings.LWJGL_OPENGL_ANY - Choose an appropriate
* OpenGL version based on system capabilities
* - AppSettings.JOGL_OPENGL_BACKWARD_COMPATIBLE
* - AppSettings.JOGL_OPENGL_FORWARD_COMPATIBLE
* - null - Disable graphics rendering
*
* @param renderer The renderer to set
* (Default: AppSettings.LWJGL_OPENGL2)
*/
public void setRenderer(String renderer) {
putString("Renderer", renderer);
}
/**
* Set a custom graphics renderer to use. The class should implement
* the {@link JmeContext} interface.
* @param clazz The custom context class.
* (Default: not set)
*/
public void setCustomRenderer(Class clazz){
put("Renderer", "CUSTOM" + clazz.getName());
}
/**
* Set the audio renderer to use. One of:
*
* - AppSettings.LWJGL_OPENAL - Default for LWJGL
* - AppSettings.JOAL
* - null - Disable audio
*
* @param audioRenderer
* (Default: LWJGL)
*/
public void setAudioRenderer(String audioRenderer) {
putString("AudioRenderer", audioRenderer);
}
/**
* @param value the width for the rendering display.
* (Default: 640)
*/
public void setWidth(int value) {
putInteger("Width", value);
}
/**
* @param value the height for the rendering display.
* (Default: 480)
*/
public void setHeight(int value) {
putInteger("Height", value);
}
/**
* Set the resolution for the rendering display
* @param width The width
* @param height The height
* (Default: 640x480)
*/
public void setResolution(int width, int height) {
setWidth(width);
setHeight(height);
}
/**
* @param value the minimum width the settings window will allow for the rendering display.
* (Default: 0)
*/
public void setMinWidth(int value) {
putInteger("MinWidth", value);
}
/**
* @param value the minimum height the settings window will allow for the rendering display.
* (Default: 0)
*/
public void setMinHeight(int value) {
putInteger("MinHeight", value);
}
/**
* Set the minimum resolution the settings window will allow for the rendering display
* @param width The minimum width
* @param height The minimum height
* (Default: 0x0)
*/
public void setMinResolution(int width, int height) {
setMinWidth(width);
setMinHeight(height);
}
/**
* Set the frequency, also known as refresh rate, for the
* rendering display.
* @param value The frequency
* (Default: 60)
*/
public void setFrequency(int value) {
putInteger("Frequency", value);
}
/**
* Sets the number of depth bits to use.
*
* The number of depth bits specifies the precision of the depth buffer.
* To increase precision, specify 32 bits. To decrease precision, specify
* 16 bits. On some platforms 24 bits might not be supported, in that case,
* specify 16 bits.
* (Default: 24)
*
* @param value The depth bits
*/
public void setDepthBits(int value){
putInteger("DepthBits", value);
}
/**
* Android Only
* Sets the number of alpha bits to use.
*
* The number of alpha bits specifies the precision of the surface view
* background alpha value. To set the surface view to opaque (fastest setting),
* leave the number of alpha bits = 0. This will cause faster rendering,
* but android views located behind the surface view will not be viewable.
* To set the surface view to translucent, set the number of alphaBits to 8
* or higher. Values less than 8 (except 0) will set the surface view pixel
* format to transparent.
* (Default: 0)
*
* @param value The alpha bits
*/
public void setAlphaBits(int value){
putInteger("AlphaBits", value);
}
/**
* Set the number of stencil bits.
*
* This value is only relevant when the stencil buffer is being used.
* Specify 8 to indicate an 8-bit stencil buffer, specify 0 to disable
* the stencil buffer.
*
* (Default: 0)
*
* @param value Number of stencil bits
*/
public void setStencilBits(int value){
putInteger("StencilBits", value);
}
/**
* Set the bits per pixel for the display. Appropriate
* values are 16 for RGB565 color format, or 24 for RGB8 color format.
*
* @param value The bits per pixel to set
* (Default: 24)
*/
public void setBitsPerPixel(int value) {
putInteger("BitsPerPixel", value);
}
/**
* Set the number of samples per pixel. A value of 1 indicates
* each pixel should be single-sampled, higher values indicate
* a pixel should be multi-sampled.
*
* @param value The number of samples
* (Default: 1)
*/
public void setSamples(int value) {
putInteger("Samples", value);
}
/**
* @param title The title of the rendering display
* (Default: jMonkeyEngine 3.0)
*/
public void setTitle(String title) {
putString("Title", title);
}
/**
* @param value true to enable full-screen rendering, false to render in a window
* (Default: false)
*/
public void setFullscreen(boolean value) {
putBoolean("Fullscreen", value);
}
/**
* Enable or disable vertical synchronization. If enabled, rendering will be
* synchronized with the display's refresh interval.
*
* @param value true to enable, false to disable (Default : true)
*/
public void setVSync(boolean value) {
putBoolean("VSync", value);
}
/**
* Enable 3D stereo.
* This feature requires hardware support from the GPU driver.
* See http://en.wikipedia.org/wiki/Quad_buffering
* Once enabled, filters or scene processors that handle 3D stereo rendering
* could use this feature to render using hardware 3D stereo.
*
* @param value true to enable 3-D stereo, false to disable (default=false)
*/
public void setStereo3D(boolean value){
putBoolean("Stereo3D", value);
}
/**
* Sets the application icons to be used, with the most preferred first.
* For Windows, you should supply at least one 16x16 icon and one 32x32. The former is used for the title/task bar,
* the latter for the alt-tab icon.
* Linux (and similar platforms) expect one 32x32 icon.
* Mac OS X should be supplied one 128x128 icon.
*
* The icon is used for the settings window, and the LWJGL render window.
* Note that a bug in Java 6 (bug ID 6445278, currently hidden but available in Google cache) currently prevents
* the icon working for alt-tab on the settings dialog in Windows.
*
* @param value An array of BufferedImages to use as icons.
* (Default: not set)
*/
public void setIcons(Object[] value) {
put("Icons", value);
}
/**
* Sets the path of the settings dialog image to use.
*
* The image will be displayed in the settings dialog when the
* application is started.
*
* (Default: /com/jme3/app/Monkey.png)
*
* @param path The path to the image in the classpath.
*/
public void setSettingsDialogImage(String path) {
putString("SettingsDialogImage", path);
}
/**
* Enable or disable gamma correction. If enabled, the main framebuffer will
* be configured for sRGB colors, and sRGB images will be linearized.
*
* Gamma correction requires a GPU that supports GL_ARB_framebuffer_sRGB;
* otherwise this setting will be ignored.
*
* @param gammaCorrection true to enable, false to disable (Default : true)
*/
public void setGammaCorrection(boolean gammaCorrection) {
putBoolean("GammaCorrection", gammaCorrection);
}
/**
* Get the framerate.
*
* @return the maximum rate (in frames per second), or -1 for unlimited
* @see #setFrameRate(int)
*/
public int getFrameRate() {
return getInteger("FrameRate");
}
/**
* Get the use input state.
*
* @return true if input is enabled, false if it's disabled
* @see #setUseInput(boolean)
*/
public boolean useInput() {
return getBoolean("UseInput");
}
/**
* Get the renderer
*
* @return the graphics renderer's name and version,
* for example "LWJGL-OpenGL33"
* @see #setRenderer(java.lang.String)
*/
public String getRenderer() {
return getString("Renderer");
}
/**
* Get the width
*
* @return the width of the rendering display (in pixels)
* @see #setWidth(int)
*/
public int getWidth() {
return getInteger("Width");
}
/**
* Get the height
*
* @return the height of the rendering display (in pixels)
* @see #setHeight(int)
*/
public int getHeight() {
return getInteger("Height");
}
/**
* Get the width
*
* @return the minimum width for the rendering display (in pixels)
* @see #setWidth(int)
*/
public int getMinWidth() {
return getInteger("MinWidth");
}
/**
* Get the height
*
* @return the minimum height for the rendering display (in pixels)
* @see #setHeight(int)
*/
public int getMinHeight() {
return getInteger("MinHeight");
}
/**
* Get the bits per pixel
*
* @return the number of color bits per rendered pixel
* @see #setBitsPerPixel(int)
*/
public int getBitsPerPixel() {
return getInteger("BitsPerPixel");
}
/**
* Get the frequency
*
* @return the refresh rate of the (full-screen) display (in Hertz)
* @see #setFrequency(int)
*/
public int getFrequency() {
return getInteger("Frequency");
}
/**
* Get the number of depth bits
*
* @return the number of depth bits per rendered pixel
* @see #setDepthBits(int)
*/
public int getDepthBits() {
return getInteger("DepthBits");
}
/**
* Android Only
* Get the number of alpha bits for the surface view to use.
*
* @return the number of alpha bits per rendered pixel
* @see #setAlphaBits(int)
*/
public int getAlphaBits() {
return getInteger("AlphaBits");
}
/**
* Get the number of stencil bits
*
* @return the number of stencil bits per rendered pixel
* @see #setStencilBits(int)
*/
public int getStencilBits() {
return getInteger("StencilBits");
}
/**
* Get the number of samples
*
* @return the number of samples per pixel (for multisample anti-aliasing)
* @see #setSamples(int)
*/
public int getSamples() {
return getInteger("Samples");
}
/**
* Get the application title
*
* @return the title text
* @see #setTitle(java.lang.String)
*/
public String getTitle() {
return getString("Title");
}
/**
* Test whether vertical synchronization should be enabled.
*
* @return true for enabled, false for disabled
* @see #setVSync(boolean)
*/
public boolean isVSync() {
return getBoolean("VSync");
}
/**
* Get the fullscreen state
*
* @return true for fullscreen display, false for windowed display
* @see #setFullscreen(boolean)
*/
public boolean isFullscreen() {
return getBoolean("Fullscreen");
}
/**
* Get the use joysticks state
*
* @return true to enable joystick input, false to disable it
* @see #setUseJoysticks(boolean)
*/
public boolean useJoysticks() {
return !getBoolean("DisableJoysticks");
}
/**
* Get the audio renderer
*
* @return the audio renderer's name, for example "LWJGL"
* @see #setAudioRenderer(java.lang.String)
*/
public String getAudioRenderer() {
return getString("AudioRenderer");
}
/**
* Get the stereo 3D state
*
* @return true if 3-D stereo is enabled, otherwise false
* @see #setStereo3D(boolean)
*/
public boolean useStereo3D(){
return getBoolean("Stereo3D");
}
/**
* Get the icon array
*
* @return the pre-existing array
* @see #setIcons(java.lang.Object[])
*/
public Object[] getIcons() {
return (Object[]) get("Icons");
}
/**
* Get the settings dialog image
*
* @return a path to the image asset
* @see #setSettingsDialogImage(java.lang.String)
*/
public String getSettingsDialogImage() {
return getString("SettingsDialogImage");
}
/**
* Test whether gamma correction should be enabled.
*
* @return true for enabled, false for disabled
*/
public boolean isGammaCorrection() {
return getBoolean("GammaCorrection");
}
/**
* Allows the display window to be resized by dragging its edges.
*
* Only supported for {@link JmeContext.Type#Display} contexts which
* are in windowed mode, ignored for other types.
* The default value is false.
*
* @param resizable True to make a resizable window, false to make a fixed
* size window.
*/
public void setResizable(boolean resizable) {
putBoolean("Resizable", resizable);
}
/**
* Determine if the display window can be resized by dragging its edges.
*
* @return True if the window is resizable, false if it is fixed size.
*
* @see #setResizable(boolean)
*/
public boolean isResizable() {
return getBoolean("Resizable");
}
/**
* When enabled the display context will swap buffers every frame.
*
* This may need to be disabled when integrating with an external
* library that handles buffer swapping on its own, e.g. Oculus Rift.
* When disabled, the engine will process window messages
* after each frame, but it will not swap buffers. Note that this
* will cause 100% CPU usage normally as there's no VSync or any framerate
* caps (unless set via {@link #setFrameRate(int) }).
* The default is true.
*
* @param swapBuffers True to enable buffer swapping, false to disable it.
*/
public void setSwapBuffers(boolean swapBuffers) {
putBoolean("SwapBuffers", swapBuffers);
}
/**
* Determine if the display context will swap buffers every frame.
*
* @return True if buffer swapping is enabled, false otherwise.
*
* @see #setSwapBuffers(boolean)
*/
public boolean isSwapBuffers() {
return getBoolean("SwapBuffers");
}
/**
* True to enable the creation of an OpenCL context.
*
* @param support whether to create the context or not
*/
public void setOpenCLSupport(boolean support) {
putBoolean("OpenCL", support);
}
public boolean isOpenCLSupport() {
return getBoolean("OpenCL");
}
/**
* Sets a custom platform chooser. This chooser specifies which platform and
* which devices are used for the OpenCL context.
*
* Default: an implementation defined one.
*
* @param chooser the class of the chooser, must have a default constructor
*/
public void setOpenCLPlatformChooser(Class chooser) {
putString("OpenCLPlatformChooser", chooser.getName());
}
public String getOpenCLPlatformChooser() {
return getString("OpenCLPlatformChooser");
}
/**
* Determine if the renderer will be run in Graphics Debug mode, which means every openGL call is checked and
* if it returns an error code, throw a {@link com.jme3.renderer.RendererException}.
* Without this, many openGL calls might fail without notice, so turning it on is recommended for development.
*
* @return whether the context will be run in Graphics Debug Mode or not
* @see #setGraphicsDebug(boolean)
*/
public boolean isGraphicsDebug() {
return getBoolean("GraphicsDebug");
}
/**
* Set whether the renderer will be run in Graphics Debug mode, which means every openGL call is checked and
* if it returns an error code, throw a {@link com.jme3.renderer.RendererException}.
* Without this, many openGL calls might fail without notice, so turning it on is recommended for development.
*
* @param debug whether the context will be run in Graphics Debug Mode or not
* @see #isGraphicsDebug()
*/
public void setGraphicsDebug(boolean debug) {
putBoolean("GraphicsDebug", debug);
}
/**
* Determine if the renderer will be run in Graphics Timing mode, which means every openGL call is checked and
* if it runs for longer than a millisecond, log it.
* It also keeps track of the time spent in GL Calls in general and displays them when
* {@link com.jme3.renderer.opengl.GL#resetStats()} is called.
*
* @return whether the context will be run in Graphics Timing Mode or not
* @see #setGraphicsTiming(boolean)
* @see com.jme3.renderer.opengl.GLTiming
*/
public boolean isGraphicsTiming() {
return getBoolean("GraphicsTiming");
}
/**
* Set whether the renderer will be run in Graphics Timing mode, which means every openGL call is checked and
* if it runs for longer than a millisecond, log it.
* It also keeps track of the time spent in GL Calls in general and displays them when
* {@link com.jme3.renderer.opengl.GL#resetStats()} is called.
*
* @param timing whether the context will be run in Graphics Timing Mode or not
* @see #isGraphicsTiming()
* @see com.jme3.renderer.opengl.GLTiming
*/
public void setGraphicsTiming(boolean timing) {
putBoolean("GraphicsTiming", timing);
}
/**
* Determine if the renderer will be run in Graphics Trace mode, which means every openGL call is logged so one
* can trace what openGL commands where executed in which order by the engine.
*
* @return whether the context will be run in Graphics Trace Mode or not
* @see #setGraphicsTrace(boolean)
* @see com.jme3.renderer.opengl.GLTracer
*/
public boolean isGraphicsTrace() {
return getBoolean("GraphicsTrace");
}
/**
* Set whether the renderer will be run in Graphics Trace mode, which means every openGL call is logged so one
* can trace what openGL commands where executed in which order by the engine.
*
* @param trace whether the context will be run in Graphics Trace Mode or not
* @see #isGraphicsTrace()
* @see com.jme3.renderer.opengl.GLTracer
*/
public void setGraphicsTrace(boolean trace) {
putBoolean("GraphicsTrace", trace);
}
/**
* Determine whether to use full resolution framebuffers on Retina displays.
*
* @return whether to use full resolution framebuffers on Retina displays.
*/
public boolean isUseRetinaFrameBuffer() {
return getBoolean("UseRetinaFrameBuffer");
}
/**
* Specifies whether to use full resolution framebuffers on Retina displays. This is ignored on other platforms.
*
* @param useRetinaFrameBuffer whether to use full resolution framebuffers on Retina displays.
*/
public void setUseRetinaFrameBuffer(boolean useRetinaFrameBuffer) {
putBoolean("UseRetinaFrameBuffer", useRetinaFrameBuffer);
}
/**
* Tests the state of the Center Window flag.
*
* The Center Window flag is used only with LWJGL3 and has no effect on
* fullscreen windows.
*
* @return true to center the window on the desktop, false to position the
* window at (WindowXPosition, WindowYPosition)
* @see #setCenterWindow(boolean)
*/
public boolean getCenterWindow() {
return getBoolean("CenterWindow");
}
/**
* Enables or disables the Center Window flag.
*
*
The Center Window flag is used only with LWJGL3 and has no effect on
* fullscreen windows. It defaults to true.
*
* @param center true to center the window on the desktop, false to position
* the window at (WindowXPosition, WindowYPosition)
*/
public void setCenterWindow(boolean center) {
putBoolean("CenterWindow", center);
}
/**
* Gets the window's initial X position on the desktop.
*
*
This setting is used only with LWJGL3, has no effect on fullscreen
* windows, and is ignored if the Center Window flag is true.
*
* @return the initial position of the window's left edge relative to the
* left edge of the desktop
* @see #setCenterWindow(boolean)
* @see #setWindowXPosition(int)
*/
public int getWindowXPosition() {
return getInteger("WindowXPosition");
}
/**
* Sets the window's initial X position on the desktop.
*
*
This setting is used only with LWJGL3, has no effect on fullscreen
* windows, and is ignored if the Center Window flag is true. Its default
* value is 0.
*
* @param pos the desired initial position of the window's left edge
* relative to the left edge of the desktop
* @see #setCenterWindow(boolean)
*/
public void setWindowXPosition(int pos) {
putInteger("WindowXPosition", pos);
}
/**
* Gets the window's initial Y position on the desktop.
*
*
This setting is used only with LWJGL3, has no effect on fullscreen
* windows, and is ignored if the Center Window flag is true.
*
* @return the initial position of the window's upper edge relative to the
* upper edge of the desktop
* @see #setCenterWindow(boolean)
* @see #setWindowYPosition(int)
*/
public int getWindowYPosition() {
return getInteger("WindowYPosition");
}
/**
* Sets the window's initial Y position on the desktop.
*
*
This setting is used only with LWJGL3, has no effect on fullscreen
* windows, and is ignored if the Center Window flag is true. Its default
* value is 0.
*
* @param pos the desired initial position of the window's upper edge
* relative to the upper edge of the desktop
* @see #setCenterWindow(boolean)
*/
public void setWindowYPosition(int pos) {
putInteger("WindowYPosition", pos);
}
}