Record Class XrFrameEndInfo

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrFrameEndInfo

All Implemented Interfaces:

IPointer, IXrFrameEndInfo

@ValueBasedCandidate
@UnsafeConstructor
public record XrFrameEndInfo(@NotNull MemorySegment segment)
extends Record
implements IXrFrameEndInfo

Represents a pointer to a XrFrameEndInfo structure in native memory.

Structure

typedef struct XrFrameEndInfo {
    XrStructureType type;
    void const* next;
    XrTime displayTime;
    XrEnvironmentBlendMode environmentBlendMode;
    uint32_t layerCount; // optional
    XrCompositionLayerBaseHeader const* const* layers; // optional
} XrFrameEndInfo;

Auto initialization

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

• type = XR_TYPE_FRAME_END_INFO

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:

• XrFrameEndInfo

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	XrFrameEndInfo.Ptr	Represents a pointer to / an array of XrFrameEndInfo 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$displayTime
static final ValueLayout.OfInt	LAYOUT$environmentBlendMode
static final ValueLayout.OfInt	LAYOUT$layerCount
static final AddressLayout	LAYOUT$layers
static final AddressLayout	LAYOUT$next
static final ValueLayout.OfInt	LAYOUT$type
static final long	OFFSET$displayTime
static final long	OFFSET$environmentBlendMode
static final long	OFFSET$layerCount
static final long	OFFSET$layers
static final long	OFFSET$next
static final long	OFFSET$type
static final MemoryLayout.PathElement	PATH$displayTime
static final MemoryLayout.PathElement	PATH$environmentBlendMode
static final MemoryLayout.PathElement	PATH$layerCount
static final MemoryLayout.PathElement	PATH$layers
static final MemoryLayout.PathElement	PATH$next
static final MemoryLayout.PathElement	PATH$type
static final long	SIZE$displayTime
static final long	SIZE$environmentBlendMode
static final long	SIZE$layerCount
static final long	SIZE$layers
static final long	SIZE$next
static final long	SIZE$type

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrFrameEndInfo	allocate(Arena arena)
static XrFrameEndInfo.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrFrameEndInfo	clone(Arena arena, XrFrameEndInfo src)
long	displayTime()
XrFrameEndInfo	displayTime(long value)
int	environmentBlendMode()
XrFrameEndInfo	environmentBlendMode(int value)
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.
int	layerCount()
XrFrameEndInfo	layerCount(int value)
@Nullable PointerPtr	layers()	Note: the returned PointerPtr does not have correct PointerPtr.size() property.
XrFrameEndInfo	layers(@Nullable PointerPtr value)
@NotNull MemorySegment	layersRaw()
void	layersRaw(@NotNull MemorySegment value)
@NotNull MemorySegment	next()
XrFrameEndInfo	next(@Nullable IPointer pointer)
XrFrameEndInfo	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()
XrFrameEndInfo	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$displayTime

public static final MemoryLayout.PathElement PATH$displayTime

PATH$environmentBlendMode

public static final MemoryLayout.PathElement PATH$environmentBlendMode

PATH$layerCount

public static final MemoryLayout.PathElement PATH$layerCount

PATH$layers

public static final MemoryLayout.PathElement PATH$layers

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$displayTime

public static final ValueLayout.OfLong LAYOUT$displayTime

LAYOUT$environmentBlendMode

public static final ValueLayout.OfInt LAYOUT$environmentBlendMode

LAYOUT$layerCount

public static final ValueLayout.OfInt LAYOUT$layerCount

LAYOUT$layers

public static final AddressLayout LAYOUT$layers

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$displayTime

public static final long SIZE$displayTime

SIZE$environmentBlendMode

public static final long SIZE$environmentBlendMode

SIZE$layerCount

public static final long SIZE$layerCount

SIZE$layers

public static final long SIZE$layers

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$displayTime

public static final long OFFSET$displayTime

OFFSET$environmentBlendMode

public static final long OFFSET$environmentBlendMode

OFFSET$layerCount

public static final long OFFSET$layerCount

OFFSET$layers

public static final long OFFSET$layers

Constructor Details

XrFrameEndInfo

public XrFrameEndInfo(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrFrameEndInfo record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrFrameEndInfo allocate(Arena arena)

allocate

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

clone

public static XrFrameEndInfo clone(Arena arena,
 XrFrameEndInfo src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrFrameEndInfo next(@Nullable
 @Nullable IPointer pointer)

displayTime

@NativeType("XrTime")
public long displayTime()

displayTime

public XrFrameEndInfo displayTime(@NativeType("XrTime")
 long value)

environmentBlendMode

@EnumType(XrEnvironmentBlendMode.class)
public int environmentBlendMode()

environmentBlendMode

public XrFrameEndInfo environmentBlendMode(@EnumType(XrEnvironmentBlendMode.class)
 int value)

layerCount

@Unsigned
public int layerCount()

layerCount

public XrFrameEndInfo layerCount(@Unsigned
 int value)

layers

@Nullable
public @Nullable PointerPtr layers()

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

layers

public XrFrameEndInfo layers(@Nullable
 @Nullable PointerPtr value)

layersRaw

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

layersRaw

public void layersRaw(@Pointer(comment="void**") @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