Package org.lwjgl.openxr

Class XrSessionCreateInfoOverlayEXTX

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrSessionCreateInfoOverlayEXTX>

org.lwjgl.openxr.XrSessionCreateInfoOverlayEXTX

All Implemented Interfaces:

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

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

Session creation extension struct providing overlay session parameters.

Valid Usage (Implicit)

• The XR_EXTX_overlay extension must be enabled prior to using XrSessionCreateInfoOverlayEXTX
• type must be TYPE_SESSION_CREATE_INFO_OVERLAY_EXTX
• next must be NULL or a valid pointer to the next structure in a structure chain
• createFlags must be 0

Layout

 struct XrSessionCreateInfoOverlayEXTX {
     XrStructureType type();
     void const * next();
     XrOverlaySessionCreateFlagsEXTX createFlags();
     uint32_t sessionLayersPlacement();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrSessionCreateInfoOverlayEXTX.Buffer	An array of XrSessionCreateInfoOverlayEXTX 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	SESSIONLAYERSPLACEMENT	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
XrSessionCreateInfoOverlayEXTX(ByteBuffer container)	Creates a XrSessionCreateInfoOverlayEXTX instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
static XrSessionCreateInfoOverlayEXTX	calloc()	Returns a new XrSessionCreateInfoOverlayEXTX instance allocated with memCalloc.
static XrSessionCreateInfoOverlayEXTX.Buffer	calloc(int capacity)	Returns a new XrSessionCreateInfoOverlayEXTX.Buffer instance allocated with memCalloc.
static XrSessionCreateInfoOverlayEXTX.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSessionCreateInfoOverlayEXTX.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSessionCreateInfoOverlayEXTX	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSessionCreateInfoOverlayEXTX instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrSessionCreateInfoOverlayEXTX	create()	Returns a new XrSessionCreateInfoOverlayEXTX instance allocated with BufferUtils.
static XrSessionCreateInfoOverlayEXTX.Buffer	create(int capacity)	Returns a new XrSessionCreateInfoOverlayEXTX.Buffer instance allocated with BufferUtils.
static XrSessionCreateInfoOverlayEXTX	create(long address)	Returns a new XrSessionCreateInfoOverlayEXTX instance for the specified memory address.
static XrSessionCreateInfoOverlayEXTX.Buffer	create(long address, int capacity)	Create a XrSessionCreateInfoOverlayEXTX.Buffer instance at the specified memory.
long	createFlags()	0 or one or more XrOverlaySessionCreateFlagBitsEXTX which indicate various characteristics desired for the overlay session.
XrSessionCreateInfoOverlayEXTX	createFlags(long value)	Sets the specified value to the createFlags() field.
static @Nullable XrSessionCreateInfoOverlayEXTX	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrSessionCreateInfoOverlayEXTX.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrSessionCreateInfoOverlayEXTX	malloc()	Returns a new XrSessionCreateInfoOverlayEXTX instance allocated with memAlloc.
static XrSessionCreateInfoOverlayEXTX.Buffer	malloc(int capacity)	Returns a new XrSessionCreateInfoOverlayEXTX.Buffer instance allocated with memAlloc.
static XrSessionCreateInfoOverlayEXTX.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrSessionCreateInfoOverlayEXTX.Buffer instance allocated on the specified MemoryStack.
static XrSessionCreateInfoOverlayEXTX	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrSessionCreateInfoOverlayEXTX 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.
XrSessionCreateInfoOverlayEXTX	next(long value)	Sets the specified value to the next() field.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	nsessionLayersPlacement(long struct)	Unsafe version of sessionLayersPlacement().
static void	nsessionLayersPlacement(long struct, int value)	Unsafe version of sessionLayersPlacement.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
int	sessionLayersPlacement()	a value indicating the desired placement of the session’s composition layers in terms of other sessions.
XrSessionCreateInfoOverlayEXTX	sessionLayersPlacement(int value)	Sets the specified value to the sessionLayersPlacement() field.
XrSessionCreateInfoOverlayEXTX	set(int type, long next, long createFlags, int sessionLayersPlacement)	Initializes this struct with the specified values.
XrSessionCreateInfoOverlayEXTX	set(XrSessionCreateInfoOverlayEXTX src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrSessionCreateInfoOverlayEXTX	type(int value)	Sets the specified value to the type() field.
XrSessionCreateInfoOverlayEXTX	type$Default()	Sets the TYPE_SESSION_CREATE_INFO_OVERLAY_EXTX 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.

SESSIONLAYERSPLACEMENT

public static final int SESSIONLAYERSPLACEMENT

The struct member offsets.

Constructor Details

XrSessionCreateInfoOverlayEXTX

public XrSessionCreateInfoOverlayEXTX(ByteBuffer container)

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

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 or this extension.

createFlags

public long createFlags()

0 or one or more XrOverlaySessionCreateFlagBitsEXTX which indicate various characteristics desired for the overlay session.

sessionLayersPlacement

public int sessionLayersPlacement()

a value indicating the desired placement of the session’s composition layers in terms of other sessions.

type

public XrSessionCreateInfoOverlayEXTX type(int value)

Sets the specified value to the type() field.

type$Default

public XrSessionCreateInfoOverlayEXTX type$Default()

Sets the TYPE_SESSION_CREATE_INFO_OVERLAY_EXTX value to the type() field.

next

public XrSessionCreateInfoOverlayEXTX next(long value)

Sets the specified value to the next() field.

createFlags

public XrSessionCreateInfoOverlayEXTX createFlags(long value)

Sets the specified value to the createFlags() field.

sessionLayersPlacement

public XrSessionCreateInfoOverlayEXTX sessionLayersPlacement(int value)

Sets the specified value to the sessionLayersPlacement() field.

set

public XrSessionCreateInfoOverlayEXTX set(int type,
 long next,
 long createFlags,
 int sessionLayersPlacement)

Initializes this struct with the specified values.

set

public XrSessionCreateInfoOverlayEXTX set(XrSessionCreateInfoOverlayEXTX src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrSessionCreateInfoOverlayEXTX malloc()

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

calloc

public static XrSessionCreateInfoOverlayEXTX calloc()

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

create

public static XrSessionCreateInfoOverlayEXTX create()

Returns a new XrSessionCreateInfoOverlayEXTX instance allocated with BufferUtils.

create

public static XrSessionCreateInfoOverlayEXTX create(long address)

Returns a new XrSessionCreateInfoOverlayEXTX instance for the specified memory address.

createSafe

public static @Nullable XrSessionCreateInfoOverlayEXTX createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrSessionCreateInfoOverlayEXTX.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrSessionCreateInfoOverlayEXTX.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrSessionCreateInfoOverlayEXTX.Buffer create(int capacity)

Returns a new XrSessionCreateInfoOverlayEXTX.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrSessionCreateInfoOverlayEXTX.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrSessionCreateInfoOverlayEXTX instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nsessionLayersPlacement

public static int nsessionLayersPlacement(long struct)

Unsafe version of sessionLayersPlacement().

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.

nsessionLayersPlacement

public static void nsessionLayersPlacement(long struct,
 int value)

Unsafe version of sessionLayersPlacement.