Package org.lwjgl.openxr

Class XrFutureCompletionEXT

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrFutureCompletionEXT>
org.lwjgl.openxr.XrFutureCompletionEXT
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrFutureCompletionEXT extends org.lwjgl.system.Struct<XrFutureCompletionEXT> implements org.lwjgl.system.NativeResource
Implementation of the XrResult-only completion structure.
Description

This is a minimal implementation of XrFutureCompletionBaseHeaderEXT, containing only the fields present in the base header structure. It is intended for use by asynchronous operations that do not have other outputs or return values beyond an XrResult value, as the output parameter of their completion function.

Valid Usage (Implicit)

Layout


 struct XrFutureCompletionEXT {
     XrStructureType type();
     void * next();
     XrResult futureResult();
 }

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

    • FUTURERESULT

      public static final int FUTURERESULT
      The struct member offsets.

  • Constructor Details

    • XrFutureCompletionEXT

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

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

    • futureResult

      public int futureResult()
      XrResult of the async operation associated with future passed to the completion function.

    • type

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

    • type$Default

      public XrFutureCompletionEXT type$Default()
      Sets the TYPE_FUTURE_COMPLETION_EXT value to the type() field.

    • next

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

    • futureResult

      public XrFutureCompletionEXT futureResult(int value)
      Sets the specified value to the futureResult() field.

    • set

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

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • create

      public static XrFutureCompletionEXT create(XrFutureCompletionBaseHeaderEXT value)
      Downcasts the specified XrFutureCompletionBaseHeaderEXT instance to XrFutureCompletionEXT.

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • create

      public static XrFutureCompletionEXT.Buffer create(XrFutureCompletionBaseHeaderEXT.Buffer value)
      Downcasts the specified XrFutureCompletionBaseHeaderEXT.Buffer instance to XrFutureCompletionEXT.Buffer.

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • nfutureResult

      public static int nfutureResult(long struct)
      Unsafe version of futureResult().

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

    • nfutureResult

      public static void nfutureResult(long struct, int value)
      Unsafe version of futureResult.