Top Description Inners Fields Constructors Methods
org.lwjgl.bgfx

public Class BGFXTransientVertexBuffer

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

Transient vertex buffer.

Layout


struct bgfx_transient_vertex_buffer_t {
    uint8_t * data;
    uint32_t size;
    uint32_t startVertex;
    uint16_t stride;
    bgfx_vertex_buffer_handle_t handle;
    bgfx_vertex_layout_handle_t layoutHandle;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
DATA

The struct member offsets.

public static final int
HANDLE

The struct member offsets.

public static final int
LAYOUTHANDLE

The struct member offsets.

public static final int
SIZE

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
STARTVERTEX

The struct member offsets.

public static final int
STRIDE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
BGFXTransientVertexBuffer(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static BGFXTransientVertexBuffer
calloc()

Returns a new BGFXTransientVertexBuffer instance allocated with memCalloc.

public static BGFXTransientVertexBuffer.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new BGFXTransientVertexBuffer.Buffer instance allocated with memCalloc.

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

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

public static BGFXTransientVertexBuffer.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static BGFXTransientVertexBuffer
callocStack()

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

Deprecated
Deprecated for removal in 3.4.0.
public static BGFXTransientVertexBuffer.Buffer
callocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static BGFXTransientVertexBuffer.Buffer
callocStack(int capacity, MemoryStack stack)

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

Returns a new BGFXTransientVertexBuffer instance allocated with BufferUtils.

public static BGFXTransientVertexBuffer
create(long address)

Returns a new BGFXTransientVertexBuffer instance for the specified memory address.

public static BGFXTransientVertexBuffer.Buffer
create(int
the buffer capacity
capacity
)

Returns a new BGFXTransientVertexBuffer.Buffer instance allocated with BufferUtils.

public static BGFXTransientVertexBuffer.Buffer
create(long
the memory address
address
,
int
the buffer capacity
capacity
)

Create a BGFXTransientVertexBuffer.Buffer instance at the specified memory.

public static BGFXTransientVertexBuffer
createSafe(long address)

Like create, but returns null if address is NULL.

public static BGFXTransientVertexBuffer.Buffer
createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

public ByteBuffer
data()

pointer to data

public BGFXTransientVertexBuffer
data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the data field.

public short
handle()

vertex buffer handle

public BGFXTransientVertexBuffer
handle(short value)

Sets the specified value to the handle field.

public short
layoutHandle()

vertex layout handle

public BGFXTransientVertexBuffer
layoutHandle(short value)

Sets the specified value to the layoutHandle field.

public static BGFXTransientVertexBuffer
malloc()

Returns a new BGFXTransientVertexBuffer instance allocated with memAlloc.

public static BGFXTransientVertexBuffer.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new BGFXTransientVertexBuffer.Buffer instance allocated with memAlloc.

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

Returns a new BGFXTransientVertexBuffer instance allocated on the specified MemoryStack.

public static BGFXTransientVertexBuffer.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

Returns a new BGFXTransientVertexBuffer.Buffer instance allocated on the specified MemoryStack.

public static BGFXTransientVertexBuffer
mallocStack()

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

Deprecated
Deprecated for removal in 3.4.0.
public static BGFXTransientVertexBuffer.Buffer
mallocStack(int capacity)

Deprecated
Deprecated for removal in 3.4.0.
public static BGFXTransientVertexBuffer.Buffer
mallocStack(int capacity, MemoryStack stack)

Deprecated
Deprecated for removal in 3.4.0.
public static ByteBuffer
ndata(long struct)

Unsafe version of data.

public static void
ndata(long struct, ByteBuffer value)

Unsafe version of data.

public static short
nhandle(long struct)

Unsafe version of handle.

public static void
nhandle(long struct, short value)

Unsafe version of handle.

public static short
nlayoutHandle(long struct)

Unsafe version of layoutHandle.

public static void
nlayoutHandle(long struct, short value)

Unsafe version of layoutHandle.

public static int
nsize(long struct)

Unsafe version of size.

public static void
nsize(long struct, int value)

Sets the specified value to the size field of the specified struct.

public static int
nstartVertex(long struct)

Unsafe version of startVertex.

public static void
nstartVertex(long struct, int value)

Unsafe version of startVertex.

public static short
nstride(long struct)

Unsafe version of stride.

public static void
nstride(long struct, short value)

Unsafe version of stride.

public BGFXTransientVertexBuffer
set(ByteBuffer data, int startVertex, short stride, short handle, short layoutHandle)

Initializes this struct with the specified values.

public BGFXTransientVertexBuffer

Returns:

this struct
set
(BGFXTransientVertexBuffer
the source struct
src
)

Copies the specified struct data to this struct.

public int
size()

data size

public int
sizeof()

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

Returns sizeof(struct).
public int
startVertex()

first vertex

public BGFXTransientVertexBuffer
startVertex(int value)

Sets the specified value to the startVertex field.

public short
stride()

vertex stride

public BGFXTransientVertexBuffer
stride(short value)

Sets the specified value to the stride field.

public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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.

DATAback to summary
public static final int DATA

The struct member offsets.

HANDLEback to summary
public static final int HANDLE

The struct member offsets.

LAYOUTHANDLEback to summary
public static final int LAYOUTHANDLE

The struct member offsets.

SIZEback to summary
public static final int SIZE

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

STARTVERTEXback to summary
public static final int STARTVERTEX

The struct member offsets.

STRIDEback to summary
public static final int STRIDE

The struct member offsets.

Constructor Detail

BGFXTransientVertexBufferback to summary
protected BGFXTransientVertexBuffer(long address, ByteBuffer container)
BGFXTransientVertexBufferback to summary
public BGFXTransientVertexBuffer(ByteBuffer container)

Creates a BGFXTransientVertexBuffer 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 BGFXTransientVertexBuffer calloc()

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

callocback to summary
public static BGFXTransientVertexBuffer.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static BGFXTransientVertexBuffer calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static BGFXTransientVertexBuffer.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

callocStackback to summary
public static BGFXTransientVertexBuffer callocStack()

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static BGFXTransientVertexBuffer.Buffer callocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
callocStackback to summary
public static BGFXTransientVertexBuffer.Buffer callocStack(int capacity, MemoryStack stack)

Deprecated

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

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

Returns a new BGFXTransientVertexBuffer instance allocated with BufferUtils.

createback to summary
public static BGFXTransientVertexBuffer create(long address)

Returns a new BGFXTransientVertexBuffer instance for the specified memory address.

createback to summary
public static BGFXTransientVertexBuffer.Buffer create(int capacity)

Returns a new BGFXTransientVertexBuffer.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

createback to summary
public static BGFXTransientVertexBuffer.Buffer create(long address, int capacity)

Create a BGFXTransientVertexBuffer.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static BGFXTransientVertexBuffer createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static BGFXTransientVertexBuffer.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
databack to summary
public ByteBuffer data()

pointer to data

Annotations
@NativeType:uint8_t *
databack to summary
public BGFXTransientVertexBuffer data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the data field.

handleback to summary
public short handle()

vertex buffer handle

Annotations
@NativeType:bgfx_vertex_buffer_handle_t
handleback to summary
public BGFXTransientVertexBuffer handle(short value)

Sets the specified value to the handle field.

layoutHandleback to summary
public short layoutHandle()

vertex layout handle

Annotations
@NativeType:bgfx_vertex_layout_handle_t
layoutHandleback to summary
public BGFXTransientVertexBuffer layoutHandle(short value)

Sets the specified value to the layoutHandle field.

mallocback to summary
public static BGFXTransientVertexBuffer malloc()

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

mallocback to summary
public static BGFXTransientVertexBuffer.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static BGFXTransientVertexBuffer malloc(MemoryStack stack)

Returns a new BGFXTransientVertexBuffer instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static BGFXTransientVertexBuffer.Buffer malloc(int capacity, MemoryStack stack)

Returns a new BGFXTransientVertexBuffer.Buffer instance allocated on the specified MemoryStack.

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

mallocStackback to summary
public static BGFXTransientVertexBuffer mallocStack()

Deprecated

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

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

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static BGFXTransientVertexBuffer.Buffer mallocStack(int capacity)

Deprecated

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

Annotations
@Deprecated
mallocStackback to summary
public static BGFXTransientVertexBuffer.Buffer mallocStack(int capacity, MemoryStack stack)

Deprecated

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

Annotations
@Deprecated
ndataback to summary
public static ByteBuffer ndata(long struct)

Unsafe version of data.

ndataback to summary
public static void ndata(long struct, ByteBuffer value)

Unsafe version of data.

nhandleback to summary
public static short nhandle(long struct)

Unsafe version of handle.

nhandleback to summary
public static void nhandle(long struct, short value)

Unsafe version of handle.

nlayoutHandleback to summary
public static short nlayoutHandle(long struct)

Unsafe version of layoutHandle.

nlayoutHandleback to summary
public static void nlayoutHandle(long struct, short value)

Unsafe version of layoutHandle.

nsizeback to summary
public static int nsize(long struct)

Unsafe version of size.

nsizeback to summary
public static void nsize(long struct, int value)

Sets the specified value to the size field of the specified struct.

nstartVertexback to summary
public static int nstartVertex(long struct)

Unsafe version of startVertex.

nstartVertexback to summary
public static void nstartVertex(long struct, int value)

Unsafe version of startVertex.

nstrideback to summary
public static short nstride(long struct)

Unsafe version of stride.

nstrideback to summary
public static void nstride(long struct, short value)

Unsafe version of stride.

setback to summary
public BGFXTransientVertexBuffer set(ByteBuffer data, int startVertex, short stride, short handle, short layoutHandle)

Initializes this struct with the specified values.

setback to summary
public BGFXTransientVertexBuffer set(BGFXTransientVertexBuffer src)

Copies the specified struct data to this struct.

Parameters
src:BGFXTransientVertexBuffer

the source struct

Returns:BGFXTransientVertexBuffer

this struct

sizeback to summary
public int size()

data size

Annotations
@NativeType:uint32_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
startVertexback to summary
public int startVertex()

first vertex

Annotations
@NativeType:uint32_t
startVertexback to summary
public BGFXTransientVertexBuffer startVertex(int value)

Sets the specified value to the startVertex field.

strideback to summary
public short stride()

vertex stride

Annotations
@NativeType:uint16_t
strideback to summary
public BGFXTransientVertexBuffer stride(short value)

Sets the specified value to the stride field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.bgfx back to summary

public Class BGFXTransientVertexBuffer.Buffer

extends StructBuffer<BGFXTransientVertexBuffer, BGFXTransientVertexBuffer.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of BGFXTransientVertexBuffer structs.

Field Summary

Modifier and TypeField and Description
private static final BGFXTransientVertexBuffer

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new BGFXTransientVertexBuffer.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public ByteBuffer

Returns:

a ByteBuffer view of the data pointed to by the BGFXTransientVertexBuffer#data field.
data
()

public BGFXTransientVertexBuffer.Buffer
data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the BGFXTransientVertexBuffer#data field.

protected BGFXTransientVertexBuffer
public short

Returns:

the value of the BGFXTransientVertexBuffer#handle field.
handle
()

public BGFXTransientVertexBuffer.Buffer
handle(short value)

Sets the specified value to the BGFXTransientVertexBuffer#handle field.

public short

Returns:

the value of the BGFXTransientVertexBuffer#layoutHandle field.
layoutHandle
()

public BGFXTransientVertexBuffer.Buffer
layoutHandle(short value)

Sets the specified value to the BGFXTransientVertexBuffer#layoutHandle field.

protected BGFXTransientVertexBuffer.Buffer
public int

Returns:

the value of the BGFXTransientVertexBuffer#size field.
size
()

public int

Returns:

the value of the BGFXTransientVertexBuffer#startVertex field.
startVertex
()

public BGFXTransientVertexBuffer.Buffer
startVertex(int value)

Sets the specified value to the BGFXTransientVertexBuffer#startVertex field.

public short

Returns:

the value of the BGFXTransientVertexBuffer#stride field.
stride
()

public BGFXTransientVertexBuffer.Buffer
stride(short value)

Sets the specified value to the BGFXTransientVertexBuffer#stride field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final BGFXTransientVertexBuffer ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new BGFXTransientVertexBuffer.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by BGFXTransientVertexBuffer#SIZEOF, and its mark will be undefined.

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

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

databack to summary
public ByteBuffer data()
Returns:ByteBuffer

a ByteBuffer view of the data pointed to by the BGFXTransientVertexBuffer#data field.

Annotations
@NativeType:uint8_t *
databack to summary
public BGFXTransientVertexBuffer.Buffer data(ByteBuffer value)

Sets the address of the specified ByteBuffer to the BGFXTransientVertexBuffer#data field.

getElementFactoryback to summary
protected BGFXTransientVertexBuffer getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
handleback to summary
public short handle()
Returns:short

the value of the BGFXTransientVertexBuffer#handle field.

Annotations
@NativeType:bgfx_vertex_buffer_handle_t
handleback to summary
public BGFXTransientVertexBuffer.Buffer handle(short value)

Sets the specified value to the BGFXTransientVertexBuffer#handle field.

layoutHandleback to summary
public short layoutHandle()
Returns:short

the value of the BGFXTransientVertexBuffer#layoutHandle field.

Annotations
@NativeType:bgfx_vertex_layout_handle_t
layoutHandleback to summary
public BGFXTransientVertexBuffer.Buffer layoutHandle(short value)

Sets the specified value to the BGFXTransientVertexBuffer#layoutHandle field.

selfback to summary
protected BGFXTransientVertexBuffer.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
sizeback to summary
public int size()
Returns:int

the value of the BGFXTransientVertexBuffer#size field.

Annotations
@NativeType:uint32_t
startVertexback to summary
public int startVertex()
Returns:int

the value of the BGFXTransientVertexBuffer#startVertex field.

Annotations
@NativeType:uint32_t
startVertexback to summary
public BGFXTransientVertexBuffer.Buffer startVertex(int value)

Sets the specified value to the BGFXTransientVertexBuffer#startVertex field.

strideback to summary
public short stride()
Returns:short

the value of the BGFXTransientVertexBuffer#stride field.

Annotations
@NativeType:uint16_t
strideback to summary
public BGFXTransientVertexBuffer.Buffer stride(short value)

Sets the specified value to the BGFXTransientVertexBuffer#stride field.