Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrHapticVibration

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

Base header for haptic feedback.
Description

The XrHapticVibration is used in calls to ApplyHapticFeedback that trigger actionname:vibration output actions.

The duration, and frequency parameters may be clamped to implementation-dependent ranges.

Valid Usage (Implicit)
See Also

XrHapticBaseHeader, ApplyHapticFeedback

Layout


struct XrHapticVibration {
    XrStructureType type;
    void const * next;
    XrDuration duration;
    float frequency;
    float amplitude;
}

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
AMPLITUDE

The struct member offsets.

public static final int
DURATION

The struct member offsets.

public static final int
FREQUENCY

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

public
XrHapticVibration(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public float
amplitude()

the amplitude of the vibration between 0.0 and 1.0.

public XrHapticVibration
amplitude(float value)

Sets the specified value to the amplitude field.

public static XrHapticVibration
calloc()

Returns a new XrHapticVibration instance allocated with memCalloc.

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

Returns a new XrHapticVibration.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrHapticVibration instance allocated with BufferUtils.

public static XrHapticVibration
create(long address)

Returns a new XrHapticVibration instance for the specified memory address.

public static XrHapticVibration
create(XrHapticBaseHeader value)

Downcasts the specified XrHapticBaseHeader instance to XrHapticVibration.

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

Returns a new XrHapticVibration.Buffer instance allocated with BufferUtils.

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

Create a XrHapticVibration.Buffer instance at the specified memory.

public static XrHapticVibration.Buffer
create(XrHapticBaseHeader.Buffer value)

Downcasts the specified XrHapticBaseHeader.Buffer instance to XrHapticVibration.Buffer.

public static XrHapticVibration
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long
duration()

the number of nanoseconds the vibration should last.

public XrHapticVibration
duration(long value)

Sets the specified value to the duration field.

public float
frequency()

the frequency of the vibration in Hz.

public XrHapticVibration
frequency(float value)

Sets the specified value to the frequency field.

public static XrHapticVibration
malloc()

Returns a new XrHapticVibration instance allocated with memAlloc.

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

Returns a new XrHapticVibration.Buffer instance allocated with memAlloc.

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

Returns a new XrHapticVibration instance allocated on the specified MemoryStack.

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

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

public static float
namplitude(long struct)

Unsafe version of amplitude.

public static void
namplitude(long struct, float value)

Unsafe version of amplitude.

public static long
nduration(long struct)

Unsafe version of duration.

public static void
nduration(long struct, long value)

Unsafe version of duration.

public long
next()

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

public XrHapticVibration
next(long value)

Sets the specified value to the next field.

public static float
nfrequency(long struct)

Unsafe version of frequency.

public static void
nfrequency(long struct, float value)

Unsafe version of frequency.

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 XrHapticVibration
set(int type, long next, long duration, float frequency, float amplitude)

Initializes this struct with the specified values.

public XrHapticVibration

Returns:

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

Sets the specified value to the type field.

public XrHapticVibration
type$Default()

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

AMPLITUDEback to summary
public static final int AMPLITUDE

The struct member offsets.

DURATIONback to summary
public static final int DURATION

The struct member offsets.

FREQUENCYback to summary
public static final int FREQUENCY

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

XrHapticVibrationback to summary
protected XrHapticVibration(long address, ByteBuffer container)
XrHapticVibrationback to summary
public XrHapticVibration(ByteBuffer container)

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

amplitudeback to summary
public float amplitude()

the amplitude of the vibration between 0.0 and 1.0.

amplitudeback to summary
public XrHapticVibration amplitude(float value)

Sets the specified value to the amplitude field.

callocback to summary
public static XrHapticVibration calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrHapticVibration calloc(MemoryStack stack)

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

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

Returns a new XrHapticVibration instance allocated with BufferUtils.

createback to summary
public static XrHapticVibration create(long address)

Returns a new XrHapticVibration instance for the specified memory address.

createback to summary
public static XrHapticVibration create(XrHapticBaseHeader value)

Downcasts the specified XrHapticBaseHeader instance to XrHapticVibration.

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

Returns a new XrHapticVibration.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrHapticVibration.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

createback to summary
public static XrHapticVibration.Buffer create(XrHapticBaseHeader.Buffer value)

Downcasts the specified XrHapticBaseHeader.Buffer instance to XrHapticVibration.Buffer.

createSafeback to summary
public static XrHapticVibration createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
durationback to summary
public long duration()

the number of nanoseconds the vibration should last. If MIN_HAPTIC_DURATION is specified, the runtime must produce a short haptics pulse of minimal supported duration for the haptic device.

Annotations
@NativeType:XrDuration
durationback to summary
public XrHapticVibration duration(long value)

Sets the specified value to the duration field.

frequencyback to summary
public float frequency()

the frequency of the vibration in Hz. If FREQUENCY_UNSPECIFIED is specified, it is left to the runtime to decide the optimal frequency value to use.

frequencyback to summary
public XrHapticVibration frequency(float value)

Sets the specified value to the frequency field.

mallocback to summary
public static XrHapticVibration malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrHapticVibration malloc(MemoryStack stack)

Returns a new XrHapticVibration instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

namplitudeback to summary
public static float namplitude(long struct)

Unsafe version of amplitude.

namplitudeback to summary
public static void namplitude(long struct, float value)

Unsafe version of amplitude.

ndurationback to summary
public static long nduration(long struct)

Unsafe version of duration.

ndurationback to summary
public static void nduration(long struct, long value)

Unsafe version of duration.

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 XrHapticVibration next(long value)

Sets the specified value to the next field.

nfrequencyback to summary
public static float nfrequency(long struct)

Unsafe version of frequency.

nfrequencyback to summary
public static void nfrequency(long struct, float value)

Unsafe version of frequency.

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 XrHapticVibration set(int type, long next, long duration, float frequency, float amplitude)

Initializes this struct with the specified values.

setback to summary
public XrHapticVibration set(XrHapticVibration src)

Copies the specified struct data to this struct.

Parameters
src:XrHapticVibration

the source struct

Returns:XrHapticVibration

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

Sets the specified value to the type field.

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

Sets the TYPE_HAPTIC_VIBRATION value to the type field.

org.lwjgl.openxr back to summary

public Class XrHapticVibration.Buffer

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

An array of XrHapticVibration structs.

Field Summary

Modifier and TypeField and Description
private static final XrHapticVibration

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrHapticVibration.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 float

Returns:

the value of the XrHapticVibration#amplitude field.
amplitude
()

public XrHapticVibration.Buffer
amplitude(float value)

Sets the specified value to the XrHapticVibration#amplitude field.

public long

Returns:

the value of the XrHapticVibration#duration field.
duration
()

public XrHapticVibration.Buffer
duration(long value)

Sets the specified value to the XrHapticVibration#duration field.

public float

Returns:

the value of the XrHapticVibration#frequency field.
frequency
()

public XrHapticVibration.Buffer
frequency(float value)

Sets the specified value to the XrHapticVibration#frequency field.

protected XrHapticVibration
public long

Returns:

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

public XrHapticVibration.Buffer
next(long value)

Sets the specified value to the XrHapticVibration#next field.

protected XrHapticVibration.Buffer
public int

Returns:

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

public XrHapticVibration.Buffer
type(int value)

Sets the specified value to the XrHapticVibration#type field.

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

Field Detail

ELEMENT_FACTORYback to summary
private static final XrHapticVibration ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

amplitudeback to summary
public float amplitude()
Returns:float

the value of the XrHapticVibration#amplitude field.

amplitudeback to summary
public XrHapticVibration.Buffer amplitude(float value)

Sets the specified value to the XrHapticVibration#amplitude field.

durationback to summary
public long duration()
Returns:long

the value of the XrHapticVibration#duration field.

Annotations
@NativeType:XrDuration
durationback to summary
public XrHapticVibration.Buffer duration(long value)

Sets the specified value to the XrHapticVibration#duration field.

frequencyback to summary
public float frequency()
Returns:float

the value of the XrHapticVibration#frequency field.

frequencyback to summary
public XrHapticVibration.Buffer frequency(float value)

Sets the specified value to the XrHapticVibration#frequency field.

getElementFactoryback to summary
protected XrHapticVibration getElementFactory()

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

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

the value of the XrHapticVibration#next field.

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

Sets the specified value to the XrHapticVibration#next field.

selfback to summary
protected XrHapticVibration.Buffer self()

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

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

the value of the XrHapticVibration#type field.

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

Sets the specified value to the XrHapticVibration#type field.

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

Sets the TYPE_HAPTIC_VIBRATION value to the XrHapticVibration#type field.