Package org.lwjgl.openxr

Class XrActiveActionSetPrioritiesEXT

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrActiveActionSetPrioritiesEXT>

org.lwjgl.openxr.XrActiveActionSetPrioritiesEXT

All Implemented Interfaces:

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

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

Active action set priority numbers.

Valid Usage (Implicit)

• The XR_EXT_active_action_set_priority extension must be enabled prior to using XrActiveActionSetPrioritiesEXT
• type must be TYPE_ACTIVE_ACTION_SET_PRIORITIES_EXT
• next must be NULL or a valid pointer to the next structure in a structure chain
• actionSetPriorities must be a pointer to an array of actionSetPriorityCount valid XrActiveActionSetPriorityEXT structures
• The actionSetPriorityCount parameter must be greater than 0

The runtime must ignore any priority numbers for action sets that were not specified as an active action set in the XrActionsSyncInfo structure as this would have no effect.

The priority numbers provided in XrActiveActionSetPriorityEXT must override the priority number of the active action set starting with the SyncActions call it is provided to, until the first subsequent call to SyncActions.

When a subsequent call is made to SyncActions where an active action set does not have a corresponding priority number specified in the XrActiveActionSetPriorityEXT structure the priority number for that action set must revert back to the priority number provided in XrActionSetCreateInfo when that action set was created.

See Also

XrActionsSyncInfo, XrActiveActionSetPriorityEXT, SyncActions

Layout

 struct XrActiveActionSetPrioritiesEXT {
     XrStructureType type();
     void const * next();
     uint32_t actionSetPriorityCount();
     XrActiveActionSetPriorityEXT const * actionSetPriorities();
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrActiveActionSetPrioritiesEXT.Buffer	An array of XrActiveActionSetPrioritiesEXT 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	ACTIONSETPRIORITIES	The struct member offsets.
static final int	ACTIONSETPRIORITYCOUNT	The struct member offsets.
static final int	ALIGNOF	The struct alignment in bytes.
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
XrActiveActionSetPrioritiesEXT(ByteBuffer container)	Creates a XrActiveActionSetPrioritiesEXT instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
XrActiveActionSetPriorityEXT.Buffer	actionSetPriorities()	a pointer to an array that maps action sets to their active priority numbers.
XrActiveActionSetPrioritiesEXT	actionSetPriorities(XrActiveActionSetPriorityEXT.Buffer value)	Sets the address of the specified XrActiveActionSetPriorityEXT.Buffer to the actionSetPriorities() field.
int	actionSetPriorityCount()	an integer specifying the number of valid elements in the actionSetPriorities array.
static XrActiveActionSetPrioritiesEXT	calloc()	Returns a new XrActiveActionSetPrioritiesEXT instance allocated with memCalloc.
static XrActiveActionSetPrioritiesEXT.Buffer	calloc(int capacity)	Returns a new XrActiveActionSetPrioritiesEXT.Buffer instance allocated with memCalloc.
static XrActiveActionSetPrioritiesEXT.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrActiveActionSetPrioritiesEXT.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrActiveActionSetPrioritiesEXT	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrActiveActionSetPrioritiesEXT instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrActiveActionSetPrioritiesEXT	create()	Returns a new XrActiveActionSetPrioritiesEXT instance allocated with BufferUtils.
static XrActiveActionSetPrioritiesEXT.Buffer	create(int capacity)	Returns a new XrActiveActionSetPrioritiesEXT.Buffer instance allocated with BufferUtils.
static XrActiveActionSetPrioritiesEXT	create(long address)	Returns a new XrActiveActionSetPrioritiesEXT instance for the specified memory address.
static XrActiveActionSetPrioritiesEXT.Buffer	create(long address, int capacity)	Create a XrActiveActionSetPrioritiesEXT.Buffer instance at the specified memory.
static @Nullable XrActiveActionSetPrioritiesEXT	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrActiveActionSetPrioritiesEXT.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrActiveActionSetPrioritiesEXT	malloc()	Returns a new XrActiveActionSetPrioritiesEXT instance allocated with memAlloc.
static XrActiveActionSetPrioritiesEXT.Buffer	malloc(int capacity)	Returns a new XrActiveActionSetPrioritiesEXT.Buffer instance allocated with memAlloc.
static XrActiveActionSetPrioritiesEXT.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrActiveActionSetPrioritiesEXT.Buffer instance allocated on the specified MemoryStack.
static XrActiveActionSetPrioritiesEXT	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrActiveActionSetPrioritiesEXT instance allocated on the specified MemoryStack.
static XrActiveActionSetPriorityEXT.Buffer	nactionSetPriorities(long struct)	Unsafe version of actionSetPriorities().
static void	nactionSetPriorities(long struct, XrActiveActionSetPriorityEXT.Buffer value)	Unsafe version of actionSetPriorities.
static int	nactionSetPriorityCount(long struct)	Unsafe version of actionSetPriorityCount().
static void	nactionSetPriorityCount(long struct, int value)	Sets the specified value to the actionSetPriorityCount field of the specified struct.
long	next()	NULL or a pointer to the next structure in a structure chain.
XrActiveActionSetPrioritiesEXT	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	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrActiveActionSetPrioritiesEXT	set(int type, long next, XrActiveActionSetPriorityEXT.Buffer actionSetPriorities)	Initializes this struct with the specified values.
XrActiveActionSetPrioritiesEXT	set(XrActiveActionSetPrioritiesEXT src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()	the XrStructureType of this structure.
XrActiveActionSetPrioritiesEXT	type(int value)	Sets the specified value to the type() field.
XrActiveActionSetPrioritiesEXT	type$Default()	Sets the TYPE_ACTIVE_ACTION_SET_PRIORITIES_EXT 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.

ACTIONSETPRIORITYCOUNT

public static final int ACTIONSETPRIORITYCOUNT

The struct member offsets.

ACTIONSETPRIORITIES

public static final int ACTIONSETPRIORITIES

The struct member offsets.

Constructor Details

XrActiveActionSetPrioritiesEXT

public XrActiveActionSetPrioritiesEXT(ByteBuffer container)

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

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.

actionSetPriorityCount

public int actionSetPriorityCount()

an integer specifying the number of valid elements in the actionSetPriorities array.

actionSetPriorities

public XrActiveActionSetPriorityEXT.Buffer actionSetPriorities()

a pointer to an array that maps action sets to their active priority numbers. If an action set is specified multiple times, the runtime may return ERROR_VALIDATION_FAILURE from SyncActions.

type

public XrActiveActionSetPrioritiesEXT type(int value)

Sets the specified value to the type() field.

type$Default

public XrActiveActionSetPrioritiesEXT type$Default()

Sets the TYPE_ACTIVE_ACTION_SET_PRIORITIES_EXT value to the type() field.

next

public XrActiveActionSetPrioritiesEXT next(long value)

Sets the specified value to the next() field.

actionSetPriorities

public XrActiveActionSetPrioritiesEXT actionSetPriorities(XrActiveActionSetPriorityEXT.Buffer value)

Sets the address of the specified XrActiveActionSetPriorityEXT.Buffer to the actionSetPriorities() field.

set

public XrActiveActionSetPrioritiesEXT set(int type,
 long next,
 XrActiveActionSetPriorityEXT.Buffer actionSetPriorities)

Initializes this struct with the specified values.

set

public XrActiveActionSetPrioritiesEXT set(XrActiveActionSetPrioritiesEXT src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrActiveActionSetPrioritiesEXT malloc()

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

calloc

public static XrActiveActionSetPrioritiesEXT calloc()

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

create

public static XrActiveActionSetPrioritiesEXT create()

Returns a new XrActiveActionSetPrioritiesEXT instance allocated with BufferUtils.

create

public static XrActiveActionSetPrioritiesEXT create(long address)

Returns a new XrActiveActionSetPrioritiesEXT instance for the specified memory address.

createSafe

public static @Nullable XrActiveActionSetPrioritiesEXT createSafe(long address)

Like create, but returns null if address is NULL.

malloc

public static XrActiveActionSetPrioritiesEXT.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrActiveActionSetPrioritiesEXT.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrActiveActionSetPrioritiesEXT.Buffer create(int capacity)

Returns a new XrActiveActionSetPrioritiesEXT.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrActiveActionSetPrioritiesEXT.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

malloc

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

Returns a new XrActiveActionSetPrioritiesEXT instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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

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

Parameters:

stack - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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

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

nactionSetPriorityCount

public static int nactionSetPriorityCount(long struct)

Unsafe version of actionSetPriorityCount().

nactionSetPriorities

public static XrActiveActionSetPriorityEXT.Buffer nactionSetPriorities(long struct)

Unsafe version of actionSetPriorities().

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.

nactionSetPriorityCount

public static void nactionSetPriorityCount(long struct,
 int value)

Sets the specified value to the actionSetPriorityCount field of the specified struct.

nactionSetPriorities

public static void nactionSetPriorities(long struct,
 XrActiveActionSetPriorityEXT.Buffer value)

Unsafe version of actionSetPriorities.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate