Record Class XrSwapchainStateFoveationFB

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrSwapchainStateFoveationFB

All Implemented Interfaces:

IPointer, IXrSwapchainStateFoveationFB

@ValueBasedCandidate
@UnsafeConstructor
public record XrSwapchainStateFoveationFB(@NotNull MemorySegment segment)
extends Record
implements IXrSwapchainStateFoveationFB

Represents a pointer to a XrSwapchainStateFoveationFB structure in native memory.

Structure

typedef struct XrSwapchainStateFoveationFB {
    XrStructureType type;
    void* next;
    XrSwapchainStateFoveationFlagsFB flags; // optional
    XrFoveationProfileFB profile;
} XrSwapchainStateFoveationFB;

Auto initialization

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

• type = XR_TYPE_SWAPCHAIN_STATE_FOVEATION_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:

• XrSwapchainStateFoveationFB

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrSwapchainStateFoveationFB	allocate(Arena arena)
static XrSwapchainStateFoveationFB.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrSwapchainStateFoveationFB	clone(Arena arena, XrSwapchainStateFoveationFB src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
long	flags()
XrSwapchainStateFoveationFB	flags(long value)
final int	hashCode()	Returns a hash code value for this object.
@NotNull MemorySegment	next()
XrSwapchainStateFoveationFB	next(@Nullable IPointer pointer)
XrSwapchainStateFoveationFB	next(@NotNull MemorySegment value)
@Nullable XrFoveationProfileFB	profile()
XrSwapchainStateFoveationFB	profile(@Nullable XrFoveationProfileFB 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()
XrSwapchainStateFoveationFB	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$flags

public static final MemoryLayout.PathElement PATH$flags

PATH$profile

public static final MemoryLayout.PathElement PATH$profile

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$flags

public static final ValueLayout.OfLong LAYOUT$flags

LAYOUT$profile

public static final AddressLayout LAYOUT$profile

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$flags

public static final long SIZE$flags

SIZE$profile

public static final long SIZE$profile

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$flags

public static final long OFFSET$flags

OFFSET$profile

public static final long OFFSET$profile

Constructor Details

XrSwapchainStateFoveationFB

public XrSwapchainStateFoveationFB(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrSwapchainStateFoveationFB record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrSwapchainStateFoveationFB allocate(Arena arena)

allocate

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

clone

public static XrSwapchainStateFoveationFB clone(Arena arena,
 XrSwapchainStateFoveationFB src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrSwapchainStateFoveationFB next(@Nullable
 @Nullable IPointer pointer)

flags

@Bitmask(XrSwapchainStateFoveationFlagsFB.class)
public long flags()

flags

public XrSwapchainStateFoveationFB flags(@Bitmask(XrSwapchainStateFoveationFlagsFB.class)
 long value)

profile

@Nullable
public @Nullable XrFoveationProfileFB profile()

profile

public XrSwapchainStateFoveationFB profile(@Nullable
 @Nullable XrFoveationProfileFB 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