Record Class XrDebugUtilsLabelEXT

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrDebugUtilsLabelEXT

All Implemented Interfaces:

IPointer, IXrDebugUtilsLabelEXT

@ValueBasedCandidate
@UnsafeConstructor
public record XrDebugUtilsLabelEXT(@NotNull MemorySegment segment)
extends Record
implements IXrDebugUtilsLabelEXT

Represents a pointer to a XrDebugUtilsLabelEXT structure in native memory.

Structure

typedef struct XrDebugUtilsLabelEXT {
    XrStructureType type;
    void const* next;
    char const* labelName;
} XrDebugUtilsLabelEXT;

Auto initialization

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

• type = XR_TYPE_DEBUG_UTILS_LABEL_EXT

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:

• XrDebugUtilsLabelEXT

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final AddressLayout	LAYOUT$labelName
static final AddressLayout	LAYOUT$next
static final ValueLayout.OfInt	LAYOUT$type
static final long	OFFSET$labelName
static final long	OFFSET$next
static final long	OFFSET$type
static final MemoryLayout.PathElement	PATH$labelName
static final MemoryLayout.PathElement	PATH$next
static final MemoryLayout.PathElement	PATH$type
static final long	SIZE$labelName
static final long	SIZE$next
static final long	SIZE$type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrDebugUtilsLabelEXT	allocate(Arena arena)
static XrDebugUtilsLabelEXT.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrDebugUtilsLabelEXT	clone(Arena arena, XrDebugUtilsLabelEXT 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.
@Nullable BytePtr	labelName()	Note: the returned BytePtr does not have correct BytePtr.size() property.
XrDebugUtilsLabelEXT	labelName(@Nullable BytePtr value)
@NotNull MemorySegment	labelNameRaw()
void	labelNameRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	next()
XrDebugUtilsLabelEXT	next(@Nullable IPointer pointer)
XrDebugUtilsLabelEXT	next(@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()
XrDebugUtilsLabelEXT	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$labelName

public static final MemoryLayout.PathElement PATH$labelName

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$labelName

public static final AddressLayout LAYOUT$labelName

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$labelName

public static final long SIZE$labelName

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$labelName

public static final long OFFSET$labelName

Constructor Details

XrDebugUtilsLabelEXT

public XrDebugUtilsLabelEXT(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrDebugUtilsLabelEXT record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrDebugUtilsLabelEXT allocate(Arena arena)

allocate

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

clone

public static XrDebugUtilsLabelEXT clone(Arena arena,
 XrDebugUtilsLabelEXT src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrDebugUtilsLabelEXT next(@Nullable
 @Nullable IPointer pointer)

labelName

@Nullable
public @Nullable BytePtr labelName()

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

labelName

public XrDebugUtilsLabelEXT labelName(@Nullable
 @Nullable BytePtr value)

labelNameRaw

@Pointer(comment="int8_t*")
@NotNull
public @NotNull MemorySegment labelNameRaw()

labelNameRaw

public void labelNameRaw(@Pointer(comment="int8_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