Top Description Inners Fields Constructors Methods
org.lwjgl.openxr

public Class XrHapticAmplitudeEnvelopeVibrationFB

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

Haptic Effect Description.
Member Descriptions

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)

Layout


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

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
AMPLITUDECOUNT

The struct member offsets.

public static final int
AMPLITUDES

The struct member offsets.

public static final int
DURATION

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
public
XrHapticAmplitudeEnvelopeVibrationFB(ByteBuffer container)

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

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

the value of the amplitudeCount field.
amplitudeCount
()

public FloatBuffer

Returns:

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

public XrHapticAmplitudeEnvelopeVibrationFB
amplitudes(FloatBuffer value)

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

public static XrHapticAmplitudeEnvelopeVibrationFB
calloc()

Returns a new XrHapticAmplitudeEnvelopeVibrationFB instance allocated with memCalloc.

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

Returns a new XrHapticAmplitudeEnvelopeVibrationFB.Buffer instance allocated with memCalloc.

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

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

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

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

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

Returns a new XrHapticAmplitudeEnvelopeVibrationFB instance allocated with BufferUtils.

public static XrHapticAmplitudeEnvelopeVibrationFB
create(long address)

Returns a new XrHapticAmplitudeEnvelopeVibrationFB instance for the specified memory address.

public static XrHapticAmplitudeEnvelopeVibrationFB
create(XrHapticBaseHeader value)

Downcasts the specified XrHapticBaseHeader instance to XrHapticAmplitudeEnvelopeVibrationFB.

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

Returns a new XrHapticAmplitudeEnvelopeVibrationFB.Buffer instance allocated with BufferUtils.

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

Create a XrHapticAmplitudeEnvelopeVibrationFB.Buffer instance at the specified memory.

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

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

public static XrHapticAmplitudeEnvelopeVibrationFB
createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

public long

Returns:

the value of the duration field.
duration
()

public XrHapticAmplitudeEnvelopeVibrationFB
duration(long value)

Sets the specified value to the duration field.

public static XrHapticAmplitudeEnvelopeVibrationFB
malloc()

Returns a new XrHapticAmplitudeEnvelopeVibrationFB instance allocated with memAlloc.

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

Returns a new XrHapticAmplitudeEnvelopeVibrationFB.Buffer instance allocated with memAlloc.

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

Returns a new XrHapticAmplitudeEnvelopeVibrationFB instance allocated on the specified MemoryStack.

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

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

public static int
namplitudeCount(long struct)

Unsafe version of amplitudeCount.

public static void
namplitudeCount(long struct, int value)

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

public static FloatBuffer
namplitudes(long struct)

Unsafe version of amplitudes.

public static void
namplitudes(long struct, FloatBuffer value)

Unsafe version of amplitudes.

public static long
nduration(long struct)

Unsafe version of duration.

public static void
nduration(long struct, long value)

Unsafe version of duration.

public long

Returns:

the value of the next field.
next
()

public XrHapticAmplitudeEnvelopeVibrationFB
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 int
ntype(long struct)

Unsafe version of type.

public static void
ntype(long struct, int value)

Unsafe version of type.

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

Initializes this struct with the specified values.

public XrHapticAmplitudeEnvelopeVibrationFB

Returns:

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

Returns:

the value of the type field.
type
()

public XrHapticAmplitudeEnvelopeVibrationFB
type(int value)

Sets the specified value to the type field.

public XrHapticAmplitudeEnvelopeVibrationFB
type$Default()

Sets the TYPE_HAPTIC_AMPLITUDE_ENVELOPE_VIBRATION_FB 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

ALIGNOFback to summary
public static final int ALIGNOF

The struct alignment in bytes.

AMPLITUDECOUNTback to summary
public static final int AMPLITUDECOUNT

The struct member offsets.

AMPLITUDESback to summary
public static final int AMPLITUDES

The struct member offsets.

DURATIONback to summary
public static final int DURATION

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

XrHapticAmplitudeEnvelopeVibrationFBback to summary
protected XrHapticAmplitudeEnvelopeVibrationFB(long address, ByteBuffer container)
XrHapticAmplitudeEnvelopeVibrationFBback to summary
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 Detail

amplitudeCountback to summary
public int amplitudeCount()
Returns:int

the value of the amplitudeCount field.

Annotations
@NativeType:uint32_t
amplitudesback to summary
public FloatBuffer amplitudes()
Returns:FloatBuffer

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

Annotations
@NativeType:float const *
amplitudesback to summary
public XrHapticAmplitudeEnvelopeVibrationFB amplitudes(FloatBuffer value)

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

callocback to summary
public static XrHapticAmplitudeEnvelopeVibrationFB calloc()

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

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

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

Parameters
capacity:int

the buffer capacity

callocback to summary
public static XrHapticAmplitudeEnvelopeVibrationFB calloc(MemoryStack stack)

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

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

Returns a new XrHapticAmplitudeEnvelopeVibrationFB instance allocated with BufferUtils.

createback to summary
public static XrHapticAmplitudeEnvelopeVibrationFB create(long address)

Returns a new XrHapticAmplitudeEnvelopeVibrationFB instance for the specified memory address.

createback to summary
public static XrHapticAmplitudeEnvelopeVibrationFB create(XrHapticBaseHeader value)

Downcasts the specified XrHapticBaseHeader instance to XrHapticAmplitudeEnvelopeVibrationFB.

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

Returns a new XrHapticAmplitudeEnvelopeVibrationFB.Buffer instance allocated with BufferUtils.

Parameters
capacity:int

the buffer capacity

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

Create a XrHapticAmplitudeEnvelopeVibrationFB.Buffer instance at the specified memory.

Parameters
address:long

the memory address

capacity:int

the buffer capacity

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

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

createSafeback to summary
public static XrHapticAmplitudeEnvelopeVibrationFB createSafe(long address)

Like create, but returns null if address is NULL.

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

Like create, but returns null if address is NULL.

Annotations
@Nullable
durationback to summary
public long duration()
Returns:long

the value of the duration field.

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

Sets the specified value to the duration field.

mallocback to summary
public static XrHapticAmplitudeEnvelopeVibrationFB malloc()

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

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

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

Parameters
capacity:int

the buffer capacity

mallocback to summary
public static XrHapticAmplitudeEnvelopeVibrationFB malloc(MemoryStack stack)

Returns a new XrHapticAmplitudeEnvelopeVibrationFB instance allocated on the specified MemoryStack.

Parameters
stack:MemoryStack

the stack from which to allocate

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

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

Parameters
capacity:int

the buffer capacity

stack:MemoryStack

the stack from which to allocate

namplitudeCountback to summary
public static int namplitudeCount(long struct)

Unsafe version of amplitudeCount.

namplitudeCountback to summary
public static void namplitudeCount(long struct, int value)

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

namplitudesback to summary
public static FloatBuffer namplitudes(long struct)

Unsafe version of amplitudes.

namplitudesback to summary
public static void namplitudes(long struct, FloatBuffer value)

Unsafe version of amplitudes.

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()
Returns:long

the value of the next field.

Annotations
@NativeType:void const *
nextback to summary
public XrHapticAmplitudeEnvelopeVibrationFB 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.

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 XrHapticAmplitudeEnvelopeVibrationFB set(int type, long next, long duration, FloatBuffer amplitudes)

Initializes this struct with the specified values.

setback to summary
public XrHapticAmplitudeEnvelopeVibrationFB set(XrHapticAmplitudeEnvelopeVibrationFB src)

Copies the specified struct data to this struct.

Parameters
src:XrHapticAmplitudeEnvelopeVibrationFB

the source struct

Returns:XrHapticAmplitudeEnvelopeVibrationFB

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()
Returns:int

the value of the type field.

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

Sets the specified value to the type field.

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

Sets the TYPE_HAPTIC_AMPLITUDE_ENVELOPE_VIBRATION_FB 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 XrHapticAmplitudeEnvelopeVibrationFB.Buffer

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

An array of XrHapticAmplitudeEnvelopeVibrationFB structs.

Field Summary

Modifier and TypeField and Description
private static final XrHapticAmplitudeEnvelopeVibrationFB

Constructor Summary

AccessConstructor and Description
public
Buffer(ByteBuffer container)

Creates a new XrHapticAmplitudeEnvelopeVibrationFB.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 int

Returns:

the value of the amplitudeCount field.
amplitudeCount
()

public FloatBuffer

Returns:

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

public XrHapticAmplitudeEnvelopeVibrationFB.Buffer
amplitudes(FloatBuffer value)

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

public long

Returns:

the value of the duration field.
duration
()

public XrHapticAmplitudeEnvelopeVibrationFB.Buffer
duration(long value)

Sets the specified value to the duration field.

protected XrHapticAmplitudeEnvelopeVibrationFB
public long

Returns:

the value of the next field.
next
()

public XrHapticAmplitudeEnvelopeVibrationFB.Buffer
next(long value)

Sets the specified value to the next field.

protected XrHapticAmplitudeEnvelopeVibrationFB.Buffer
public int

Returns:

the value of the type field.
type
()

public XrHapticAmplitudeEnvelopeVibrationFB.Buffer
type(int value)

Sets the specified value to the type field.

public XrHapticAmplitudeEnvelopeVibrationFB.Buffer
type$Default()

Sets the TYPE_HAPTIC_AMPLITUDE_ENVELOPE_VIBRATION_FB value to the type field.

Inherited from org.lwjgl.system.StructBuffer:
applyapplyforEachgetgetgetgetiteratorparallelStreamputputsizeofspliteratorstream

Field Detail

ELEMENT_FACTORYback to summary
private static final XrHapticAmplitudeEnvelopeVibrationFB ELEMENT_FACTORY

Constructor Detail

Bufferback to summary
public Buffer(ByteBuffer container)

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

amplitudeCountback to summary
public int amplitudeCount()
Returns:int

the value of the amplitudeCount field.

Annotations
@NativeType:uint32_t
amplitudesback to summary
public FloatBuffer amplitudes()
Returns:FloatBuffer

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

Annotations
@NativeType:float const *
amplitudesback to summary
public XrHapticAmplitudeEnvelopeVibrationFB.Buffer amplitudes(FloatBuffer value)

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

durationback to summary
public long duration()
Returns:long

the value of the duration field.

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

Sets the specified value to the duration field.

getElementFactoryback to summary
protected XrHapticAmplitudeEnvelopeVibrationFB getElementFactory()

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

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

the value of the next field.

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

Sets the specified value to the next field.

selfback to summary
protected XrHapticAmplitudeEnvelopeVibrationFB.Buffer self()

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

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

the value of the type field.

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

Sets the specified value to the type field.

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

Sets the TYPE_HAPTIC_AMPLITUDE_ENVELOPE_VIBRATION_FB value to the type field.