Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrActionSetCreateInfo

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

XrActionSet creation info.
Description

When multiple actions are bound to the same input source, the priority of 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 isActive field must be FALSE when 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 actionSetName or localizedActionSetName are empty strings, the runtime must return ERROR_NAME_INVALID or ERROR_LOCALIZED_NAME_INVALID respectively. If actionSetName or localizedActionSetName are duplicates of the corresponding field for any existing action set in the specified instance, the runtime must return ERROR_NAME_DUPLICATED or ERROR_LOCALIZED_NAME_DUPLICATED respectively. If the conflicting action set is destroyed, the conflicting field is no longer considered duplicated. If actionSetName contains characters which are not allowed in a single level of a well-formed path string, the runtime must return ERROR_PATH_FORMAT_INVALID.

Valid Usage (Implicit)
See Also

CreateActionSet

Layout


struct XrActionSetCreateInfo {
    XrStructureType type;
    void const * next;
    char actionSetName[XR_MAX_ACTION_SET_NAME_SIZE];
    char localizedActionSetName[XR_MAX_LOCALIZED_ACTION_SET_NAME_SIZE];
    uint32_t priority;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ACTIONSETNAME

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
LOCALIZEDACTIONSETNAME

The struct member offsets.

public static final int
NEXT

The struct member offsets.

public static final int
PRIORITY

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

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
XrActionSetCreateInfo(long address, ByteBuffer container)

public
XrActionSetCreateInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public ByteBuffer
actionSetName()

an array containing a NULL terminated non-empty string with the name of this action set.

public XrActionSetCreateInfo
actionSetName(ByteBuffer value)

Copies the specified encoded string to the actionSetName field.

public String
actionSetNameString()

an array containing a NULL terminated non-empty string with the name of this action set.

public static XrActionSetCreateInfo
calloc()

Returns a new XrActionSetCreateInfo instance allocated with memCalloc.

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

Returns a new XrActionSetCreateInfo.Buffer instance allocated with memCalloc.

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

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

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

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

protected XrActionSetCreateInfo
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 XrActionSetCreateInfo
create()

Returns a new XrActionSetCreateInfo instance allocated with BufferUtils.

public static XrActionSetCreateInfo
create(long address)

Returns a new XrActionSetCreateInfo instance for the specified memory address.

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

Returns a new XrActionSetCreateInfo.Buffer instance allocated with BufferUtils.

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

Create a XrActionSetCreateInfo.Buffer instance at the specified memory.

public static XrActionSetCreateInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public ByteBuffer
localizedActionSetName()

an array containing a NULL terminated UTF-8 string that can be presented to the user as a description of the action set.

public XrActionSetCreateInfo
localizedActionSetName(ByteBuffer value)

Copies the specified encoded string to the localizedActionSetName field.

public String
localizedActionSetNameString()

an array containing a NULL terminated UTF-8 string that can be presented to the user as a description of the action set.

public static XrActionSetCreateInfo
malloc()

Returns a new XrActionSetCreateInfo instance allocated with memAlloc.

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

Returns a new XrActionSetCreateInfo.Buffer instance allocated with memAlloc.

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

Returns a new XrActionSetCreateInfo instance allocated on the specified MemoryStack.

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

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

public static ByteBuffer
nactionSetName(long struct)

Unsafe version of actionSetName.

public static void
nactionSetName(long struct, ByteBuffer value)

Unsafe version of actionSetName.

public static String
nactionSetNameString(long struct)

Unsafe version of actionSetNameString.

public long
next()

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

public XrActionSetCreateInfo
next(long value)

Sets the specified value to the next field.

public static ByteBuffer
nlocalizedActionSetName(long struct)

Unsafe version of localizedActionSetName.

public static void
nlocalizedActionSetName(long struct, ByteBuffer value)

Unsafe version of localizedActionSetName.

public static String
public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static int
npriority(long struct)

Unsafe version of priority.

public static void
npriority(long struct, int value)

Unsafe version of priority.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

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.

public XrActionSetCreateInfo
priority(int value)

Sets the specified value to the priority field.

public XrActionSetCreateInfo
set(int type, long next, ByteBuffer actionSetName, ByteBuffer localizedActionSetName, int priority)

Initializes this struct with the specified values.

public XrActionSetCreateInfo

Returns:

this struct
set
(XrActionSetCreateInfo
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 int
type()

the XrStructureType of this structure.

public XrActionSetCreateInfo
type(int value)

Sets the specified value to the type field.

public XrActionSetCreateInfo
type$Default()

Sets the TYPE_ACTION_SET_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

ACTIONSETNAMEback to summary
public static final int ACTIONSETNAME

The struct member offsets.

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

LOCALIZEDACTIONSETNAMEback to summary
public static final int LOCALIZEDACTIONSETNAME

The struct member offsets.

NEXTback to summary
public static final int NEXT

The struct member offsets.

PRIORITYback to summary
public static final int PRIORITY

The struct member offsets.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrActionSetCreateInfoback to summary
protected XrActionSetCreateInfo(long address, ByteBuffer container)
XrActionSetCreateInfoback to summary
public XrActionSetCreateInfo(ByteBuffer container)

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

actionSetNameback to summary
public ByteBuffer actionSetName()

an array containing a NULL terminated non-empty string with the name of this action set.

Annotations
@NativeType:char[XR_MAX_ACTION_SET_NAME_SIZE]
actionSetNameback to summary
public XrActionSetCreateInfo actionSetName(ByteBuffer value)

Copies the specified encoded string to the actionSetName field.

actionSetNameStringback to summary
public String actionSetNameString()

an array containing a NULL terminated non-empty string with the name of this action set.

Annotations
@NativeType:char[XR_MAX_ACTION_SET_NAME_SIZE]
callocback to summary
public static XrActionSetCreateInfo calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrActionSetCreateInfo calloc(MemoryStack stack)

Returns a new XrActionSetCreateInfo 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 XrActionSetCreateInfo.Buffer calloc(int capacity, MemoryStack stack)

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

Returns a new XrActionSetCreateInfo instance allocated with BufferUtils.

createback to summary
public static XrActionSetCreateInfo create(long address)

Returns a new XrActionSetCreateInfo instance for the specified memory address.

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

Returns a new XrActionSetCreateInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrActionSetCreateInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrActionSetCreateInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
localizedActionSetNameback to summary
public ByteBuffer localizedActionSetName()

an array containing a NULL terminated UTF-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.

Annotations
@NativeType:char[XR_MAX_LOCALIZED_ACTION_SET_NAME_SIZE]
localizedActionSetNameback to summary
public XrActionSetCreateInfo localizedActionSetName(ByteBuffer value)

Copies the specified encoded string to the localizedActionSetName field.

localizedActionSetNameStringback to summary
public String localizedActionSetNameString()

an array containing a NULL terminated UTF-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.

Annotations
@NativeType:char[XR_MAX_LOCALIZED_ACTION_SET_NAME_SIZE]
mallocback to summary
public static XrActionSetCreateInfo malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrActionSetCreateInfo malloc(MemoryStack stack)

Returns a new XrActionSetCreateInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nactionSetNameback to summary
public static ByteBuffer nactionSetName(long struct)

Unsafe version of actionSetName.

nactionSetNameback to summary
public static void nactionSetName(long struct, ByteBuffer value)

Unsafe version of actionSetName.

nactionSetNameStringback to summary
public static String nactionSetNameString(long struct)

Unsafe version of actionSetNameString.

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.

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

Sets the specified value to the next field.

nlocalizedActionSetNameback to summary
public static ByteBuffer nlocalizedActionSetName(long struct)

Unsafe version of localizedActionSetName.

nlocalizedActionSetNameback to summary
public static void nlocalizedActionSetName(long struct, ByteBuffer value)

Unsafe version of localizedActionSetName.

nlocalizedActionSetNameStringback to summary
public static String nlocalizedActionSetNameString(long struct)

Unsafe version of localizedActionSetNameString.

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.

npriorityback to summary
public static int npriority(long struct)

Unsafe version of priority.

npriorityback to summary
public static void npriority(long struct, int value)

Unsafe version of priority.

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.

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

Annotations
@NativeType:uint32_t
priorityback to summary
public XrActionSetCreateInfo priority(int value)

Sets the specified value to the priority field.

setback to summary
public XrActionSetCreateInfo set(int type, long next, ByteBuffer actionSetName, ByteBuffer localizedActionSetName, int priority)

Initializes this struct with the specified values.

setback to summary
public XrActionSetCreateInfo set(XrActionSetCreateInfo src)

Copies the specified struct data to this struct.

Parameters
src:XrActionSetCreateInfo

the source struct

Returns:XrActionSetCreateInfo

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
typeback to summary
public int type()

the XrStructureType of this structure.

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

Sets the specified value to the type field.

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

Sets the TYPE_ACTION_SET_CREATE_INFO value to the type field.

org.lwjgl.openxr back to summary

public Class XrActionSetCreateInfo.Buffer

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

An array of XrActionSetCreateInfo structs.

Field Summary

Modifier and TypeField and Description
private static final XrActionSetCreateInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrActionSetCreateInfo.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 ByteBuffer
public XrActionSetCreateInfo.Buffer
actionSetName(ByteBuffer value)

Copies the specified encoded string to the XrActionSetCreateInfo#actionSetName field.

public String

Returns:

the null-terminated string stored in the XrActionSetCreateInfo#actionSetName field.
actionSetNameString
()

protected XrActionSetCreateInfo
public ByteBuffer
public XrActionSetCreateInfo.Buffer
localizedActionSetName(ByteBuffer value)

Copies the specified encoded string to the XrActionSetCreateInfo#localizedActionSetName field.

public String

Returns:

the null-terminated string stored in the XrActionSetCreateInfo#localizedActionSetName field.
localizedActionSetNameString
()

public long

Returns:

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

public XrActionSetCreateInfo.Buffer
next(long value)

Sets the specified value to the XrActionSetCreateInfo#next field.

public int

Returns:

the value of the XrActionSetCreateInfo#priority field.
priority
()

public XrActionSetCreateInfo.Buffer
priority(int value)

Sets the specified value to the XrActionSetCreateInfo#priority field.

protected XrActionSetCreateInfo.Buffer
public int

Returns:

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

public XrActionSetCreateInfo.Buffer
type(int value)

Sets the specified value to the XrActionSetCreateInfo#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrActionSetCreateInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrActionSetCreateInfo.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 XrActionSetCreateInfo#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

actionSetNameback to summary
public ByteBuffer actionSetName()
Returns:ByteBuffer

a ByteBuffer view of the XrActionSetCreateInfo#actionSetName field.

Annotations
@NativeType:char[XR_MAX_ACTION_SET_NAME_SIZE]
actionSetNameback to summary
public XrActionSetCreateInfo.Buffer actionSetName(ByteBuffer value)

Copies the specified encoded string to the XrActionSetCreateInfo#actionSetName field.

actionSetNameStringback to summary
public String actionSetNameString()
Returns:String

the null-terminated string stored in the XrActionSetCreateInfo#actionSetName field.

Annotations
@NativeType:char[XR_MAX_ACTION_SET_NAME_SIZE]
getElementFactoryback to summary
protected XrActionSetCreateInfo getElementFactory()

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

Annotations
@Override
localizedActionSetNameback to summary
public ByteBuffer localizedActionSetName()
Returns:ByteBuffer

a ByteBuffer view of the XrActionSetCreateInfo#localizedActionSetName field.

Annotations
@NativeType:char[XR_MAX_LOCALIZED_ACTION_SET_NAME_SIZE]
localizedActionSetNameback to summary
public XrActionSetCreateInfo.Buffer localizedActionSetName(ByteBuffer value)

Copies the specified encoded string to the XrActionSetCreateInfo#localizedActionSetName field.

localizedActionSetNameStringback to summary
public String localizedActionSetNameString()
Returns:String

the null-terminated string stored in the XrActionSetCreateInfo#localizedActionSetName field.

Annotations
@NativeType:char[XR_MAX_LOCALIZED_ACTION_SET_NAME_SIZE]
nextback to summary
public long next()
Returns:long

the value of the XrActionSetCreateInfo#next field.

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

Sets the specified value to the XrActionSetCreateInfo#next field.

priorityback to summary
public int priority()
Returns:int

the value of the XrActionSetCreateInfo#priority field.

Annotations
@NativeType:uint32_t
priorityback to summary
public XrActionSetCreateInfo.Buffer priority(int value)

Sets the specified value to the XrActionSetCreateInfo#priority field.

selfback to summary
protected XrActionSetCreateInfo.Buffer self()

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

Annotations
@Override
typeback to summary
public int type()
Returns:int

the value of the XrActionSetCreateInfo#type field.

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

Sets the specified value to the XrActionSetCreateInfo#type field.

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

Sets the TYPE_ACTION_SET_CREATE_INFO value to the XrActionSetCreateInfo#type field.