Package org.lwjgl.openxr

Class XrBaseOutStructure

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrBaseOutStructure>
org.lwjgl.openxr.XrBaseOutStructure
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrBaseOutStructure extends org.lwjgl.system.Struct<XrBaseOutStructure> implements org.lwjgl.system.NativeResource
Convenience type for iterating (mutable).
Description

XrBaseOutStructure can be used to facilitate iterating through a structure pointer chain that returns data back to the application.

See Also

XrBaseInStructure, XrBaseOutStructure

Layout


 struct XrBaseOutStructure {
     XrStructureType type();
     XrBaseOutStructure * next();
 }

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

  • Constructor Details

    • XrBaseOutStructure

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

    • type

      public int type()
      the XrStructureType of this structure. This base structure itself has no associated XrStructureType value.

    • next

      public XrBaseOutStructure next()
      NULL or a pointer to the next structure in a structure chain.

    • type

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

    • next

      public XrBaseOutStructure next(XrBaseOutStructure value)
      Sets the address of the specified XrBaseOutStructure to the next() field.

    • set

      public XrBaseOutStructure set(int type, XrBaseOutStructure next)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

      public static XrBaseOutStructure.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
      Returns a new XrBaseOutStructure.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 XrBaseOutStructure nnext(long struct)
      Unsafe version of next().

    • ntype

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

    • nnext

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

    • validate

      public static void validate(long struct)
      Validates pointer members that should not be NULL.
      Parameters:
      struct - the struct to validate