Package org.lwjgl.openxr

Class XrRenderModelBufferFB

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrRenderModelBufferFB>
org.lwjgl.openxr.XrRenderModelBufferFB
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrRenderModelBufferFB extends org.lwjgl.system.Struct<XrRenderModelBufferFB> implements org.lwjgl.system.NativeResource
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();
 }

  • Field Details

    • SIZEOF

      public static final int SIZEOF
      The struct size in bytes.

    • ALIGNOF

      public static final int ALIGNOF
      The struct alignment in bytes.

    • TYPE

      public static final int TYPE
      The struct member offsets.

    • NEXT

      public static final int NEXT
      The struct member offsets.

    • BUFFERCAPACITYINPUT

      public static final int BUFFERCAPACITYINPUT
      The struct member offsets.

    • BUFFERCOUNTOUTPUT

      public static final int BUFFERCOUNTOUTPUT
      The struct member offsets.

    • BUFFER

      public static final int BUFFER
      The struct member offsets.

  • Constructor Details

    • XrRenderModelBufferFB

      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 Details

    • sizeof

      public int sizeof()
      Specified by:
      sizeof in class org.lwjgl.system.Struct<XrRenderModelBufferFB>

    • type

      public int type()
      the XrStructureType of this structure.

    • next

      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.

    • bufferCapacityInput

      public int bufferCapacityInput()
      the capacity of the buffer, or 0 to retrieve the required capacity.

    • bufferCountOutput

      public int bufferCountOutput()
      the count of uint8_t buffer written, or the required capacity in the case that bufferCapacityInput is insufficient.

    • buffer

      public @Nullable ByteBuffer buffer()
      a pointer to an application-allocated array that will be filled with the render model binary data.

    • type

      public XrRenderModelBufferFB type(int value)
      Sets the specified value to the type() field.

    • type$Default

      public XrRenderModelBufferFB type$Default()
      Sets the TYPE_RENDER_MODEL_BUFFER_FB value to the type() field.

    • next

      public XrRenderModelBufferFB next(long value)
      Sets the specified value to the next() field.

    • bufferCapacityInput

      public XrRenderModelBufferFB bufferCapacityInput(int value)
      Sets the specified value to the bufferCapacityInput() field.

    • bufferCountOutput

      public XrRenderModelBufferFB bufferCountOutput(int value)
      Sets the specified value to the bufferCountOutput() field.

    • buffer

      public XrRenderModelBufferFB buffer(@Nullable ByteBuffer value)
      Sets the address of the specified ByteBuffer to the buffer() field.

    • set

      public XrRenderModelBufferFB set(int type, long next, int bufferCapacityInput, int bufferCountOutput, @Nullable ByteBuffer buffer)
      Initializes this struct with the specified values.

    • set

      public XrRenderModelBufferFB set(XrRenderModelBufferFB src)
      Copies the specified struct data to this struct.
      Parameters:
      src - the source struct
      Returns:
      this struct

    • malloc

      public static XrRenderModelBufferFB malloc()
      Returns a new XrRenderModelBufferFB instance allocated with memAlloc. The instance must be explicitly freed.

    • calloc

      public static XrRenderModelBufferFB calloc()
      Returns a new XrRenderModelBufferFB instance allocated with memCalloc. The instance must be explicitly freed.

    • create

      public static XrRenderModelBufferFB create()
      Returns a new XrRenderModelBufferFB instance allocated with BufferUtils.

    • create

      public static XrRenderModelBufferFB create(long address)
      Returns a new XrRenderModelBufferFB instance for the specified memory address.

    • createSafe

      public static @Nullable XrRenderModelBufferFB createSafe(long address)
      Like create, but returns null if address is NULL.

    • malloc

      public static XrRenderModelBufferFB.Buffer malloc(int capacity)
      Returns a new XrRenderModelBufferFB.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • calloc

      public static XrRenderModelBufferFB.Buffer calloc(int capacity)
      Returns a new XrRenderModelBufferFB.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
      Parameters:
      capacity - the buffer capacity

    • create

      public static XrRenderModelBufferFB.Buffer create(int capacity)
      Returns a new XrRenderModelBufferFB.Buffer instance allocated with BufferUtils.
      Parameters:
      capacity - the buffer capacity

    • create

      public static XrRenderModelBufferFB.Buffer create(long address, int capacity)
      Create a XrRenderModelBufferFB.Buffer instance at the specified memory.
      Parameters:
      address - the memory address
      capacity - the buffer capacity

    • createSafe

      public static @Nullable XrRenderModelBufferFB.Buffer createSafe(long address, int capacity)
      Like create, but returns null if address is NULL.

    • malloc

      public static XrRenderModelBufferFB malloc(org.lwjgl.system.MemoryStack stack)
      Returns a new XrRenderModelBufferFB instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static XrRenderModelBufferFB calloc(org.lwjgl.system.MemoryStack stack)
      Returns a new XrRenderModelBufferFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      stack - the stack from which to allocate

    • malloc

      public static XrRenderModelBufferFB.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new XrRenderModelBufferFB.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

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

    • ntype

      public static int ntype(long struct)
      Unsafe version of type().

    • nnext

      public static long nnext(long struct)
      Unsafe version of next().

    • nbufferCapacityInput

      public static int nbufferCapacityInput(long struct)
      Unsafe version of bufferCapacityInput().

    • nbufferCountOutput

      public static int nbufferCountOutput(long struct)
      Unsafe version of bufferCountOutput().

    • nbuffer

      public static @Nullable ByteBuffer nbuffer(long struct)
      Unsafe version of buffer.

    • ntype

      public static void ntype(long struct, int value)
      Unsafe version of type.

    • nnext

      public static void nnext(long struct, long value)
      Unsafe version of next.

    • nbufferCapacityInput

      public static void nbufferCapacityInput(long struct, int value)
      Sets the specified value to the bufferCapacityInput field of the specified struct.

    • nbufferCountOutput

      public static void nbufferCountOutput(long struct, int value)
      Unsafe version of bufferCountOutput.

    • nbuffer

      public static void nbuffer(long struct, @Nullable ByteBuffer value)
      Unsafe version of buffer.