Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrEventDataInteractionProfileChanged

extends Struct<XrEventDataInteractionProfileChanged>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
Imports
javax.annotation.*, java.nio.*, org.lwjgl.*, org.lwjgl.system.*
Notifies the application than the active interaction profile has changed.
Description

The XrEventDataInteractionProfileChanged event is sent to the application to notify it that the active input form factor for one or more top level user paths has changed. This event must only be sent for interaction profiles that the application indicated its support for via SuggestInteractionProfileBindings. This event must only be sent for running sessions.

The application can call GetCurrentInteractionProfile if it wants to change its own behavior based on the active hardware.

Valid Usage (Implicit)
See Also

GetCurrentInteractionProfile, SuggestInteractionProfileBindings

Layout


struct XrEventDataInteractionProfileChanged {
    XrStructureType type;
    void const * next;
    XrSession session;
}

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
XrEventDataInteractionProfileChanged.Buffer

An array of XrEventDataInteractionProfileChanged structs.

Field Summary

Modifier and TypeField and Description
public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
NEXT

The struct member offsets.

public static final int
SESSION

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

public
XrEventDataInteractionProfileChanged(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public static XrEventDataInteractionProfileChanged
calloc()

Returns a new XrEventDataInteractionProfileChanged instance allocated with memCalloc.

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

Returns a new XrEventDataInteractionProfileChanged.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrEventDataInteractionProfileChanged instance allocated with BufferUtils.

public static XrEventDataInteractionProfileChanged
create(long address)

Returns a new XrEventDataInteractionProfileChanged instance for the specified memory address.

public static XrEventDataInteractionProfileChanged
create(XrEventDataBaseHeader value)

Downcasts the specified XrEventDataBaseHeader instance to XrEventDataInteractionProfileChanged.

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

Returns a new XrEventDataInteractionProfileChanged.Buffer instance allocated with BufferUtils.

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

Create a XrEventDataInteractionProfileChanged.Buffer instance at the specified memory.

public static XrEventDataInteractionProfileChanged.Buffer
create(XrEventDataBaseHeader.Buffer value)

Downcasts the specified XrEventDataBaseHeader.Buffer instance to XrEventDataInteractionProfileChanged.Buffer.

public static XrEventDataInteractionProfileChanged
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrEventDataInteractionProfileChanged
malloc()

Returns a new XrEventDataInteractionProfileChanged instance allocated with memAlloc.

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

Returns a new XrEventDataInteractionProfileChanged.Buffer instance allocated with memAlloc.

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

Returns a new XrEventDataInteractionProfileChanged instance allocated on the specified MemoryStack.

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

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

public long
next()

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

public XrEventDataInteractionProfileChanged
next(long value)

Sets the specified value to the next field.

public static long
nnext(long struct)

Unsafe version of next.

public static void
nnext(long struct, long value)

Unsafe version of next.

public static long
nsession(long struct)

Unsafe version of session.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public long
session()

the XrSession for which at least one of the interaction profiles for a top level path has changed.

public XrEventDataInteractionProfileChanged
set(int type, long next)

Initializes this struct with the specified values.

public XrEventDataInteractionProfileChanged

Returns:

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

Sets the specified value to the type field.

public XrEventDataInteractionProfileChanged
type$Default()

Sets the TYPE_EVENT_DATA_INTERACTION_PROFILE_CHANGED 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.

NEXTback to summary
public static final int NEXT

The struct member offsets.

SESSIONback to summary
public static final int SESSION

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

XrEventDataInteractionProfileChangedback to summary
protected XrEventDataInteractionProfileChanged(long address, ByteBuffer container)
XrEventDataInteractionProfileChangedback to summary
public XrEventDataInteractionProfileChanged(ByteBuffer container)

Creates a XrEventDataInteractionProfileChanged 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 XrEventDataInteractionProfileChanged calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrEventDataInteractionProfileChanged calloc(MemoryStack stack)

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

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

Returns a new XrEventDataInteractionProfileChanged instance allocated with BufferUtils.

createback to summary
public static XrEventDataInteractionProfileChanged create(long address)

Returns a new XrEventDataInteractionProfileChanged instance for the specified memory address.

createback to summary
public static XrEventDataInteractionProfileChanged create(XrEventDataBaseHeader value)

Downcasts the specified XrEventDataBaseHeader instance to XrEventDataInteractionProfileChanged.

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

Returns a new XrEventDataInteractionProfileChanged.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrEventDataInteractionProfileChanged.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createback to summary
public static XrEventDataInteractionProfileChanged.Buffer create(XrEventDataBaseHeader.Buffer value)

Downcasts the specified XrEventDataBaseHeader.Buffer instance to XrEventDataInteractionProfileChanged.Buffer.

createSafeback to summary
public static XrEventDataInteractionProfileChanged createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrEventDataInteractionProfileChanged malloc(MemoryStack stack)

Returns a new XrEventDataInteractionProfileChanged instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

Returns a new XrEventDataInteractionProfileChanged.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 const *
nextback to summary
public XrEventDataInteractionProfileChanged next(long value)

Sets the specified value to the next field.

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.

nsessionback to summary
public static long nsession(long struct)

Unsafe version of session.

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.

sessionback to summary
public long session()

the XrSession for which at least one of the interaction profiles for a top level path has changed.

Annotations
@NativeType:XrSession
setback to summary
public XrEventDataInteractionProfileChanged set(int type, long next)

Initializes this struct with the specified values.

setback to summary
public XrEventDataInteractionProfileChanged set(XrEventDataInteractionProfileChanged src)

Copies the specified struct data to this struct.

Parameters
src:XrEventDataInteractionProfileChanged

the source struct

Returns:XrEventDataInteractionProfileChanged

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

Sets the specified value to the type field.

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

Sets the TYPE_EVENT_DATA_INTERACTION_PROFILE_CHANGED value to the type field.

org.lwjgl.openxr back to summary

public Class XrEventDataInteractionProfileChanged.Buffer

extends StructBuffer<XrEventDataInteractionProfileChanged, XrEventDataInteractionProfileChanged.Buffer>
implements NativeResource
Class Inheritance
All Implemented Interfaces
org.lwjgl.system.NativeResource, java.lang.AutoCloseable
An array of XrEventDataInteractionProfileChanged structs.

Field Summary

Modifier and TypeField and Description
private static final XrEventDataInteractionProfileChanged
ELEMENT_FACTORY

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrEventDataInteractionProfileChanged.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 XrEventDataInteractionProfileChanged
getElementFactory()

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

public long

Returns:

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

public XrEventDataInteractionProfileChanged.Buffer
next(long value)

Sets the specified value to the XrEventDataInteractionProfileChanged#next field.

protected XrEventDataInteractionProfileChanged.Buffer
self()

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

public long

Returns:

the value of the XrEventDataInteractionProfileChanged#session field.
session()

public int

Returns:

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

public XrEventDataInteractionProfileChanged.Buffer
type(int value)

Sets the specified value to the XrEventDataInteractionProfileChanged#type field.

public XrEventDataInteractionProfileChanged.Buffer
type$Default()

Sets the TYPE_EVENT_DATA_INTERACTION_PROFILE_CHANGED value to the XrEventDataInteractionProfileChanged#type field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrEventDataInteractionProfileChanged ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

Creates a new XrEventDataInteractionProfileChanged.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 XrEventDataInteractionProfileChanged#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 XrEventDataInteractionProfileChanged getElementFactory()

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

Annotations
@Override
nextback to summary
public long next()
Returns:long

the value of the XrEventDataInteractionProfileChanged#next field.

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

Sets the specified value to the XrEventDataInteractionProfileChanged#next field.

selfback to summary
protected XrEventDataInteractionProfileChanged.Buffer self()

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

Annotations
@Override
sessionback to summary
public long session()
Returns:long

the value of the XrEventDataInteractionProfileChanged#session field.

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

the value of the XrEventDataInteractionProfileChanged#type field.

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

Sets the specified value to the XrEventDataInteractionProfileChanged#type field.

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

Sets the TYPE_EVENT_DATA_INTERACTION_PROFILE_CHANGED value to the XrEventDataInteractionProfileChanged#type field.