Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrRenderModelBufferFB

extends Struct<XrRenderModelBufferFB>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

The buffer containing the data for the render model.
Description

XrRenderModelBufferFB is used when loading the binary data for a render model. XrRenderModelBufferFB must be provided when calling LoadRenderModelFB.

Valid Usage (Implicit)
See Also

LoadRenderModelFB

Layout


struct XrRenderModelBufferFB {
    XrStructureType type;
    void * next;
    uint32_t bufferCapacityInput;
    uint32_t bufferCountOutput;
    uint8_t * buffer;
}

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
BUFFER

The struct member offsets.

public static final int
BUFFERCAPACITYINPUT

The struct member offsets.

public static final int
BUFFERCOUNTOUTPUT

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrRenderModelBufferFB(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public ByteBuffer
buffer()

a pointer to an application-allocated array that will be filled with the render model binary data.

public XrRenderModelBufferFB
buffer(ByteBuffer value)

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

public int
bufferCapacityInput()

the capacity of the buffer, or 0 to retrieve the required capacity.

public XrRenderModelBufferFB
bufferCapacityInput(int value)

Sets the specified value to the bufferCapacityInput field.

public int
bufferCountOutput()

the count of uint8_t buffer written, or the required capacity in the case that bufferCapacityInput is insufficient.

public XrRenderModelBufferFB
bufferCountOutput(int value)

Sets the specified value to the bufferCountOutput field.

public static XrRenderModelBufferFB
calloc()

Returns a new XrRenderModelBufferFB instance allocated with memCalloc.

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

Returns a new XrRenderModelBufferFB.Buffer instance allocated with memCalloc.

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

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

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

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

protected XrRenderModelBufferFB
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 XrRenderModelBufferFB
create()

Returns a new XrRenderModelBufferFB instance allocated with BufferUtils.

public static XrRenderModelBufferFB
create(long address)

Returns a new XrRenderModelBufferFB instance for the specified memory address.

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

Returns a new XrRenderModelBufferFB.Buffer instance allocated with BufferUtils.

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

Create a XrRenderModelBufferFB.Buffer instance at the specified memory.

public static XrRenderModelBufferFB
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrRenderModelBufferFB
malloc()

Returns a new XrRenderModelBufferFB instance allocated with memAlloc.

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

Returns a new XrRenderModelBufferFB.Buffer instance allocated with memAlloc.

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

Returns a new XrRenderModelBufferFB instance allocated on the specified MemoryStack.

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

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

public static ByteBuffer
nbuffer(long struct)

Unsafe version of buffer.

public static void
nbuffer(long struct, ByteBuffer value)

Unsafe version of buffer.

public static int
nbufferCapacityInput(long struct)

Unsafe version of bufferCapacityInput.

public static void
nbufferCapacityInput(long struct, int value)

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

public static int
nbufferCountOutput(long struct)

Unsafe version of bufferCountOutput.

public static void
nbufferCountOutput(long struct, int value)

Unsafe version of bufferCountOutput.

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrRenderModelBufferFB
next(long value)

Sets the specified value to the next field.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrRenderModelBufferFB
set(int type, long next, int bufferCapacityInput, int bufferCountOutput, ByteBuffer buffer)

Initializes this struct with the specified values.

public XrRenderModelBufferFB

Returns:

this struct
set
(XrRenderModelBufferFB
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
type()

the XrStructureType of this structure.

public XrRenderModelBufferFB
type(int value)

Sets the specified value to the type field.

public XrRenderModelBufferFB
type$Default()

Sets the TYPE_RENDER_MODEL_BUFFER_FB value to the type 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.

BUFFERback to summary
public static final int BUFFER

The struct member offsets.

BUFFERCAPACITYINPUTback to summary
public static final int BUFFERCAPACITYINPUT

The struct member offsets.

BUFFERCOUNTOUTPUTback to summary
public static final int BUFFERCOUNTOUTPUT

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrRenderModelBufferFBback to summary
protected XrRenderModelBufferFB(long address, ByteBuffer container)
XrRenderModelBufferFBback to summary
public XrRenderModelBufferFB(ByteBuffer container)

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

bufferback to summary
public ByteBuffer buffer()

a pointer to an application-allocated array that will be filled with the render model binary data.

Annotations
@Nullable
@NativeType:uint8_t *
bufferback to summary
public XrRenderModelBufferFB buffer(ByteBuffer value)

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

bufferCapacityInputback to summary
public int bufferCapacityInput()

the capacity of the buffer, or 0 to retrieve the required capacity.

Annotations
@NativeType:uint32_t
bufferCapacityInputback to summary
public XrRenderModelBufferFB bufferCapacityInput(int value)

Sets the specified value to the bufferCapacityInput field.

bufferCountOutputback to summary
public int bufferCountOutput()

the count of uint8_t buffer written, or the required capacity in the case that bufferCapacityInput is insufficient.

Annotations
@NativeType:uint32_t
bufferCountOutputback to summary
public XrRenderModelBufferFB bufferCountOutput(int value)

Sets the specified value to the bufferCountOutput field.

callocback to summary
public static XrRenderModelBufferFB calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrRenderModelBufferFB calloc(MemoryStack stack)

Returns a new XrRenderModelBufferFB 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 XrRenderModelBufferFB.Buffer calloc(int capacity, MemoryStack stack)

Returns a new XrRenderModelBufferFB.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

createback to summary
protected XrRenderModelBufferFB 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 XrRenderModelBufferFB create()

Returns a new XrRenderModelBufferFB instance allocated with BufferUtils.

createback to summary
public static XrRenderModelBufferFB create(long address)

Returns a new XrRenderModelBufferFB instance for the specified memory address.

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

Returns a new XrRenderModelBufferFB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrRenderModelBufferFB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrRenderModelBufferFB createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrRenderModelBufferFB malloc(MemoryStack stack)

Returns a new XrRenderModelBufferFB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nbufferback to summary
public static ByteBuffer nbuffer(long struct)

Unsafe version of buffer.

Annotations
@Nullable
nbufferback to summary
public static void nbuffer(long struct, ByteBuffer value)

Unsafe version of buffer.

nbufferCapacityInputback to summary
public static int nbufferCapacityInput(long struct)

Unsafe version of bufferCapacityInput.

nbufferCapacityInputback to summary
public static void nbufferCapacityInput(long struct, int value)

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

nbufferCountOutputback to summary
public static int nbufferCountOutput(long struct)

Unsafe version of bufferCountOutput.

nbufferCountOutputback to summary
public static void nbufferCountOutput(long struct, int value)

Unsafe version of bufferCountOutput.

nextback to summary
public long next()

NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.

Annotations
@NativeType:void *
nextback to summary
public XrRenderModelBufferFB next(long value)

Sets the specified value to the next field.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

setback to summary
public XrRenderModelBufferFB set(int type, long next, int bufferCapacityInput, int bufferCountOutput, ByteBuffer buffer)

Initializes this struct with the specified values.

setback to summary
public XrRenderModelBufferFB set(XrRenderModelBufferFB src)

Copies the specified struct data to this struct.

Parameters
src:XrRenderModelBufferFB

the source struct

Returns:XrRenderModelBufferFB

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
typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrRenderModelBufferFB type(int value)

Sets the specified value to the type field.

type$Defaultback to summary
public XrRenderModelBufferFB type$Default()

Sets the TYPE_RENDER_MODEL_BUFFER_FB value to the type field.

org.lwjgl.openxr back to summary

public Class XrRenderModelBufferFB.Buffer

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

An array of XrRenderModelBufferFB structs.

Field Summary

Modifier and TypeField and Description
private static final XrRenderModelBufferFB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrRenderModelBufferFB.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 XrRenderModelBufferFB#buffer field.
buffer
()

public XrRenderModelBufferFB.Buffer
buffer(ByteBuffer value)

Sets the address of the specified ByteBuffer to the XrRenderModelBufferFB#buffer field.

public int
public XrRenderModelBufferFB.Buffer
bufferCapacityInput(int value)

Sets the specified value to the XrRenderModelBufferFB#bufferCapacityInput field.

public int
public XrRenderModelBufferFB.Buffer
bufferCountOutput(int value)

Sets the specified value to the XrRenderModelBufferFB#bufferCountOutput field.

protected XrRenderModelBufferFB
public long

Returns:

the value of the XrRenderModelBufferFB#next field.
next
()

public XrRenderModelBufferFB.Buffer
next(long value)

Sets the specified value to the XrRenderModelBufferFB#next field.

protected XrRenderModelBufferFB.Buffer
public int

Returns:

the value of the XrRenderModelBufferFB#type field.
type
()

public XrRenderModelBufferFB.Buffer
type(int value)

Sets the specified value to the XrRenderModelBufferFB#type field.

public XrRenderModelBufferFB.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrRenderModelBufferFB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrRenderModelBufferFB.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 XrRenderModelBufferFB#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

bufferback to summary
public ByteBuffer buffer()
Returns:ByteBuffer

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

Annotations
@Nullable
@NativeType:uint8_t *
bufferback to summary
public XrRenderModelBufferFB.Buffer buffer(ByteBuffer value)

Sets the address of the specified ByteBuffer to the XrRenderModelBufferFB#buffer field.

bufferCapacityInputback to summary
public int bufferCapacityInput()
Returns:int

the value of the XrRenderModelBufferFB#bufferCapacityInput field.

Annotations
@NativeType:uint32_t
bufferCapacityInputback to summary
public XrRenderModelBufferFB.Buffer bufferCapacityInput(int value)

Sets the specified value to the XrRenderModelBufferFB#bufferCapacityInput field.

bufferCountOutputback to summary
public int bufferCountOutput()
Returns:int

the value of the XrRenderModelBufferFB#bufferCountOutput field.

Annotations
@NativeType:uint32_t
bufferCountOutputback to summary
public XrRenderModelBufferFB.Buffer bufferCountOutput(int value)

Sets the specified value to the XrRenderModelBufferFB#bufferCountOutput field.

getElementFactoryback to summary
protected XrRenderModelBufferFB getElementFactory()

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

Annotations
@Override
nextback to summary
public long next()
Returns:long

the value of the XrRenderModelBufferFB#next field.

Annotations
@NativeType:void *
nextback to summary
public XrRenderModelBufferFB.Buffer next(long value)

Sets the specified value to the XrRenderModelBufferFB#next field.

selfback to summary
protected XrRenderModelBufferFB.Buffer self()

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

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrRenderModelBufferFB#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrRenderModelBufferFB.Buffer type(int value)

Sets the specified value to the XrRenderModelBufferFB#type field.

type$Defaultback to summary
public XrRenderModelBufferFB.Buffer type$Default()

Sets the TYPE_RENDER_MODEL_BUFFER_FB value to the XrRenderModelBufferFB#type field.