Class XrActionSetCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrActionSetCreateInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrActionSetCreateInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceXrActionSet creation info.Description
When multiple actions are bound to the same input source, the
priorityof each action set determines which bindings are suppressed. Runtimes must ignore input sources from action sets with a lower priority number if those specific input sources are also present in active actions within a higher priority action set. If multiple action sets with the same priority are bound to the same input source and that is the highest priority number, runtimes must process all those bindings at the same time.Two actions are considered to be bound to the same input source if they use the same identifier and optional location path segments, even if they have different component segments.
When runtimes are ignoring bindings because of priority, they must treat the binding to that input source as though they do not exist. That means the
isActivefield must beFALSEwhen retrieving action data, and that the runtime must not provide any visual, haptic, or other feedback related to the binding of that action to that input source. Other actions in the same action set which are bound to input sources that do not collide are not affected and are processed as normal.If
actionSetNameorlocalizedActionSetNameare empty strings, the runtime must returnERROR_NAME_INVALIDorERROR_LOCALIZED_NAME_INVALIDrespectively. IfactionSetNameorlocalizedActionSetNameare duplicates of the corresponding field for any existing action set in the specified instance, the runtime must returnERROR_NAME_DUPLICATEDorERROR_LOCALIZED_NAME_DUPLICATEDrespectively. If the conflicting action set is destroyed, the conflicting field is no longer considered duplicated. IfactionSetNamecontains characters which are not allowed in a single level of a well-formed path string, the runtime must returnERROR_PATH_FORMAT_INVALID.Valid Usage (Implicit)
typemust beTYPE_ACTION_SET_CREATE_INFOnextmust beNULLor a valid pointer to the next structure in a structure chainactionSetNamemust be a null-terminated UTF-8 string whose length is less than or equal toMAX_ACTION_SET_NAME_SIZElocalizedActionSetNamemust be a null-terminated UTF-8 string whose length is less than or equal toMAX_LOCALIZED_ACTION_SET_NAME_SIZE
See Also
Layout
struct XrActionSetCreateInfo { XrStructureTypetype(); void const *next(); charactionSetName()[XR_MAX_ACTION_SET_NAME_SIZE]; charlocalizedActionSetName()[XR_MAX_LOCALIZED_ACTION_SET_NAME_SIZE]; uint32_tpriority(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrActionSetCreateInfo.BufferAn array ofXrActionSetCreateInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intACTIONSETNAMEThe struct member offsets.static intALIGNOFThe struct alignment in bytes.static intLOCALIZEDACTIONSETNAME
NEXT
PRIORITYThe struct member offsets.static intSIZEOFThe struct size in bytes.static intTYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description XrActionSetCreateInfo(java.nio.ByteBuffer container)Creates aXrActionSetCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description java.nio.ByteBufferactionSetName()an array containing aNULLterminated non-empty string with the name of this action set.XrActionSetCreateInfoactionSetName(java.nio.ByteBuffer value)Copies the specified encoded string to theactionSetName()field.java.lang.StringactionSetNameString()an array containing aNULLterminated non-empty string with the name of this action set.static XrActionSetCreateInfocalloc()Returns a newXrActionSetCreateInfoinstance allocated withmemCalloc.static XrActionSetCreateInfo.Buffercalloc(int capacity)Returns a newXrActionSetCreateInfo.Bufferinstance allocated withmemCalloc.static XrActionSetCreateInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrActionSetCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrActionSetCreateInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrActionSetCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrActionSetCreateInfocreate()Returns a newXrActionSetCreateInfoinstance allocated withBufferUtils.static XrActionSetCreateInfo.Buffercreate(int capacity)Returns a newXrActionSetCreateInfo.Bufferinstance allocated withBufferUtils.static XrActionSetCreateInfocreate(long address)Returns a newXrActionSetCreateInfoinstance for the specified memory address.static XrActionSetCreateInfo.Buffercreate(long address, int capacity)Create aXrActionSetCreateInfo.Bufferinstance at the specified memory.static XrActionSetCreateInfocreateSafe(long address)static XrActionSetCreateInfo.BuffercreateSafe(long address, int capacity)java.nio.ByteBufferlocalizedActionSetName()an array containing aNULLterminatedUTF-8 string that can be presented to the user as a description of the action set.XrActionSetCreateInfolocalizedActionSetName(java.nio.ByteBuffer value)Copies the specified encoded string to thelocalizedActionSetName()field.java.lang.StringlocalizedActionSetNameString()an array containing aNULLterminatedUTF-8 string that can be presented to the user as a description of the action set.static XrActionSetCreateInfomalloc()Returns a newXrActionSetCreateInfoinstance allocated withmemAlloc.static XrActionSetCreateInfo.Buffermalloc(int capacity)Returns a newXrActionSetCreateInfo.Bufferinstance allocated withmemAlloc.static XrActionSetCreateInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrActionSetCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static XrActionSetCreateInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrActionSetCreateInfoinstance allocated on the specifiedMemoryStack.static java.nio.ByteBuffernactionSetName(long struct)Unsafe version ofactionSetName().static voidnactionSetName(long struct, java.nio.ByteBuffer value)Unsafe version ofactionSetName.static java.lang.StringnactionSetNameString(long struct)Unsafe version ofactionSetNameString().longnext()NULLor a pointer to the next structure in a structure chain.XrActionSetCreateInfonext(long value)Sets the specified value to thenext()field.static java.nio.ByteBuffernlocalizedActionSetName(long struct)Unsafe version oflocalizedActionSetName().static voidnlocalizedActionSetName(long struct, java.nio.ByteBuffer value)Unsafe version oflocalizedActionSetName.static java.lang.StringnlocalizedActionSetNameString(long struct)Unsafe version oflocalizedActionSetNameString().static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static intnpriority(long struct)Unsafe version ofpriority().static voidnpriority(long struct, int value)Unsafe version ofpriority.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.intpriority()defines which action sets' actions are active on a given input source when actions on multiple active action sets are bound to the same input source.XrActionSetCreateInfopriority(int value)Sets the specified value to thepriority()field.XrActionSetCreateInfoset(int type, long next, java.nio.ByteBuffer actionSetName, java.nio.ByteBuffer localizedActionSetName, int priority)Initializes this struct with the specified values.XrActionSetCreateInfoset(XrActionSetCreateInfo src)Copies the specified struct data to this struct.intsizeof()inttype()theXrStructureTypeof this structure.XrActionSetCreateInfotype(int value)Sets the specified value to thetype()field.XrActionSetCreateInfotype$Default()Sets theTYPE_ACTION_SET_CREATE_INFOvalue to thetype()field.
-
-
-
Constructor Detail
-
XrActionSetCreateInfo
public XrActionSetCreateInfo(java.nio.ByteBuffer container)
Creates aXrActionSetCreateInfoinstance at the current position of the specifiedByteBuffercontainer. 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
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
type
public int type()
theXrStructureTypeof this structure.
-
next
public long next()
NULLor a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.
-
actionSetName, actionSetNameString
public java.nio.ByteBuffer actionSetName() public java.lang.String actionSetNameString()
an array containing aNULLterminated non-empty string with the name of this action set.
-
localizedActionSetName, localizedActionSetNameString
public java.nio.ByteBuffer localizedActionSetName() public java.lang.String localizedActionSetNameString()
an array containing aNULLterminatedUTF-8 string that can be presented to the user as a description of the action set. This string should be presented in the system’s current active locale.
-
priority
public int priority()
defines which action sets' actions are active on a given input source when actions on multiple active action sets are bound to the same input source. Larger priority numbers take precedence over smaller priority numbers.
-
type
public XrActionSetCreateInfo type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrActionSetCreateInfo type$Default()
Sets theTYPE_ACTION_SET_CREATE_INFOvalue to thetype()field.
-
next
public XrActionSetCreateInfo next(long value)
Sets the specified value to thenext()field.
-
actionSetName
public XrActionSetCreateInfo actionSetName(java.nio.ByteBuffer value)
Copies the specified encoded string to theactionSetName()field.
-
localizedActionSetName
public XrActionSetCreateInfo localizedActionSetName(java.nio.ByteBuffer value)
Copies the specified encoded string to thelocalizedActionSetName()field.
-
priority
public XrActionSetCreateInfo priority(int value)
Sets the specified value to thepriority()field.
-
set
public XrActionSetCreateInfo set(int type, long next, java.nio.ByteBuffer actionSetName, java.nio.ByteBuffer localizedActionSetName, int priority)
Initializes this struct with the specified values.
-
set
public XrActionSetCreateInfo set(XrActionSetCreateInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static XrActionSetCreateInfo malloc()
Returns a newXrActionSetCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrActionSetCreateInfo calloc()
Returns a newXrActionSetCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrActionSetCreateInfo create()
Returns a newXrActionSetCreateInfoinstance allocated withBufferUtils.
-
create
public static XrActionSetCreateInfo create(long address)
Returns a newXrActionSetCreateInfoinstance for the specified memory address.
-
createSafe
@Nullable public static XrActionSetCreateInfo createSafe(long address)
-
malloc
public static XrActionSetCreateInfo.Buffer malloc(int capacity)
Returns a newXrActionSetCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrActionSetCreateInfo.Buffer calloc(int capacity)
Returns a newXrActionSetCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrActionSetCreateInfo.Buffer create(int capacity)
Returns a newXrActionSetCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrActionSetCreateInfo.Buffer create(long address, int capacity)
Create aXrActionSetCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrActionSetCreateInfo.Buffer createSafe(long address, int capacity)
-
malloc
public static XrActionSetCreateInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrActionSetCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrActionSetCreateInfo calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrActionSetCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static XrActionSetCreateInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrActionSetCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrActionSetCreateInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrActionSetCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
ntype
public static int ntype(long struct)
Unsafe version oftype().
-
nnext
public static long nnext(long struct)
Unsafe version ofnext().
-
nactionSetName
public static java.nio.ByteBuffer nactionSetName(long struct)
Unsafe version ofactionSetName().
-
nactionSetNameString
public static java.lang.String nactionSetNameString(long struct)
Unsafe version ofactionSetNameString().
-
nlocalizedActionSetName
public static java.nio.ByteBuffer nlocalizedActionSetName(long struct)
Unsafe version oflocalizedActionSetName().
-
nlocalizedActionSetNameString
public static java.lang.String nlocalizedActionSetNameString(long struct)
Unsafe version oflocalizedActionSetNameString().
-
npriority
public static int npriority(long struct)
Unsafe version ofpriority().
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
nnext
public static void nnext(long struct, long value)Unsafe version ofnext.
-
nactionSetName
public static void nactionSetName(long struct, java.nio.ByteBuffer value)Unsafe version ofactionSetName.
-
nlocalizedActionSetName
public static void nlocalizedActionSetName(long struct, java.nio.ByteBuffer value)Unsafe version oflocalizedActionSetName.
-
npriority
public static void npriority(long struct, int value)Unsafe version ofpriority.
-
-