Package org.lwjgl.openxr

Class XrEventDataBuffer

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrEventDataBuffer>
org.lwjgl.openxr.XrEventDataBuffer
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrEventDataBuffer extends org.lwjgl.system.Struct<XrEventDataBuffer> implements org.lwjgl.system.NativeResource
Event buffer.
Description

The XrEventDataBuffer is a structure passed to PollEvent large enough to contain any returned event data element. The maximum size is specified by MAX_EVENT_DATA_SIZE.

An application can set (or reset) only the type member and clear the next member of an XrEventDataBuffer before passing it as an input to PollEvent. The runtime must ignore the contents of the varying field and overwrite it without reading it.

A pointer to an XrEventDataBuffer may be type-cast to an XrEventDataBaseHeader pointer, or a pointer to any other appropriate event data based on the type parameter.

Valid Usage (Implicit)
See Also

XrEventDataBaseHeader, PollEvent

Layout


 struct XrEventDataBuffer {
     XrStructureType type();
     void const * next();
     uint8_t varying()[4000];
 }

  • 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.

    • VARYING

      public static final int VARYING
      The struct member offsets.

  • Constructor Details

    • XrEventDataBuffer

      public XrEventDataBuffer(ByteBuffer container)
      Creates a XrEventDataBuffer 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<XrEventDataBuffer>

    • 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.

    • varying

      public ByteBuffer varying()
      a fixed sized output buffer big enough to hold returned data elements for all specified event data types.

    • varying

      public byte varying(int index)
      a fixed sized output buffer big enough to hold returned data elements for all specified event data types.

    • type

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

    • type$Default

      public XrEventDataBuffer type$Default()
      Sets the TYPE_EVENT_DATA_BUFFER value to the type() field.

    • next

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

    • varying

      public XrEventDataBuffer varying(ByteBuffer value)
      Copies the specified ByteBuffer to the varying() field.

    • varying

      public XrEventDataBuffer varying(int index, byte value)
      Sets the specified value at the specified index of the varying() field.

    • set

      public XrEventDataBuffer set(int type, long next, ByteBuffer varying)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nvarying

      public static ByteBuffer nvarying(long struct)
      Unsafe version of varying().

    • nvarying

      public static byte nvarying(long struct, int index)
      Unsafe version of varying.

    • 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.

    • nvarying

      public static void nvarying(long struct, ByteBuffer value)
      Unsafe version of varying.

    • nvarying

      public static void nvarying(long struct, int index, byte value)
      Unsafe version of varying.