Package org.lwjgl.openxr
Class XrHapticVibration
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.openxr.XrHapticVibration
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class XrHapticVibration extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceBase header for haptic feedback.Description
The
XrHapticVibrationis used in calls toApplyHapticFeedbackthat trigger actionname:vibration output actions.The
duration, andfrequencyparameters may be clamped to implementation-dependent ranges.Valid Usage (Implicit)
typemust beTYPE_HAPTIC_VIBRATIONnextmust beNULLor a valid pointer to the next structure in a structure chain
See Also
XrHapticBaseHeader,ApplyHapticFeedbackLayout
struct XrHapticVibration { XrStructureTypetype(); void const *next(); XrDurationduration(); floatfrequency(); floatamplitude(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classXrHapticVibration.BufferAn array ofXrHapticVibrationstructs.
-
Constructor Summary
Constructors Constructor Description XrHapticVibration(java.nio.ByteBuffer container)Creates aXrHapticVibrationinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description floatamplitude()the amplitude of the vibration between0.0and1.0.XrHapticVibrationamplitude(float value)Sets the specified value to theamplitude()field.static XrHapticVibrationcalloc()Returns a newXrHapticVibrationinstance allocated withmemCalloc.static XrHapticVibration.Buffercalloc(int capacity)Returns a newXrHapticVibration.Bufferinstance allocated withmemCalloc.static XrHapticVibration.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrHapticVibration.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrHapticVibrationcalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrHapticVibrationinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static XrHapticVibrationcreate()Returns a newXrHapticVibrationinstance allocated withBufferUtils.static XrHapticVibration.Buffercreate(int capacity)Returns a newXrHapticVibration.Bufferinstance allocated withBufferUtils.static XrHapticVibrationcreate(long address)Returns a newXrHapticVibrationinstance for the specified memory address.static XrHapticVibration.Buffercreate(long address, int capacity)Create aXrHapticVibration.Bufferinstance at the specified memory.static XrHapticVibrationcreate(XrHapticBaseHeader value)Downcasts the specifiedXrHapticBaseHeaderinstance toXrHapticVibration.static XrHapticVibration.Buffercreate(XrHapticBaseHeader.Buffer value)Downcasts the specifiedXrHapticBaseHeader.Bufferinstance toXrHapticVibration.Buffer.static XrHapticVibrationcreateSafe(long address)static XrHapticVibration.BuffercreateSafe(long address, int capacity)longduration()the number of nanoseconds the vibration should last.XrHapticVibrationduration(long value)Sets the specified value to theduration()field.floatfrequency()the frequency of the vibration in Hz.XrHapticVibrationfrequency(float value)Sets the specified value to thefrequency()field.static XrHapticVibrationmalloc()Returns a newXrHapticVibrationinstance allocated withmemAlloc.static XrHapticVibration.Buffermalloc(int capacity)Returns a newXrHapticVibration.Bufferinstance allocated withmemAlloc.static XrHapticVibration.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newXrHapticVibration.Bufferinstance allocated on the specifiedMemoryStack.static XrHapticVibrationmalloc(org.lwjgl.system.MemoryStack stack)Returns a newXrHapticVibrationinstance allocated on the specifiedMemoryStack.static floatnamplitude(long struct)Unsafe version ofamplitude().static voidnamplitude(long struct, float value)Unsafe version ofamplitude.static longnduration(long struct)Unsafe version ofduration().static voidnduration(long struct, long value)Unsafe version ofduration.longnext()NULLor a pointer to the next structure in a structure chain.XrHapticVibrationnext(long value)Sets the specified value to thenext()field.static floatnfrequency(long struct)Unsafe version offrequency().static voidnfrequency(long struct, float value)Unsafe version offrequency.static longnnext(long struct)Unsafe version ofnext().static voidnnext(long struct, long value)Unsafe version ofnext.static intntype(long struct)Unsafe version oftype().static voidntype(long struct, int value)Unsafe version oftype.XrHapticVibrationset(int type, long next, long duration, float frequency, float amplitude)Initializes this struct with the specified values.XrHapticVibrationset(XrHapticVibration src)Copies the specified struct data to this struct.intsizeof()inttype()theXrStructureTypeof this structure.XrHapticVibrationtype(int value)Sets the specified value to thetype()field.XrHapticVibrationtype$Default()Sets theTYPE_HAPTIC_VIBRATIONvalue to thetype()field.
-
-
-
Constructor Detail
-
XrHapticVibration
public XrHapticVibration(java.nio.ByteBuffer container)
Creates aXrHapticVibrationinstance at the current position of the specifiedByteBuffercontainer. 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
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
type
public int type()
theXrStructureTypeof this structure.
-
next
public long next()
NULLor a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR.
-
duration
public long duration()
the number of nanoseconds the vibration should last. IfMIN_HAPTIC_DURATIONis specified, the runtime must produce a short haptics pulse of minimal supported duration for the haptic device.
-
frequency
public float frequency()
the frequency of the vibration in Hz. IfFREQUENCY_UNSPECIFIEDis specified, it is left to the runtime to decide the optimal frequency value to use.
-
amplitude
public float amplitude()
the amplitude of the vibration between0.0and1.0.
-
type
public XrHapticVibration type(int value)
Sets the specified value to thetype()field.
-
type$Default
public XrHapticVibration type$Default()
Sets theTYPE_HAPTIC_VIBRATIONvalue to thetype()field.
-
next
public XrHapticVibration next(long value)
Sets the specified value to thenext()field.
-
duration
public XrHapticVibration duration(long value)
Sets the specified value to theduration()field.
-
frequency
public XrHapticVibration frequency(float value)
Sets the specified value to thefrequency()field.
-
amplitude
public XrHapticVibration amplitude(float value)
Sets the specified value to theamplitude()field.
-
set
public XrHapticVibration set(int type, long next, long duration, float frequency, float amplitude)
Initializes this struct with the specified values.
-
set
public XrHapticVibration set(XrHapticVibration src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static XrHapticVibration malloc()
Returns a newXrHapticVibrationinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static XrHapticVibration calloc()
Returns a newXrHapticVibrationinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static XrHapticVibration create()
Returns a newXrHapticVibrationinstance allocated withBufferUtils.
-
create
public static XrHapticVibration create(long address)
Returns a newXrHapticVibrationinstance for the specified memory address.
-
createSafe
@Nullable public static XrHapticVibration createSafe(long address)
-
create
public static XrHapticVibration create(XrHapticBaseHeader value)
Downcasts the specifiedXrHapticBaseHeaderinstance toXrHapticVibration.
-
malloc
public static XrHapticVibration.Buffer malloc(int capacity)
Returns a newXrHapticVibration.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static XrHapticVibration.Buffer calloc(int capacity)
Returns a newXrHapticVibration.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static XrHapticVibration.Buffer create(int capacity)
Returns a newXrHapticVibration.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static XrHapticVibration.Buffer create(long address, int capacity)
Create aXrHapticVibration.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static XrHapticVibration.Buffer createSafe(long address, int capacity)
-
create
public static XrHapticVibration.Buffer create(XrHapticBaseHeader.Buffer value)
Downcasts the specifiedXrHapticBaseHeader.Bufferinstance toXrHapticVibration.Buffer.
-
malloc
public static XrHapticVibration malloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrHapticVibrationinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static XrHapticVibration calloc(org.lwjgl.system.MemoryStack stack)
Returns a newXrHapticVibrationinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static XrHapticVibration.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrHapticVibration.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static XrHapticVibration.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newXrHapticVibration.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
ntype
public static int ntype(long struct)
Unsafe version oftype().
-
nnext
public static long nnext(long struct)
Unsafe version ofnext().
-
nduration
public static long nduration(long struct)
Unsafe version ofduration().
-
nfrequency
public static float nfrequency(long struct)
Unsafe version offrequency().
-
namplitude
public static float namplitude(long struct)
Unsafe version ofamplitude().
-
ntype
public static void ntype(long struct, int value)Unsafe version oftype.
-
nnext
public static void nnext(long struct, long value)Unsafe version ofnext.
-
nduration
public static void nduration(long struct, long value)Unsafe version ofduration.
-
nfrequency
public static void nfrequency(long struct, float value)Unsafe version offrequency.
-
namplitude
public static void namplitude(long struct, float value)Unsafe version ofamplitude.
-
-