Package org.lwjgl.system

Class Configuration<T>

  • public class Configuration<T>
extends java.lang.Object
    This class can be used to programmatically set the LWJGL runtime configuration. It is an alternative to using system properties.

    Care must be taken when setting static options. Such options are only read once or cached in static final fields. They must be configured through this class before touching any other LWJGL class.

    • Field Detail

      • LIBRARY_PATH

        public static final Configuration<java.lang.String> LIBRARY_PATH
        Takes priority over java.library.path. It may contain one or more directory paths, separated by File.pathSeparator.

        Property: org.lwjgl.librarypath
           Usage: Dynamic

      • BUNDLED_LIBRARY_NAME_MAPPER

        public static final Configuration<java.lang.Object> BUNDLED_LIBRARY_NAME_MAPPER
        Sets the mapping algorithm used to resolve the name of bundled shared libraries. Supported values:
        • default - Maps <libname> to <libname>.
        • legacy - Maps <libname> to is64bit(arch) ? <libname> : <libname>32.
        • <classpath> - A class that implements the Function<String, String> interface. It will be instantiated using reflection.

        When set programmatically, it can also be a Function<String, String> instance.

        Property: org.lwjgl.system.bundledLibrary.nameMapper
            Type: String or a Function<String, String> instance
           Usage: Static

      • BUNDLED_LIBRARY_PATH_MAPPER

        public static final Configuration<java.lang.Object> BUNDLED_LIBRARY_PATH_MAPPER
        Sets the mapping algorithm used to resolve bundled shared libraries in the classpath/modulepath. Supported values:
        • default - Maps <libpath> to <arch>/<libpath>.
        • legacy - Maps <libpath> to <libpath>.
        • <classpath> - A class that implements the Function<String, String> interface. It will be instantiated using reflection.

        When set programmatically, it can also be a Function<String, String> instance.

        Property: org.lwjgl.system.bundledLibrary.nameMapper
            Type: String or a Function<String, String> instance
           Usage: Static

      • SHARED_LIBRARY_EXTRACT_DIRECTORY

        public static final Configuration<java.lang.String> SHARED_LIBRARY_EXTRACT_DIRECTORY
        Changes the temporary directory name created by LWJGL when extracting shared libraries from JAR files. If this option is not set, it defaults to lwjgl<user name>.

        Property: org.lwjgl.system.SharedLibraryExtractDirectory
           Usage: Dynamic

      • SHARED_LIBRARY_EXTRACT_PATH

        public static final Configuration<java.lang.String> SHARED_LIBRARY_EXTRACT_PATH
        Changes the path where LWJGL extracts shared libraries from JAR files. If this option is not set, LWJGL will try the following paths and the first successful will be used:
        • System.getProperty("java.io.tmpdir")/extractDir/version/
        • System.getProperty("user.home")/.extractDir/version/
        • .extractDir/version/
        • Files.createTempFile("lwjgl", "")
        where: 
        
 extractDir = Configuration.SHARED_LIBRARY_EXTRACT_DIRECTORY
 version = Version.getVersion().replace(' ', '-')

        Property: org.lwjgl.system.SharedLibraryExtractPath
           Usage: Dynamic

      • LIBRARY_NAME

        public static final Configuration<java.lang.String> LIBRARY_NAME
        Can be used to override the LWJGL library name. It can be an absolute path.

        Property: org.lwjgl.libname
           Usage: Dynamic

      • MEMORY_ALLOCATOR

        public static final Configuration<java.lang.Object> MEMORY_ALLOCATOR
        Sets the allocator used for the MemoryUtil explicit memory management API (memAlloc/memFree/etc). Supported values:
        • jemalloc - The allocator provided by the jemalloc library
        • rpmalloc - The allocator provided by the rpmalloc library.

          LWJGL calls rpmalloc_initialize once, when the allocator is created. It never calls rpmalloc_finalize. The user is responsible for calling rpmalloc_thread_initialize and rpmalloc_thread_finalize when appropriate.

        • system - The default system memory allocator
        • <classpath> - A class that implements the MemoryAllocator interface. It will be instantiated using reflection.

        When set programmatically, it can also be a MemoryAllocator instance.

        Property: org.lwjgl.system.allocator
            Type: String or a MemoryUtil.MemoryAllocator instance
           Usage: Static

      • STACK_SIZE

        public static final Configuration<java.lang.Integer> STACK_SIZE
        Sets the stack size, in kilobytes, that will be used in the default MemoryStack constructor. This value is also used for the LWJGL-managed, thread-local, MemoryStack instances.

        If this option is not set, it defaults to 64.

        Property: org.lwjgl.system.stackSize
           Usage: Static

      • ARRAY_TLC_SIZE

        public static final Configuration<java.lang.Integer> ARRAY_TLC_SIZE
        Sets the size of arrays cached in thread-local storage to minimize allocations while decoding text.

        The memory cost for the cache is up to two arrays per thread that does text decoding. When the text length is up to this value, a cached array will be used. When the text length is longer than this value, a new array buffer will be allocated.

        If this option is not set, it defaults to 8192. Setting the value to 0 will disable the array cache.

        Property: org.lwjgl.system.arrayTLCSize
           Usage: Static

      • DISABLE_CHECKS

        public static final Configuration<java.lang.Boolean> DISABLE_CHECKS
        Set to true to disable LWJGL's basic checks. These are trivial checks that LWJGL performs to avoid JVM crashes, very useful during development. Their performance impact is usually minimal, but they may be disabled for release builds.

        Property: org.lwjgl.util.NoChecks
           Usage: Static

      • DISABLE_FUNCTION_CHECKS

        public static final Configuration<java.lang.Boolean> DISABLE_FUNCTION_CHECKS
        Set to true to disable LWJGL's function lookup checks. These checks ensure that required functions are not missing from dynamically loaded shared libraries. This setting is useful when a trusted incompatible library must be loaded.

        Property: org.lwjgl.util.NoFunctionChecks
           Usage: Dynamic

      • DEBUG

        public static final Configuration<java.lang.Boolean> DEBUG
        Set to true to enable LWJGL's debug mode. Information messages will be printed to the APIUtil.DEBUG_STREAM and extra runtime checks will be performed (some potentially expensive, performance-wise).

        Property: org.lwjgl.util.Debug
           Usage: Static

      • DEBUG_LOADER

        public static final Configuration<java.lang.Boolean> DEBUG_LOADER
        When enabled, ShaderLibraryLoader exceptions will be printed to the DEBUG_STREAM.

        This option requires DEBUG to be enabled.

        Property: org.lwjgl.util.DebugLoader
           Usage: Static

      • DEBUG_STREAM

        public static final Configuration<java.lang.Object> DEBUG_STREAM
        Can be set to override the default APIUtil.DEBUG_STREAM. It must be the name of a class that implements the Supplier<PrintStream> interface. The class will be instantiated using reflection and the result of get will become the #DEBUG_STREAM used by LWJGL.

        When set programmatically, it can also be a PrintStream instance.

        Property: org.lwjgl.util.DebugStream
            Type: String or a PrintStream instance
           Usage: Static

      • DEBUG_MEMORY_ALLOCATOR

        public static final Configuration<java.lang.Boolean> DEBUG_MEMORY_ALLOCATOR
        Set to true to enable LWJGL's debug mode for the MemoryUtil explicit memory management API (memAlloc/memFree/etc). All memory allocations through that API will be tracked and leaks will be reported on JVM exit. The memReport methods can also be used.

        When this option is enabled, a stacktrace is generated on every allocation, which may negatively impact performance. If this becomes a serious issue, the JVM option -XX:MaxJavaStackTraceDepth=d (where d >= 6) can be used to reduce the overhead.

        Property: org.lwjgl.util.DebugAllocator
           Usage: Static

      • DEBUG_MEMORY_ALLOCATOR_INTERNAL

        public static final Configuration<java.lang.Boolean> DEBUG_MEMORY_ALLOCATOR_INTERNAL
        Set to false to disable tracking of internal memory allocations, in native shared libraries that have been set up to use the LWJGL memory allocator.

        If this option is not set, it defaults to true.

        Property: org.lwjgl.util.DebugAllocator.internal
           Usage: Static

      • DEBUG_STACK

        public static final Configuration<java.lang.Boolean> DEBUG_STACK
        Set to true to enable LWJGL's debug mode for the MemoryStack. When using the stack, each frame should be popped in the same method that pushed it. If this symmetry is broken, this mode will report it immediately.

        When this option is enabled, a stacktrace is generated on every push or pop to the stack, which may negatively impact performance. If this becomes a serious issue, the JVM option -XX:MaxJavaStackTraceDepth=d (where d >= 5) can be used to reduce the overhead.

        Property: org.lwjgl.util.DebugStack
           Usage: Static

      • DEBUG_FUNCTIONS

        public static final Configuration<java.lang.Boolean> DEBUG_FUNCTIONS
        When enabled, capabilities classes will print an error message when they fail to retrieve a function pointer.

        Function pointers in such classes are retrieved unconditionally, so this option may generate a lot of output and many false negatives.

        This option requires DEBUG to be enabled.

        Property: org.lwjgl.util.DebugFunctions
           Usage: Static

      • ASSIMP_LIBRARY_NAME

        public static final Configuration<java.lang.String> ASSIMP_LIBRARY_NAME
        Similar to LIBRARY_NAME for the AssImp library (org.lwjgl.assimp.libname).

      • BGFX_LIBRARY_NAME

        public static final Configuration<java.lang.String> BGFX_LIBRARY_NAME
        Similar to LIBRARY_NAME for the BGFX library (org.lwjgl.bgfx.libname).

      • CUDA_LIBRARY_NAME

        public static final Configuration<java.lang.String> CUDA_LIBRARY_NAME
        Similar to LIBRARY_NAME for the CUDA Driver library – nvcuda (org.lwjgl.cuda.libname).

      • CUDA_TOOLKIT_VERSION

        public static final Configuration<java.lang.String> CUDA_TOOLKIT_VERSION
        By default, when LWJGL detects multiple CUDA Toolkits, it will use the toolkit with the greatest version. This option can be used to force a specific CUDA Toolkit version.

        Property: org.lwjgl.cuda.toolkit.version
           Usage: Static

      • CUDA_TOOLKIT_PATH

        public static final Configuration<java.lang.String> CUDA_TOOLKIT_PATH
        By default, LWJGL will try to detect CUDA Toolkits in the default installation folder. This option can be used to load toolkit libraries from a non-standard installation folder.

        Property: org.lwjgl.cuda.toolkit.path
           Usage: Static

      • CUDA_NVRTC_LIBRARY_NAME

        public static final Configuration<java.lang.String> CUDA_NVRTC_LIBRARY_NAME
        Similar to LIBRARY_NAME for the CUDA NVRTC library (org.lwjgl.cuda.nvrtc.libname).

      • CUDA_NVRTC_BUILTINS_LIBRARY_NAME

        public static final Configuration<java.lang.String> CUDA_NVRTC_BUILTINS_LIBRARY_NAME
        Similar to LIBRARY_NAME for the CUDA NVRTC Builtins library (org.lwjgl.cuda.nvrtc-builtins.libname).

      • CUDA_API_PER_THREAD_DEFAULT_STREAM

        public static final Configuration<java.lang.Boolean> CUDA_API_PER_THREAD_DEFAULT_STREAM
        By default, CUDA uses the legacy default stream. To enable per-thread synchronization, set this option to true before initializing the CUDA driver.

        To check if the CUDA driver supports PTDS, call org.lwjgl.cuda.CUDA.isPerThreadDefaultStreamSupported()

        Property: org.lwjgl.cuda.ptds
           Usage: Static

      • EGL_EXPLICIT_INIT

        public static final Configuration<java.lang.Boolean> EGL_EXPLICIT_INIT
        By default, LWJGL will automatically initialize the EGL library, when it is first accessed. Set this property to disable this behavior.

        Property: org.lwjgl.egl.explicitInit
           Usage: Static

      • EGL_LIBRARY_NAME

        public static final Configuration<java.lang.String> EGL_LIBRARY_NAME
        Similar to LIBRARY_NAME for the EGL library (org.lwjgl.egl.libname).

      • GLFW_LIBRARY_NAME

        public static final Configuration<java.lang.String> GLFW_LIBRARY_NAME
        Similar to LIBRARY_NAME for the GLFW library (org.lwjgl.glfw.libname).

      • GLFW_CHECK_THREAD0

        public static final Configuration<java.lang.Boolean> GLFW_CHECK_THREAD0
        By default, LWJGL will check if certain GLFW functions are called on the first thread of the process and fail if that is not the case. Set this property to false to disable this behavior.

        Property: org.lwjgl.glfw.checkThread0
           Usage: Static

      • JAWT_LIBRARY_NAME

        public static final Configuration<java.lang.String> JAWT_LIBRARY_NAME
        Similar to LIBRARY_NAME for the jawt library (org.lwjgl.system.jawt.libname).

      • JEMALLOC_LIBRARY_NAME

        public static final Configuration<java.lang.String> JEMALLOC_LIBRARY_NAME
        Similar to LIBRARY_NAME for the jemalloc library (org.lwjgl.system.jemalloc.libname).

      • LLVM_LIBRARY_NAME

        public static final Configuration<java.lang.String> LLVM_LIBRARY_NAME
        Similar to LIBRARY_NAME for the LLVM library (org.lwjgl.llvm.libname).

      • LLVM_CLANG_LIBRARY_NAME

        public static final Configuration<java.lang.String> LLVM_CLANG_LIBRARY_NAME
        Similar to LIBRARY_NAME for the LLVM/Clang Library (org.lwjgl.llvm.clang.libname).

      • LLVM_LTO_LIBRARY_NAME

        public static final Configuration<java.lang.String> LLVM_LTO_LIBRARY_NAME
        Similar to LIBRARY_NAME for the LLVM/LTO library (org.lwjgl.llvm.clang.libname).

      • ODBC_LIBRARY_NAME

        public static final Configuration<java.lang.String> ODBC_LIBRARY_NAME
        Similar to LIBRARY_NAME for the ODBC library (org.lwjgl.odbc.libname).

      • OPENAL_EXPLICIT_INIT

        public static final Configuration<java.lang.Boolean> OPENAL_EXPLICIT_INIT
        Similar to EGL_EXPLICIT_INIT for the OpenAL library (org.lwjgl.openal.explicitInit).

      • OPENAL_LIBRARY_NAME

        public static final Configuration<java.lang.String> OPENAL_LIBRARY_NAME
        Similar to LIBRARY_NAME for the OpenAL library (org.lwjgl.openal.libname).

      • OPENCL_EXPLICIT_INIT

        public static final Configuration<java.lang.Boolean> OPENCL_EXPLICIT_INIT
        Similar to EGL_EXPLICIT_INIT for the OpenCL library (org.lwjgl.opencl.explicitInit).

      • OPENCL_LIBRARY_NAME

        public static final Configuration<java.lang.String> OPENCL_LIBRARY_NAME
        Similar to LIBRARY_NAME for the OpenCL library (org.lwjgl.opencl.libname).

      • OPENGL_EXPLICIT_INIT

        public static final Configuration<java.lang.Boolean> OPENGL_EXPLICIT_INIT
        Similar to EGL_EXPLICIT_INIT for the OpenGL library (org.lwjgl.opengl.explicitInit).

      • OPENGL_LIBRARY_NAME

        public static final Configuration<java.lang.String> OPENGL_LIBRARY_NAME
        Similar to LIBRARY_NAME for the OpenGL library (org.lwjgl.opengl.libname).

      • OPENGL_MAXVERSION

        public static final Configuration<java.lang.Object> OPENGL_MAXVERSION
        Can be used to limit the maximum available OpenGL version. This can be useful to ensure that an application has not accidentally used features only available in a higher OpenGL version.

        When set programmatically, it can also be an APIUtil.APIVersion instance.

        Property: org.lwjgl.opengl.maxVersion
            Type: String (M.n) or an APIUtil.APIVersion instance
           Usage: Static

      • OPENGLES_EXPLICIT_INIT

        public static final Configuration<java.lang.Boolean> OPENGLES_EXPLICIT_INIT
        Similar to EGL_EXPLICIT_INIT for the OpenGL ES library (org.lwjgl.opengles.explicitInit).

      • OPENGLES_LIBRARY_NAME

        public static final Configuration<java.lang.String> OPENGLES_LIBRARY_NAME
        Similar to LIBRARY_NAME for the OpenGL ES library (org.lwjgl.opengles.libname).

      • OPENGLES_MAXVERSION

        public static final Configuration<java.lang.Object> OPENGLES_MAXVERSION
        Similar to OPENGL_MAXVERSION for the OpenGL ES library (org.lwjgl.opengles.maxVersion).

      • OPENVR_LIBRARY_NAME

        public static final Configuration<java.lang.String> OPENVR_LIBRARY_NAME
        Similar to LIBRARY_NAME for the OpenVR library (org.lwjgl.openvr.libname).

      • OPUS_LIBRARY_NAME

        public static final Configuration<java.lang.String> OPUS_LIBRARY_NAME
        Similar to LIBRARY_NAME for the Opus library (org.lwjgl.opus.libname).

      • SHADERC_LIBRARY_NAME

        public static final Configuration<java.lang.String> SHADERC_LIBRARY_NAME
        Similar to LIBRARY_NAME for the Shaderc libshaderc library (org.lwjgl.shaderc.libname).

      • SHADERC_SPVC_LIBRARY_NAME

        public static final Configuration<java.lang.String> SHADERC_SPVC_LIBRARY_NAME
        Similar to LIBRARY_NAME for the Shaderc libshaderc_spvc library (org.lwjgl.shaderc_spvc.libname).

      • VULKAN_EXPLICIT_INIT

        public static final Configuration<java.lang.Boolean> VULKAN_EXPLICIT_INIT
        Similar to EGL_EXPLICIT_INIT for the Vulkan library (org.lwjgl.vulkan.explicitInit).

      • VULKAN_LIBRARY_NAME

        public static final Configuration<java.lang.String> VULKAN_LIBRARY_NAME
        Similar to LIBRARY_NAME for the Vulkan library (org.lwjgl.vulkan.libname).

    • Method Detail

      • getProperty

        public java.lang.String getProperty()

      • set

        public void set​(@Nullable
                T value)
        Sets the option value.
        Parameters:
        value - the value to set

      • get

        @Nullable
public T get()
        Returns the option value.

        If the option value has not been set, null will be returned.

      • get

        public T get​(T defaultValue)
        Returns the option value.

        If the option value has not been set, the specified default value will be returned.

        Parameters:
        defaultValue - the default value