Package org.lwjgl.openxr
Class XrInstanceCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrInstanceCreateInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrInstanceCreateInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying params of a newly created instance.Valid Usage (Implicit)
typemust beTYPE_INSTANCE_CREATE_INFOnextmust beNULLor a valid pointer to the next structure in a structure chain. See also:XrDebugUtilsMessengerCreateInfoEXTcreateFlagsmust be 0applicationInfomust be a validXrApplicationInfostructure- If
enabledApiLayerCountis not 0,enabledApiLayerNamesmust be a pointer to an array ofenabledApiLayerCountnull-terminated UTF-8 strings - If
enabledExtensionCountis not 0,enabledExtensionNamesmust be a pointer to an array ofenabledExtensionCountnull-terminated UTF-8 strings
See Also
XrApplicationInfo,CreateInstanceLayout
struct XrInstanceCreateInfo { XrStructureTypetype(); void const *next(); XrInstanceCreateFlagscreateFlags();XrApplicationInfoapplicationInfo(); uint32_tenabledApiLayerCount(); char const * const *enabledApiLayerNames(); uint32_tenabledExtensionCount(); char const * const *enabledExtensionNames(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrInstanceCreateInfo.BufferAn array ofXrInstanceCreateInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intAPPLICATIONINFO
CREATEFLAGS
ENABLEDAPILAYERCOUNT
ENABLEDAPILAYERNAMES
ENABLEDEXTENSIONCOUNT
ENABLEDEXTENSIONNAMES
NEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description XrInstanceCreateInfo(java.nio.ByteBuffer container)Creates aXrInstanceCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description XrApplicationInfoapplicationInfo()an instance ofXrApplicationInfo.XrInstanceCreateInfoapplicationInfo(java.util.function.Consumer<XrApplicationInfo> consumer)Passes theapplicationInfo()field to the specifiedConsumer.XrInstanceCreateInfoapplicationInfo(XrApplicationInfo value)Copies the specifiedXrApplicationInfoto theapplicationInfo()field.static XrInstanceCreateInfocalloc()Returns a newXrInstanceCreateInfoinstance allocated withmemCalloc.static XrInstanceCreateInfo.Buffercalloc(int capacity)Returns a newXrInstanceCreateInfo.Bufferinstance allocated withmemCalloc.static XrInstanceCreateInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrInstanceCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrInstanceCreateInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrInstanceCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrInstanceCreateInfocreate()Returns a newXrInstanceCreateInfoinstance allocated withBufferUtils.static XrInstanceCreateInfo.Buffercreate(int capacity)Returns a newXrInstanceCreateInfo.Bufferinstance allocated withBufferUtils.static XrInstanceCreateInfocreate(long address)Returns a newXrInstanceCreateInfoinstance for the specified memory address.static XrInstanceCreateInfo.Buffercreate(long address, int capacity)Create aXrInstanceCreateInfo.Bufferinstance at the specified memory.longcreateFlags()a bitmask ofXrInstanceCreateFlagsthat identifies options that apply to the creation.XrInstanceCreateInfocreateFlags(long value)Sets the specified value to thecreateFlags()field.static XrInstanceCreateInfocreateSafe(long address)static XrInstanceCreateInfo.BuffercreateSafe(long address, int capacity)intenabledApiLayerCount()the number of global API layers to enable.org.lwjgl.PointerBufferenabledApiLayerNames()a pointer to an array ofenabledApiLayerCountstrings containing the names of API layers to enable for the created instance.XrInstanceCreateInfoenabledApiLayerNames(org.lwjgl.PointerBuffer value)Sets the address of the specifiedPointerBufferto theenabledApiLayerNames()field.intenabledExtensionCount()the number of global extensions to enable.org.lwjgl.PointerBufferenabledExtensionNames()a pointer to an array ofenabledExtensionCountstrings containing the names of extensions to enable.XrInstanceCreateInfoenabledExtensionNames(org.lwjgl.PointerBuffer value)Sets the address of the specifiedPointerBufferto theenabledExtensionNames()field.static XrInstanceCreateInfomalloc()Returns a newXrInstanceCreateInfoinstance allocated withmemAlloc.static XrInstanceCreateInfo.Buffermalloc(int capacity)Returns a newXrInstanceCreateInfo.Bufferinstance allocated withmemAlloc.static XrInstanceCreateInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrInstanceCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static XrInstanceCreateInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrInstanceCreateInfoinstance allocated on the specifiedMemoryStack.static XrApplicationInfonapplicationInfo(long struct)Unsafe version ofapplicationInfo().static voidnapplicationInfo(long struct, XrApplicationInfo value)Unsafe version ofapplicationInfo.static longncreateFlags(long struct)Unsafe version ofcreateFlags().static voidncreateFlags(long struct, long value)Unsafe version ofcreateFlags.static intnenabledApiLayerCount(long struct)Unsafe version ofenabledApiLayerCount().static voidnenabledApiLayerCount(long struct, int value)Sets the specified value to theenabledApiLayerCountfield of the specifiedstruct.static org.lwjgl.PointerBuffernenabledApiLayerNames(long struct)Unsafe version ofenabledApiLayerNames.static voidnenabledApiLayerNames(long struct, org.lwjgl.PointerBuffer value)Unsafe version ofenabledApiLayerNames.static intnenabledExtensionCount(long struct)Unsafe version ofenabledExtensionCount().static voidnenabledExtensionCount(long struct, int value)Sets the specified value to theenabledExtensionCountfield of the specifiedstruct.static org.lwjgl.PointerBuffernenabledExtensionNames(long struct)Unsafe version ofenabledExtensionNames.static voidnenabledExtensionNames(long struct, org.lwjgl.PointerBuffer value)Unsafe version ofenabledExtensionNames.longnext()NULLor a pointer to the next structure in a structure chain.XrInstanceCreateInfonext(long value)Sets the specified value to thenext()field.XrInstanceCreateInfonext(XrDebugUtilsMessengerCreateInfoEXT value)Prepends the specifiedXrDebugUtilsMessengerCreateInfoEXTvalue to thenextchain.static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.XrInstanceCreateInfoset(int type, long next, long createFlags, XrApplicationInfo applicationInfo, org.lwjgl.PointerBuffer enabledApiLayerNames, org.lwjgl.PointerBuffer enabledExtensionNames)Initializes this struct with the specified values.XrInstanceCreateInfoset(XrInstanceCreateInfo src)Copies the specified struct data to this struct.intsizeof()inttype()theXrStructureTypeof this structure.XrInstanceCreateInfotype(int value)Sets the specified value to thetype()field.XrInstanceCreateInfotype$Default()Sets theTYPE_INSTANCE_CREATE_INFOvalue to thetype()field.static voidvalidate(long struct)Validates pointer members that should not beNULL.
-
-
-
Constructor Detail
-
XrInstanceCreateInfo
public XrInstanceCreateInfo(java.nio.ByteBuffer container)
Creates aXrInstanceCreateInfoinstance at the current position of the specifiedByteBuffercontainer. 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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
type
public int type()
theXrStructureTypeof this structure.
-
next
public long next()
NULLor a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.
-
createFlags
public long createFlags()
a bitmask ofXrInstanceCreateFlagsthat identifies options that apply to the creation.
-
applicationInfo
public XrApplicationInfo applicationInfo()
an instance ofXrApplicationInfo. This information helps runtimes recognize behavior inherent to classes of applications.XrApplicationInfois defined in detail below.
-
enabledApiLayerCount
public int enabledApiLayerCount()
the number of global API layers to enable.
-
enabledApiLayerNames
@Nullable public org.lwjgl.PointerBuffer enabledApiLayerNames()
a pointer to an array ofenabledApiLayerCountstrings 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
@Nullable public org.lwjgl.PointerBuffer enabledExtensionNames()
a pointer to an array ofenabledExtensionCountstrings containing the names of extensions to enable.
-
type
public XrInstanceCreateInfo type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrInstanceCreateInfo type$Default()
Sets theTYPE_INSTANCE_CREATE_INFOvalue to thetype()field.
-
next
public XrInstanceCreateInfo next(long value)
Sets the specified value to thenext()field.
-
next
public XrInstanceCreateInfo next(XrDebugUtilsMessengerCreateInfoEXT value)
Prepends the specifiedXrDebugUtilsMessengerCreateInfoEXTvalue to thenextchain.
-
createFlags
public XrInstanceCreateInfo createFlags(long value)
Sets the specified value to thecreateFlags()field.
-
applicationInfo
public XrInstanceCreateInfo applicationInfo(XrApplicationInfo value)
Copies the specifiedXrApplicationInfoto theapplicationInfo()field.
-
applicationInfo
public XrInstanceCreateInfo applicationInfo(java.util.function.Consumer<XrApplicationInfo> consumer)
Passes theapplicationInfo()field to the specifiedConsumer.
-
enabledApiLayerNames
public XrInstanceCreateInfo enabledApiLayerNames(@Nullable org.lwjgl.PointerBuffer value)
Sets the address of the specifiedPointerBufferto theenabledApiLayerNames()field.
-
enabledExtensionNames
public XrInstanceCreateInfo enabledExtensionNames(@Nullable org.lwjgl.PointerBuffer value)
Sets the address of the specifiedPointerBufferto theenabledExtensionNames()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 newXrInstanceCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrInstanceCreateInfo calloc()
Returns a newXrInstanceCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrInstanceCreateInfo create()
Returns a newXrInstanceCreateInfoinstance allocated withBufferUtils.
-
create
public static XrInstanceCreateInfo create(long address)
Returns a newXrInstanceCreateInfoinstance for the specified memory address.
-
createSafe
@Nullable public static XrInstanceCreateInfo createSafe(long address)
-
malloc
public static XrInstanceCreateInfo.Buffer malloc(int capacity)
Returns a newXrInstanceCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrInstanceCreateInfo.Buffer calloc(int capacity)
Returns a newXrInstanceCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrInstanceCreateInfo.Buffer create(int capacity)
Returns a newXrInstanceCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrInstanceCreateInfo.Buffer create(long address, int capacity)
Create aXrInstanceCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrInstanceCreateInfo.Buffer createSafe(long address, int capacity)
-
malloc
public static XrInstanceCreateInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrInstanceCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrInstanceCreateInfo calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrInstanceCreateInfoinstance allocated on the specifiedMemoryStackand 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 newXrInstanceCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrInstanceCreateInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrInstanceCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
ntype
public static int ntype(long struct)
Unsafe version oftype().
-
nnext
public static long nnext(long struct)
Unsafe version ofnext().
-
ncreateFlags
public static long ncreateFlags(long struct)
Unsafe version ofcreateFlags().
-
napplicationInfo
public static XrApplicationInfo napplicationInfo(long struct)
Unsafe version ofapplicationInfo().
-
nenabledApiLayerCount
public static int nenabledApiLayerCount(long struct)
Unsafe version ofenabledApiLayerCount().
-
nenabledApiLayerNames
@Nullable public static org.lwjgl.PointerBuffer nenabledApiLayerNames(long struct)
Unsafe version ofenabledApiLayerNames.
-
nenabledExtensionCount
public static int nenabledExtensionCount(long struct)
Unsafe version ofenabledExtensionCount().
-
nenabledExtensionNames
@Nullable public static org.lwjgl.PointerBuffer nenabledExtensionNames(long struct)
Unsafe version ofenabledExtensionNames.
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
nnext
public static void nnext(long struct, long value)Unsafe version ofnext.
-
ncreateFlags
public static void ncreateFlags(long struct, long value)Unsafe version ofcreateFlags.
-
napplicationInfo
public static void napplicationInfo(long struct, XrApplicationInfo value)Unsafe version ofapplicationInfo.
-
nenabledApiLayerCount
public static void nenabledApiLayerCount(long struct, int value)Sets the specified value to theenabledApiLayerCountfield of the specifiedstruct.
-
nenabledApiLayerNames
public static void nenabledApiLayerNames(long struct, @Nullable org.lwjgl.PointerBuffer value)Unsafe version ofenabledApiLayerNames.
-
nenabledExtensionCount
public static void nenabledExtensionCount(long struct, int value)Sets the specified value to theenabledExtensionCountfield of the specifiedstruct.
-
nenabledExtensionNames
public static void nenabledExtensionNames(long struct, @Nullable org.lwjgl.PointerBuffer value)Unsafe version ofenabledExtensionNames.
-
validate
public static void validate(long struct)
Validates pointer members that should not beNULL.- Parameters:
struct- the struct to validate
-
-