org.lwjgl.system.package-info Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of lwjgl Show documentation
The LWJGL core library.
There is a newer version: 3.3.4
/*
 * Copyright LWJGL. All rights reserved.
 * License terms: https://www.lwjgl.org/license
 */

/**
 * 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 dyncall 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:
 * 
 * {@link org.lwjgl.system.MemoryUtil MemoryUtil}, used for off-heap data access and memory allocation/deallocation.
 * {@link org.lwjgl.system.MemoryStack MemoryStack}, used for emulated off-heap stack allocations.
 * {@link org.lwjgl.system.FunctionProvider FunctionProvider}, {@link org.lwjgl.system.Library Library} and
 * {@link org.lwjgl.system.SharedLibrary SharedLibrary}, used for loading shared libraries and accessing function pointers.
 * {@link org.lwjgl.system.Pointer Pointer}, used as off-heap resource abstractions.
 * {@link org.lwjgl.system.Configuration Configuration}, used for programmatic configuration at runtime.
 * {@link org.lwjgl.system.Struct Struct} and {@link org.lwjgl.system.StructBuffer StructBuffer}, the base classes for struct types and struct buffers.
 * 
 */
@NonnullDefault
package org.lwjgl.system;