@NonnullDefault

Package org.lwjgl.bgfx

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:

• Geometry Compiler (geometryc)
• Shader Compiler (shaderc)
• Texture Compiler (texturec)
• Texture Viewer (texturev)

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

Interface	Description
BGFXCacheReadCallbackI	Reads cached item.
BGFXCacheReadSizeCallbackI	Returns the size of a cached item.
BGFXCacheWriteCallbackI	Writes cached item.
BGFXCaptureBeginCallbackI	Called when video capture begins.
BGFXCaptureEndCallbackI	Called when video capture ends.
BGFXCaptureFrameCallbackI	Captured frame.
BGFXFatalCallbackI	If fatal code is not FATAL_DEBUG_CHECK this callback is called on unrecoverable error.
BGFXProfilerBeginI	Profiler region begin.
BGFXProfilerBeginLiteralI	Profiler region begin with string literal name.
BGFXProfilerEndI	Profiler region end.
BGFXReallocCallbackI	Allocates memory.
BGFXReleaseFunctionCallbackI	Instances of this interface may be passed to the make_ref_release method.
BGFXScreenShotCallbackI	Screenshot captured.
BGFXTraceVarArgsCallbackI	Prints a debug message.

Class Summary

Class	Description
BGFX	Native bindings to the C API of the bgfx library.
BGFX.Functions	Contains the function pointers loaded from the bgfx SharedLibrary.
BGFXAllocatorInterface	Custom allocator.
BGFXAllocatorVtbl	Allocator virtual table
BGFXAllocatorVtbl.Buffer	An array of BGFXAllocatorVtbl structs.
BGFXAttachment	Frame buffer texture attachment info.
BGFXAttachment.Buffer	An array of BGFXAttachment structs.
BGFXCacheReadCallback	Reads cached item.
BGFXCacheReadSizeCallback	Returns the size of a cached item.
BGFXCacheWriteCallback	Writes cached item.
BGFXCallbackInterface	Callback interface to implement application specific behavior.
BGFXCallbackVtbl	Callback virtual table.
BGFXCaps	Renderer capabilities.
BGFXCapsGPU	GPU info.
BGFXCapsGPU.Buffer	An array of BGFXCapsGPU structs.
BGFXCapsLimits	Rendering limits.
BGFXCapsLimits.Buffer	An array of BGFXCapsLimits structs.
BGFXCaptureBeginCallback	Called when video capture begins.
BGFXCaptureEndCallback	Called when video capture ends.
BGFXCaptureFrameCallback	Captured frame.
BGFXEncoderStats	Encoder stats.
BGFXEncoderStats.Buffer	An array of BGFXEncoderStats structs.
BGFXFatalCallback	If fatal code is not FATAL_DEBUG_CHECK this callback is called on unrecoverable error.
BGFXInit	Initialization parameters used by init.
BGFXInitLimits	Member documentation
BGFXInstanceDataBuffer	Instance data buffer info.
BGFXInstanceDataBuffer.Buffer	An array of BGFXInstanceDataBuffer structs.
BGFXInternalData	Internal data.
BGFXMemory	Memory must be obtained by calling alloc, copy, or make_ref.
BGFXMemory.Buffer	An array of BGFXMemory structs.
BGFXPlatform	Native bindings to the C platform API of the bgfx library.
BGFXPlatform.Functions	Contains the function pointers loaded from BGFX.getLibrary().
BGFXPlatformData	Platform data.
BGFXProfilerBegin	Profiler region begin.
BGFXProfilerBeginLiteral	Profiler region begin with string literal name.
BGFXProfilerEnd	Profiler region end.
BGFXReallocCallback	Allocates memory.
BGFXReleaseFunctionCallback	Instances of this class may be passed to the make_ref_release method.
BGFXResolution	Backbuffer resolution and reset parameters.
BGFXScreenShotCallback	Screenshot captured.
BGFXStats	Renderer statistics data.
BGFXStats.Buffer	An array of BGFXStats structs.
BGFXTextureInfo	Texture info.
BGFXTextureInfo.Buffer	An array of BGFXTextureInfo structs.
BGFXTraceVarArgsCallback	Prints a debug message.
BGFXTransform	Transform data.
BGFXTransform.Buffer	An array of BGFXTransform structs.
BGFXTransientIndexBuffer	Transient index buffer.
BGFXTransientIndexBuffer.Buffer	An array of BGFXTransientIndexBuffer structs.
BGFXTransientVertexBuffer	Transient vertex buffer.
BGFXTransientVertexBuffer.Buffer	An array of BGFXTransientVertexBuffer structs.
BGFXUniformInfo	Uniform info.
BGFXUniformInfo.Buffer	An array of BGFXUniformInfo structs.
BGFXVertexLayout	Vertex layout.
BGFXVertexLayout.Buffer	An array of BGFXVertexLayout structs.
BGFXViewStats	View stats.
BGFXViewStats.Buffer	An array of BGFXViewStats structs.