Top Description Fields Constructors Methods
org.lwjgl.bgfx

public Class BGFXInitLimits

extends Struct<BGFXInitLimits>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Annotations
@NativeType:struct bgfx_init_limits_t
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Configurable runtime limits parameters.

Layout


struct bgfx_init_limits_t {
    uint16_t maxEncoders;
    uint32_t minResourceCbSize;
    uint32_t transientVbSize;
    uint32_t transientIbSize;
}

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
MAXENCODERS

The struct member offsets.

public static final int
MINRESOURCECBSIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TRANSIENTIBSIZE

The struct member offsets.

public static final int
TRANSIENTVBSIZE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
BGFXInitLimits(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static BGFXInitLimits
calloc()

Returns a new BGFXInitLimits instance allocated with memCalloc.

public static BGFXInitLimits
calloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new BGFXInitLimits instance allocated on the specified MemoryStack and initializes all its bits to zero.

public static BGFXInitLimits
callocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static BGFXInitLimits
callocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
protected BGFXInitLimits
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 BGFXInitLimits
create()

Returns a new BGFXInitLimits instance allocated with BufferUtils.

public static BGFXInitLimits
create(long address)

Returns a new BGFXInitLimits instance for the specified memory address.

public static BGFXInitLimits
createSafe(long address)

Like create, but returns null if address is NULL.

public static BGFXInitLimits
malloc()

Returns a new BGFXInitLimits instance allocated with memAlloc.

public static BGFXInitLimits
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new BGFXInitLimits instance allocated on the specified MemoryStack.

public static BGFXInitLimits
mallocStack()

Deprecated
Deprecated for removal in 3.4.0.
public static BGFXInitLimits
mallocStack(MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public short
maxEncoders()

maximum number of encoder threads

public BGFXInitLimits
maxEncoders(short value)

Sets the specified value to the maxEncoders field.

public int
minResourceCbSize()

minimum resource command buffer size

public BGFXInitLimits
minResourceCbSize(int value)

Sets the specified value to the minResourceCbSize field.

public static short
nmaxEncoders(long struct)

Unsafe version of maxEncoders.

public static void
nmaxEncoders(long struct, short value)

Unsafe version of maxEncoders.

public static int
nminResourceCbSize(long struct)

Unsafe version of minResourceCbSize.

public static void
nminResourceCbSize(long struct, int value)

Unsafe version of minResourceCbSize.

public static int
ntransientIbSize(long struct)

Unsafe version of transientIbSize.

public static void
ntransientIbSize(long struct, int value)

Unsafe version of transientIbSize.

public static int
ntransientVbSize(long struct)

Unsafe version of transientVbSize.

public static void
ntransientVbSize(long struct, int value)

Unsafe version of transientVbSize.

public BGFXInitLimits
set(short maxEncoders, int minResourceCbSize, int transientVbSize, int transientIbSize)

Initializes this struct with the specified values.

public BGFXInitLimits

Returns:

this struct
set
(BGFXInitLimits
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

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

Returns sizeof(struct).
public int
transientIbSize()

maximum transient index buffer size

public BGFXInitLimits
transientIbSize(int value)

Sets the specified value to the transientIbSize field.

public int
transientVbSize()

maximum transient vertex buffer size

public BGFXInitLimits
transientVbSize(int value)

Sets the specified value to the transientVbSize field.

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.

MAXENCODERSback to summary
public static final int MAXENCODERS

The struct member offsets.

MINRESOURCECBSIZEback to summary
public static final int MINRESOURCECBSIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TRANSIENTIBSIZEback to summary
public static final int TRANSIENTIBSIZE

The struct member offsets.

TRANSIENTVBSIZEback to summary
public static final int TRANSIENTVBSIZE

The struct member offsets.

Constructor Detail

BGFXInitLimitsback to summary
protected BGFXInitLimits(long address, ByteBuffer container)
BGFXInitLimitsback to summary
public BGFXInitLimits(ByteBuffer container)

Creates a BGFXInitLimits 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

callocback to summary
public static BGFXInitLimits calloc()

Returns a new BGFXInitLimits instance allocated with memCalloc. The instance must be explicitly freed.

callocback to summary
public static BGFXInitLimits calloc(MemoryStack stack)

Returns a new BGFXInitLimits instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters
stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static BGFXInitLimits callocStack()

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
callocStackback to summary
public static BGFXInitLimits callocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

Annotations
@Deprecated
createback to summary
protected BGFXInitLimits 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 BGFXInitLimits create()

Returns a new BGFXInitLimits instance allocated with BufferUtils.

createback to summary
public static BGFXInitLimits create(long address)

Returns a new BGFXInitLimits instance for the specified memory address.

createSafeback to summary
public static BGFXInitLimits createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static BGFXInitLimits malloc()

Returns a new BGFXInitLimits instance allocated with memAlloc. The instance must be explicitly freed.

mallocback to summary
public static BGFXInitLimits malloc(MemoryStack stack)

Returns a new BGFXInitLimits instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static BGFXInitLimits mallocStack()

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
mallocStackback to summary
public static BGFXInitLimits mallocStack(MemoryStack stack)

Deprecated

Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

Annotations
@Deprecated
maxEncodersback to summary
public short maxEncoders()

maximum number of encoder threads

Annotations
@NativeType:uint16_t
maxEncodersback to summary
public BGFXInitLimits maxEncoders(short value)

Sets the specified value to the maxEncoders field.

minResourceCbSizeback to summary
public int minResourceCbSize()

minimum resource command buffer size

Annotations
@NativeType:uint32_t
minResourceCbSizeback to summary
public BGFXInitLimits minResourceCbSize(int value)

Sets the specified value to the minResourceCbSize field.

nmaxEncodersback to summary
public static short nmaxEncoders(long struct)

Unsafe version of maxEncoders.

nmaxEncodersback to summary
public static void nmaxEncoders(long struct, short value)

Unsafe version of maxEncoders.

nminResourceCbSizeback to summary
public static int nminResourceCbSize(long struct)

Unsafe version of minResourceCbSize.

nminResourceCbSizeback to summary
public static void nminResourceCbSize(long struct, int value)

Unsafe version of minResourceCbSize.

ntransientIbSizeback to summary
public static int ntransientIbSize(long struct)

Unsafe version of transientIbSize.

ntransientIbSizeback to summary
public static void ntransientIbSize(long struct, int value)

Unsafe version of transientIbSize.

ntransientVbSizeback to summary
public static int ntransientVbSize(long struct)

Unsafe version of transientVbSize.

ntransientVbSizeback to summary
public static void ntransientVbSize(long struct, int value)

Unsafe version of transientVbSize.

setback to summary
public BGFXInitLimits set(short maxEncoders, int minResourceCbSize, int transientVbSize, int transientIbSize)

Initializes this struct with the specified values.

setback to summary
public BGFXInitLimits set(BGFXInitLimits src)

Copies the specified struct data to this struct.

Parameters
src:BGFXInitLimits

the source struct

Returns:BGFXInitLimits

this struct

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
transientIbSizeback to summary
public int transientIbSize()

maximum transient index buffer size

Annotations
@NativeType:uint32_t
transientIbSizeback to summary
public BGFXInitLimits transientIbSize(int value)

Sets the specified value to the transientIbSize field.

transientVbSizeback to summary
public int transientVbSize()

maximum transient vertex buffer size

Annotations
@NativeType:uint32_t
transientVbSizeback to summary
public BGFXInitLimits transientVbSize(int value)

Sets the specified value to the transientVbSize field.