@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 notFATAL_DEBUG_CHECKthis 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 themake_ref_releasemethod.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 bgfxSharedLibrary.BGFXAllocatorInterface Custom allocator.BGFXAllocatorVtbl Allocator virtual tableBGFXAllocatorVtbl.Buffer An array ofBGFXAllocatorVtblstructs.BGFXAttachment Frame buffer texture attachment info.BGFXAttachment.Buffer An array ofBGFXAttachmentstructs.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 ofBGFXCapsGPUstructs.BGFXCapsLimits Renderer runtime limits.BGFXCapsLimits.Buffer An array ofBGFXCapsLimitsstructs.BGFXCaptureBeginCallback Called when video capture begins.BGFXCaptureEndCallback Called when video capture ends.BGFXCaptureFrameCallback Captured frame.BGFXEncoderStats Encoder stats.BGFXEncoderStats.Buffer An array ofBGFXEncoderStatsstructs.BGFXFatalCallback If fatal code is notFATAL_DEBUG_CHECKthis callback is called on unrecoverable error.BGFXInit Initialization parameters used byinit.BGFXInitLimits Configurable runtime limits parameters.BGFXInstanceDataBuffer Instance data buffer info.BGFXInstanceDataBuffer.Buffer An array ofBGFXInstanceDataBufferstructs.BGFXInternalData Internal data.BGFXMemory BGFXMemory.Buffer An array ofBGFXMemorystructs.BGFXPlatform Native bindings to the C platform API of the bgfx library.BGFXPlatform.Functions Contains the function pointers loaded fromBGFX.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 themake_ref_releasemethod.BGFXResolution Backbuffer resolution and reset parameters.BGFXScreenShotCallback Screenshot captured.BGFXStats Renderer statistics data.BGFXStats.Buffer An array ofBGFXStatsstructs.BGFXTextureInfo Texture info.BGFXTextureInfo.Buffer An array ofBGFXTextureInfostructs.BGFXTraceVarArgsCallback Prints a debug message.BGFXTransform Transform data.BGFXTransform.Buffer An array ofBGFXTransformstructs.BGFXTransientIndexBuffer Transient index buffer.BGFXTransientIndexBuffer.Buffer An array ofBGFXTransientIndexBufferstructs.BGFXTransientVertexBuffer Transient vertex buffer.BGFXTransientVertexBuffer.Buffer An array ofBGFXTransientVertexBufferstructs.BGFXUniformInfo Uniform info.BGFXUniformInfo.Buffer An array ofBGFXUniformInfostructs.BGFXVertexLayout Vertex layout.BGFXVertexLayout.Buffer An array ofBGFXVertexLayoutstructs.BGFXViewStats View stats.BGFXViewStats.Buffer An array ofBGFXViewStatsstructs.