Top Description Interfaces Classes
module lwjgl.bgfx

Package org.lwjgl.bgfx

Annotations
@NonnullDefault

Contains bindings to the bgfx library.

The bgfx documentation can be found online here. The API reference is available here.

Starting with LWJGL 3.2.1, builds of the bgfx tools are available for download via the LWJGL site's file browser. These tools are:

The binaries are built from source, at the corresponding commit that was used to build the bgfx library. For example, the latest Windows x64 version of shaderc can be found under nightly/windows/x64/bgfx-tools/.

Interface Summary

Modifier and TypeInterface and Description
public interface
BGFXCacheReadCallbackI

Reads cached item.

public interface
BGFXCacheReadSizeCallbackI

Returns the size of a cached item.

public interface
BGFXCacheWriteCallbackI

Writes cached item.

public interface
BGFXCaptureBeginCallbackI

Called when video capture begins.

public interface
BGFXCaptureEndCallbackI

Called when video capture ends.

public interface
public interface
BGFXFatalCallbackI

If fatal code is not FATAL_DEBUG_CHECK this callback is called on unrecoverable error.

public interface
BGFXProfilerBeginI

Profiler region begin.

public interface
BGFXProfilerBeginLiteralI

Profiler region begin with string literal name.

public interface
BGFXProfilerEndI

Profiler region end.

public interface
BGFXReallocCallbackI

Allocates memory.

public interface
BGFXReleaseFunctionCallbackI

Instances of this interface may be passed to the make_ref_release method.

public interface
BGFXScreenShotCallbackI

Screenshot captured.

public interface
BGFXTraceVarArgsCallbackI

Prints a debug message.

Class Summary

Modifier and TypeClass and Description
public class
BGFX

Native bindings to the C API of the bgfx library.

public class
BGFXAllocatorInterface

Custom allocator.

public class
BGFXAllocatorVtbl

Allocator virtual table Layout


struct bgfx_allocator_vtbl_t {
    void * (*realloc) (bgfx_allocator_interface_t *_this, void *_ptr, size_t _size, size_t _align, char *_file, uint32_t _line);
}
public class
BGFXAttachment

Frame buffer texture attachment info.

public abstract class
BGFXCacheReadCallback

Reads cached item.

public abstract class
BGFXCacheReadSizeCallback

Returns the size of a cached item.

public abstract class
BGFXCacheWriteCallback

Writes cached item.

public class
BGFXCallbackInterface

Callback interface to implement application specific behavior.

public class
BGFXCallbackVtbl

Callback virtual table.

public class
BGFXCaps

Renderer capabilities.

public class
BGFXCapsGPU

GPU info.

public class
BGFXCapsLimits

Renderer runtime limits.

public abstract class
BGFXCaptureBeginCallback

Called when video capture begins.

public abstract class
BGFXCaptureEndCallback

Called when video capture ends.

public abstract class
BGFXCaptureFrameCallback

Captured frame.

public class
BGFXEncoderStats

Encoder stats.

public abstract class
BGFXFatalCallback

If fatal code is not FATAL_DEBUG_CHECK this callback is called on unrecoverable error.

public class
BGFXInit

Initialization parameters used by init.

public class
BGFXInitLimits

Configurable runtime limits parameters.

public class
BGFXInstanceDataBuffer

Instance data buffer info.

public class
BGFXInternalData

Internal data.

public class
BGFXMemory

Memory must be obtained by calling alloc, copy, or make_ref.

public class
BGFXPlatform

Native bindings to the C platform API of the bgfx library.

public class
BGFXPlatformData

Platform data.

public abstract class
BGFXProfilerBegin

Profiler region begin.

public abstract class
BGFXProfilerBeginLiteral

Profiler region begin with string literal name.

public abstract class
BGFXProfilerEnd

Profiler region end.

public abstract class
BGFXReallocCallback

Allocates memory.

public abstract class
BGFXReleaseFunctionCallback

Instances of this class may be passed to the make_ref_release method.

public class
BGFXResolution

Backbuffer resolution and reset parameters.

public abstract class
BGFXScreenShotCallback

Screenshot captured.

public class
BGFXStats

Renderer statistics data.

public class
BGFXTextureInfo

Texture info.

public abstract class
BGFXTraceVarArgsCallback

Prints a debug message.

public class
BGFXTransform

Transform data.

public class
BGFXTransientIndexBuffer

Transient index buffer.

public class
BGFXTransientVertexBuffer

Transient vertex buffer.

public class
BGFXUniformInfo

Uniform info.

public class
BGFXVertexLayout

Vertex layout.

public class
BGFXViewStats

View stats.