Class XrHapticPcmVibrationFB

java.lang.Object

org.lwjgl.system.Pointer.Default

org.lwjgl.system.Struct<XrHapticPcmVibrationFB>

org.lwjgl.openxr.XrHapticPcmVibrationFB

All Implemented Interfaces:

AutoCloseable, NativeResource, Pointer

public class XrHapticPcmVibrationFB
extends Struct<XrHapticPcmVibrationFB>
implements NativeResource

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

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class Struct

Struct.StructValidation

Nested classes/interfaces inherited from interface Pointer

Pointer.Default

Field Summary

Fields

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

BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	append()
XrHapticPcmVibrationFB	append(boolean value)	Sets the specified value to the append field.
FloatBuffer	buffer()
XrHapticPcmVibrationFB	buffer(FloatBuffer value)	Sets the address of the specified FloatBuffer to the buffer field.
int	bufferSize()
static XrHapticPcmVibrationFB	calloc()	Returns a new XrHapticPcmVibrationFB instance allocated with memCalloc.
static XrHapticPcmVibrationFB.Buffer	calloc(int capacity)	Returns a new XrHapticPcmVibrationFB.Buffer instance allocated with memCalloc.
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.
static XrHapticPcmVibrationFB	calloc(MemoryStack stack)	Returns a new XrHapticPcmVibrationFB instance allocated on the specified MemoryStack and initializes all its bits to zero.
static XrHapticPcmVibrationFB	create()	Returns a new XrHapticPcmVibrationFB instance allocated with BufferUtils.
static XrHapticPcmVibrationFB.Buffer	create(int capacity)	Returns a new XrHapticPcmVibrationFB.Buffer instance allocated with BufferUtils.
static XrHapticPcmVibrationFB	create(long address)	Returns a new XrHapticPcmVibrationFB instance for the specified memory address.
static XrHapticPcmVibrationFB.Buffer	create(long address, int capacity)	Create a XrHapticPcmVibrationFB.Buffer instance at the specified memory.
static XrHapticPcmVibrationFB	create(XrHapticBaseHeader value)	Downcasts the specified XrHapticBaseHeader instance to XrHapticPcmVibrationFB.
static XrHapticPcmVibrationFB.Buffer	create(XrHapticBaseHeader.Buffer value)	Downcasts the specified XrHapticBaseHeader.Buffer instance to XrHapticPcmVibrationFB.Buffer.
static @Nullable XrHapticPcmVibrationFB	createSafe(long address)	Like create, but returns null if address is NULL.
static @Nullable XrHapticPcmVibrationFB.Buffer	createSafe(long address, int capacity)	Like create, but returns null if address is NULL.
static XrHapticPcmVibrationFB	malloc()	Returns a new XrHapticPcmVibrationFB instance allocated with memAlloc.
static XrHapticPcmVibrationFB.Buffer	malloc(int capacity)	Returns a new XrHapticPcmVibrationFB.Buffer instance allocated with memAlloc.
static XrHapticPcmVibrationFB.Buffer	malloc(int capacity, MemoryStack stack)	Returns a new XrHapticPcmVibrationFB.Buffer instance allocated on the specified MemoryStack.
static XrHapticPcmVibrationFB	malloc(MemoryStack stack)	Returns a new XrHapticPcmVibrationFB instance allocated on the specified MemoryStack.
static int	nappend(long struct)	Unsafe version of append().
static void	nappend(long struct, int value)	Unsafe version of append.
static FloatBuffer	nbuffer(long struct)	Unsafe version of buffer.
static void	nbuffer(long struct, FloatBuffer value)	Unsafe version of buffer.
static int	nbufferSize(long struct)	Unsafe version of bufferSize().
static void	nbufferSize(long struct, int value)	Sets the specified value to the bufferSize field of the specified struct.
long	next()
XrHapticPcmVibrationFB	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 float	nsampleRate(long struct)	Unsafe version of sampleRate().
static void	nsampleRate(long struct, float value)	Unsafe version of sampleRate.
static IntBuffer	nsamplesConsumed(long struct, int capacity)	Unsafe version of samplesConsumed.
static void	nsamplesConsumed(long struct, IntBuffer value)	Unsafe version of samplesConsumed.
static int	ntype(long struct)	Unsafe version of type().
static void	ntype(long struct, int value)	Unsafe version of type.
float	sampleRate()
XrHapticPcmVibrationFB	sampleRate(float value)	Sets the specified value to the sampleRate field.
IntBuffer	samplesConsumed(int capacity)
XrHapticPcmVibrationFB	samplesConsumed(IntBuffer value)	Sets the address of the specified IntBuffer to the samplesConsumed field.
XrHapticPcmVibrationFB	set(int type, long next, FloatBuffer buffer, float sampleRate, boolean append, IntBuffer samplesConsumed)	Initializes this struct with the specified values.
XrHapticPcmVibrationFB	set(XrHapticPcmVibrationFB src)	Copies the specified struct data to this struct.
int	sizeof()	Returns sizeof(struct).
int	type()
XrHapticPcmVibrationFB	type(int value)	Sets the specified value to the type field.
XrHapticPcmVibrationFB	type$Default()	Sets the TYPE_HAPTIC_PCM_VIBRATION_FB value to the type field.
static void	validate(long struct)	Validates pointer members that should not be NULL.

Methods inherited from class Struct

clear, free, isNull, validate, validate

Methods inherited from class Pointer.Default

address, equals, hashCode, toString

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface 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.

BUFFERSIZE

public static final int BUFFERSIZE

The struct member offsets.

BUFFER

public static final int BUFFER

The struct member offsets.

SAMPLERATE

public static final int SAMPLERATE

The struct member offsets.

APPEND

public static final int APPEND

The struct member offsets.

SAMPLESCONSUMED

public static final int SAMPLESCONSUMED

The struct member offsets.

Constructor Details

XrHapticPcmVibrationFB

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 Details

sizeof

public int sizeof()

Description copied from class: Struct

Returns sizeof(struct).

Specified by:

sizeof in class Struct<XrHapticPcmVibrationFB>

type

@NativeType("XrStructureType")
public int type()

Returns:

the value of the type field.

next

@NativeType("void const *")
public long next()

Returns:

the value of the next field.

bufferSize

@NativeType("uint32_t")
public int bufferSize()

Returns:

the value of the bufferSize field.

buffer

@NativeType("float const *")
public FloatBuffer buffer()

Returns:

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

sampleRate

public float sampleRate()

Returns:

the value of the sampleRate field.

append

@NativeType("XrBool32")
public boolean append()

Returns:

the value of the append field.

samplesConsumed

@NativeType("uint32_t *")
public IntBuffer samplesConsumed(int capacity)

Returns:

a IntBuffer view of the data pointed to by the samplesConsumed field.

type

public XrHapticPcmVibrationFB type(@NativeType("XrStructureType")
 int value)

Sets the specified value to the type field.

type$Default

public XrHapticPcmVibrationFB type$Default()

Sets the TYPE_HAPTIC_PCM_VIBRATION_FB value to the type field.

next

public XrHapticPcmVibrationFB next(@NativeType("void const *")
 long value)

Sets the specified value to the next field.

buffer

public XrHapticPcmVibrationFB buffer(@NativeType("float const *")
 FloatBuffer value)

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

sampleRate

public XrHapticPcmVibrationFB sampleRate(float value)

Sets the specified value to the sampleRate field.

append

public XrHapticPcmVibrationFB append(@NativeType("XrBool32")
 boolean value)

Sets the specified value to the append field.

samplesConsumed

public XrHapticPcmVibrationFB samplesConsumed(@NativeType("uint32_t *")
 IntBuffer value)

Sets the address of the specified IntBuffer to the samplesConsumed field.

set

public XrHapticPcmVibrationFB set(int type,
 long next,
 FloatBuffer buffer,
 float sampleRate,
 boolean append,
 IntBuffer samplesConsumed)

Initializes this struct with the specified values.

set

public XrHapticPcmVibrationFB set(XrHapticPcmVibrationFB src)

Copies the specified struct data to this struct.

Parameters:

src - the source struct

Returns:

this struct

malloc

public static XrHapticPcmVibrationFB malloc()

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

calloc

public static XrHapticPcmVibrationFB calloc()

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

create

public static XrHapticPcmVibrationFB create()

Returns a new XrHapticPcmVibrationFB instance allocated with BufferUtils.

create

public static XrHapticPcmVibrationFB create(long address)

Returns a new XrHapticPcmVibrationFB instance for the specified memory address.

createSafe

public static @Nullable XrHapticPcmVibrationFB createSafe(long address)

Like create, but returns null if address is NULL.

create

public static XrHapticPcmVibrationFB create(XrHapticBaseHeader value)

Downcasts the specified XrHapticBaseHeader instance to XrHapticPcmVibrationFB.

malloc

public static XrHapticPcmVibrationFB.Buffer malloc(int capacity)

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

Parameters:

capacity - the buffer capacity

calloc

public static XrHapticPcmVibrationFB.Buffer calloc(int capacity)

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

Parameters:

capacity - the buffer capacity

create

public static XrHapticPcmVibrationFB.Buffer create(int capacity)

Returns a new XrHapticPcmVibrationFB.Buffer instance allocated with BufferUtils.

Parameters:

capacity - the buffer capacity

create

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

Create a XrHapticPcmVibrationFB.Buffer instance at the specified memory.

Parameters:

address - the memory address

capacity - the buffer capacity

createSafe

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

Like create, but returns null if address is NULL.

create

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

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

malloc

public static XrHapticPcmVibrationFB malloc(MemoryStack stack)

Returns a new XrHapticPcmVibrationFB instance allocated on the specified MemoryStack.

Parameters:

stack - the stack from which to allocate

calloc

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 - the stack from which to allocate

malloc

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

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

Parameters:

capacity - the buffer capacity

stack - the stack from which to allocate

calloc

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 - 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().

nbufferSize

public static int nbufferSize(long struct)

Unsafe version of bufferSize().

nbuffer

public static FloatBuffer nbuffer(long struct)

Unsafe version of buffer.

nsampleRate

public static float nsampleRate(long struct)

Unsafe version of sampleRate().

nappend

public static int nappend(long struct)

Unsafe version of append().

nsamplesConsumed

public static IntBuffer nsamplesConsumed(long struct,
 int capacity)

Unsafe version of samplesConsumed.

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.

nbufferSize

public static void nbufferSize(long struct,
 int value)

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

nbuffer

public static void nbuffer(long struct,
 FloatBuffer value)

Unsafe version of buffer.

nsampleRate

public static void nsampleRate(long struct,
 float value)

Unsafe version of sampleRate.

nappend

public static void nappend(long struct,
 int value)

Unsafe version of append.

nsamplesConsumed

public static void nsamplesConsumed(long struct,
 IntBuffer value)

Unsafe version of samplesConsumed.

validate

public static void validate(long struct)

Validates pointer members that should not be NULL.

Parameters:

struct - the struct to validate