Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrSessionCreateInfo

extends Struct<XrSessionCreateInfo>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*

Creates a session.
Valid Usage
Valid Usage (Implicit)
See Also

CreateSession

Layout


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

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
CREATEFLAGS

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SYSTEMID

The struct member offsets.

public static final int
TYPE

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

AccessConstructor and Description
protected
XrSessionCreateInfo(long address, ByteBuffer container)

public
XrSessionCreateInfo(ByteBuffer container)

Creates a XrSessionCreateInfo instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and TypeMethod and Description
public static XrSessionCreateInfo
calloc()

Returns a new XrSessionCreateInfo instance allocated with memCalloc.

public static XrSessionCreateInfo.Buffer
calloc(int
the buffer capacity
capacity
)

Returns a new XrSessionCreateInfo.Buffer instance allocated with memCalloc.

public static XrSessionCreateInfo
calloc(MemoryStack
the stack from which to allocate
stack
)

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

public static XrSessionCreateInfo.Buffer
calloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

protected XrSessionCreateInfo
create(long
the struct memory address
address
,
ByteBuffer
an optional container buffer, to be referenced strongly by the struct instance.
container
)

Implements abstract org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.
public static XrSessionCreateInfo
create()

Returns a new XrSessionCreateInfo instance allocated with BufferUtils.

public static XrSessionCreateInfo
create(long address)

Returns a new XrSessionCreateInfo instance for the specified memory address.

public static XrSessionCreateInfo.Buffer
create(int
the buffer capacity
capacity
)

Returns a new XrSessionCreateInfo.Buffer instance allocated with BufferUtils.

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

Create a XrSessionCreateInfo.Buffer instance at the specified memory.

public long
createFlags()

identifies XrSessionCreateFlags that apply to the creation.

public XrSessionCreateInfo
createFlags(long value)

Sets the specified value to the createFlags field.

public static XrSessionCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrSessionCreateInfo
malloc()

Returns a new XrSessionCreateInfo instance allocated with memAlloc.

public static XrSessionCreateInfo.Buffer
malloc(int
the buffer capacity
capacity
)

Returns a new XrSessionCreateInfo.Buffer instance allocated with memAlloc.

public static XrSessionCreateInfo
malloc(MemoryStack
the stack from which to allocate
stack
)

Returns a new XrSessionCreateInfo instance allocated on the specified MemoryStack.

public static XrSessionCreateInfo.Buffer
malloc(int
the buffer capacity
capacity
,
MemoryStack
the stack from which to allocate
stack
)

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

public static long
ncreateFlags(long struct)

Unsafe version of createFlags.

public static void
ncreateFlags(long struct, long value)

Unsafe version of createFlags.

public long
next()

NULL or a pointer to the next structure in a structure chain.

public XrSessionCreateInfo
next(long value)

Sets the specified value to the next field.

public XrSessionCreateInfo
next(XrGraphicsBindingEGLMNDX value)

Prepends the specified XrGraphicsBindingEGLMNDX value to the next chain.

public XrSessionCreateInfo
next(XrGraphicsBindingOpenGLWaylandKHR value)

Prepends the specified XrGraphicsBindingOpenGLWaylandKHR value to the next chain.

public XrSessionCreateInfo
next(XrGraphicsBindingOpenGLWin32KHR value)

Prepends the specified XrGraphicsBindingOpenGLWin32KHR value to the next chain.

public XrSessionCreateInfo
next(XrGraphicsBindingOpenGLXcbKHR value)

Prepends the specified XrGraphicsBindingOpenGLXcbKHR value to the next chain.

public XrSessionCreateInfo
next(XrGraphicsBindingOpenGLXlibKHR value)

Prepends the specified XrGraphicsBindingOpenGLXlibKHR value to the next chain.

public XrSessionCreateInfo
next(XrGraphicsBindingVulkan2KHR value)

Prepends the specified XrGraphicsBindingVulkan2KHR value to the next chain.

public XrSessionCreateInfo
next(XrGraphicsBindingVulkanKHR value)

Prepends the specified XrGraphicsBindingVulkanKHR value to the next chain.

public XrSessionCreateInfo
next(XrHolographicWindowAttachmentMSFT value)

Prepends the specified XrHolographicWindowAttachmentMSFT value to the next chain.

public XrSessionCreateInfo
next(XrSessionCreateInfoOverlayEXTX value)

Prepends the specified XrSessionCreateInfoOverlayEXTX value to the next chain.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static long
nsystemId(long struct)

Unsafe version of systemId.

public static void
nsystemId(long struct, long value)

Unsafe version of systemId.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

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

Initializes this struct with the specified values.

public XrSessionCreateInfo

Returns:

this struct
set
(XrSessionCreateInfo
the source struct
src
)

Copies the specified struct data to this struct.

public int
sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).
public long
systemId()

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

public XrSessionCreateInfo
systemId(long value)

Sets the specified value to the systemId field.

public int
type()

the XrStructureType of this structure.

public XrSessionCreateInfo
type(int value)

Sets the specified value to the type field.

public XrSessionCreateInfo
type$Default()

Sets the TYPE_SESSION_CREATE_INFO value to the type field.

Inherited from org.lwjgl.system.Struct:
__array__array__array__checkContainer__checkMalloc__create__getContainer__getContainer__member__member__member__padding__padding__struct__struct__union__unionclearfreeisNullvalidate

Field Detail

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

CREATEFLAGSback to summary
public static final int CREATEFLAGS

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SYSTEMIDback to summary
public static final int SYSTEMID

The struct member offsets.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrSessionCreateInfoback to summary
protected XrSessionCreateInfo(long address, ByteBuffer container)
XrSessionCreateInfoback to summary
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 Detail

callocback to summary
public static XrSessionCreateInfo calloc()

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

callocback to summary
public static XrSessionCreateInfo.Buffer calloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrSessionCreateInfo calloc(MemoryStack stack)

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

Parameters
stack:MemoryStack

the stack from which to allocate

callocback to summary
public static XrSessionCreateInfo.Buffer calloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

createback to summary
protected XrSessionCreateInfo create(long address, ByteBuffer container)

Implements abstract org.lwjgl.system.Struct.create.

Doc from org.lwjgl.system.Struct.create.

Similar to the constructor, but returns the exact type of the Struct subclass.

Effectively, every Struct instance is a factory for more instances of the same type. This is used by StructBuffer.

Parameters
address:long

the struct memory address

container:ByteBuffer

an optional container buffer, to be referenced strongly by the struct instance.

Annotations
@Override
createback to summary
public static XrSessionCreateInfo create()

Returns a new XrSessionCreateInfo instance allocated with BufferUtils.

createback to summary
public static XrSessionCreateInfo create(long address)

Returns a new XrSessionCreateInfo instance for the specified memory address.

createback to summary
public static XrSessionCreateInfo.Buffer create(int capacity)

Returns a new XrSessionCreateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrSessionCreateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createFlagsback to summary
public long createFlags()

identifies XrSessionCreateFlags that apply to the creation.

Annotations
@NativeType:XrSessionCreateFlags
createFlagsback to summary
public XrSessionCreateInfo createFlags(long value)

Sets the specified value to the createFlags field.

createSafeback to summary
public static XrSessionCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

Annotations
@Nullable
createSafeback to summary
public static XrSessionCreateInfo.Buffer createSafe(long address, int capacity)

Like create, but returns null if address is NULL.

Annotations
@Nullable
mallocback to summary
public static XrSessionCreateInfo malloc()

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

mallocback to summary
public static XrSessionCreateInfo.Buffer malloc(int capacity)

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrSessionCreateInfo malloc(MemoryStack stack)

Returns a new XrSessionCreateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

mallocback to summary
public static XrSessionCreateInfo.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

ncreateFlagsback to summary
public static long ncreateFlags(long struct)

Unsafe version of createFlags.

ncreateFlagsback to summary
public static void ncreateFlags(long struct, long value)

Unsafe version of createFlags.

nextback to summary
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.

Annotations
@NativeType:void const *
nextback to summary
public XrSessionCreateInfo next(long value)

Sets the specified value to the next field.

nextback to summary
public XrSessionCreateInfo next(XrGraphicsBindingEGLMNDX value)

Prepends the specified XrGraphicsBindingEGLMNDX value to the next chain.

nextback to summary
public XrSessionCreateInfo next(XrGraphicsBindingOpenGLWaylandKHR value)

Prepends the specified XrGraphicsBindingOpenGLWaylandKHR value to the next chain.

nextback to summary
public XrSessionCreateInfo next(XrGraphicsBindingOpenGLWin32KHR value)

Prepends the specified XrGraphicsBindingOpenGLWin32KHR value to the next chain.

nextback to summary
public XrSessionCreateInfo next(XrGraphicsBindingOpenGLXcbKHR value)

Prepends the specified XrGraphicsBindingOpenGLXcbKHR value to the next chain.

nextback to summary
public XrSessionCreateInfo next(XrGraphicsBindingOpenGLXlibKHR value)

Prepends the specified XrGraphicsBindingOpenGLXlibKHR value to the next chain.

nextback to summary
public XrSessionCreateInfo next(XrGraphicsBindingVulkan2KHR value)

Prepends the specified XrGraphicsBindingVulkan2KHR value to the next chain.

nextback to summary
public XrSessionCreateInfo next(XrGraphicsBindingVulkanKHR value)

Prepends the specified XrGraphicsBindingVulkanKHR value to the next chain.

nextback to summary
public XrSessionCreateInfo next(XrHolographicWindowAttachmentMSFT value)

Prepends the specified XrHolographicWindowAttachmentMSFT value to the next chain.

nextback to summary
public XrSessionCreateInfo next(XrSessionCreateInfoOverlayEXTX value)

Prepends the specified XrSessionCreateInfoOverlayEXTX value to the next chain.

nnextback to summary
public static long nnext(long struct)

Unsafe version of next.

nnextback to summary
public static void nnext(long struct, long value)

Unsafe version of next.

nsystemIdback to summary
public static long nsystemId(long struct)

Unsafe version of systemId.

nsystemIdback to summary
public static void nsystemId(long struct, long value)

Unsafe version of systemId.

ntypeback to summary
public static int ntype(long struct)

Unsafe version of type.

ntypeback to summary
public static void ntype(long struct, int value)

Unsafe version of type.

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

Initializes this struct with the specified values.

setback to summary
public XrSessionCreateInfo set(XrSessionCreateInfo src)

Copies the specified struct data to this struct.

Parameters
src:XrSessionCreateInfo

the source struct

Returns:XrSessionCreateInfo

this struct

sizeofback to summary
public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations
@Override
systemIdback to summary
public long systemId()

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

Annotations
@NativeType:XrSystemId
systemIdback to summary
public XrSessionCreateInfo systemId(long value)

Sets the specified value to the systemId field.

typeback to summary
public int type()

the XrStructureType of this structure.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrSessionCreateInfo type(int value)

Sets the specified value to the type field.

type$Defaultback to summary
public XrSessionCreateInfo type$Default()

Sets the TYPE_SESSION_CREATE_INFO value to the type field.

org.lwjgl.openxr back to summary

public Class XrSessionCreateInfo.Buffer

extends StructBuffer<XrSessionCreateInfo, XrSessionCreateInfo.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrSessionCreateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final XrSessionCreateInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrSessionCreateInfo.Buffer instance backed by the specified container.

public
Buffer(long address, int cap)

pack-priv
Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Summary

Modifier and TypeMethod and Description
public long

Returns:

the value of the XrSessionCreateInfo#createFlags field.
createFlags
()

public XrSessionCreateInfo.Buffer
createFlags(long value)

Sets the specified value to the XrSessionCreateInfo#createFlags field.

protected XrSessionCreateInfo
public long

Returns:

the value of the XrSessionCreateInfo#next field.
next
()

public XrSessionCreateInfo.Buffer
next(long value)

Sets the specified value to the XrSessionCreateInfo#next field.

public XrSessionCreateInfo.Buffer
next(XrGraphicsBindingEGLMNDX value)

Prepends the specified XrGraphicsBindingEGLMNDX value to the next chain.

public XrSessionCreateInfo.Buffer
next(XrGraphicsBindingOpenGLWaylandKHR value)

Prepends the specified XrGraphicsBindingOpenGLWaylandKHR value to the next chain.

public XrSessionCreateInfo.Buffer
next(XrGraphicsBindingOpenGLWin32KHR value)

Prepends the specified XrGraphicsBindingOpenGLWin32KHR value to the next chain.

public XrSessionCreateInfo.Buffer
next(XrGraphicsBindingOpenGLXcbKHR value)

Prepends the specified XrGraphicsBindingOpenGLXcbKHR value to the next chain.

public XrSessionCreateInfo.Buffer
next(XrGraphicsBindingOpenGLXlibKHR value)

Prepends the specified XrGraphicsBindingOpenGLXlibKHR value to the next chain.

public XrSessionCreateInfo.Buffer
next(XrGraphicsBindingVulkan2KHR value)

Prepends the specified XrGraphicsBindingVulkan2KHR value to the next chain.

public XrSessionCreateInfo.Buffer
next(XrGraphicsBindingVulkanKHR value)

Prepends the specified XrGraphicsBindingVulkanKHR value to the next chain.

public XrSessionCreateInfo.Buffer
next(XrHolographicWindowAttachmentMSFT value)

Prepends the specified XrHolographicWindowAttachmentMSFT value to the next chain.

public XrSessionCreateInfo.Buffer
next(XrSessionCreateInfoOverlayEXTX value)

Prepends the specified XrSessionCreateInfoOverlayEXTX value to the next chain.

protected XrSessionCreateInfo.Buffer
public long

Returns:

the value of the XrSessionCreateInfo#systemId field.
systemId
()

public XrSessionCreateInfo.Buffer
systemId(long value)

Sets the specified value to the XrSessionCreateInfo#systemId field.

public int

Returns:

the value of the XrSessionCreateInfo#type field.
type
()

public XrSessionCreateInfo.Buffer
type(int value)

Sets the specified value to the XrSessionCreateInfo#type field.

public XrSessionCreateInfo.Buffer
Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrSessionCreateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrSessionCreateInfo.Buffer instance backed by the specified container.

Changes to the container's content will be visible to the struct buffer instance and vice versa. The two buffers' position, limit, and mark values will be independent. The new buffer's position will be zero, its capacity and its limit will be the number of bytes remaining in this buffer divided by XrSessionCreateInfo#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Bufferback to summary
public Buffer(long address, int cap)
Bufferback to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

createFlagsback to summary
public long createFlags()
Returns:long

the value of the XrSessionCreateInfo#createFlags field.

Annotations
@NativeType:XrSessionCreateFlags
createFlagsback to summary
public XrSessionCreateInfo.Buffer createFlags(long value)

Sets the specified value to the XrSessionCreateInfo#createFlags field.

getElementFactoryback to summary
protected XrSessionCreateInfo getElementFactory()

Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.

Annotations
@Override
nextback to summary
public long next()
Returns:long

the value of the XrSessionCreateInfo#next field.

Annotations
@NativeType:void const *
nextback to summary
public XrSessionCreateInfo.Buffer next(long value)

Sets the specified value to the XrSessionCreateInfo#next field.

nextback to summary
public XrSessionCreateInfo.Buffer next(XrGraphicsBindingEGLMNDX value)

Prepends the specified XrGraphicsBindingEGLMNDX value to the next chain.

nextback to summary
public XrSessionCreateInfo.Buffer next(XrGraphicsBindingOpenGLWaylandKHR value)

Prepends the specified XrGraphicsBindingOpenGLWaylandKHR value to the next chain.

nextback to summary
public XrSessionCreateInfo.Buffer next(XrGraphicsBindingOpenGLWin32KHR value)

Prepends the specified XrGraphicsBindingOpenGLWin32KHR value to the next chain.

nextback to summary
public XrSessionCreateInfo.Buffer next(XrGraphicsBindingOpenGLXcbKHR value)

Prepends the specified XrGraphicsBindingOpenGLXcbKHR value to the next chain.

nextback to summary
public XrSessionCreateInfo.Buffer next(XrGraphicsBindingOpenGLXlibKHR value)

Prepends the specified XrGraphicsBindingOpenGLXlibKHR value to the next chain.

nextback to summary
public XrSessionCreateInfo.Buffer next(XrGraphicsBindingVulkan2KHR value)

Prepends the specified XrGraphicsBindingVulkan2KHR value to the next chain.

nextback to summary
public XrSessionCreateInfo.Buffer next(XrGraphicsBindingVulkanKHR value)

Prepends the specified XrGraphicsBindingVulkanKHR value to the next chain.

nextback to summary
public XrSessionCreateInfo.Buffer next(XrHolographicWindowAttachmentMSFT value)

Prepends the specified XrHolographicWindowAttachmentMSFT value to the next chain.

nextback to summary
public XrSessionCreateInfo.Buffer next(XrSessionCreateInfoOverlayEXTX value)

Prepends the specified XrSessionCreateInfoOverlayEXTX value to the next chain.

selfback to summary
protected XrSessionCreateInfo.Buffer self()

Implements abstract org.lwjgl.system.CustomBuffer.self.

Annotations
@Override
systemIdback to summary
public long systemId()
Returns:long

the value of the XrSessionCreateInfo#systemId field.

Annotations
@NativeType:XrSystemId
systemIdback to summary
public XrSessionCreateInfo.Buffer systemId(long value)

Sets the specified value to the XrSessionCreateInfo#systemId field.

typeback to summary
public int type()
Returns:int

the value of the XrSessionCreateInfo#type field.

Annotations
@NativeType:XrStructureType
typeback to summary
public XrSessionCreateInfo.Buffer type(int value)

Sets the specified value to the XrSessionCreateInfo#type field.

type$Defaultback to summary
public XrSessionCreateInfo.Buffer type$Default()

Sets the TYPE_SESSION_CREATE_INFO value to the XrSessionCreateInfo#type field.