Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrHapticActionInfo

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

Information to output haptic feedback.
Description

See XrActionCreateInfo for a description of subaction paths, and the restrictions on their use.

Valid Usage (Implicit)
See Also

ApplyHapticFeedback, GetDeviceSampleRateFB, StopHapticFeedback

Layout


struct XrHapticActionInfo {
    XrStructureType type;
    void const * next;
    XrAction action;
    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
ACTION

The struct member offsets.

public static final int
ALIGNOF

The struct alignment in bytes.

public static final int
NEXT

The struct member offsets.

public static final int
SIZEOF

The struct size in bytes.

public static final int
SUBACTIONPATH

The struct member offsets.

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

public
XrHapticActionInfo(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public long
action()

the XrAction handle for the desired output haptic action.

public XrHapticActionInfo
action(XrAction value)

Sets the specified value to the action field.

public static XrHapticActionInfo
calloc()

Returns a new XrHapticActionInfo instance allocated with memCalloc.

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

Returns a new XrHapticActionInfo.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrHapticActionInfo instance allocated with BufferUtils.

public static XrHapticActionInfo
create(long address)

Returns a new XrHapticActionInfo instance for the specified memory address.

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

Returns a new XrHapticActionInfo.Buffer instance allocated with BufferUtils.

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

Create a XrHapticActionInfo.Buffer instance at the specified memory.

public static XrHapticActionInfo
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public static XrHapticActionInfo
malloc()

Returns a new XrHapticActionInfo instance allocated with memAlloc.

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

Returns a new XrHapticActionInfo.Buffer instance allocated with memAlloc.

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

Returns a new XrHapticActionInfo instance allocated on the specified MemoryStack.

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

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

public static long
naction(long struct)

Unsafe version of action.

public static void
naction(long struct, XrAction value)

Unsafe version of action.

public long
next()

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

public XrHapticActionInfo
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
nsubactionPath(long struct)

Unsafe version of subactionPath.

public static void
nsubactionPath(long struct, long value)

Unsafe version of subactionPath.

public static int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

public XrHapticActionInfo
set(int type, long next, XrAction action, long subactionPath)

Initializes this struct with the specified values.

public XrHapticActionInfo

Returns:

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

the subaction path XrPath of the device to send the haptic event to, or NULL_PATH to specify all subaction paths.

public XrHapticActionInfo
subactionPath(long value)

Sets the specified value to the subactionPath field.

public int
type()

the XrStructureType of this structure.

public XrHapticActionInfo
type(int value)

Sets the specified value to the type field.

public XrHapticActionInfo
type$Default()

Sets the TYPE_HAPTIC_ACTION_INFO value to the type 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

ACTIONback to summary
public static final int ACTION

The struct member offsets.

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.

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.

TYPEback to summary
public static final int TYPE

The struct member offsets.

Constructor Detail

XrHapticActionInfoback to summary
protected XrHapticActionInfo(long address, ByteBuffer container)
XrHapticActionInfoback to summary
public XrHapticActionInfo(ByteBuffer container)

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

actionback to summary
public long action()

the XrAction handle for the desired output haptic action.

Annotations
@NativeType:XrAction
actionback to summary
public XrHapticActionInfo action(XrAction value)

Sets the specified value to the action field.

callocback to summary
public static XrHapticActionInfo calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrHapticActionInfo calloc(MemoryStack stack)

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

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

Returns a new XrHapticActionInfo instance allocated with BufferUtils.

createback to summary
public static XrHapticActionInfo create(long address)

Returns a new XrHapticActionInfo instance for the specified memory address.

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

Returns a new XrHapticActionInfo.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrHapticActionInfo.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createSafeback to summary
public static XrHapticActionInfo createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

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

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrHapticActionInfo malloc(MemoryStack stack)

Returns a new XrHapticActionInfo instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

nactionback to summary
public static long naction(long struct)

Unsafe version of action.

nactionback to summary
public static void naction(long struct, XrAction value)

Unsafe version of action.

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 XrHapticActionInfo 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.

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.

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 XrHapticActionInfo set(int type, long next, XrAction action, long subactionPath)

Initializes this struct with the specified values.

setback to summary
public XrHapticActionInfo set(XrHapticActionInfo src)

Copies the specified struct data to this struct.

Parameters
src:XrHapticActionInfo

the source struct

Returns:XrHapticActionInfo

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()

the subaction path XrPath of the device to send the haptic event to, or NULL_PATH to specify all subaction paths. If the subaction path is specified, it is one of the subaction paths that were specified when the action was created. If the subaction path was not specified when the action was created, the runtime must return ERROR_PATH_UNSUPPORTED. If this parameter is specified, the runtime must trigger the haptic events only on the device from the subaction path.

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

Sets the specified value to the subactionPath field.

typeback to summary
public int type()

the XrStructureType of this structure.

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

Sets the specified value to the type field.

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

Sets the TYPE_HAPTIC_ACTION_INFO value to the type 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 XrHapticActionInfo.Buffer

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

An array of XrHapticActionInfo structs.

Field Summary

Modifier and TypeField and Description
private static final XrHapticActionInfo

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

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

public XrHapticActionInfo.Buffer
action(XrAction value)

Sets the specified value to the XrHapticActionInfo#action field.

protected XrHapticActionInfo
public long

Returns:

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

public XrHapticActionInfo.Buffer
next(long value)

Sets the specified value to the XrHapticActionInfo#next field.

protected XrHapticActionInfo.Buffer
public long

Returns:

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

public XrHapticActionInfo.Buffer
subactionPath(long value)

Sets the specified value to the XrHapticActionInfo#subactionPath field.

public int

Returns:

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

public XrHapticActionInfo.Buffer
type(int value)

Sets the specified value to the XrHapticActionInfo#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrHapticActionInfo ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

actionback to summary
public long action()
Returns:long

the value of the XrHapticActionInfo#action field.

Annotations
@NativeType:XrAction
actionback to summary
public XrHapticActionInfo.Buffer action(XrAction value)

Sets the specified value to the XrHapticActionInfo#action field.

getElementFactoryback to summary
protected XrHapticActionInfo getElementFactory()

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

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

the value of the XrHapticActionInfo#next field.

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

Sets the specified value to the XrHapticActionInfo#next field.

selfback to summary
protected XrHapticActionInfo.Buffer self()

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

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

the value of the XrHapticActionInfo#subactionPath field.

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

Sets the specified value to the XrHapticActionInfo#subactionPath field.

typeback to summary
public int type()
Returns:int

the value of the XrHapticActionInfo#type field.

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

Sets the specified value to the XrHapticActionInfo#type field.

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

Sets the TYPE_HAPTIC_ACTION_INFO value to the XrHapticActionInfo#type field.