Record Class XrBindingModificationsKHR

java.lang.Object

java.lang.Record

club.doki7.openxr.datatype.XrBindingModificationsKHR

All Implemented Interfaces:

IPointer, IXrBindingModificationsKHR

@ValueBasedCandidate
@UnsafeConstructor
public record XrBindingModificationsKHR(@NotNull MemorySegment segment)
extends Record
implements IXrBindingModificationsKHR

Represents a pointer to a XrBindingModificationsKHR structure in native memory.

Structure

typedef struct XrBindingModificationsKHR {
    XrStructureType type;
    void const* next;
    uint32_t bindingModificationCount; // optional
    XrBindingModificationBaseHeaderKHR const* const* bindingModifications; // optional
} XrBindingModificationsKHR;

Auto initialization

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

• type = XR_TYPE_BINDING_MODIFICATIONS_KHR

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:

• XrBindingModificationsKHR

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$bindingModificationCount

PATH$bindingModifications

public static final MemoryLayout.PathElement PATH$bindingModifications

LAYOUT$type

public static final ValueLayout.OfInt LAYOUT$type

LAYOUT$next

public static final AddressLayout LAYOUT$next

LAYOUT$bindingModificationCount

public static final ValueLayout.OfInt LAYOUT$bindingModificationCount

LAYOUT$bindingModifications

public static final AddressLayout LAYOUT$bindingModifications

SIZE$type

public static final long SIZE$type

SIZE$next

public static final long SIZE$next

SIZE$bindingModificationCount

public static final long SIZE$bindingModificationCount

SIZE$bindingModifications

public static final long SIZE$bindingModifications

OFFSET$type

public static final long OFFSET$type

OFFSET$next

public static final long OFFSET$next

OFFSET$bindingModificationCount

public static final long OFFSET$bindingModificationCount

OFFSET$bindingModifications

public static final long OFFSET$bindingModifications

Constructor Details

XrBindingModificationsKHR

public XrBindingModificationsKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a XrBindingModificationsKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static XrBindingModificationsKHR allocate(Arena arena)

allocate

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

clone

public static XrBindingModificationsKHR clone(Arena arena,
 XrBindingModificationsKHR src)

autoInit

public void autoInit()

type

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

type

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

next

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

next

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

next

public XrBindingModificationsKHR next(@Nullable
 @Nullable IPointer pointer)

bindingModificationCount

@Unsigned
public int bindingModificationCount()

bindingModificationCount

public XrBindingModificationsKHR bindingModificationCount(@Unsigned
 int value)

bindingModifications

@Nullable
public @Nullable PointerPtr bindingModifications()

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.

bindingModifications

public XrBindingModificationsKHR bindingModifications(@Nullable
 @Nullable PointerPtr value)

bindingModificationsRaw

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

bindingModificationsRaw

public void bindingModificationsRaw(@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