Haptic Effect Description.

Description

This structure describes a PCM haptic effect.

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

If append is TRUE and a preceding XrHapticPcmVibrationFB haptic effect on this action has not yet completed, then the runtime must finish playing the preceding samples and then play the new haptic effect. If a preceding haptic event on this action has not yet completed, and either the preceding effect is not an XrHapticPcmVibrationFB haptic effect or append is FALSE, the runtime must cancel the preceding incomplete effects on that action and start playing the new haptic effect, as usual for the core specification.

When append is true and a preceding XrHapticPcmVibrationFB haptic effect on this action has not yet completed, then the application can provide a different sampleRate in the new haptic effect.

The runtime must populate the samplesConsumed with the count of the samples from buffer which were consumed. The samplesConsumed is populated before the ApplyHapticFeedback returns.

Valid Usage (Implicit)

The XR_FB_haptic_pcm extension must be enabled prior to using XrHapticPcmVibrationFB
type must be TYPE_HAPTIC_PCM_VIBRATION_FB
next must be NULL or a valid pointer to the next structure in a structure chain
buffer must be a pointer to an array of bufferSize float values
samplesConsumed must be a pointer to a uint32_t value
The bufferSize parameter must be greater than 0

Layout


struct XrHapticPcmVibrationFB {
    XrStructureType type;
    void const * next;
    uint32_t bufferSize;
    float const * buffer;
    float sampleRate;
    XrBool32 append;
    uint32_t * samplesConsumed;
}

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	XrHapticPcmVibrationFB.Buffer An array of `XrHapticPcmVibrationFB` structs.

Field Summary

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	APPEND The struct member offsets.
public static final int	BUFFER The struct member offsets.
public static final int	BUFFERSIZE The struct member offsets.
public static final int	NEXT The struct member offsets.
public static final int	SAMPLERATE The struct member offsets.
public static final int	SAMPLESCONSUMED 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:: container DEFAULT_ALIGN_AS DEFAULT_PACK_ALIGNMENT

Constructor Summary

Access	Constructor and Description
protected	XrHapticPcmVibrationFB(long address, ByteBuffer container)
public	XrHapticPcmVibrationFB(ByteBuffer container) Creates a `XrHapticPcmVibrationFB` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public boolean	append() if set to `FALSE`, any existing samples will be cleared and a new haptic effect will begin, if `TRUE`, samples will be appended to the currently playing effect
public XrHapticPcmVibrationFB	append(boolean value) Sets the specified value to the `append` field.
public FloatBuffer	buffer() a pointer to a float array representing the PCM samples.
public XrHapticPcmVibrationFB	buffer(FloatBuffer value) Sets the address of the specified `FloatBuffer` to the `buffer` field.
public int	bufferSize() the number of samples in the buffer.
public static XrHapticPcmVibrationFB	calloc() Returns a new `XrHapticPcmVibrationFB` instance allocated with `memCalloc`.
public static XrHapticPcmVibrationFB.Buffer	calloc(int the buffer capacity capacity) Returns a new `XrHapticPcmVibrationFB.Buffer` instance allocated with `memCalloc`.
public static XrHapticPcmVibrationFB	calloc(MemoryStack the stack from which to allocate stack) Returns a new `XrHapticPcmVibrationFB` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static XrHapticPcmVibrationFB.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrHapticPcmVibrationFB.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
protected XrHapticPcmVibrationFB	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 XrHapticPcmVibrationFB	create() Returns a new `XrHapticPcmVibrationFB` instance allocated with `BufferUtils`.
public static XrHapticPcmVibrationFB	create(long address) Returns a new `XrHapticPcmVibrationFB` instance for the specified memory address.
public static XrHapticPcmVibrationFB	create(XrHapticBaseHeader value) Downcasts the specified `XrHapticBaseHeader` instance to `XrHapticPcmVibrationFB`.
public static XrHapticPcmVibrationFB.Buffer	create(int the buffer capacity capacity) Returns a new `XrHapticPcmVibrationFB.Buffer` instance allocated with `BufferUtils`.
public static XrHapticPcmVibrationFB.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `XrHapticPcmVibrationFB.Buffer` instance at the specified memory.
public static XrHapticPcmVibrationFB.Buffer	create(XrHapticBaseHeader.Buffer value) Downcasts the specified `XrHapticBaseHeader.Buffer` instance to `XrHapticPcmVibrationFB.Buffer`.
public static XrHapticPcmVibrationFB	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static XrHapticPcmVibrationFB.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public static XrHapticPcmVibrationFB	malloc() Returns a new `XrHapticPcmVibrationFB` instance allocated with `memAlloc`.
public static XrHapticPcmVibrationFB.Buffer	malloc(int the buffer capacity capacity) Returns a new `XrHapticPcmVibrationFB.Buffer` instance allocated with `memAlloc`.
public static XrHapticPcmVibrationFB	malloc(MemoryStack the stack from which to allocate stack) Returns a new `XrHapticPcmVibrationFB` instance allocated on the specified `MemoryStack`.
public static XrHapticPcmVibrationFB.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `XrHapticPcmVibrationFB.Buffer` instance allocated on the specified `MemoryStack`.
public static int	nappend(long struct) Unsafe version of `append`.
public static void	nappend(long struct, int value) Unsafe version of `append`.
public static FloatBuffer	nbuffer(long struct) Unsafe version of `buffer`.
public static void	nbuffer(long struct, FloatBuffer value) Unsafe version of `buffer`.
public static int	nbufferSize(long struct) Unsafe version of `bufferSize`.
public static void	nbufferSize(long struct, int value) Sets the specified value to the `bufferSize` field of the specified `struct`.
public long	next() `NULL` or a pointer to the next structure in a structure chain.
public XrHapticPcmVibrationFB	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 float	nsampleRate(long struct) Unsafe version of `sampleRate`.
public static void	nsampleRate(long struct, float value) Unsafe version of `sampleRate`.
public static IntBuffer	nsamplesConsumed(long struct, int capacity) Unsafe version of `samplesConsumed`.
public static void	nsamplesConsumed(long struct, IntBuffer value) Unsafe version of `samplesConsumed`.
public static int	ntype(long struct) Unsafe version of `type`.
public static void	ntype(long struct, int value) Unsafe version of `type`.
public float	sampleRate() the number of samples to be played per second, this is used to determine the duration of the haptic effect.
public XrHapticPcmVibrationFB	sampleRate(float value) Sets the specified value to the `sampleRate` field.
public IntBuffer	Returns: a pointer to an unsigned integer; it is populated by runtime, to tell the application about how many samples were consumed from the input `buffer` samplesConsumed(int the number of elements in the returned buffer capacity)
public XrHapticPcmVibrationFB	samplesConsumed(IntBuffer value) Sets the address of the specified `IntBuffer` to the `samplesConsumed` field.
public XrHapticPcmVibrationFB	set(int type, long next, FloatBuffer buffer, float sampleRate, boolean append, IntBuffer samplesConsumed) Initializes this struct with the specified values.
public XrHapticPcmVibrationFB	Returns: this struct set(XrHapticPcmVibrationFB 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 XrHapticPcmVibrationFB	type(int value) Sets the specified value to the `type` field.
public XrHapticPcmVibrationFB	type$Default() Sets the `TYPE_HAPTIC_PCM_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`.

Field Detail

ALIGNOF	back to summary
public static final int ALIGNOF The struct alignment in bytes.

APPEND	back to summary
public static final int APPEND The struct member offsets.

BUFFER	back to summary
public static final int BUFFER The struct member offsets.

BUFFERSIZE	back to summary
public static final int BUFFERSIZE The struct member offsets.

NEXT	back to summary
public static final int NEXT The struct member offsets.

SAMPLERATE	back to summary
public static final int SAMPLERATE The struct member offsets.

SAMPLESCONSUMED	back to summary
public static final int SAMPLESCONSUMED The struct member offsets.

SIZEOF	back to summary
public static final int SIZEOF The struct size in bytes.

TYPE	back to summary
public static final int TYPE The struct member offsets.

Constructor Detail

XrHapticPcmVibrationFB	back to summary
protected XrHapticPcmVibrationFB(long address, ByteBuffer container)

XrHapticPcmVibrationFB back to summary

XrHapticPcmVibrationFB	back to summary
public XrHapticPcmVibrationFB(ByteBuffer container) Creates a `XrHapticPcmVibrationFB` 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.

public XrHapticPcmVibrationFB(ByteBuffer container)

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

append back to summary

append	back to summary
public boolean append() if set to `FALSE`, any existing samples will be cleared and a new haptic effect will begin, if `TRUE`, samples will be appended to the currently playing effect Annotations @NativeType:XrBool32

public boolean append()

if set to FALSE, any existing samples will be cleared and a new haptic effect will begin, if TRUE, samples will be appended to the currently playing effect

Annotations

@NativeType:XrBool32

append	back to summary
public XrHapticPcmVibrationFB append(boolean value) Sets the specified value to the `append` field.

buffer	back to summary
public FloatBuffer buffer() a pointer to a float array representing the PCM samples. If you consider the haptic effect as a sampled analog audio, then this buffer will contain the samples representing that effect. The values in this buffer are expected to be in the range [-1.0, 1.0]. Annotations @NativeType:float const *

buffer

back to summary

public FloatBuffer buffer()

a pointer to a float array representing the PCM samples. If you consider the haptic effect as a sampled analog audio, then this buffer will contain the samples representing that effect. The values in this buffer are expected to be in the range [-1.0, 1.0].

Annotations

@NativeType:float const *

buffer	back to summary
public XrHapticPcmVibrationFB buffer(FloatBuffer value) Sets the address of the specified `FloatBuffer` to the `buffer` field.

bufferSize	back to summary
public int bufferSize() the number of samples in the buffer. Annotations @NativeType:uint32_t

bufferSize

back to summary

public int bufferSize()

the number of samples in the buffer.

Annotations

@NativeType:uint32_t

calloc	back to summary
public static XrHapticPcmVibrationFB calloc() Returns a new `XrHapticPcmVibrationFB` instance allocated with `memCalloc`. The instance must be explicitly freed.

calloc back to summary

calloc	back to summary
public static XrHapticPcmVibrationFB.Buffer calloc(int capacity) Returns a new `XrHapticPcmVibrationFB.Buffer` instance allocated with `memCalloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrHapticPcmVibrationFB.Buffer calloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

calloc back to summary

calloc	back to summary
public static XrHapticPcmVibrationFB calloc(MemoryStack stack) Returns a new `XrHapticPcmVibrationFB` instance allocated on the specified `MemoryStack` and initializes all its bits to zero. Parameters stack:MemoryStack the stack from which to allocate

public static XrHapticPcmVibrationFB calloc(MemoryStack stack)

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

Parameters

stack:MemoryStack: the stack from which to allocate

calloc back to summary

calloc	back to summary
public static XrHapticPcmVibrationFB.Buffer calloc(int capacity, MemoryStack stack) Returns a new `XrHapticPcmVibrationFB.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

public static XrHapticPcmVibrationFB.Buffer calloc(int capacity, MemoryStack stack)

Returns a new XrHapticPcmVibrationFB.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

create back to summary

create	back to summary
protected XrHapticPcmVibrationFB 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

protected XrHapticPcmVibrationFB 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

create	back to summary
public static XrHapticPcmVibrationFB create() Returns a new `XrHapticPcmVibrationFB` instance allocated with `BufferUtils`.

create	back to summary
public static XrHapticPcmVibrationFB create(long address) Returns a new `XrHapticPcmVibrationFB` instance for the specified memory address.

create	back to summary
public static XrHapticPcmVibrationFB create(XrHapticBaseHeader value) Downcasts the specified `XrHapticBaseHeader` instance to `XrHapticPcmVibrationFB`.

create back to summary

create	back to summary
public static XrHapticPcmVibrationFB.Buffer create(int capacity) Returns a new `XrHapticPcmVibrationFB.Buffer` instance allocated with `BufferUtils`. Parameters capacity:int the buffer capacity

public static XrHapticPcmVibrationFB.Buffer create(int capacity)

Returns a new XrHapticPcmVibrationFB.Buffer instance allocated with BufferUtils.

Parameters

capacity:int: the buffer capacity

create back to summary

create	back to summary
public static XrHapticPcmVibrationFB.Buffer create(long address, int capacity) Create a `XrHapticPcmVibrationFB.Buffer` instance at the specified memory. Parameters address:long the memory address capacity:int the buffer capacity

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

Create a XrHapticPcmVibrationFB.Buffer instance at the specified memory.

Parameters

address:long: the memory address
capacity:int: the buffer capacity

create	back to summary
public static XrHapticPcmVibrationFB.Buffer create(XrHapticBaseHeader.Buffer value) Downcasts the specified `XrHapticBaseHeader.Buffer` instance to `XrHapticPcmVibrationFB.Buffer`.

createSafe back to summary

createSafe	back to summary
public static XrHapticPcmVibrationFB createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

public static XrHapticPcmVibrationFB createSafe(long address)

Like create, but returns null if address is NULL.

Annotations

@Nullable

createSafe back to summary

createSafe	back to summary
public static XrHapticPcmVibrationFB.Buffer createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`. Annotations @Nullable

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

Like create, but returns null if address is NULL.

Annotations

@Nullable

malloc	back to summary
public static XrHapticPcmVibrationFB malloc() Returns a new `XrHapticPcmVibrationFB` instance allocated with `memAlloc`. The instance must be explicitly freed.

malloc back to summary

malloc	back to summary
public static XrHapticPcmVibrationFB.Buffer malloc(int capacity) Returns a new `XrHapticPcmVibrationFB.Buffer` instance allocated with `memAlloc`. The instance must be explicitly freed. Parameters capacity:int the buffer capacity

public static XrHapticPcmVibrationFB.Buffer malloc(int capacity)

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

Parameters

capacity:int: the buffer capacity

malloc back to summary

malloc	back to summary
public static XrHapticPcmVibrationFB malloc(MemoryStack stack) Returns a new `XrHapticPcmVibrationFB` instance allocated on the specified `MemoryStack`. Parameters stack:MemoryStack the stack from which to allocate

public static XrHapticPcmVibrationFB malloc(MemoryStack stack)

Returns a new XrHapticPcmVibrationFB instance allocated on the specified MemoryStack.

Parameters

stack:MemoryStack: the stack from which to allocate

malloc back to summary

malloc	back to summary
public static XrHapticPcmVibrationFB.Buffer malloc(int capacity, MemoryStack stack) Returns a new `XrHapticPcmVibrationFB.Buffer` instance allocated on the specified `MemoryStack`. Parameters capacity:int the buffer capacity stack:MemoryStack the stack from which to allocate

public static XrHapticPcmVibrationFB.Buffer malloc(int capacity, MemoryStack stack)

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

Parameters

capacity:int: the buffer capacity
stack:MemoryStack: the stack from which to allocate

nappend	back to summary
public static int nappend(long struct) Unsafe version of `append`.

nappend	back to summary
public static void nappend(long struct, int value) Unsafe version of `append`.

nbuffer	back to summary
public static FloatBuffer nbuffer(long struct) Unsafe version of `buffer`.

nbuffer	back to summary
public static void nbuffer(long struct, FloatBuffer value) Unsafe version of `buffer`.

nbufferSize	back to summary
public static int nbufferSize(long struct) Unsafe version of `bufferSize`.

nbufferSize	back to summary
public static void nbufferSize(long struct, int value) Sets the specified value to the `bufferSize` field of the specified `struct`.

next back to summary

next	back 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 or this extension. Annotations @NativeType:void const *

public long next()

NULL or a pointer to the next structure in a structure chain. No such structures are defined in core OpenXR or this extension.

Annotations

@NativeType:void const *

next	back to summary
public XrHapticPcmVibrationFB next(long value) Sets the specified value to the `next` field.

nnext	back to summary
public static long nnext(long struct) Unsafe version of `next`.

nnext	back to summary
public static void nnext(long struct, long value) Unsafe version of `next`.

nsampleRate	back to summary
public static float nsampleRate(long struct) Unsafe version of `sampleRate`.

nsampleRate	back to summary
public static void nsampleRate(long struct, float value) Unsafe version of `sampleRate`.

nsamplesConsumed	back to summary
public static IntBuffer nsamplesConsumed(long struct, int capacity) Unsafe version of `samplesConsumed`.

nsamplesConsumed	back to summary
public static void nsamplesConsumed(long struct, IntBuffer value) Unsafe version of `samplesConsumed`.

ntype	back to summary
public static int ntype(long struct) Unsafe version of `type`.

ntype	back to summary
public static void ntype(long struct, int value) Unsafe version of `type`.

sampleRate	back to summary
public float sampleRate() the number of samples to be played per second, this is used to determine the duration of the haptic effect.

sampleRate	back to summary
public XrHapticPcmVibrationFB sampleRate(float value) Sets the specified value to the `sampleRate` field.

samplesConsumed	back to summary
public IntBuffer samplesConsumed(int capacity) Parameters capacity:int the number of elements in the returned buffer Returns:IntBuffer a pointer to an unsigned integer; it is populated by runtime, to tell the application about how many samples were consumed from the input `buffer` Annotations @NativeType:uint32_t *

samplesConsumed	back to summary
public XrHapticPcmVibrationFB samplesConsumed(IntBuffer value) Sets the address of the specified `IntBuffer` to the `samplesConsumed` field.

set	back to summary
public XrHapticPcmVibrationFB set(int type, long next, FloatBuffer buffer, float sampleRate, boolean append, IntBuffer samplesConsumed) Initializes this struct with the specified values.

set

back to summary

public XrHapticPcmVibrationFB set(XrHapticPcmVibrationFB src)

Copies the specified struct data to this struct.

Parameters

src:XrHapticPcmVibrationFB: the source struct

Returns:XrHapticPcmVibrationFB

this struct

sizeof back to summary

public int sizeof()

Implements abstract org.lwjgl.system.Struct.sizeof.

Doc from org.lwjgl.system.Struct.sizeof.

Returns sizeof(struct).

Annotations

@Override

type back to summary

public int type()

the XrStructureType of this structure.

Annotations

@NativeType:XrStructureType

type	back to summary
public XrHapticPcmVibrationFB type(int value) Sets the specified value to the `type` field.

type$Default	back to summary
public XrHapticPcmVibrationFB type$Default() Sets the `TYPE_HAPTIC_PCM_VIBRATION_FB` value to the `type` field.

validate back 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 XrHapticPcmVibrationFB.Buffer

Class Inheritance

extends StructBuffer<XrHapticPcmVibrationFB, XrHapticPcmVibrationFB.Buffer>
implements NativeResource

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.CustomBuffer
org.lwjgl.system.StructBuffer
org.lwjgl.openxr.XrHapticPcmVibrationFB.Buffer

All Implemented Interfaces

org.lwjgl.system.NativeResource, java.lang.AutoCloseable

An array of XrHapticPcmVibrationFB structs.

Field Summary

Modifier and Type	Field and Description
private static final XrHapticPcmVibrationFB	ELEMENT_FACTORY

Constructor Summary

Access	Constructor and Description
public	Buffer(ByteBuffer container) Creates a new `XrHapticPcmVibrationFB.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 Type	Method and Description
public boolean	Returns: the value of the `XrHapticPcmVibrationFB#append` field. append()
public XrHapticPcmVibrationFB.Buffer	append(boolean value) Sets the specified value to the `XrHapticPcmVibrationFB#append` field.
public FloatBuffer	Returns: a `FloatBuffer` view of the data pointed to by the `XrHapticPcmVibrationFB#buffer` field. buffer()
public XrHapticPcmVibrationFB.Buffer	buffer(FloatBuffer value) Sets the address of the specified `FloatBuffer` to the `XrHapticPcmVibrationFB#buffer` field.
public int	Returns: the value of the `XrHapticPcmVibrationFB#bufferSize` field. bufferSize()
protected XrHapticPcmVibrationFB	getElementFactory() Implements abstract org.lwjgl.system.StructBuffer.getElementFactory.
public long	Returns: the value of the `XrHapticPcmVibrationFB#next` field. next()
public XrHapticPcmVibrationFB.Buffer	next(long value) Sets the specified value to the `XrHapticPcmVibrationFB#next` field.
public float	Returns: the value of the `XrHapticPcmVibrationFB#sampleRate` field. sampleRate()
public XrHapticPcmVibrationFB.Buffer	sampleRate(float value) Sets the specified value to the `XrHapticPcmVibrationFB#sampleRate` field.
public IntBuffer	Returns: a `IntBuffer` view of the data pointed to by the `XrHapticPcmVibrationFB#samplesConsumed` field. samplesConsumed(int the number of elements in the returned buffer capacity)
public XrHapticPcmVibrationFB.Buffer	samplesConsumed(IntBuffer value) Sets the address of the specified `IntBuffer` to the `XrHapticPcmVibrationFB#samplesConsumed` field.
protected XrHapticPcmVibrationFB.Buffer	self() Implements abstract org.lwjgl.system.CustomBuffer.self.
public int	Returns: the value of the `XrHapticPcmVibrationFB#type` field. type()
public XrHapticPcmVibrationFB.Buffer	type(int value) Sets the specified value to the `XrHapticPcmVibrationFB#type` field.
public XrHapticPcmVibrationFB.Buffer	type$Default() Sets the `TYPE_HAPTIC_PCM_VIBRATION_FB` value to the `XrHapticPcmVibrationFB#type` field.

Inherited from org.lwjgl.system.StructBuffer:: apply apply forEach get get get get iterator parallelStream put put sizeof spliterator stream

Field Detail

ELEMENT_FACTORY	back to summary
private static final XrHapticPcmVibrationFB ELEMENT_FACTORY

Constructor Detail

Buffer back to summary

public Buffer(ByteBuffer container)

Creates a new XrHapticPcmVibrationFB.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 XrHapticPcmVibrationFB#SIZEOF, and its mark will be undefined.

The created buffer instance holds a strong reference to the container object.

Buffer	back to summary
public Buffer(long address, int cap)

Buffer	back to summary
pack-priv Buffer(long address, ByteBuffer container, int mark, int pos, int lim, int cap)

Method Detail

append	back to summary
public boolean append() Returns:boolean the value of the `XrHapticPcmVibrationFB#append` field. Annotations @NativeType:XrBool32

append	back to summary
public XrHapticPcmVibrationFB.Buffer append(boolean value) Sets the specified value to the `XrHapticPcmVibrationFB#append` field.

buffer	back to summary
public FloatBuffer buffer() Returns:FloatBuffer a `FloatBuffer` view of the data pointed to by the `XrHapticPcmVibrationFB#buffer` field. Annotations @NativeType:float const *

buffer	back to summary
public XrHapticPcmVibrationFB.Buffer buffer(FloatBuffer value) Sets the address of the specified `FloatBuffer` to the `XrHapticPcmVibrationFB#buffer` field.

bufferSize	back to summary
public int bufferSize() Returns:int the value of the `XrHapticPcmVibrationFB#bufferSize` field. Annotations @NativeType:uint32_t

getElementFactory

back to summary

protected XrHapticPcmVibrationFB getElementFactory()

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

Annotations

@Override

next	back to summary
public long next() Returns:long the value of the `XrHapticPcmVibrationFB#next` field. Annotations @NativeType:void const *

next	back to summary
public XrHapticPcmVibrationFB.Buffer next(long value) Sets the specified value to the `XrHapticPcmVibrationFB#next` field.

sampleRate	back to summary
public float sampleRate() Returns:float the value of the `XrHapticPcmVibrationFB#sampleRate` field.

sampleRate	back to summary
public XrHapticPcmVibrationFB.Buffer sampleRate(float value) Sets the specified value to the `XrHapticPcmVibrationFB#sampleRate` field.

samplesConsumed	back to summary
public IntBuffer samplesConsumed(int capacity) Parameters capacity:int the number of elements in the returned buffer Returns:IntBuffer a `IntBuffer` view of the data pointed to by the `XrHapticPcmVibrationFB#samplesConsumed` field. Annotations @NativeType:uint32_t *

samplesConsumed	back to summary
public XrHapticPcmVibrationFB.Buffer samplesConsumed(IntBuffer value) Sets the address of the specified `IntBuffer` to the `XrHapticPcmVibrationFB#samplesConsumed` field.

self

back to summary

protected XrHapticPcmVibrationFB.Buffer self()

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

Annotations

@Override

type	back to summary
public int type() Returns:int the value of the `XrHapticPcmVibrationFB#type` field. Annotations @NativeType:XrStructureType

type	back to summary
public XrHapticPcmVibrationFB.Buffer type(int value) Sets the specified value to the `XrHapticPcmVibrationFB#type` field.

type$Default	back to summary
public XrHapticPcmVibrationFB.Buffer type$Default() Sets the `TYPE_HAPTIC_PCM_VIBRATION_FB` value to the `XrHapticPcmVibrationFB#type` field.