Top Description Fields Constructors Methods
org.lwjgl.bgfx

public Class BGFXCaps

extends Struct<BGFXCaps>
Class Inheritance
Annotations
@NativeType:struct bgfx_caps_t
Imports
javax.annotation.*, java.nio.*, org.lwjgl.system.*

Renderer capabilities.

Layout


struct bgfx_caps_t {
    bgfx_renderer_type_t rendererType;
    uint64_t supported;
    uint16_t vendorId;
    uint16_t deviceId;
    bool homogeneousDepth;
    bool originBottomLeft;
    uint8_t numGPUs;
    bgfx_caps_gpu_t gpu[4];
    bgfx_caps_limits_t limits;
    uint16_t formats[BGFX_TEXTURE_FORMAT_COUNT];
}

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DEVICEID

The struct member offsets.

public static final int
FORMATS

The struct member offsets.

public static final int
GPU

The struct member offsets.

public static final int
HOMOGENEOUSDEPTH

The struct member offsets.

public static final int
LIMITS

The struct member offsets.

public static final int
NUMGPUS

The struct member offsets.

public static final int
ORIGINBOTTOMLEFT

The struct member offsets.

public static final int
RENDERERTYPE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SUPPORTED

The struct member offsets.

public static final int
VENDORID

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
BGFXCaps(long address, ByteBuffer container)

public
BGFXCaps(ByteBuffer container)

Creates a BGFXCaps instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
protected BGFXCaps
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static BGFXCaps
create(long address)

Returns a new BGFXCaps instance for the specified memory address.

public static BGFXCaps
createSafe(long address)

Like create, but returns null if address is NULL.

public short
deviceId()

selected GPU device id

public ShortBuffer
formats()

supported texture formats

public short
formats(int index)

supported texture formats

public BGFXCapsGPU.Buffer
gpu()

enumerated GPUs

public BGFXCapsGPU
gpu(int index)

enumerated GPUs

public boolean
homogeneousDepth()

true when NDC depth is in [-1, 1] range, otherwise its [0, 1]

public BGFXCapsLimits
limits()

renderer runtime limits

public static short
ndeviceId(long struct)

Unsafe version of deviceId.

public static ShortBuffer
nformats(long struct)

Unsafe version of formats.

public static short
nformats(long struct, int index)

Unsafe version of formats.

public static BGFXCapsGPU.Buffer
ngpu(long struct)

Unsafe version of gpu.

public static BGFXCapsGPU
ngpu(long struct, int index)

Unsafe version of gpu.

public static boolean
nhomogeneousDepth(long struct)

Unsafe version of homogeneousDepth.

public static BGFXCapsLimits
nlimits(long struct)

Unsafe version of limits.

public static byte
nnumGPUs(long struct)

Unsafe version of numGPUs.

public static boolean
noriginBottomLeft(long struct)

Unsafe version of originBottomLeft.

public static int
nrendererType(long struct)

Unsafe version of rendererType.

public static long
nsupported(long struct)

Unsafe version of supported.

public byte
numGPUs()

number of enumerated GPUs

public static short
nvendorId(long struct)

Unsafe version of vendorId.

public boolean
originBottomLeft()

true when NDC origin is at bottom left

public int
rendererType()

renderer backend type.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public long
supported()

supported functionality.

public short
Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

DEVICEIDback to summary
public static final int DEVICEID

The struct member offsets.

FORMATSback to summary
public static final int FORMATS

The struct member offsets.

GPUback to summary
public static final int GPU

The struct member offsets.

HOMOGENEOUSDEPTHback to summary
public static final int HOMOGENEOUSDEPTH

The struct member offsets.

LIMITSback to summary
public static final int LIMITS

The struct member offsets.

NUMGPUSback to summary
public static final int NUMGPUS

The struct member offsets.

ORIGINBOTTOMLEFTback to summary
public static final int ORIGINBOTTOMLEFT

The struct member offsets.

RENDERERTYPEback to summary
public static final int RENDERERTYPE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SUPPORTEDback to summary
public static final int SUPPORTED

The struct member offsets.

VENDORIDback to summary
public static final int VENDORID

The struct member offsets.

Constructor Detail

BGFXCapsback to summary
protected BGFXCaps(long address, ByteBuffer container)
BGFXCapsback to summary
public BGFXCaps(ByteBuffer container)

Creates a BGFXCaps instance at the current position of the specified ByteBuffer container. Changes to the buffer's content will be visible to the struct instance and vice versa.

The created instance holds a strong reference to the container object.

Method Detail

createback to summary
protected BGFXCaps create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static BGFXCaps create(long address)

Returns a new BGFXCaps instance for the specified memory address.

createSafeback to summary
public static BGFXCaps createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
deviceIdback to summary
public short deviceId()

selected GPU device id

Annotations
@NativeType:uint16_t
formatsback to summary
public ShortBuffer formats()

supported texture formats

Annotations
@NativeType:uint16_t[BGFX_TEXTURE_FORMAT_COUNT]
formatsback to summary
public short formats(int index)

supported texture formats

Annotations
@NativeType:uint16_t
gpuback to summary
public BGFXCapsGPU.Buffer gpu()

enumerated GPUs

Annotations
@NativeType:bgfx_caps_gpu_t[4]
gpuback to summary
public BGFXCapsGPU gpu(int index)

enumerated GPUs

Annotations
@NativeType:bgfx_caps_gpu_t
homogeneousDepthback to summary
public boolean homogeneousDepth()

true when NDC depth is in [-1, 1] range, otherwise its [0, 1]

Annotations
@NativeType:bool
limitsback to summary
public BGFXCapsLimits limits()

renderer runtime limits

Annotations
@NativeType:bgfx_caps_limits_t
ndeviceIdback to summary
public static short ndeviceId(long struct)

Unsafe version of deviceId.

nformatsback to summary
public static ShortBuffer nformats(long struct)

Unsafe version of formats.

nformatsback to summary
public static short nformats(long struct, int index)

Unsafe version of formats.

ngpuback to summary
public static BGFXCapsGPU.Buffer ngpu(long struct)

Unsafe version of gpu.

ngpuback to summary
public static BGFXCapsGPU ngpu(long struct, int index)

Unsafe version of gpu.

nhomogeneousDepthback to summary
public static boolean nhomogeneousDepth(long struct)

Unsafe version of homogeneousDepth.

nlimitsback to summary
public static BGFXCapsLimits nlimits(long struct)

Unsafe version of limits.

nnumGPUsback to summary
public static byte nnumGPUs(long struct)

Unsafe version of numGPUs.

noriginBottomLeftback to summary
public static boolean noriginBottomLeft(long struct)

Unsafe version of originBottomLeft.

nrendererTypeback to summary
public static int nrendererType(long struct)

Unsafe version of rendererType.

nsupportedback to summary
public static long nsupported(long struct)

Unsafe version of supported.

numGPUsback to summary
public byte numGPUs()

number of enumerated GPUs

Annotations
@NativeType:uint8_t
nvendorIdback to summary
public static short nvendorId(long struct)

Unsafe version of vendorId.

originBottomLeftback to summary
public boolean originBottomLeft()

true when NDC origin is at bottom left

Annotations
@NativeType:bool
rendererTypeback to summary
public int rendererType()

renderer backend type. One of:

RENDERER_TYPE_NOOPRENDERER_TYPE_AGCRENDERER_TYPE_DIRECT3D9RENDERER_TYPE_DIRECT3D11
RENDERER_TYPE_DIRECT3D12RENDERER_TYPE_GNMRENDERER_TYPE_METALRENDERER_TYPE_NVN
RENDERER_TYPE_OPENGLESRENDERER_TYPE_OPENGLRENDERER_TYPE_VULKAN
Annotations
@NativeType:bgfx_renderer_type_t
sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
supportedback to summary
public long supported()

supported functionality. One or more of:

CAPS_ALPHA_TO_COVERAGECAPS_BLEND_INDEPENDENTCAPS_COMPUTECAPS_CONSERVATIVE_RASTER
CAPS_DRAW_INDIRECTCAPS_FRAGMENT_DEPTHCAPS_FRAGMENT_ORDERINGCAPS_GRAPHICS_DEBUGGER
CAPS_HDR10CAPS_HIDPICAPS_IMAGE_RWCAPS_INDEX32
CAPS_INSTANCINGCAPS_OCCLUSION_QUERYCAPS_RENDERER_MULTITHREADEDCAPS_SWAP_CHAIN
CAPS_TEXTURE_2D_ARRAYCAPS_TEXTURE_3DCAPS_TEXTURE_BLITCAPS_TRANSPARENT_BACKBUFFER
CAPS_TEXTURE_COMPARE_RESERVEDCAPS_TEXTURE_COMPARE_LEQUALCAPS_TEXTURE_COMPARE_ALLCAPS_TEXTURE_CUBE_ARRAY
CAPS_TEXTURE_DIRECT_ACCESSCAPS_TEXTURE_READ_BACKCAPS_VERTEX_ATTRIB_HALFCAPS_VERTEX_ATTRIB_UINT10
CAPS_VERTEX_IDCAPS_PRIMITIVE_IDCAPS_VIEWPORT_LAYER_ARRAYCAPS_DRAW_INDIRECT_COUNT
Annotations
@NativeType:uint64_t
vendorIdback to summary
public short vendorId()

selected GPU vendor PCI id. One of:

PCI_ID_NONEPCI_ID_SOFTWARE_RASTERIZERPCI_ID_AMDPCI_ID_APPLEPCI_ID_INTEL
PCI_ID_NVIDIAPCI_ID_MICROSOFTPCI_ID_ARM
Annotations
@NativeType:uint16_t