org.lwjgl.bgfx.BGFXTransientVertexBuffer

All Implemented Interfaces:: AutoCloseable, NativeResource, Pointer

@NativeType("struct bgfx_transient_vertex_buffer_t") public class BGFXTransientVertexBuffer extends Struct<BGFXTransientVertexBuffer> implements NativeResource

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 Class Summary

Nested Classes

Modifier and Type

Class

Description

static class

BGFXTransientVertexBuffer.Buffer

An array of BGFXTransientVertexBuffer structs.

Nested classes/interfaces inherited from class Struct
Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer
Pointer.Default
Field Summary

Fields

Modifier and Type

Field

Description

static final int

ALIGNOF

The struct alignment in bytes.

static final int

DATA

The struct member offsets.

static final int

HANDLE

The struct member offsets.

static final int

LAYOUTHANDLE

The struct member offsets.

static final int

SIZE

The struct member offsets.

static final int

SIZEOF

The struct size in bytes.

static final int

STARTVERTEX

The struct member offsets.

static final int

STRIDE

The struct member offsets.

Fields inherited from interface Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
Constructor Summary

Constructors

Constructor

Description

BGFXTransientVertexBuffer(ByteBuffer container)

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

Modifier and Type

Method

Description

static BGFXTransientVertexBuffer

calloc()

Returns a new BGFXTransientVertexBuffer instance allocated with memCalloc.

static BGFXTransientVertexBuffer.Buffer

calloc(int capacity)

Returns a new BGFXTransientVertexBuffer.Buffer instance allocated with memCalloc.

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.

static BGFXTransientVertexBuffer

calloc(MemoryStack stack)

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

static BGFXTransientVertexBuffer

create()

Returns a new BGFXTransientVertexBuffer instance allocated with BufferUtils.

static BGFXTransientVertexBuffer.Buffer

create(int capacity)

Returns a new BGFXTransientVertexBuffer.Buffer instance allocated with BufferUtils.

static BGFXTransientVertexBuffer

create(long address)

Returns a new BGFXTransientVertexBuffer instance for the specified memory address.

static BGFXTransientVertexBuffer.Buffer

create(long address, int capacity)

Create a BGFXTransientVertexBuffer.Buffer instance at the specified memory.

static @Nullable BGFXTransientVertexBuffer

createSafe(long address)

Like create, but returns null if address is NULL.

static @Nullable BGFXTransientVertexBuffer.Buffer

createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

ByteBuffer

data()

BGFXTransientVertexBuffer

data(ByteBuffer value)

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

short

handle()

BGFXTransientVertexBuffer

handle(short value)

Sets the specified value to the handle field.

short

layoutHandle()

BGFXTransientVertexBuffer

layoutHandle(short value)

Sets the specified value to the layoutHandle field.

static BGFXTransientVertexBuffer

malloc()

Returns a new BGFXTransientVertexBuffer instance allocated with memAlloc.

static BGFXTransientVertexBuffer.Buffer

malloc(int capacity)

Returns a new BGFXTransientVertexBuffer.Buffer instance allocated with memAlloc.

static BGFXTransientVertexBuffer.Buffer

malloc(int capacity, MemoryStack stack)

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

static BGFXTransientVertexBuffer

malloc(MemoryStack stack)

Returns a new BGFXTransientVertexBuffer instance allocated on the specified MemoryStack.

static ByteBuffer

ndata(long struct)

Unsafe version of data.

static void

ndata(long struct, ByteBuffer value)

Unsafe version of data.

static short

nhandle(long struct)

Unsafe version of handle().

static void

nhandle(long struct, short value)

Unsafe version of handle.

static short

nlayoutHandle(long struct)

Unsafe version of layoutHandle().

static void

nlayoutHandle(long struct, short value)

Unsafe version of layoutHandle.

static int

nsize(long struct)

Unsafe version of size().

static void

nsize(long struct, int value)

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

static int

nstartVertex(long struct)

Unsafe version of startVertex().

static void

nstartVertex(long struct, int value)

Unsafe version of startVertex.

static short

nstride(long struct)

Unsafe version of stride().

static void

nstride(long struct, short value)

Unsafe version of stride.

BGFXTransientVertexBuffer

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

Initializes this struct with the specified values.

BGFXTransientVertexBuffer

set(BGFXTransientVertexBuffer src)

Copies the specified struct data to this struct.

int

size()

int

sizeof()

Returns sizeof(struct).

int

startVertex()

BGFXTransientVertexBuffer

startVertex(int value)

Sets the specified value to the startVertex field.

short

stride()

BGFXTransientVertexBuffer

stride(short value)

Sets the specified value to the stride field.

static void

validate(long struct)

Validates pointer members that should not be NULL.

Methods inherited from class Struct
clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default
address, equals, hashCode, toString

Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface NativeResource
close, free

Field Details
- SIZEOF
  
  public static final int SIZEOF
  
  The struct size in bytes.
- ALIGNOF
  
  public static final int ALIGNOF
  
  The struct alignment in bytes.
- DATA
  
  public static final int DATA
  
  The struct member offsets.
- SIZE
  
  public static final int SIZE
  
  The struct member offsets.
- STARTVERTEX
  
  public static final int STARTVERTEX
  
  The struct member offsets.
- STRIDE
  
  public static final int STRIDE
  
  The struct member offsets.
- HANDLE
  
  public static final int HANDLE
  
  The struct member offsets.
- LAYOUTHANDLE
  
  public static final int LAYOUTHANDLE
  
  The struct member offsets.
Constructor Details
- BGFXTransientVertexBuffer
  
  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 Details
- sizeof
  
  public int sizeof()
  
  Description copied from class: Struct
  
  Returns sizeof(struct).
  
  Specified by:
  
  sizeof in class Struct<BGFXTransientVertexBuffer>
- data
  
  @NativeType("uint8_t *") public ByteBuffer data()
  
  Returns:
  
  a ByteBuffer view of the data pointed to by the data field.
- size
  
  @NativeType("uint32_t") public int size()
  
  Returns:
  
  the value of the size field.
- startVertex
  
  @NativeType("uint32_t") public int startVertex()
  
  Returns:
  
  the value of the startVertex field.
- stride
  
  @NativeType("uint16_t") public short stride()
  
  Returns:
  
  the value of the stride field.
- handle
  
  @NativeType("bgfx_vertex_buffer_handle_t") public short handle()
  
  Returns:
  
  the value of the handle field.
- layoutHandle
  
  @NativeType("bgfx_vertex_layout_handle_t") public short layoutHandle()
  
  Returns:
  
  the value of the layoutHandle field.
- data
  
  public BGFXTransientVertexBuffer data(@NativeType("uint8_t *") ByteBuffer value)
  
  Sets the address of the specified ByteBuffer to the data field.
- startVertex
  
  public BGFXTransientVertexBuffer startVertex(@NativeType("uint32_t") int value)
  
  Sets the specified value to the startVertex field.
- stride
  
  public BGFXTransientVertexBuffer stride(@NativeType("uint16_t") short value)
  
  Sets the specified value to the stride field.
- handle
  
  public BGFXTransientVertexBuffer handle(@NativeType("bgfx_vertex_buffer_handle_t") short value)
  
  Sets the specified value to the handle field.
- layoutHandle
  
  public BGFXTransientVertexBuffer layoutHandle(@NativeType("bgfx_vertex_layout_handle_t") short value)
  
  Sets the specified value to the layoutHandle field.
- set
  
  public BGFXTransientVertexBuffer set(ByteBuffer data, int startVertex, short stride, short handle, short layoutHandle)
  
  Initializes this struct with the specified values.
- set
  
  public BGFXTransientVertexBuffer set(BGFXTransientVertexBuffer src)
  
  Copies the specified struct data to this struct.
  
  Parameters:
  
  src - the source struct
  
  Returns:
  
  this struct
- malloc
  
  public static BGFXTransientVertexBuffer malloc()
  
  Returns a new BGFXTransientVertexBuffer instance allocated with memAlloc. The instance must be explicitly freed.
- calloc
  
  public static BGFXTransientVertexBuffer calloc()
  
  Returns a new BGFXTransientVertexBuffer instance allocated with memCalloc. The instance must be explicitly freed.
- create
  
  public static BGFXTransientVertexBuffer create()
  
  Returns a new BGFXTransientVertexBuffer instance allocated with BufferUtils.
- create
  
  public static BGFXTransientVertexBuffer create(long address)
  
  Returns a new BGFXTransientVertexBuffer instance for the specified memory address.
- createSafe
  
  public static @Nullable BGFXTransientVertexBuffer createSafe(long address)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static BGFXTransientVertexBuffer.Buffer malloc(int capacity)
  
  Returns a new BGFXTransientVertexBuffer.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- calloc
  
  public static BGFXTransientVertexBuffer.Buffer calloc(int capacity)
  
  Returns a new BGFXTransientVertexBuffer.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static BGFXTransientVertexBuffer.Buffer create(int capacity)
  
  Returns a new BGFXTransientVertexBuffer.Buffer instance allocated with BufferUtils.
  
  Parameters:
  
  capacity - the buffer capacity
- create
  
  public static BGFXTransientVertexBuffer.Buffer create(long address, int capacity)
  
  Create a BGFXTransientVertexBuffer.Buffer instance at the specified memory.
  
  Parameters:
  
  address - the memory address
  
  capacity - the buffer capacity
- createSafe
  
  public static @Nullable BGFXTransientVertexBuffer.Buffer createSafe(long address, int capacity)
  
  Like create, but returns null if address is NULL.
- malloc
  
  public static BGFXTransientVertexBuffer malloc(MemoryStack stack)
  
  Returns a new BGFXTransientVertexBuffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  stack - the stack from which to allocate
- calloc
  
  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 - the stack from which to allocate
- malloc
  
  public static BGFXTransientVertexBuffer.Buffer malloc(int capacity, MemoryStack stack)
  
  Returns a new BGFXTransientVertexBuffer.Buffer instance allocated on the specified MemoryStack.
  
  Parameters:
  
  capacity - the buffer capacity
  
  stack - the stack from which to allocate
- calloc
  
  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 - the buffer capacity
  
  stack - the stack from which to allocate
- ndata
  
  public static ByteBuffer ndata(long struct)
  
  Unsafe version of data.
- nsize
  
  public static int nsize(long struct)
  
  Unsafe version of size().
- nstartVertex
  
  public static int nstartVertex(long struct)
  
  Unsafe version of startVertex().
- nstride
  
  public static short nstride(long struct)
  
  Unsafe version of stride().
- nhandle
  
  public static short nhandle(long struct)
  
  Unsafe version of handle().
- nlayoutHandle
  
  public static short nlayoutHandle(long struct)
  
  Unsafe version of layoutHandle().
- ndata
  
  public static void ndata(long struct, ByteBuffer value)
  
  Unsafe version of data.
- nsize
  
  public static void nsize(long struct, int value)
  
  Sets the specified value to the size field of the specified struct.
- nstartVertex
  
  public static void nstartVertex(long struct, int value)
  
  Unsafe version of startVertex.
- nstride
  
  public static void nstride(long struct, short value)
  
  Unsafe version of stride.
- nhandle
  
  public static void nhandle(long struct, short value)
  
  Unsafe version of handle.
- nlayoutHandle
  
  public static void nlayoutHandle(long struct, short value)
  
  Unsafe version of layoutHandle.
- validate
  
  public static void validate(long struct)
  
  Validates pointer members that should not be NULL.
  
  Parameters:
  
  struct - the struct to validate

Class BGFXTransientVertexBuffer

Nested Class Summary

Nested classes/interfaces inherited from class Struct

Nested classes/interfaces inherited from interface Pointer

Field Summary

Fields inherited from interface Pointer

Constructor Summary

Method Summary

Methods inherited from class Struct

Methods inherited from class Pointer.Default

Methods inherited from class Object

Methods inherited from interface NativeResource

Field Details

SIZEOF

ALIGNOF

DATA

SIZE

STARTVERTEX

STRIDE

HANDLE

LAYOUTHANDLE

Constructor Details

BGFXTransientVertexBuffer

Method Details

sizeof

data

size

startVertex

stride

handle

layoutHandle

data

startVertex

stride

handle

layoutHandle

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

malloc

calloc

malloc

calloc

ndata

nsize

nstartVertex

nstride

nhandle

nlayoutHandle

ndata

nsize

nstartVertex

nstride

nhandle

nlayoutHandle

validate