Record Class XrCompositionLayerBaseHeader

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrCompositionLayerBaseHeader

All Implemented Interfaces:

IPointer, IXrCompositionLayerBaseHeader

@ValueBasedCandidate
@UnsafeConstructor
public record XrCompositionLayerBaseHeader(@NotNull MemorySegment segment)
extends Record
implements IXrCompositionLayerBaseHeader

Represents a pointer to a XrCompositionLayerBaseHeader structure in native memory.

Structure

typedef struct XrCompositionLayerBaseHeader {
    XrStructureType type;
    void const* next;
    XrCompositionLayerFlags layerFlags; // optional
    XrSpace space;
} XrCompositionLayerBaseHeader;

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:

• XrCompositionLayerBaseHeader

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrCompositionLayerBaseHeader	allocate(Arena arena)
static XrCompositionLayerBaseHeader.Ptr	allocate(Arena arena, long count)
static XrCompositionLayerBaseHeader	clone(Arena arena, XrCompositionLayerBaseHeader 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.
long	layerFlags()
XrCompositionLayerBaseHeader	layerFlags(long value)
@NotNull MemorySegment	next()
XrCompositionLayerBaseHeader	next(@Nullable IPointer pointer)
XrCompositionLayerBaseHeader	next(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@Nullable XrSpace	space()
XrCompositionLayerBaseHeader	space(@Nullable XrSpace value)
final String	toString()	Returns a string representation of this record class.
int	type()
XrCompositionLayerBaseHeader	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$layerFlags

public static final MemoryLayout.PathElement PATH$layerFlags

PATH$space

public static final MemoryLayout.PathElement PATH$space

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$layerFlags

public static final ValueLayout.OfLong LAYOUT$layerFlags

LAYOUT$space

public static final AddressLayout LAYOUT$space

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$layerFlags

public static final long SIZE$layerFlags

SIZE$space

public static final long SIZE$space

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$layerFlags

public static final long OFFSET$layerFlags

OFFSET$space

public static final long OFFSET$space

Constructor Details

XrCompositionLayerBaseHeader

public XrCompositionLayerBaseHeader(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrCompositionLayerBaseHeader record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrCompositionLayerBaseHeader allocate(Arena arena)

allocate

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

clone

public static XrCompositionLayerBaseHeader clone(Arena arena,
 XrCompositionLayerBaseHeader src)

type

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

type

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

next

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

next

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

next

public XrCompositionLayerBaseHeader next(@Nullable
 @Nullable IPointer pointer)

layerFlags

@Bitmask(XrCompositionLayerFlags.class)
public long layerFlags()

layerFlags

public XrCompositionLayerBaseHeader layerFlags(@Bitmask(XrCompositionLayerFlags.class)
 long value)

space

@Nullable
public @Nullable XrSpace space()

space

public XrCompositionLayerBaseHeader space(@Nullable
 @Nullable XrSpace 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