Record Class XrHapticPcmVibrationFB

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrHapticPcmVibrationFB

All Implemented Interfaces:

IPointer, IXrHapticPcmVibrationFB

@ValueBasedCandidate
@UnsafeConstructor
public record XrHapticPcmVibrationFB(@NotNull MemorySegment segment)
extends Record
implements IXrHapticPcmVibrationFB

Represents a pointer to a XrHapticPcmVibrationFB structure in native memory.

Structure

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

Auto initialization

This structure has the following members that can be automatically initialized:

• type = XR_TYPE_HAPTIC_PCM_VIBRATION_FB

The allocate (allocate(Arena), allocate(Arena, long)) functions will automatically initialize these fields. Also, you may call autoInit() to initialize these fields manually for non-allocated instances.

Contracts

The property segment() should always be not-null (segment != NULL && !segment.equals(MemorySegment.NULL)), and properly aligned to LAYOUT.byteAlignment() bytes. To represent null pointer, you may use a Java null instead. See the documentation of IPointer.segment() for more details.

The constructor of this class is marked as UnsafeConstructor, because it does not perform any runtime check. The constructor can be useful for automatic code generators.

See Also:

• XrHapticPcmVibrationFB

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	XrHapticPcmVibrationFB.Ptr	Represents a pointer to / an array of XrHapticPcmVibrationFB structure(s) in native memory.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfInt	LAYOUT$append
static final AddressLayout	LAYOUT$buffer
static final ValueLayout.OfInt	LAYOUT$bufferSize
static final AddressLayout	LAYOUT$next
static final ValueLayout.OfFloat	LAYOUT$sampleRate
static final AddressLayout	LAYOUT$samplesConsumed
static final ValueLayout.OfInt	LAYOUT$type
static final long	OFFSET$append
static final long	OFFSET$buffer
static final long	OFFSET$bufferSize
static final long	OFFSET$next
static final long	OFFSET$sampleRate
static final long	OFFSET$samplesConsumed
static final long	OFFSET$type
static final MemoryLayout.PathElement	PATH$append
static final MemoryLayout.PathElement	PATH$buffer
static final MemoryLayout.PathElement	PATH$bufferSize
static final MemoryLayout.PathElement	PATH$next
static final MemoryLayout.PathElement	PATH$sampleRate
static final MemoryLayout.PathElement	PATH$samplesConsumed
static final MemoryLayout.PathElement	PATH$type
static final long	SIZE$append
static final long	SIZE$buffer
static final long	SIZE$bufferSize
static final long	SIZE$next
static final long	SIZE$sampleRate
static final long	SIZE$samplesConsumed
static final long	SIZE$type

Constructor Summary

Constructors

Constructor	Description
XrHapticPcmVibrationFB(@NotNull MemorySegment segment)	Creates an instance of a XrHapticPcmVibrationFB record class.

Method Summary

Modifier and Type	Method	Description
static XrHapticPcmVibrationFB	allocate(Arena arena)
static XrHapticPcmVibrationFB.Ptr	allocate(Arena arena, long count)
int	append()
XrHapticPcmVibrationFB	append(int value)
void	autoInit()
@Nullable FloatPtr	buffer()	Note: the returned FloatPtr does not have correct FloatPtr.size() property.
XrHapticPcmVibrationFB	buffer(@Nullable FloatPtr value)
@NotNull MemorySegment	bufferRaw()
void	bufferRaw(@NotNull MemorySegment value)
int	bufferSize()
XrHapticPcmVibrationFB	bufferSize(int value)
static XrHapticPcmVibrationFB	clone(Arena arena, XrHapticPcmVibrationFB src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@NotNull MemorySegment	next()
XrHapticPcmVibrationFB	next(@Nullable IPointer pointer)
XrHapticPcmVibrationFB	next(@NotNull MemorySegment value)
float	sampleRate()
XrHapticPcmVibrationFB	sampleRate(float value)
@Nullable IntPtr	samplesConsumed()	Note: the returned IntPtr does not have correct IntPtr.size() property.
XrHapticPcmVibrationFB	samplesConsumed(@Nullable IntPtr value)
@NotNull MemorySegment	samplesConsumedRaw()
void	samplesConsumedRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
int	type()
XrHapticPcmVibrationFB	type(int value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LAYOUT

public static final StructLayout LAYOUT

BYTES

public static final long BYTES

PATH$type

public static final MemoryLayout.PathElement PATH$type

PATH$next

public static final MemoryLayout.PathElement PATH$next

PATH$bufferSize

public static final MemoryLayout.PathElement PATH$bufferSize

PATH$buffer

public static final MemoryLayout.PathElement PATH$buffer

PATH$sampleRate

public static final MemoryLayout.PathElement PATH$sampleRate

PATH$append

public static final MemoryLayout.PathElement PATH$append

PATH$samplesConsumed

public static final MemoryLayout.PathElement PATH$samplesConsumed

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$bufferSize

public static final ValueLayout.OfInt LAYOUT$bufferSize

LAYOUT$buffer

public static final AddressLayout LAYOUT$buffer

LAYOUT$sampleRate

public static final ValueLayout.OfFloat LAYOUT$sampleRate

LAYOUT$append

public static final ValueLayout.OfInt LAYOUT$append

LAYOUT$samplesConsumed

public static final AddressLayout LAYOUT$samplesConsumed

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$bufferSize

public static final long SIZE$bufferSize

SIZE$buffer

public static final long SIZE$buffer

SIZE$sampleRate

public static final long SIZE$sampleRate

SIZE$append

public static final long SIZE$append

SIZE$samplesConsumed

public static final long SIZE$samplesConsumed

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$bufferSize

public static final long OFFSET$bufferSize

OFFSET$buffer

public static final long OFFSET$buffer

OFFSET$sampleRate

public static final long OFFSET$sampleRate

OFFSET$append

public static final long OFFSET$append

OFFSET$samplesConsumed

public static final long OFFSET$samplesConsumed

Constructor Details

XrHapticPcmVibrationFB

public XrHapticPcmVibrationFB(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrHapticPcmVibrationFB record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrHapticPcmVibrationFB allocate(Arena arena)

allocate

public static XrHapticPcmVibrationFB.Ptr allocate(Arena arena,
 long count)

clone

public static XrHapticPcmVibrationFB clone(Arena arena,
 XrHapticPcmVibrationFB src)

autoInit

public void autoInit()

type

@EnumType(XrStructureType.class)
public int type()

type

public XrHapticPcmVibrationFB type(@EnumType(XrStructureType.class)
 int value)

next

@Pointer(comment="void*")
@NotNull
public @NotNull MemorySegment next()

next

public XrHapticPcmVibrationFB next(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

next

public XrHapticPcmVibrationFB next(@Nullable
 @Nullable IPointer pointer)

bufferSize

@Unsigned
public int bufferSize()

bufferSize

public XrHapticPcmVibrationFB bufferSize(@Unsigned
 int value)

buffer

@Nullable
public @Nullable FloatPtr buffer()

Note: the returned FloatPtr does not have correct FloatPtr.size() property. It's up to user to track the size of the buffer, and use FloatPtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

buffer

public XrHapticPcmVibrationFB buffer(@Nullable
 @Nullable FloatPtr value)

bufferRaw

@Pointer(comment="float*")
@NotNull
public @NotNull MemorySegment bufferRaw()

bufferRaw

public void bufferRaw(@Pointer(comment="float*") @NotNull
 @NotNull MemorySegment value)

sampleRate

public float sampleRate()

sampleRate

public XrHapticPcmVibrationFB sampleRate(float value)

append

@NativeType("XrBool32")
@Unsigned
public int append()

append

public XrHapticPcmVibrationFB append(@NativeType("XrBool32") @Unsigned
 int value)

samplesConsumed

@Nullable
@Unsigned
public @Nullable IntPtr samplesConsumed()

Note: the returned IntPtr does not have correct IntPtr.size() property. It's up to user to track the size of the buffer, and use IntPtr.reinterpret(long) to set the size before actually reading from or writing to the buffer.

samplesConsumed

public XrHapticPcmVibrationFB samplesConsumed(@Nullable @Unsigned
 @Nullable IntPtr value)

samplesConsumedRaw

@Pointer(comment="uint32_t*")
@NotNull
public @NotNull MemorySegment samplesConsumedRaw()

samplesConsumedRaw

public void samplesConsumedRaw(@Pointer(comment="uint32_t*") @NotNull
 @NotNull MemorySegment value)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

segment

@NotNull
public @NotNull MemorySegment segment()

Returns the value of the segment record component.

Specified by:

segment in interface IPointer

Returns:

the value of the segment record component