Record Class XrEnvironmentDepthImageViewMETA

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrEnvironmentDepthImageViewMETA

All Implemented Interfaces:

IPointer, IXrEnvironmentDepthImageViewMETA

@ValueBasedCandidate
@UnsafeConstructor
public record XrEnvironmentDepthImageViewMETA(@NotNull MemorySegment segment)
extends Record
implements IXrEnvironmentDepthImageViewMETA

Represents a pointer to a XrEnvironmentDepthImageViewMETA structure in native memory.

Structure

typedef struct XrEnvironmentDepthImageViewMETA {
    XrStructureType type;
    void const* next;
    XrFovf fov;
    XrPosef pose;
} XrEnvironmentDepthImageViewMETA;

Auto initialization

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

• type = XR_TYPE_ENVIRONMENT_DEPTH_IMAGE_VIEW_META

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:

• XrEnvironmentDepthImageViewMETA

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrEnvironmentDepthImageViewMETA	allocate(Arena arena)
static XrEnvironmentDepthImageViewMETA.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrEnvironmentDepthImageViewMETA	clone(Arena arena, XrEnvironmentDepthImageViewMETA src)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull XrFovf	fov()
XrEnvironmentDepthImageViewMETA	fov(@NotNull XrFovf value)
XrEnvironmentDepthImageViewMETA	fov(Consumer<@NotNull XrFovf> consumer)
final int	hashCode()	Returns a hash code value for this object.
@NotNull MemorySegment	next()
XrEnvironmentDepthImageViewMETA	next(@Nullable IPointer pointer)
XrEnvironmentDepthImageViewMETA	next(@NotNull MemorySegment value)
@NotNull XrPosef	pose()
XrEnvironmentDepthImageViewMETA	pose(@NotNull XrPosef value)
XrEnvironmentDepthImageViewMETA	pose(Consumer<@NotNull XrPosef> consumer)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
int	type()
XrEnvironmentDepthImageViewMETA	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$fov

public static final MemoryLayout.PathElement PATH$fov

PATH$pose

public static final MemoryLayout.PathElement PATH$pose

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$fov

public static final StructLayout LAYOUT$fov

LAYOUT$pose

public static final StructLayout LAYOUT$pose

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$fov

public static final long SIZE$fov

SIZE$pose

public static final long SIZE$pose

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$fov

public static final long OFFSET$fov

OFFSET$pose

public static final long OFFSET$pose

Constructor Details

XrEnvironmentDepthImageViewMETA

public XrEnvironmentDepthImageViewMETA(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrEnvironmentDepthImageViewMETA record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrEnvironmentDepthImageViewMETA allocate(Arena arena)

allocate

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

clone

public static XrEnvironmentDepthImageViewMETA clone(Arena arena,
 XrEnvironmentDepthImageViewMETA src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrEnvironmentDepthImageViewMETA next(@Nullable
 @Nullable IPointer pointer)

fov

@NotNull
public @NotNull XrFovf fov()

fov

public XrEnvironmentDepthImageViewMETA fov(@NotNull
 @NotNull XrFovf value)

fov

public XrEnvironmentDepthImageViewMETA fov(Consumer<@NotNull XrFovf> consumer)

pose

@NotNull
public @NotNull XrPosef pose()

pose

public XrEnvironmentDepthImageViewMETA pose(@NotNull
 @NotNull XrPosef value)

pose

public XrEnvironmentDepthImageViewMETA pose(Consumer<@NotNull XrPosef> consumer)

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