Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrActiveActionSet

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

Describes an active action set.
Description

This structure defines a single active action set and subaction path combination. Applications can provide a list of these structures to the SyncActions function.

Valid Usage (Implicit)
See Also

XrActionsSyncInfo, SyncActions

Layout


struct XrActiveActionSet {
    XrActionSet actionSet;
    XrPath subactionPath;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ACTIONSET

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SUBACTIONPATH

The struct member offsets.

Inherited from org.lwjgl.system.Struct:
containerDEFAULT_ALIGN_ASDEFAULT_PACK_ALIGNMENT

Constructor Summary

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

public
XrActiveActionSet(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long
actionSet()

the handle of the action set to activate.

public XrActiveActionSet
actionSet(XrActionSet value)

Sets the specified value to the actionSet field.

public static XrActiveActionSet
calloc()

Returns a new XrActiveActionSet instance allocated with memCalloc.

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

Returns a new XrActiveActionSet.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrActiveActionSet instance allocated with BufferUtils.

public static XrActiveActionSet
create(long address)

Returns a new XrActiveActionSet instance for the specified memory address.

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

Returns a new XrActiveActionSet.Buffer instance allocated with BufferUtils.

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

Create a XrActiveActionSet.Buffer instance at the specified memory.

public static XrActiveActionSet
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrActiveActionSet
malloc()

Returns a new XrActiveActionSet instance allocated with memAlloc.

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

Returns a new XrActiveActionSet.Buffer instance allocated with memAlloc.

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

Returns a new XrActiveActionSet instance allocated on the specified MemoryStack.

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

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

public static long
nactionSet(long struct)

Unsafe version of actionSet.

public static void
nactionSet(long struct, XrActionSet value)

Unsafe version of actionSet.

public static long
nsubactionPath(long struct)

Unsafe version of subactionPath.

public static void
nsubactionPath(long struct, long value)

Unsafe version of subactionPath.

public XrActiveActionSet
set(XrActionSet actionSet, long subactionPath)

Initializes this struct with the specified values.

public XrActiveActionSet

Returns:

this struct
set
(XrActiveActionSet
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
subactionPath()

a subaction path that was declared when one or more actions in the action set was created or NULL_PATH.

public XrActiveActionSet
subactionPath(long value)

Sets the specified value to the subactionPath field.

public static void
validate(long
the struct to validate
struct
)

Validates pointer members that should not be NULL.

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

ACTIONSETback to summary
public static final int ACTIONSET

The struct member offsets.

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

SIZEOFback to summary
public static final int SIZEOF

The struct size in bytes.

SUBACTIONPATHback to summary
public static final int SUBACTIONPATH

The struct member offsets.

Constructor Detail

XrActiveActionSetback to summary
protected XrActiveActionSet(long address, ByteBuffer container)
XrActiveActionSetback to summary
public XrActiveActionSet(ByteBuffer container)

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

actionSetback to summary
public long actionSet()

the handle of the action set to activate.

Annotations
@NativeType:XrActionSet
actionSetback to summary
public XrActiveActionSet actionSet(XrActionSet value)

Sets the specified value to the actionSet field.

callocback to summary
public static XrActiveActionSet calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrActiveActionSet calloc(MemoryStack stack)

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

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

Returns a new XrActiveActionSet instance allocated with BufferUtils.

createback to summary
public static XrActiveActionSet create(long address)

Returns a new XrActiveActionSet instance for the specified memory address.

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

Returns a new XrActiveActionSet.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrActiveActionSet.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrActiveActionSet createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrActiveActionSet malloc(MemoryStack stack)

Returns a new XrActiveActionSet instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nactionSetback to summary
public static long nactionSet(long struct)

Unsafe version of actionSet.

nactionSetback to summary
public static void nactionSet(long struct, XrActionSet value)

Unsafe version of actionSet.

nsubactionPathback to summary
public static long nsubactionPath(long struct)

Unsafe version of subactionPath.

nsubactionPathback to summary
public static void nsubactionPath(long struct, long value)

Unsafe version of subactionPath.

setback to summary
public XrActiveActionSet set(XrActionSet actionSet, long subactionPath)

Initializes this struct with the specified values.

setback to summary
public XrActiveActionSet set(XrActiveActionSet src)

Copies the specified struct data to this struct.

Parameters
src:XrActiveActionSet

the source struct

Returns:XrActiveActionSet

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
subactionPathback to summary
public long subactionPath()

a subaction path that was declared when one or more actions in the action set was created or NULL_PATH. If the application wants to activate the action set on more than one subaction path, it can include additional XrActiveActionSet structs with the other subactionPath values. Using NULL_PATH as the value for subactionPath, acts as a wildcard for all subaction paths on the actions in the action set. If the subaction path was not specified on any of the actions in the actionSet when that action was created, the runtime must return ERROR_PATH_UNSUPPORTED.

Annotations
@NativeType:XrPath
subactionPathback to summary
public XrActiveActionSet subactionPath(long value)

Sets the specified value to the subactionPath field.

validateback to summary
public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters
struct:long

the struct to validate

org.lwjgl.openxr back to summary

public Class XrActiveActionSet.Buffer

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

An array of XrActiveActionSet structs.

Field Summary

Modifier and TypeField and Description
private static final XrActiveActionSet

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrActiveActionSet.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 XrActiveActionSet#actionSet field.
actionSet
()

public XrActiveActionSet.Buffer
actionSet(XrActionSet value)

Sets the specified value to the XrActiveActionSet#actionSet field.

protected XrActiveActionSet
protected XrActiveActionSet.Buffer
public long

Returns:

the value of the XrActiveActionSet#subactionPath field.
subactionPath
()

public XrActiveActionSet.Buffer
subactionPath(long value)

Sets the specified value to the XrActiveActionSet#subactionPath field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrActiveActionSet ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

actionSetback to summary
public long actionSet()
Returns:long

the value of the XrActiveActionSet#actionSet field.

Annotations
@NativeType:XrActionSet
actionSetback to summary
public XrActiveActionSet.Buffer actionSet(XrActionSet value)

Sets the specified value to the XrActiveActionSet#actionSet field.

getElementFactoryback to summary
protected XrActiveActionSet getElementFactory()

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

Annotations
@Override
selfback to summary
protected XrActiveActionSet.Buffer self()

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

Annotations
@Override
subactionPathback to summary
public long subactionPath()
Returns:long

the value of the XrActiveActionSet#subactionPath field.

Annotations
@NativeType:XrPath
subactionPathback to summary
public XrActiveActionSet.Buffer subactionPath(long value)

Sets the specified value to the XrActiveActionSet#subactionPath field.