Package org.lwjgl.openxr

Class XrHapticAmplitudeEnvelopeVibrationFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrHapticAmplitudeEnvelopeVibrationFB>

org.lwjgl.openxr.XrHapticAmplitudeEnvelopeVibrationFB

All Implemented Interfaces:

AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer

public class XrHapticAmplitudeEnvelopeVibrationFB
extends org.lwjgl.system.Struct<XrHapticAmplitudeEnvelopeVibrationFB>
implements org.lwjgl.system.NativeResource

Haptic Effect Description.

Member Descriptions

• type is the XrStructureType of this structure.
• next is NULL or a pointer to the next structure in a structure chain.
• duration is the duration of the haptic effect in nanoseconds. See duration for more details.
• amplitudeCount is the number of samples in the buffer.
• amplitudes is the pointer to a float array that contains the samples.

The runtime should resample the provided samples in the amplitudes, and maintain an internal buffer which should be of MAX_HAPTIC_AMPLITUDE_ENVELOPE_SAMPLES_FB length. The resampling should happen based on the duration, amplitudeCount, and the device’s sample rate.

Valid Usage (Implicit)

• The XR_FB_haptic_amplitude_envelope extension must be enabled prior to using XrHapticAmplitudeEnvelopeVibrationFB
• type must be TYPE_HAPTIC_AMPLITUDE_ENVELOPE_VIBRATION_FB
• next must be NULL or a valid pointer to the next structure in a structure chain
• amplitudes must be a pointer to an array of amplitudeCount float values
• The amplitudeCount parameter must be greater than 0

Layout

 struct XrHapticAmplitudeEnvelopeVibrationFB {
     XrStructureType type;
     void const * next;
     XrDuration duration;
     uint32_t amplitudeCount;
     float const * amplitudes;
 }

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XrHapticAmplitudeEnvelopeVibrationFB.Buffer	An array of XrHapticAmplitudeEnvelopeVibrationFB structs.

Nested classes/interfaces inherited from class org.lwjgl.system.Struct

org.lwjgl.system.Struct.StructValidation

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

org.lwjgl.system.Pointer.Default

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ALIGNOF	The struct alignment in bytes.
static final int	AMPLITUDECOUNT	The struct member offsets.
static final int	AMPLITUDES	The struct member offsets.
static final int	DURATION	The struct member offsets.
static final int	NEXT	The struct member offsets.
static final int	SIZEOF	The struct size in bytes.
static final int	TYPE	The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

Constructor	Description
XrHapticAmplitudeEnvelopeVibrationFB(ByteBuffer container)	Creates a XrHapticAmplitudeEnvelopeVibrationFB instance at the current position of the specified ByteBuffer container.

Method Summary

Modifier and Type	Method	Description
int	amplitudeCount()
FloatBuffer	amplitudes()
XrHapticAmplitudeEnvelopeVibrationFB	amplitudes(FloatBuffer value)	Sets the address of the specified FloatBuffer to the amplitudes field.
static XrHapticAmplitudeEnvelopeVibrationFB	calloc()	Returns a new XrHapticAmplitudeEnvelopeVibrationFB instance allocated with memCalloc.
static XrHapticAmplitudeEnvelopeVibrationFB.Buffer	calloc(int capacity)	Returns a new XrHapticAmplitudeEnvelopeVibrationFB.Buffer instance allocated with memCalloc.
static XrHapticAmplitudeEnvelopeVibrationFB.Buffer	calloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrHapticAmplitudeEnvelopeVibrationFB.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrHapticAmplitudeEnvelopeVibrationFB	calloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrHapticAmplitudeEnvelopeVibrationFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrHapticAmplitudeEnvelopeVibrationFB	create()	Returns a new XrHapticAmplitudeEnvelopeVibrationFB instance allocated with BufferUtils.
static XrHapticAmplitudeEnvelopeVibrationFB.Buffer	create(int capacity)	Returns a new XrHapticAmplitudeEnvelopeVibrationFB.Buffer instance allocated with BufferUtils.
static XrHapticAmplitudeEnvelopeVibrationFB	create(long address)	Returns a new XrHapticAmplitudeEnvelopeVibrationFB instance for the specified memory address.
static XrHapticAmplitudeEnvelopeVibrationFB.Buffer	create(long address, int capacity)	Create a XrHapticAmplitudeEnvelopeVibrationFB.Buffer instance at the specified memory.
static XrHapticAmplitudeEnvelopeVibrationFB	create(XrHapticBaseHeader value)	Downcasts the specified XrHapticBaseHeader instance to XrHapticAmplitudeEnvelopeVibrationFB.
static XrHapticAmplitudeEnvelopeVibrationFB.Buffer	create(XrHapticBaseHeader.Buffer value)	Downcasts the specified XrHapticBaseHeader.Buffer instance to XrHapticAmplitudeEnvelopeVibrationFB.Buffer.
static @Nullable XrHapticAmplitudeEnvelopeVibrationFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrHapticAmplitudeEnvelopeVibrationFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
long	duration()
XrHapticAmplitudeEnvelopeVibrationFB	duration(long value)	Sets the specified value to the duration field.
static XrHapticAmplitudeEnvelopeVibrationFB	malloc()	Returns a new XrHapticAmplitudeEnvelopeVibrationFB instance allocated with memAlloc.
static XrHapticAmplitudeEnvelopeVibrationFB.Buffer	malloc(int capacity)	Returns a new XrHapticAmplitudeEnvelopeVibrationFB.Buffer instance allocated with memAlloc.
static XrHapticAmplitudeEnvelopeVibrationFB.Buffer	malloc(int capacity, org.lwjgl.system.MemoryStack stack)	Returns a new XrHapticAmplitudeEnvelopeVibrationFB.Buffer instance allocated on the specified MemoryStack.
static XrHapticAmplitudeEnvelopeVibrationFB	malloc(org.lwjgl.system.MemoryStack stack)	Returns a new XrHapticAmplitudeEnvelopeVibrationFB instance allocated on the specified MemoryStack.
static int	namplitudeCount(long struct)	Unsafe version of amplitudeCount().
static void	namplitudeCount(long struct, int value)	Sets the specified value to the amplitudeCount field of the specified struct.
static FloatBuffer	namplitudes(long struct)	Unsafe version of amplitudes.
static void	namplitudes(long struct, FloatBuffer value)	Unsafe version of amplitudes.
static long	nduration(long struct)	Unsafe version of duration().
static void	nduration(long struct, long value)	Unsafe version of duration.
long	next()
XrHapticAmplitudeEnvelopeVibrationFB	next(long value)	Sets the specified value to the next field.
static long	nnext(long struct)	Unsafe version of next().
static void	nnext(long struct, long value)	Unsafe version of next.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
XrHapticAmplitudeEnvelopeVibrationFB	set(int type, long next, long duration, FloatBuffer amplitudes)	Initializes this struct with the specified values.
XrHapticAmplitudeEnvelopeVibrationFB	set(XrHapticAmplitudeEnvelopeVibrationFB src)	Copies the specified struct data to this struct.
int	sizeof()
int	type()
XrHapticAmplitudeEnvelopeVibrationFB	type(int value)	Sets the specified value to the type field.
XrHapticAmplitudeEnvelopeVibrationFB	type$Default()	Sets the TYPE_HAPTIC_AMPLITUDE_ENVELOPE_VIBRATION_FB value to the type field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class org.lwjgl.system.Struct

clear, free, isNull, validate, validate

Methods inherited from class org.lwjgl.system.Pointer.Default

address, equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource

close, free

Field Details

SIZEOF

public static final int SIZEOF

The struct size in bytes.

ALIGNOF

public static final int ALIGNOF

The struct alignment in bytes.

TYPE

public static final int TYPE

The struct member offsets.

NEXT

public static final int NEXT

The struct member offsets.

DURATION

public static final int DURATION

The struct member offsets.

AMPLITUDECOUNT

public static final int AMPLITUDECOUNT

The struct member offsets.

AMPLITUDES

public static final int AMPLITUDES

The struct member offsets.

Constructor Details

XrHapticAmplitudeEnvelopeVibrationFB

public XrHapticAmplitudeEnvelopeVibrationFB(ByteBuffer container)

Creates a XrHapticAmplitudeEnvelopeVibrationFB 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 Details

sizeof

public int sizeof()

Specified by:

sizeof in class org.lwjgl.system.Struct<XrHapticAmplitudeEnvelopeVibrationFB>

type

public int type()

Returns:

the value of the type field.

next

public long next()

Returns:

the value of the next field.

duration

public long duration()

Returns:

the value of the duration field.

amplitudeCount

public int amplitudeCount()

Returns:

the value of the amplitudeCount field.

amplitudes

public FloatBuffer amplitudes()

Returns:

a FloatBuffer view of the data pointed to by the amplitudes field.

type

public XrHapticAmplitudeEnvelopeVibrationFB type(int value)

Sets the specified value to the type field.

type$Default

public XrHapticAmplitudeEnvelopeVibrationFB type$Default()

Sets the TYPE_HAPTIC_AMPLITUDE_ENVELOPE_VIBRATION_FB value to the type field.

next

public XrHapticAmplitudeEnvelopeVibrationFB next(long value)

Sets the specified value to the next field.

duration

public XrHapticAmplitudeEnvelopeVibrationFB duration(long value)

Sets the specified value to the duration field.

amplitudes

public XrHapticAmplitudeEnvelopeVibrationFB amplitudes(FloatBuffer value)

Sets the address of the specified FloatBuffer to the amplitudes field.

set

public XrHapticAmplitudeEnvelopeVibrationFB set(int type,
 long next,
 long duration,
 FloatBuffer amplitudes)

Initializes this struct with the specified values.

set

public XrHapticAmplitudeEnvelopeVibrationFB set(XrHapticAmplitudeEnvelopeVibrationFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrHapticAmplitudeEnvelopeVibrationFB malloc()

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

calloc

public static XrHapticAmplitudeEnvelopeVibrationFB calloc()

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

create

public static XrHapticAmplitudeEnvelopeVibrationFB create()

Returns a new XrHapticAmplitudeEnvelopeVibrationFB instance allocated with BufferUtils.

create

public static XrHapticAmplitudeEnvelopeVibrationFB create(long address)

Returns a new XrHapticAmplitudeEnvelopeVibrationFB instance for the specified memory address.

createSafe

public static @Nullable XrHapticAmplitudeEnvelopeVibrationFB createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrHapticAmplitudeEnvelopeVibrationFB create(XrHapticBaseHeader value)

Downcasts the specified XrHapticBaseHeader instance to XrHapticAmplitudeEnvelopeVibrationFB.

malloc

public static XrHapticAmplitudeEnvelopeVibrationFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrHapticAmplitudeEnvelopeVibrationFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrHapticAmplitudeEnvelopeVibrationFB.Buffer create(int capacity)

Returns a new XrHapticAmplitudeEnvelopeVibrationFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

public static XrHapticAmplitudeEnvelopeVibrationFB.Buffer create(long address,
 int capacity)

Create a XrHapticAmplitudeEnvelopeVibrationFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

public static @Nullable XrHapticAmplitudeEnvelopeVibrationFB.Buffer createSafe(long address,
 int capacity)

Like create, but returns null if address is NULL.

create

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

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

malloc

public static XrHapticAmplitudeEnvelopeVibrationFB malloc(org.lwjgl.system.MemoryStack stack)

Returns a new XrHapticAmplitudeEnvelopeVibrationFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

public static XrHapticAmplitudeEnvelopeVibrationFB calloc(org.lwjgl.system.MemoryStack stack)

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

Parameters:

stack - the stack from which to allocate

malloc

public static XrHapticAmplitudeEnvelopeVibrationFB.Buffer malloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

public static XrHapticAmplitudeEnvelopeVibrationFB.Buffer calloc(int capacity,
 org.lwjgl.system.MemoryStack stack)

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

ntype

public static int ntype(long struct)

Unsafe version of type().

nnext

public static long nnext(long struct)

Unsafe version of next().

nduration

public static long nduration(long struct)

Unsafe version of duration().

namplitudeCount

public static int namplitudeCount(long struct)

Unsafe version of amplitudeCount().

namplitudes

public static FloatBuffer namplitudes(long struct)

Unsafe version of amplitudes.

ntype

public static void ntype(long struct,
 int value)

Unsafe version of type.

nnext

public static void nnext(long struct,
 long value)

Unsafe version of next.

nduration

public static void nduration(long struct,
 long value)

Unsafe version of duration.

namplitudeCount

public static void namplitudeCount(long struct,
 int value)

Sets the specified value to the amplitudeCount field of the specified struct.

namplitudes

public static void namplitudes(long struct,
 FloatBuffer value)

Unsafe version of amplitudes.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate