LwjglApplicationConfiguration (libgdx API)

java.lang.Object
- com.badlogic.gdx.backends.lwjgl.LwjglApplicationConfiguration

public class LwjglApplicationConfiguration
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class LwjglApplicationConfiguration.LwjglApplicationConfigurationDisplayMode

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`LwjglApplicationConfiguration.LwjglApplicationConfigurationDisplayMode`

Field Summary

Fields
Modifier and Type	Field and Description
`int`	`a` number of bits per color channel
`boolean`	`allowSoftwareMode` Allows software OpenGL rendering if hardware acceleration was not available.
`int`	`audioDeviceBufferCount` the audio device buffer count
`int`	`audioDeviceBufferSize` the audio device buffer size in samples
`int`	`audioDeviceSimultaneousSources` the maximum number of sources that can be played simultaneously
`int`	`b` number of bits per color channel
`int`	`backgroundFPS` Target framerate when the window is not in the foreground.
`int`	`depth` number of bits for depth and stencil buffer
`static boolean`	`disableAudio` If true, OpenAL will not be used.
`boolean`	`forceExit` whether to call System.exit() on tear-down.
`int`	`foregroundFPS` Target framerate when the window is in the foreground.
`boolean`	`fullscreen` fullscreen
`int`	`g` number of bits per color channel
`int`	`gles30ContextMajorVersion` The OpenGL context major version (the part in front of the decimal point) used to emulate OpenGL ES 3.0, when the version is not supported it will fall back to OpenGL ES 2.0 emulation.
`int`	`gles30ContextMinorVersion` The OpenGL context major version (the part after the decimal point) used to emulate OpenGL ES 3.0, when the version is not supported it will fall back to OpenGL ES 2.0 emulation.
`int`	`height` width & height of application window
`Color`	`initialBackgroundColor`
`int`	`maxNetThreads` The maximum number of threads to use for network requests.
`int`	`overrideDensity` used to emulate screen densities
`boolean`	`pauseWhenBackground` `LifecycleListener.pause()` (but continue rendering) when the window is not minimized and not the foreground window.
`boolean`	`pauseWhenMinimized` `LifecycleListener.pause()` and don't render when the window is minimized.
`java.lang.String`	`preferencesDirectory` Preferences directory on the desktop.
`Files.FileType`	`preferencesFileType` Preferences file type on the desktop.
`int`	`r` number of bits per color channel
`boolean`	`resizable` whether the window is resizable
`int`	`samples` number of samples for MSAA
`LwjglGraphics.SetDisplayModeCallback`	`setDisplayModeCallback` Callback used when trying to create a display, can handle failures, default value is null (disabled)
`int`	`stencil` number of bits for depth and stencil buffer
`java.lang.String`	`title` title of application
`boolean`	`undecorated` whether the window is undecorated
`boolean`	`useGL30` whether to attempt use OpenGL ES 3.0.
`boolean`	`useHDPI` enable HDPI mode on Mac OS X
`boolean`	`vSyncEnabled` whether to enable vsync, can be changed at runtime via `Graphics.setVSync(boolean)`
`int`	`width` width & height of application window
`int`	`x` x & y of application window, -1 for center
`int`	`y` x & y of application window, -1 for center

Constructor Summary

Constructors
Constructor and Description

LwjglApplicationConfiguration()

Constructors
Constructor and Description
`LwjglApplicationConfiguration()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addIcon(java.lang.String path, Files.FileType fileType)` Adds a window icon.
`static Graphics.DisplayMode`	`getDesktopDisplayMode()`
`static Graphics.DisplayMode[]`	`getDisplayModes()`
`void`	`setFromDisplayMode(Graphics.DisplayMode mode)` Sets the r, g, b and a bits per channel based on the given `Graphics.DisplayMode` and sets the fullscreen flag to true.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - disableAudio
```
public static boolean disableAudio
```
    If true, OpenAL will not be used. This means Application.getAudio() returns null and the gdx-openal.jar and OpenAL natives are not needed.
  - maxNetThreads
```
public int maxNetThreads
```
    The maximum number of threads to use for network requests. Default is Integer.MAX_VALUE.
  - useGL30
```
public boolean useGL30
```
    whether to attempt use OpenGL ES 3.0.
  - gles30ContextMajorVersion
```
public int gles30ContextMajorVersion
```
    The OpenGL context major version (the part in front of the decimal point) used to emulate OpenGL ES 3.0, when the version is not supported it will fall back to OpenGL ES 2.0 emulation. Defaults to 3.2 (major=3, minor=2). Only used when useGL30 is true. OpenGL is fully compatible with OpenGL ES 3.0 since version 4.3, setting the context version to a lower value might cause some features not to function properly. OSX requires 3.2 though.
    
    See Also:
    
    LWJGL OSX ContextAttribs note
  - gles30ContextMinorVersion
```
public int gles30ContextMinorVersion
```
    The OpenGL context major version (the part after the decimal point) used to emulate OpenGL ES 3.0, when the version is not supported it will fall back to OpenGL ES 2.0 emulation. Defaults to 3.2 (major=3, minor=2). Only used when useGL30 is true. OpenGL is fully compatible with OpenGL ES 3.0 since version 4.3, setting the context version to a lower value might cause some features not to function properly. OSX requires 3.2 though.
    
    See Also:
    
    LWJGL OSX ContextAttribs note
  - r
```
public int r
```
    number of bits per color channel
  - g
```
public int g
```
    number of bits per color channel
  - b
```
public int b
```
    number of bits per color channel
  - a
```
public int a
```
    number of bits per color channel
  - depth
```
public int depth
```
    number of bits for depth and stencil buffer
  - stencil
```
public int stencil
```
    number of bits for depth and stencil buffer
  - samples
```
public int samples
```
    number of samples for MSAA
  - width
```
public int width
```
    width & height of application window
  - height
```
public int height
```
    width & height of application window
  - x
```
public int x
```
    x & y of application window, -1 for center
  - y
```
public int y
```
    x & y of application window, -1 for center
  - fullscreen
```
public boolean fullscreen
```
    fullscreen
  - overrideDensity
```
public int overrideDensity
```
    used to emulate screen densities
  - vSyncEnabled
```
public boolean vSyncEnabled
```
    whether to enable vsync, can be changed at runtime via Graphics.setVSync(boolean)
  - title
```
public java.lang.String title
```
    title of application
  - forceExit
```
public boolean forceExit
```
    whether to call System.exit() on tear-down. Needed for Webstarts on some versions of Mac OS X it seems
  - resizable
```
public boolean resizable
```
    whether the window is resizable
  - undecorated
```
public boolean undecorated
```
    whether the window is undecorated
  - audioDeviceSimultaneousSources
```
public int audioDeviceSimultaneousSources
```
    the maximum number of sources that can be played simultaneously
  - audioDeviceBufferSize
```
public int audioDeviceBufferSize
```
    the audio device buffer size in samples
  - audioDeviceBufferCount
```
public int audioDeviceBufferCount
```
    the audio device buffer count
  - initialBackgroundColor
```
public Color initialBackgroundColor
```
  - foregroundFPS
```
public int foregroundFPS
```
    Target framerate when the window is in the foreground. The CPU sleeps as needed. Use 0 to never sleep.
  - backgroundFPS
```
public int backgroundFPS
```
    Target framerate when the window is not in the foreground. The CPU sleeps as needed. Use 0 to never sleep, -1 to not render.
  - pauseWhenMinimized
```
public boolean pauseWhenMinimized
```
    LifecycleListener.pause() and don't render when the window is minimized.
  - pauseWhenBackground
```
public boolean pauseWhenBackground
```
    LifecycleListener.pause() (but continue rendering) when the window is not minimized and not the foreground window. To stop rendering when not the foreground window, use backgroundFPS -1.
  - allowSoftwareMode
```
public boolean allowSoftwareMode
```
    Allows software OpenGL rendering if hardware acceleration was not available.
    
    See Also:
    
    LwjglGraphics#isSoftwareMode()
  - preferencesDirectory
```
public java.lang.String preferencesDirectory
```
    Preferences directory on the desktop. Default is ".prefs/".
  - preferencesFileType
```
public Files.FileType preferencesFileType
```
    Preferences file type on the desktop. Default is FileType.External
  - setDisplayModeCallback
```
public LwjglGraphics.SetDisplayModeCallback setDisplayModeCallback
```
    Callback used when trying to create a display, can handle failures, default value is null (disabled)
  - useHDPI
```
public boolean useHDPI
```
    enable HDPI mode on Mac OS X
- Constructor Detail
  - LwjglApplicationConfiguration
```
public LwjglApplicationConfiguration()
```
- Method Detail
  - addIcon
```
public void addIcon(java.lang.String path,
                    Files.FileType fileType)
```
    Adds a window icon. Icons are tried in the order added, the first one that works is used. Typically three icons should be provided: 128x128 (for Mac), 32x32 (for Windows and Linux), and 16x16 (for Windows).
  - setFromDisplayMode
```
public void setFromDisplayMode(Graphics.DisplayMode mode)
```
    Sets the r, g, b and a bits per channel based on the given Graphics.DisplayMode and sets the fullscreen flag to true.
    
    Parameters:
    
    mode -
  - getDesktopDisplayMode
```
public static Graphics.DisplayMode getDesktopDisplayMode()
```
  - getDisplayModes
```
public static Graphics.DisplayMode[] getDisplayModes()
```

Class LwjglApplicationConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

disableAudio

maxNetThreads

useGL30

gles30ContextMajorVersion

gles30ContextMinorVersion

r

g

b

a

depth

stencil

samples

width

height

x

y

fullscreen

overrideDensity

vSyncEnabled

title

forceExit

resizable

undecorated

audioDeviceSimultaneousSources

audioDeviceBufferSize

audioDeviceBufferCount

initialBackgroundColor

foregroundFPS

backgroundFPS

pauseWhenMinimized

pauseWhenBackground

allowSoftwareMode

preferencesDirectory

preferencesFileType

setDisplayModeCallback

useHDPI

Constructor Detail

LwjglApplicationConfiguration

Method Detail

addIcon

setFromDisplayMode

getDesktopDisplayMode

getDisplayModes