All Implemented Interfaces:
```
public final class Settings

                    
```
Settings for PolyUI.
This contains many values that concern the rendering and event handling of PolyUI internally.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`Settings.ResourcePolicy`	How to handle resource (image and font) loading errors.

Field Summary

Fields
Modifier and Type	Field	Description
`private <Error class: unknown class>`	`debug`
`private Boolean`	`enableDebugKeybind`
`private Integer`	`maxFPS`
`private Integer`	`unfocusedFPS`
`private Boolean`	`enableVSync`
`private String`	`defaultLocale`
`private Settings.ResourcePolicy`	`resourcePolicy`
`private Boolean`	`isMasterFrameBuffer`
`private Integer`	`minDrawablesForFramebuffer`
`private Boolean`	`framebuffersEnabled`
`private Boolean`	`renderPausingEnabled`
`private Long`	`comboMaxInterval`
`private Integer`	`maxComboSize`
`private Boolean`	`clearComboWhenMaxed`
`private Float`	`dragThreshold`
`private Vec2`	`scrollMultiplier`
`private Boolean`	`naturalScrolling`
`private Vec2`	`minimumSize`
`private Vec2`	`maximumSize`
`private Vec2`	`aspectRatio`
`private Boolean`	`cleanupAfterInit`
`private Boolean`	`cleanupOnShutdown`
`private Boolean`	`loadTranslationsOnInit`
`private Boolean`	`forceSetsInitialSize`

Constructor Summary

Constructors
Constructor	Description
`Settings()`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final <Error class: unknown class>`	`isDebugMode()`	this enables the debug renderer and various other debug features, including more verbose checks and logging.
`final Unit`	`)>enableDebugMode(<Error class: unknown class> debug)`	this enables the debug renderer and various other debug features, including more verbose checks and logging.
`final Boolean`	`hasDebugKeybind()`	enable the debug keybind in the window (Ctrl+Shift+I)
`final Unit`	`enableDebugKeybind(Boolean enableDebugKeybind)`	enable the debug keybind in the window (Ctrl+Shift+I)
`final Integer`	`getMaxFPS()`	set this to something other than 0 to set a framerate cap for the UI.
`final Unit`	`setMaxFPS(Integer maxFPS)`	set this to something other than 0 to set a framerate cap for the UI.
`final Integer`	`getUnfocusedFPS()`	set this to something other than 0 to change the framerate from the current maxFPS to this value when it is unfocused.
`final Unit`	`setUnfocusedFPS(Integer unfocusedFPS)`	set this to something other than 0 to change the framerate from the current maxFPS to this value when it is unfocused.
`final Boolean`	`isVSyncEnabled()`
`final Unit`	`enableVSync(Boolean enableVSync)`
`final String`	`getDefaultLocale()`
`final Unit`	`setDefaultLocale(String defaultLocale)`
`final Settings.ResourcePolicy`	`getResourcePolicy()`	How to handle resource (image and font) loading errors.
`final Unit`	`setResourcePolicy(Settings.ResourcePolicy resourcePolicy)`	How to handle resource (image and font) loading errors.
`final Boolean`	`isMasterFrameBuffer()`	If true, the renderer will render all layout and component to a 'master' framebuffer, then every frame, render that.
`final Unit`	`setMasterFrameBuffer(@ApiStatus.Experimental() Boolean isMasterFrameBuffer)`	If true, the renderer will render all layout and component to a 'master' framebuffer, then every frame, render that.
`final Integer`	`getMinDrawablesForFramebuffer()`	minimum number of drawables in a group before it will use a framebuffer.
`final Unit`	`setMinDrawablesForFramebuffer(@ApiStatus.Experimental() Integer minDrawablesForFramebuffer)`	minimum number of drawables in a group before it will use a framebuffer.
`final Boolean`	`framebuffersEnabled()`	Enable or disable framebuffers.
`final Unit`	`enableFramebuffers(@ApiStatus.Experimental() Boolean framebuffersEnabled)`	Enable or disable framebuffers.
`final Boolean`	`isRenderPausingEnabled()`	This optimization enables "render pausing", or allowing the renderer to pause rendering when there are no changes to the UI.
`final Unit`	`enableRenderPausing(Boolean renderPausingEnabled)`	This optimization enables "render pausing", or allowing the renderer to pause rendering when there are no changes to the UI.
`final Long`	`getComboMaxInterval()`	the time between clicks for them to be considered as a combo.
`final Unit`	`setComboMaxInterval(Long comboMaxInterval)`	the time between clicks for them to be considered as a combo.
`final Integer`	`getMaxComboSize()`	maximum amount of clicks that can be combo-ed in any interval
`final Unit`	`setMaxComboSize(Integer maxComboSize)`	maximum amount of clicks that can be combo-ed in any interval
`final Boolean`	`enableComboClearing()`	if true, the combo will be cleared when it reaches maxComboSize.
`final Unit`	`shouldClearComboWhenMaxed(Boolean clearComboWhenMaxed)`	if true, the combo will be cleared when it reaches maxComboSize.
`final Float`	`getDragThreshold()`	The threshold for a drag to be considered a 'drag', meaning the drag event will begin to be dispatched, in pixels.
`final Unit`	`setDragThreshold(Float dragThreshold)`	The threshold for a drag to be considered a 'drag', meaning the drag event will begin to be dispatched, in pixels.
`final Vec2`	`getScrollMultiplier()`	Scroll multiplier factor, which will multiply the returned value of the callback by this value.
`final Unit`	`setScrollMultiplier(Vec2 scrollMultiplier)`	Scroll multiplier factor, which will multiply the returned value of the callback by this value.
`final Boolean`	`isNaturalScrolling()`	Weather to invert the scroll direction
`final Unit`	`enableNaturalScrolling(Boolean naturalScrolling)`	Weather to invert the scroll direction
`final Vec2`	`getMinimumSize()`	Set the minimum renderer size (width by height) that this instance can be resized to.
`final Unit`	`setMinimumSize(Vec2 minimumSize)`	Set the minimum renderer size (width by height) that this instance can be resized to.
`final Vec2`	`getMaximumSize()`	Set the maximum renderer size (width by height) that this instance can be resized to.
`final Unit`	`setMaximumSize(Vec2 maximumSize)`	Set the maximum renderer size (width by height) that this instance can be resized to.
`final Vec2`	`getAspectRatio()`	Set the renderer aspect ratio, with the ratio being width:height, e.g.
`final Unit`	`setAspectRatio(Vec2 aspectRatio)`	Set the renderer aspect ratio, with the ratio being width:height, e.g.
`final Boolean`	`willCleanupAfterInit()`	This property will explicitly clean up after the initialization of PolyUI, calling the garbage collector to free up temporary objects created during initialization.
`final Unit`	`enableInitCleanup(Boolean cleanupAfterInit)`	This property will explicitly clean up after the initialization of PolyUI, calling the garbage collector to free up temporary objects created during initialization.
`final Boolean`	`willCleanupOnShutdown()`	This property will run the cleanup() method in a shutdown hook which will free memory used by PolyUI.
`final Unit`	`enableShutdownCleanup(Boolean cleanupOnShutdown)`	This property will run the cleanup() method in a shutdown hook which will free memory used by PolyUI.
`final Boolean`	`shouldLoadTranslationsOnInit()`	Set this to true to enable loading of translation keys upon startup, instead of the default behaviour of loading them when they are first used.
`final Unit`	`enableTranslationLoadingOnInit(Boolean loadTranslationsOnInit)`	Set this to true to enable loading of translation keys upon startup, instead of the default behaviour of loading them when they are first used.
`final Boolean`	`forceSetsInitialSize()`	This property will mean that, if `force` is true in the `resize` method, the initial size will be set to the size given.
`final Unit`	`enableForceSettingInitialSize(Boolean forceSetsInitialSize)`	This property will mean that, if `force` is true in the `resize` method, the initial size will be set to the size given.

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

- Constructor Detail
  - Settings
```
Settings()
```
- Method Detail
  - isDebugMode
```
 final <Error class: unknown class> isDebugMode()
```
    this enables the debug renderer and various other debug features, including more verbose checks and logging.
    It can be enabled using -Dpolyui.debug=true in the JVM arguments, or by pressing Ctrl+Shift+I in the application if enabled.
  - enableDebugMode
```
 final Unit )>enableDebugMode(<Error class: unknown class> debug)
```
    this enables the debug renderer and various other debug features, including more verbose checks and logging.
    It can be enabled using -Dpolyui.debug=true in the JVM arguments, or by pressing Ctrl+Shift+I in the application if enabled.
  - hasDebugKeybind
```
 final Boolean hasDebugKeybind()
```
    enable the debug keybind in the window (Ctrl+Shift+I)
  - enableDebugKeybind
```
 final Unit enableDebugKeybind(Boolean enableDebugKeybind)
```
    enable the debug keybind in the window (Ctrl+Shift+I)
  - getMaxFPS
```
 final Integer getMaxFPS()
```
    set this to something other than 0 to set a framerate cap for the UI.
    Most implementations will only use this if vsync is disabled.
  - setMaxFPS
```
 final Unit setMaxFPS(Integer maxFPS)
```
    set this to something other than 0 to set a framerate cap for the UI.
    Most implementations will only use this if vsync is disabled.
  - getUnfocusedFPS
```
 final Integer getUnfocusedFPS()
```
    set this to something other than 0 to change the framerate from the current maxFPS to this value when it is unfocused.
  - setUnfocusedFPS
```
 final Unit setUnfocusedFPS(Integer unfocusedFPS)
```
    set this to something other than 0 to change the framerate from the current maxFPS to this value when it is unfocused.
  - isVSyncEnabled
```
 final Boolean isVSyncEnabled()
```
  - enableVSync
```
 final Unit enableVSync(Boolean enableVSync)
```
  - getDefaultLocale
```
 final String getDefaultLocale()
```
  - setDefaultLocale
```
 final Unit setDefaultLocale(String defaultLocale)
```
  - getResourcePolicy
```
 final Settings.ResourcePolicy getResourcePolicy()
```
    How to handle resource (image and font) loading errors.
  - setResourcePolicy
```
 final Unit setResourcePolicy(Settings.ResourcePolicy resourcePolicy)
```
    How to handle resource (image and font) loading errors.
  - isMasterFrameBuffer
```
 final Boolean isMasterFrameBuffer()
```
    If true, the renderer will render all layout and component to a 'master' framebuffer, then every frame, render that.
    
    Since:
    
    0.18.0
  - setMasterFrameBuffer
```
 final Unit setMasterFrameBuffer(@ApiStatus.Experimental() Boolean isMasterFrameBuffer)
```
    If true, the renderer will render all layout and component to a 'master' framebuffer, then every frame, render that.
    
    Since:
    
    0.18.0
  - getMinDrawablesForFramebuffer
```
 final Integer getMinDrawablesForFramebuffer()
```
    minimum number of drawables in a group before it will use a framebuffer.
    This value should be set to something relatively high, as the performance gain from using a framebuffer only works if there is a large amount of draw calls.
  - setMinDrawablesForFramebuffer
```
 final Unit setMinDrawablesForFramebuffer(@ApiStatus.Experimental() Integer minDrawablesForFramebuffer)
```
    minimum number of drawables in a group before it will use a framebuffer.
    This value should be set to something relatively high, as the performance gain from using a framebuffer only works if there is a large amount of draw calls.
  - framebuffersEnabled
```
 final Boolean framebuffersEnabled()
```
    Enable or disable framebuffers. Please note that PolyUI is designed to work with framebuffers, so disabling them may cause performance issues.
    
    Since:
    
    0.18.0
  - enableFramebuffers
```
 final Unit enableFramebuffers(@ApiStatus.Experimental() Boolean framebuffersEnabled)
```
    Enable or disable framebuffers. Please note that PolyUI is designed to work with framebuffers, so disabling them may cause performance issues.
    
    Since:
    
    0.18.0
  - isRenderPausingEnabled
```
 final Boolean isRenderPausingEnabled()
```
    This optimization enables "render pausing", or allowing the renderer to pause rendering when there are no changes to the UI.
    This requires a setup such as if (polyUI.drew) glfwSwapBuffers(handle) in your main loop.
    
    Since:
    
    0.12.0
  - enableRenderPausing
```
 final Unit enableRenderPausing(Boolean renderPausingEnabled)
```
    This optimization enables "render pausing", or allowing the renderer to pause rendering when there are no changes to the UI.
    This requires a setup such as if (polyUI.drew) glfwSwapBuffers(handle) in your main loop.
    
    Since:
    
    0.12.0
  - getComboMaxInterval
```
 final Long getComboMaxInterval()
```
    the time between clicks for them to be considered as a combo.
  - setComboMaxInterval
```
 final Unit setComboMaxInterval(Long comboMaxInterval)
```
    the time between clicks for them to be considered as a combo.
  - getMaxComboSize
```
 final Integer getMaxComboSize()
```
    maximum amount of clicks that can be combo-ed in any interval
  - setMaxComboSize
```
 final Unit setMaxComboSize(Integer maxComboSize)
```
    maximum amount of clicks that can be combo-ed in any interval
  - enableComboClearing
```
 final Boolean enableComboClearing()
```
    if true, the combo will be cleared when it reaches maxComboSize. Otherwise, it will just continue to dispatch the max event for future clicks if they are within the combo frame.
  - shouldClearComboWhenMaxed
```
 final Unit shouldClearComboWhenMaxed(Boolean clearComboWhenMaxed)
```
    if true, the combo will be cleared when it reaches maxComboSize. Otherwise, it will just continue to dispatch the max event for future clicks if they are within the combo frame.
  - getDragThreshold
```
 final Float getDragThreshold()
```
    The threshold for a drag to be considered a 'drag', meaning the drag event will begin to be dispatched, in pixels.
    
    Since:
    
    1.6.1
  - setDragThreshold
```
 final Unit setDragThreshold(Float dragThreshold)
```
    The threshold for a drag to be considered a 'drag', meaning the drag event will begin to be dispatched, in pixels.
    
    Since:
    
    1.6.1
  - getScrollMultiplier
```
 final Vec2 getScrollMultiplier()
```
    Scroll multiplier factor, which will multiply the returned value of the callback by this value. First value is the X scroll multiplier, with the second being the Y scroll multiplier.
  - setScrollMultiplier
```
 final Unit setScrollMultiplier(Vec2 scrollMultiplier)
```
    Scroll multiplier factor, which will multiply the returned value of the callback by this value. First value is the X scroll multiplier, with the second being the Y scroll multiplier.
  - isNaturalScrolling
```
 final Boolean isNaturalScrolling()
```
    Weather to invert the scroll direction
  - enableNaturalScrolling
```
 final Unit enableNaturalScrolling(Boolean naturalScrolling)
```
    Weather to invert the scroll direction
  - getMinimumSize
```
 final Vec2 getMinimumSize()
```
    Set the minimum renderer size (width by height) that this instance can be resized to.
    Set to -1 to disable an axis.
    
    Since:
    
    0.18.4
  - setMinimumSize
```
 final Unit setMinimumSize(Vec2 minimumSize)
```
    Set the minimum renderer size (width by height) that this instance can be resized to.
    Set to -1 to disable an axis.
    
    Since:
    
    0.18.4
  - getMaximumSize
```
 final Vec2 getMaximumSize()
```
    Set the maximum renderer size (width by height) that this instance can be resized to.
    Set to -1 to disable an axis.
    
    Since:
    
    0.18.4
  - setMaximumSize
```
 final Unit setMaximumSize(Vec2 maximumSize)
```
    Set the maximum renderer size (width by height) that this instance can be resized to.
    Set to -1 to disable an axis.
    
    Since:
    
    0.18.4
  - getAspectRatio
```
 final Vec2 getAspectRatio()
```
    Set the renderer aspect ratio, with the ratio being width:height, e.g. 16 to 9 = 16:9.
    While PolyUI will resize the content to this aspect ratio, if the renderer is not at this aspect ratio it may look odd (content smaller than the window). To prevent this, you must ensure that the window implementation is only allowing resizes to this aspect ratio.
    Set to -1 to disable, or 0 to infer it automatically. Any other value is the aspect ratio.
    
    Since:
    
    0.18.4
  - setAspectRatio
```
 final Unit setAspectRatio(Vec2 aspectRatio)
```
    Set the renderer aspect ratio, with the ratio being width:height, e.g. 16 to 9 = 16:9.
    While PolyUI will resize the content to this aspect ratio, if the renderer is not at this aspect ratio it may look odd (content smaller than the window). To prevent this, you must ensure that the window implementation is only allowing resizes to this aspect ratio.
    Set to -1 to disable, or 0 to infer it automatically. Any other value is the aspect ratio.
    
    Since:
    
    0.18.4
  - willCleanupAfterInit
```
 final Boolean willCleanupAfterInit()
```
    This property will explicitly clean up after the initialization of PolyUI, calling the garbage collector to free up temporary objects created during initialization.
    This option will usually halve or more the memory usage, but takes time (~10ms). It is recommended for memory limited scenarios and in production.
    
    Since:
    
    0.20.0
  - enableInitCleanup
```
 final Unit enableInitCleanup(Boolean cleanupAfterInit)
```
    This property will explicitly clean up after the initialization of PolyUI, calling the garbage collector to free up temporary objects created during initialization.
    This option will usually halve or more the memory usage, but takes time (~10ms). It is recommended for memory limited scenarios and in production.
    
    Since:
    
    0.20.0
  - willCleanupOnShutdown
```
 final Boolean willCleanupOnShutdown()
```
    This property will run the cleanup() method in a shutdown hook which will free memory used by PolyUI.
    
    Since:
    
    0.20.1
  - enableShutdownCleanup
```
 final Unit enableShutdownCleanup(Boolean cleanupOnShutdown)
```
    This property will run the cleanup() method in a shutdown hook which will free memory used by PolyUI.
    
    Since:
    
    0.20.1
  - shouldLoadTranslationsOnInit
```
 final Boolean shouldLoadTranslationsOnInit()
```
    Set this to true to enable loading of translation keys upon startup, instead of the default behaviour of loading them when they are first used.
    
    Since:
    
    0.21.1
  - enableTranslationLoadingOnInit
```
 final Unit enableTranslationLoadingOnInit(Boolean loadTranslationsOnInit)
```
    Set this to true to enable loading of translation keys upon startup, instead of the default behaviour of loading them when they are first used.
    
    Since:
    
    0.21.1
  - forceSetsInitialSize
```
 final Boolean forceSetsInitialSize()
```
    This property will mean that, if force is true in the resize method, the initial size will be set to the size given.
    
    Since:
    
    1.1.63
  - enableForceSettingInitialSize
```
 final Unit enableForceSettingInitialSize(Boolean forceSetsInitialSize)
```
    This property will mean that, if force is true in the resize method, the initial size will be set to the size given.
    
    Since:
    
    1.1.63

Class Settings

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Settings

Method Detail

isDebugMode

enableDebugMode

hasDebugKeybind

enableDebugKeybind

getMaxFPS

setMaxFPS

getUnfocusedFPS

setUnfocusedFPS

isVSyncEnabled

enableVSync

getDefaultLocale

setDefaultLocale

getResourcePolicy

setResourcePolicy

isMasterFrameBuffer

setMasterFrameBuffer

getMinDrawablesForFramebuffer

setMinDrawablesForFramebuffer

framebuffersEnabled

enableFramebuffers

isRenderPausingEnabled

enableRenderPausing

getComboMaxInterval

setComboMaxInterval

getMaxComboSize

setMaxComboSize

enableComboClearing

shouldClearComboWhenMaxed

getDragThreshold

setDragThreshold

getScrollMultiplier

setScrollMultiplier

isNaturalScrolling

enableNaturalScrolling

getMinimumSize

setMinimumSize

getMaximumSize

setMaximumSize

getAspectRatio

setAspectRatio

willCleanupAfterInit

enableInitCleanup

willCleanupOnShutdown

enableShutdownCleanup

shouldLoadTranslationsOnInit

enableTranslationLoadingOnInit

forceSetsInitialSize

enableForceSettingInitialSize