Package org.lwjgl.openxr

Class XrInstanceCreateInfo

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<XrInstanceCreateInfo>
org.lwjgl.openxr.XrInstanceCreateInfo
All Implemented Interfaces:
AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
public class XrInstanceCreateInfo extends org.lwjgl.system.Struct<XrInstanceCreateInfo> implements org.lwjgl.system.NativeResource
Structure specifying params of a newly created instance.
Valid Usage (Implicit)
See Also

XrApplicationInfo, CreateInstance

Layout


 struct XrInstanceCreateInfo {
     XrStructureType type();
     void const * next();
     XrInstanceCreateFlags createFlags();
     XrApplicationInfo applicationInfo();
     uint32_t enabledApiLayerCount();
     char const * const * enabledApiLayerNames();
     uint32_t enabledExtensionCount();
     char const * const * enabledExtensionNames();
 }

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

    • CREATEFLAGS

      public static final int CREATEFLAGS
      The struct member offsets.

    • APPLICATIONINFO

      public static final int APPLICATIONINFO
      The struct member offsets.

    • ENABLEDAPILAYERCOUNT

      public static final int ENABLEDAPILAYERCOUNT
      The struct member offsets.

    • ENABLEDAPILAYERNAMES

      public static final int ENABLEDAPILAYERNAMES
      The struct member offsets.

    • ENABLEDEXTENSIONCOUNT

      public static final int ENABLEDEXTENSIONCOUNT
      The struct member offsets.

    • ENABLEDEXTENSIONNAMES

      public static final int ENABLEDEXTENSIONNAMES
      The struct member offsets.

  • Constructor Details

    • XrInstanceCreateInfo

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

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

    • createFlags

      public long createFlags()
      a bitmask of XrInstanceCreateFlags that identifies options that apply to the creation.

    • applicationInfo

      public XrApplicationInfo applicationInfo()
      an instance of XrApplicationInfo. This information helps runtimes recognize behavior inherent to classes of applications. XrApplicationInfo is defined in detail below.

    • enabledApiLayerCount

      public int enabledApiLayerCount()
      the number of global API layers to enable.

    • enabledApiLayerNames

      public @Nullable org.lwjgl.PointerBuffer enabledApiLayerNames()
      a pointer to an array of enabledApiLayerCount strings containing the names of API layers to enable for the created instance. See the API Layers and Extensions section for further details.

    • enabledExtensionCount

      public int enabledExtensionCount()
      the number of global extensions to enable.

    • enabledExtensionNames

      public @Nullable org.lwjgl.PointerBuffer enabledExtensionNames()
      a pointer to an array of enabledExtensionCount strings containing the names of extensions to enable.

    • type

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

    • type$Default

      public XrInstanceCreateInfo type$Default()
      Sets the TYPE_INSTANCE_CREATE_INFO value to the type() field.

    • next

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

    • next

      public XrInstanceCreateInfo next(XrDebugUtilsMessengerCreateInfoEXT value)
      Prepends the specified XrDebugUtilsMessengerCreateInfoEXT value to the next chain.

    • createFlags

      public XrInstanceCreateInfo createFlags(long value)
      Sets the specified value to the createFlags() field.

    • applicationInfo

      public XrInstanceCreateInfo applicationInfo(XrApplicationInfo value)
      Copies the specified XrApplicationInfo to the applicationInfo() field.

    • applicationInfo

      public XrInstanceCreateInfo applicationInfo(Consumer<XrApplicationInfo> consumer)
      Passes the applicationInfo() field to the specified Consumer.

    • enabledApiLayerNames

      public XrInstanceCreateInfo enabledApiLayerNames(@Nullable org.lwjgl.PointerBuffer value)
      Sets the address of the specified PointerBuffer to the enabledApiLayerNames() field.

    • enabledExtensionNames

      public XrInstanceCreateInfo enabledExtensionNames(@Nullable org.lwjgl.PointerBuffer value)
      Sets the address of the specified PointerBuffer to the enabledExtensionNames() field.

    • set

      public XrInstanceCreateInfo set(int type, long next, long createFlags, XrApplicationInfo applicationInfo, @Nullable org.lwjgl.PointerBuffer enabledApiLayerNames, @Nullable org.lwjgl.PointerBuffer enabledExtensionNames)
      Initializes this struct with the specified values.

    • set

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • create

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

    • create

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

    • createSafe

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

    • malloc

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

    • calloc

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

    • malloc

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

    • calloc

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

    • ncreateFlags

      public static long ncreateFlags(long struct)
      Unsafe version of createFlags().

    • napplicationInfo

      public static XrApplicationInfo napplicationInfo(long struct)
      Unsafe version of applicationInfo().

    • nenabledApiLayerCount

      public static int nenabledApiLayerCount(long struct)
      Unsafe version of enabledApiLayerCount().

    • nenabledApiLayerNames

      public static @Nullable org.lwjgl.PointerBuffer nenabledApiLayerNames(long struct)
      Unsafe version of enabledApiLayerNames.

    • nenabledExtensionCount

      public static int nenabledExtensionCount(long struct)
      Unsafe version of enabledExtensionCount().

    • nenabledExtensionNames

      public static @Nullable org.lwjgl.PointerBuffer nenabledExtensionNames(long struct)
      Unsafe version of enabledExtensionNames.

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

    • ncreateFlags

      public static void ncreateFlags(long struct, long value)
      Unsafe version of createFlags.

    • napplicationInfo

      public static void napplicationInfo(long struct, XrApplicationInfo value)
      Unsafe version of applicationInfo.

    • nenabledApiLayerCount

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

    • nenabledApiLayerNames

      public static void nenabledApiLayerNames(long struct, @Nullable org.lwjgl.PointerBuffer value)
      Unsafe version of enabledApiLayerNames.

    • nenabledExtensionCount

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

    • nenabledExtensionNames

      public static void nenabledExtensionNames(long struct, @Nullable org.lwjgl.PointerBuffer value)
      Unsafe version of enabledExtensionNames.

    • validate

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