Package org.lwjgl.openxr

Class XrSessionCreateInfo

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSessionCreateInfo>

org.lwjgl.openxr.XrSessionCreateInfo

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class XrSessionCreateInfo
extends org.lwjgl.system.Struct<XrSessionCreateInfo>
implements org.lwjgl.system.NativeResource

Creates a session.

Valid Usage

• systemId must be a valid XrSystemId or ERROR_SYSTEM_INVALID must be returned.
• next, unless otherwise specified via an extension, must contain exactly one graphics API binding structure (a structure whose name begins with “XrGraphicsBinding”) or ERROR_GRAPHICS_DEVICE_INVALID must be returned.

Valid Usage (Implicit)

• type must be TYPE_SESSION_CREATE_INFO
• next must be NULL or a valid pointer to the next structure in a structure chain. See also: XrGraphicsBindingEGLMNDX, XrGraphicsBindingOpenGLWaylandKHR, XrGraphicsBindingOpenGLWin32KHR, XrGraphicsBindingOpenGLXcbKHR, XrGraphicsBindingOpenGLXlibKHR, XrGraphicsBindingVulkanKHR, XrHolographicWindowAttachmentMSFT, XrSessionCreateInfoOverlayEXTX
• createFlags must be 0

See Also

CreateSession

Layout

 struct XrSessionCreateInfo {
     XrStructureType type();
     void const * next();
     XrSessionCreateFlags createFlags();
     XrSystemId systemId();
 }

Nested Class Summary

Nested Classes

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

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

org.lwjgl.system.Struct.StructValidation

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

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	CREATEFLAGS	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	SYSTEMID	The struct member offsets.
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
XrSessionCreateInfo(ByteBuffer container)	Creates a XrSessionCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSessionCreateInfo	calloc()	Returns a new XrSessionCreateInfo instance allocated with memCalloc.
static XrSessionCreateInfo.Buffer	calloc(int capacity)	Returns a new XrSessionCreateInfo.Buffer instance allocated with memCalloc.
static XrSessionCreateInfo.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSessionCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSessionCreateInfo	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSessionCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSessionCreateInfo	create()	Returns a new XrSessionCreateInfo instance allocated with BufferUtils.
static XrSessionCreateInfo.Buffer	create(int capacity)	Returns a new XrSessionCreateInfo.Buffer instance allocated with BufferUtils.
static XrSessionCreateInfo	create(long address)	Returns a new XrSessionCreateInfo instance for the specified memory address.
static XrSessionCreateInfo.Buffer	create(long address, int capacity)	Create a XrSessionCreateInfo.Buffer instance at the specified memory.
long	createFlags()	identifies XrSessionCreateFlags that apply to the creation.
XrSessionCreateInfo	createFlags(long value)	Sets the specified value to the createFlags() field.
static @Nullable XrSessionCreateInfo	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSessionCreateInfo.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSessionCreateInfo	malloc()	Returns a new XrSessionCreateInfo instance allocated with memAlloc.
static XrSessionCreateInfo.Buffer	malloc(int capacity)	Returns a new XrSessionCreateInfo.Buffer instance allocated with memAlloc.
static XrSessionCreateInfo.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSessionCreateInfo.Buffer instance allocated on the specified MemoryStack.
static XrSessionCreateInfo	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSessionCreateInfo instance allocated on the specified MemoryStack.
static long	ncreateFlags(long struct)	Unsafe version of createFlags().
static void	ncreateFlags(long struct, long value)	Unsafe version of createFlags.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrSessionCreateInfo	next(long value)	Sets the specified value to the next() field.
XrSessionCreateInfo	next(XrGraphicsBindingEGLMNDX value)	Prepends the specified XrGraphicsBindingEGLMNDX value to the next chain.
XrSessionCreateInfo	next(XrGraphicsBindingOpenGLWaylandKHR value)	Prepends the specified XrGraphicsBindingOpenGLWaylandKHR value to the next chain.
XrSessionCreateInfo	next(XrGraphicsBindingOpenGLWin32KHR value)	Prepends the specified XrGraphicsBindingOpenGLWin32KHR value to the next chain.
XrSessionCreateInfo	next(XrGraphicsBindingOpenGLXcbKHR value)	Prepends the specified XrGraphicsBindingOpenGLXcbKHR value to the next chain.
XrSessionCreateInfo	next(XrGraphicsBindingOpenGLXlibKHR value)	Prepends the specified XrGraphicsBindingOpenGLXlibKHR value to the next chain.
XrSessionCreateInfo	next(XrGraphicsBindingVulkan2KHR value)	Prepends the specified XrGraphicsBindingVulkan2KHR value to the next chain.
XrSessionCreateInfo	next(XrGraphicsBindingVulkanKHR value)	Prepends the specified XrGraphicsBindingVulkanKHR value to the next chain.
XrSessionCreateInfo	next(XrHolographicWindowAttachmentMSFT value)	Prepends the specified XrHolographicWindowAttachmentMSFT value to the next chain.
XrSessionCreateInfo	next(XrSessionCreateInfoOverlayEXTX value)	Prepends the specified XrSessionCreateInfoOverlayEXTX 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 long	nsystemId(long struct)	Unsafe version of systemId().
static void	nsystemId(long struct, long value)	Unsafe version of systemId.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrSessionCreateInfo	set(int type, long next, long createFlags, long systemId)	Initializes this struct with the specified values.
XrSessionCreateInfo	set(XrSessionCreateInfo src)	Copies the specified struct data to this struct.
int	sizeof()
long	systemId()	the XrSystemId representing the system of devices to be used by this session.
XrSessionCreateInfo	systemId(long value)	Sets the specified value to the systemId() field.
int	type()	the XrStructureType of this structure.
XrSessionCreateInfo	type(int value)	Sets the specified value to the type() field.
XrSessionCreateInfo	type$Default()	Sets the TYPE_SESSION_CREATE_INFO value to the type() field.

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.

SYSTEMID

public static final int SYSTEMID

The struct member offsets.

Constructor Details

XrSessionCreateInfo

public XrSessionCreateInfo(ByteBuffer container)

Creates a XrSessionCreateInfo 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<XrSessionCreateInfo>

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. Note that in most cases one graphics API extension specific struct needs to be in this next chain.

createFlags

public long createFlags()

identifies XrSessionCreateFlags that apply to the creation.

systemId

public long systemId()

the XrSystemId representing the system of devices to be used by this session.

type

public XrSessionCreateInfo type(int value)

Sets the specified value to the type() field.

type$Default

public XrSessionCreateInfo type$Default()

Sets the TYPE_SESSION_CREATE_INFO value to the type() field.

next

public XrSessionCreateInfo next(long value)

Sets the specified value to the next() field.

next

public XrSessionCreateInfo next(XrGraphicsBindingEGLMNDX value)

Prepends the specified XrGraphicsBindingEGLMNDX value to the next chain.

next

public XrSessionCreateInfo next(XrGraphicsBindingOpenGLWaylandKHR value)

Prepends the specified XrGraphicsBindingOpenGLWaylandKHR value to the next chain.

next

public XrSessionCreateInfo next(XrGraphicsBindingOpenGLWin32KHR value)

Prepends the specified XrGraphicsBindingOpenGLWin32KHR value to the next chain.

next

public XrSessionCreateInfo next(XrGraphicsBindingOpenGLXcbKHR value)

Prepends the specified XrGraphicsBindingOpenGLXcbKHR value to the next chain.

next

public XrSessionCreateInfo next(XrGraphicsBindingOpenGLXlibKHR value)

Prepends the specified XrGraphicsBindingOpenGLXlibKHR value to the next chain.

next

public XrSessionCreateInfo next(XrGraphicsBindingVulkan2KHR value)

Prepends the specified XrGraphicsBindingVulkan2KHR value to the next chain.

next

public XrSessionCreateInfo next(XrGraphicsBindingVulkanKHR value)

Prepends the specified XrGraphicsBindingVulkanKHR value to the next chain.

next

public XrSessionCreateInfo next(XrHolographicWindowAttachmentMSFT value)

Prepends the specified XrHolographicWindowAttachmentMSFT value to the next chain.

next

public XrSessionCreateInfo next(XrSessionCreateInfoOverlayEXTX value)

Prepends the specified XrSessionCreateInfoOverlayEXTX value to the next chain.

createFlags

public XrSessionCreateInfo createFlags(long value)

Sets the specified value to the createFlags() field.

systemId

public XrSessionCreateInfo systemId(long value)

Sets the specified value to the systemId() field.

set

public XrSessionCreateInfo set(int type,
 long next,
 long createFlags,
 long systemId)

Initializes this struct with the specified values.

set

public XrSessionCreateInfo set(XrSessionCreateInfo src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSessionCreateInfo malloc()

Returns a new XrSessionCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.

calloc

public static XrSessionCreateInfo calloc()

Returns a new XrSessionCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.

create

public static XrSessionCreateInfo create()

Returns a new XrSessionCreateInfo instance allocated with BufferUtils.

create

public static XrSessionCreateInfo create(long address)

Returns a new XrSessionCreateInfo instance for the specified memory address.

createSafe

public static @Nullable XrSessionCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSessionCreateInfo.Buffer malloc(int capacity)

Returns a new XrSessionCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

calloc

public static XrSessionCreateInfo.Buffer calloc(int capacity)

Returns a new XrSessionCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.

Parameters:

capacity - the buffer capacity

create

public static XrSessionCreateInfo.Buffer create(int capacity)

Returns a new XrSessionCreateInfo.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static XrSessionCreateInfo.Buffer create(long address,
 int capacity)

Create a XrSessionCreateInfo.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable XrSessionCreateInfo.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

malloc

public static XrSessionCreateInfo malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrSessionCreateInfo instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XrSessionCreateInfo calloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrSessionCreateInfo instance allocated on the specified MemoryStack and initializes all its bits to zero.

Parameters:

stack - the stack from which to allocate

malloc

public static XrSessionCreateInfo.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new XrSessionCreateInfo.Buffer instance allocated on the specified MemoryStack.

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static XrSessionCreateInfo.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

Returns a new XrSessionCreateInfo.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().

nsystemId

public static long nsystemId(long struct)

Unsafe version of systemId().

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.

nsystemId

public static void nsystemId(long struct,
 long value)

Unsafe version of systemId.