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, NativeResource, Pointer

public class XrInstanceCreateInfo
extends Struct<XrInstanceCreateInfo>
implements NativeResource

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrInstanceCreateInfo.Buffer	An array of XrInstanceCreateInfo structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	APPLICATIONINFO	The struct member offsets.
static final int	CREATEFLAGS	The struct member offsets.
static final int	ENABLEDAPILAYERCOUNT	The struct member offsets.
static final int	ENABLEDAPILAYERNAMES	The struct member offsets.
static final int	ENABLEDEXTENSIONCOUNT	The struct member offsets.
static final int	ENABLEDEXTENSIONNAMES	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
XrInstanceCreateInfo(ByteBuffer container)	Creates a XrInstanceCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
XrApplicationInfo	applicationInfo()
XrInstanceCreateInfo	applicationInfo(Consumer<XrApplicationInfo> consumer)	Passes the applicationInfo field to the specified Consumer.
XrInstanceCreateInfo	applicationInfo(XrApplicationInfo value)	Copies the specified XrApplicationInfo to the applicationInfo field.
static XrInstanceCreateInfo	calloc()	Returns a new XrInstanceCreateInfo instance allocated with memCalloc.
static XrInstanceCreateInfo.Buffer	calloc(int capacity)	Returns a new XrInstanceCreateInfo.Buffer instance allocated with memCalloc.
static XrInstanceCreateInfo.Buffer	calloc(int capacity, MemoryStack stack)	Returns a new XrInstanceCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrInstanceCreateInfo	calloc(MemoryStack stack)	Returns a new XrInstanceCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrInstanceCreateInfo	create()	Returns a new XrInstanceCreateInfo instance allocated with BufferUtils.
static XrInstanceCreateInfo.Buffer	create(int capacity)	Returns a new XrInstanceCreateInfo.Buffer instance allocated with BufferUtils.
static XrInstanceCreateInfo	create(long address)	Returns a new XrInstanceCreateInfo instance for the specified memory address.
static XrInstanceCreateInfo.Buffer	create(long address, int capacity)	Create a XrInstanceCreateInfo.Buffer instance at the specified memory.
long	createFlags()
XrInstanceCreateInfo	createFlags(long value)	Sets the specified value to the createFlags field.
static @Nullable XrInstanceCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrInstanceCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
int	enabledApiLayerCount()
@Nullable PointerBuffer	enabledApiLayerNames()
XrInstanceCreateInfo	enabledApiLayerNames(@Nullable PointerBuffer value)	Sets the address of the specified PointerBuffer to the enabledApiLayerNames field.
int	enabledExtensionCount()
@Nullable PointerBuffer	enabledExtensionNames()
XrInstanceCreateInfo	enabledExtensionNames(@Nullable PointerBuffer value)	Sets the address of the specified PointerBuffer to the enabledExtensionNames field.
static XrInstanceCreateInfo	malloc()	Returns a new XrInstanceCreateInfo instance allocated with memAlloc.
static XrInstanceCreateInfo.Buffer	malloc(int capacity)	Returns a new XrInstanceCreateInfo.Buffer instance allocated with memAlloc.
static XrInstanceCreateInfo.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new XrInstanceCreateInfo.Buffer instance allocated on the specified MemoryStack.
static XrInstanceCreateInfo	malloc(MemoryStack stack)	Returns a new XrInstanceCreateInfo instance allocated on the specified MemoryStack.
static XrApplicationInfo	napplicationInfo(long struct)	Unsafe version of applicationInfo().
static void	napplicationInfo(long struct, XrApplicationInfo value)	Unsafe version of applicationInfo.
static long	ncreateFlags(long struct)	Unsafe version of createFlags().
static void	ncreateFlags(long struct, long value)	Unsafe version of createFlags.
static int	nenabledApiLayerCount(long struct)	Unsafe version of enabledApiLayerCount().
static void	nenabledApiLayerCount(long struct, int value)	Sets the specified value to the enabledApiLayerCount field of the specified struct.
static @Nullable PointerBuffer	nenabledApiLayerNames(long struct)	Unsafe version of enabledApiLayerNames.
static void	nenabledApiLayerNames(long struct, @Nullable PointerBuffer value)	Unsafe version of enabledApiLayerNames.
static int	nenabledExtensionCount(long struct)	Unsafe version of enabledExtensionCount().
static void	nenabledExtensionCount(long struct, int value)	Sets the specified value to the enabledExtensionCount field of the specified struct.
static @Nullable PointerBuffer	nenabledExtensionNames(long struct)	Unsafe version of enabledExtensionNames.
static void	nenabledExtensionNames(long struct, @Nullable PointerBuffer value)	Unsafe version of enabledExtensionNames.
long	next()
XrInstanceCreateInfo	next(long value)	Sets the specified value to the next field.
XrInstanceCreateInfo	next(XrDebugUtilsMessengerCreateInfoEXT value)	Prepends the specified XrDebugUtilsMessengerCreateInfoEXT value to the next chain.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrInstanceCreateInfo	set(int type, long next, long createFlags, XrApplicationInfo applicationInfo, @Nullable PointerBuffer enabledApiLayerNames, @Nullable PointerBuffer enabledExtensionNames)	Initializes this struct with the specified values.
XrInstanceCreateInfo	set(XrInstanceCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	type()
XrInstanceCreateInfo	type(int value)	Sets the specified value to the type field.
XrInstanceCreateInfo	type$Default()	Sets the TYPE_INSTANCE_CREATE_INFO value to the type field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

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()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<XrInstanceCreateInfo>

type

public int type()

Returns:

the value of the type field.

next

public long next()

Returns:

the value of the next field.

createFlags

public long createFlags()

Returns:

the value of the createFlags field.

applicationInfo

public XrApplicationInfo applicationInfo()

Returns:

a XrApplicationInfo view of the applicationInfo field.

enabledApiLayerCount

public int enabledApiLayerCount()

Returns:

the value of the enabledApiLayerCount field.

enabledApiLayerNames

public @Nullable PointerBuffer enabledApiLayerNames()

Returns:

a PointerBuffer view of the data pointed to by the enabledApiLayerNames field.

enabledExtensionCount

public int enabledExtensionCount()

Returns:

the value of the enabledExtensionCount field.

enabledExtensionNames

public @Nullable PointerBuffer enabledExtensionNames()

Returns:

a PointerBuffer view of the data pointed to by the enabledExtensionNames field.

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 PointerBuffer value)

Sets the address of the specified PointerBuffer to the enabledApiLayerNames field.

enabledExtensionNames

public XrInstanceCreateInfo enabledExtensionNames(@Nullable 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 PointerBuffer enabledApiLayerNames,
 @Nullable 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(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(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,
 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,
 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 PointerBuffer nenabledApiLayerNames(long struct)

Unsafe version of enabledApiLayerNames.

nenabledExtensionCount

public static int nenabledExtensionCount(long struct)

Unsafe version of enabledExtensionCount().

nenabledExtensionNames

public static @Nullable 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 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 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