Record Class XrPassthroughStyleFB

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrPassthroughStyleFB

All Implemented Interfaces:

IPointer, IXrPassthroughStyleFB

@ValueBasedCandidate
@UnsafeConstructor
public record XrPassthroughStyleFB(@NotNull MemorySegment segment)
extends Record
implements IXrPassthroughStyleFB

Represents a pointer to a XrPassthroughStyleFB structure in native memory.

Structure

typedef struct XrPassthroughStyleFB {
    XrStructureType type;
    void const* next;
    float textureOpacityFactor;
    XrColor4f edgeColor;
} XrPassthroughStyleFB;

Auto initialization

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

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

• XrPassthroughStyleFB

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static XrPassthroughStyleFB	allocate(Arena arena)
static XrPassthroughStyleFB.Ptr	allocate(Arena arena, long count)
void	autoInit()
static XrPassthroughStyleFB	clone(Arena arena, XrPassthroughStyleFB src)
@NotNull XrColor4f	edgeColor()
XrPassthroughStyleFB	edgeColor(@NotNull XrColor4f value)
XrPassthroughStyleFB	edgeColor(Consumer<@NotNull XrColor4f> consumer)
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.
@NotNull MemorySegment	next()
XrPassthroughStyleFB	next(@Nullable IPointer pointer)
XrPassthroughStyleFB	next(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
float	textureOpacityFactor()
XrPassthroughStyleFB	textureOpacityFactor(float value)
final String	toString()	Returns a string representation of this record class.
int	type()
XrPassthroughStyleFB	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$textureOpacityFactor

public static final MemoryLayout.PathElement PATH$textureOpacityFactor

PATH$edgeColor

public static final MemoryLayout.PathElement PATH$edgeColor

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$textureOpacityFactor

public static final ValueLayout.OfFloat LAYOUT$textureOpacityFactor

LAYOUT$edgeColor

public static final StructLayout LAYOUT$edgeColor

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$textureOpacityFactor

public static final long SIZE$textureOpacityFactor

SIZE$edgeColor

public static final long SIZE$edgeColor

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$textureOpacityFactor

public static final long OFFSET$textureOpacityFactor

OFFSET$edgeColor

public static final long OFFSET$edgeColor

Constructor Details

XrPassthroughStyleFB

public XrPassthroughStyleFB(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrPassthroughStyleFB record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrPassthroughStyleFB allocate(Arena arena)

allocate

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

clone

public static XrPassthroughStyleFB clone(Arena arena,
 XrPassthroughStyleFB src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrPassthroughStyleFB next(@Nullable
 @Nullable IPointer pointer)

textureOpacityFactor

public float textureOpacityFactor()

textureOpacityFactor

public XrPassthroughStyleFB textureOpacityFactor(float value)

edgeColor

@NotNull
public @NotNull XrColor4f edgeColor()

edgeColor

public XrPassthroughStyleFB edgeColor(@NotNull
 @NotNull XrColor4f value)

edgeColor

public XrPassthroughStyleFB edgeColor(Consumer<@NotNull XrColor4f> 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