LWJGL 3.3.3 · org.lwjgl.system

Contains implementation details and platform-specific functionality required to make LWJGL work. Unlike other packages, this package and its sub-packages make no guarantees of forward compatibility. Any public API contained here may change between releases and revisions.

In more detail, this package contains the following:

Functionality required for loading native shared libraries (the LWJGL JNI code, as well as 3rd-party libraries) and invoking native functions.
Functionality required for efficiently accessing and managing off-heap memory.
Platform and operating system specific API bindings.
The libffi bindings, used for implementing native function callbacks via Java code.
Miscellaneous bindings for advanced users, or bindings that are not proven to be generally useful yet.
Functionality used internally by API bindings. This functionality is unfortunately public, as it is shared by all bindings.

Even though this package is reserved for breaking changes, some of the above functionality may be very useful to advanced users. For this to be practical, the API of certain interfaces and classes will remain as stable as possible. This affects the following classes:

MemoryUtil, used for off-heap data access and memory allocation/deallocation.
MemoryStack, used for emulated off-heap stack allocations.
FunctionProvider, Library and SharedLibrary, used for loading shared libraries and accessing function pointers.
Pointer, used as off-heap resource abstractions.
Configuration, used for programmatic configuration at runtime.
Struct and StructBuffer, the base classes for struct types and struct buffers.

Interface Summary

Modifier and Type	Interface and Description
public interface	CallbackI Interface for dynamically created native functions that call into Java code (upcalls).
public interface	FunctionProvider A provider of native function addresses.
public interface	FunctionProviderLocal A platform/device/context specific provider of native function addresses.
public interface	NativeResource Classes that implement this interface are associated with one or more native resources.
public interface	Pointer Pointer interface.
public interface	SharedLibrary A `FunctionProvider` implementation that opens a platform-specific shared library and returns functions pointers from it.

Annotation Summary

Modifier and Type	Annotation and Description
public @interface	NativeType Annotates parameter and return types in LWJGL bindings with the C type as defined in the native function.
public @interface	NonnullDefault

Class Summary

Modifier and Type	Class and Description
public class	APIUtil Utility class useful to API bindings.
public abstract class	Callback Base class for dynamically created native functions that call into Java code.
public class	CheckIntrinsics Simple index checks.
public class	Checks A class to check buffer boundaries in general.
public class	Configuration<T> This class can be used to programmatically set the LWJGL runtime configuration.
public abstract class	CustomBuffer<SELF extends CustomBuffer<SELF>> Base class of custom buffers with an API that mirrors `java.nio` for convenience.
public class	JNI This class contains native methods that can be used to call dynamically loaded functions.
public class	Library Initializes the LWJGL shared library and handles loading additional shared libraries.
public class	LibraryResource Handles loading of native resources in LWJGL.
public class	MathUtil Math utility class.
pack-priv class	MemoryAccessJNI Memory access utilities.
pack-priv class	MemoryManage Provides `MemoryAllocator` implementations for `MemoryUtil` to use.
public class	MemoryStack An off-heap memory stack.
public class	MemoryUtil This class provides functionality for managing native memory.
pack-priv class	MultiReleaseMemCopy
pack-priv class	MultiReleaseTextDecoding String decoding utilities.
pack-priv class	SharedLibraryLoader Loads shared libraries and native resources from the classpath.
public class	SharedLibraryUtil
pack-priv class	StackWalkUtil Stack-walking utilities.
public abstract class	Struct<SELF extends Struct<SELF>> Base class of all struct implementations.
public abstract class	StructBuffer<T extends Struct<T>, SELF extends StructBuffer<T, SELF>> Base class of struct custom buffers.
public class	ThreadLocalUtil This class supports bindings with thread-local data.

Package org.lwjgl.system

Interface Summary

Annotation Summary

Class Summary

Enum Summary