Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrInteractionProfileState

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

Receives active interaction profile for a top level path.
Description

The runtime must only include interaction profiles that the application has provided bindings for via SuggestInteractionProfileBindings or NULL_PATH. If the runtime is rebinding an interaction profile provided by the application to a device that the application did not provide bindings for, it must return the interaction profile path that it is emulating. If the runtime is unable to provide input because it cannot emulate any of the application-provided interaction profiles, it must return NULL_PATH.

Valid Usage (Implicit)
See Also

XrActionSuggestedBinding, GetCurrentInteractionProfile, SuggestInteractionProfileBindings

Layout


struct XrInteractionProfileState {
    XrStructureType type;
    void * next;
    XrPath interactionProfile;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
INTERACTIONPROFILE

The struct member offsets.

public static final int
NEXT

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

public
XrInteractionProfileState(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrInteractionProfileState
calloc()

Returns a new XrInteractionProfileState instance allocated with memCalloc.

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

Returns a new XrInteractionProfileState.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrInteractionProfileState instance allocated with BufferUtils.

public static XrInteractionProfileState
create(long address)

Returns a new XrInteractionProfileState instance for the specified memory address.

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

Returns a new XrInteractionProfileState.Buffer instance allocated with BufferUtils.

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

Create a XrInteractionProfileState.Buffer instance at the specified memory.

public static XrInteractionProfileState
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
interactionProfile()

the XrPath of the interaction profile path for the topLevelUserPath used to retrieve this state, or NULL_PATH if there is no active interaction profile at that top level user path.

public XrInteractionProfileState
interactionProfile(long value)

Sets the specified value to the interactionProfile field.

public static XrInteractionProfileState
malloc()

Returns a new XrInteractionProfileState instance allocated with memAlloc.

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

Returns a new XrInteractionProfileState.Buffer instance allocated with memAlloc.

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

Returns a new XrInteractionProfileState instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrInteractionProfileState
next(long value)

Sets the specified value to the next field.

public static long
ninteractionProfile(long struct)

Unsafe version of interactionProfile.

public static void
ninteractionProfile(long struct, long value)

Unsafe version of interactionProfile.

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
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrInteractionProfileState
set(int type, long next, long interactionProfile)

Initializes this struct with the specified values.

public XrInteractionProfileState

Returns:

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

Sets the specified value to the type field.

public XrInteractionProfileState
type$Default()

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

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

INTERACTIONPROFILEback to summary
public static final int INTERACTIONPROFILE

The struct member offsets.

NEXTback to summary
public static final int NEXT

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

XrInteractionProfileStateback to summary
protected XrInteractionProfileState(long address, ByteBuffer container)
XrInteractionProfileStateback to summary
public XrInteractionProfileState(ByteBuffer container)

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

callocback to summary
public static XrInteractionProfileState calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrInteractionProfileState calloc(MemoryStack stack)

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

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

Returns a new XrInteractionProfileState instance allocated with BufferUtils.

createback to summary
public static XrInteractionProfileState create(long address)

Returns a new XrInteractionProfileState instance for the specified memory address.

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

Returns a new XrInteractionProfileState.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrInteractionProfileState.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrInteractionProfileState createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
interactionProfileback to summary
public long interactionProfile()

the XrPath of the interaction profile path for the topLevelUserPath used to retrieve this state, or NULL_PATH if there is no active interaction profile at that top level user path.

Annotations
@NativeType:XrPath
interactionProfileback to summary
public XrInteractionProfileState interactionProfile(long value)

Sets the specified value to the interactionProfile field.

mallocback to summary
public static XrInteractionProfileState malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrInteractionProfileState malloc(MemoryStack stack)

Returns a new XrInteractionProfileState instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

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 *
nextback to summary
public XrInteractionProfileState next(long value)

Sets the specified value to the next field.

ninteractionProfileback to summary
public static long ninteractionProfile(long struct)

Unsafe version of interactionProfile.

ninteractionProfileback to summary
public static void ninteractionProfile(long struct, long value)

Unsafe version of interactionProfile.

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.

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.

setback to summary
public XrInteractionProfileState set(int type, long next, long interactionProfile)

Initializes this struct with the specified values.

setback to summary
public XrInteractionProfileState set(XrInteractionProfileState src)

Copies the specified struct data to this struct.

Parameters
src:XrInteractionProfileState

the source struct

Returns:XrInteractionProfileState

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 XrInteractionProfileState type(int value)

Sets the specified value to the type field.

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

Sets the TYPE_INTERACTION_PROFILE_STATE value to the type field.

org.lwjgl.openxr back to summary

public Class XrInteractionProfileState.Buffer

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

An array of XrInteractionProfileState structs.

Field Summary

Modifier and TypeField and Description
private static final XrInteractionProfileState

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrInteractionProfileState.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
protected XrInteractionProfileState
public long
public XrInteractionProfileState.Buffer
interactionProfile(long value)

Sets the specified value to the XrInteractionProfileState#interactionProfile field.

public long

Returns:

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

public XrInteractionProfileState.Buffer
next(long value)

Sets the specified value to the XrInteractionProfileState#next field.

protected XrInteractionProfileState.Buffer
public int

Returns:

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

public XrInteractionProfileState.Buffer
type(int value)

Sets the specified value to the XrInteractionProfileState#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrInteractionProfileState ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

getElementFactoryback to summary
protected XrInteractionProfileState getElementFactory()

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

Annotations
@Override
interactionProfileback to summary
public long interactionProfile()
Returns:long

the value of the XrInteractionProfileState#interactionProfile field.

Annotations
@NativeType:XrPath
interactionProfileback to summary
public XrInteractionProfileState.Buffer interactionProfile(long value)

Sets the specified value to the XrInteractionProfileState#interactionProfile field.

nextback to summary
public long next()
Returns:long

the value of the XrInteractionProfileState#next field.

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

Sets the specified value to the XrInteractionProfileState#next field.

selfback to summary
protected XrInteractionProfileState.Buffer self()

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

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

the value of the XrInteractionProfileState#type field.

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

Sets the specified value to the XrInteractionProfileState#type field.

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

Sets the TYPE_INTERACTION_PROFILE_STATE value to the XrInteractionProfileState#type field.