Record Class VkClusterAccelerationStructureInstantiateClusterInfoNV

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkClusterAccelerationStructureInstantiateClusterInfoNV

All Implemented Interfaces:

IPointer, IVkClusterAccelerationStructureInstantiateClusterInfoNV

@ValueBasedCandidate
@UnsafeConstructor
public record VkClusterAccelerationStructureInstantiateClusterInfoNV(@NotNull MemorySegment segment)
extends Record
implements IVkClusterAccelerationStructureInstantiateClusterInfoNV

Represents a pointer to a VkClusterAccelerationStructureInstantiateClusterInfoNV structure in native memory.

Structure

typedef struct VkClusterAccelerationStructureInstantiateClusterInfoNV {
    uint32_t clusterIdOffset;
    uint32_t geometryIndexOffset : 24;
    uint32_t reserved : 8;
    VkDeviceAddress clusterTemplateAddress;
    VkStridedDeviceAddressNV vertexBuffer;
} VkClusterAccelerationStructureInstantiateClusterInfoNV;

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:

• VkClusterAccelerationStructureInstantiateClusterInfoNV

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkClusterAccelerationStructureInstantiateClusterInfoNV.Ptr	Represents a pointer to / an array of VkClusterAccelerationStructureInstantiateClusterInfoNV 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$bitfield$geometryIndexOffset$reserved
static final ValueLayout.OfInt	LAYOUT$clusterIdOffset
static final ValueLayout.OfLong	LAYOUT$clusterTemplateAddress
static final StructLayout	LAYOUT$vertexBuffer
static final long	OFFSET$bitfield$geometryIndexOffset$reserved
static final long	OFFSET$clusterIdOffset
static final long	OFFSET$clusterTemplateAddress
static final long	OFFSET$vertexBuffer
static final MemoryLayout.PathElement	PATH$bitfield$geometryIndexOffset$reserved
static final MemoryLayout.PathElement	PATH$clusterIdOffset
static final MemoryLayout.PathElement	PATH$clusterTemplateAddress
static final MemoryLayout.PathElement	PATH$vertexBuffer
static final long	SIZE$clusterIdOffset
static final long	SIZE$clusterTemplateAddress
static final long	SIZE$vertexBuffer

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkClusterAccelerationStructureInstantiateClusterInfoNV	allocate(Arena arena)
static VkClusterAccelerationStructureInstantiateClusterInfoNV.Ptr	allocate(Arena arena, long count)
static VkClusterAccelerationStructureInstantiateClusterInfoNV	clone(Arena arena, VkClusterAccelerationStructureInstantiateClusterInfoNV src)
int	clusterIdOffset()
VkClusterAccelerationStructureInstantiateClusterInfoNV	clusterIdOffset(int value)
long	clusterTemplateAddress()
VkClusterAccelerationStructureInstantiateClusterInfoNV	clusterTemplateAddress(long value)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	geometryIndexOffset()
VkClusterAccelerationStructureInstantiateClusterInfoNV	geometryIndexOffset(int value)
final int	hashCode()	Returns a hash code value for this object.
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
@NotNull VkStridedDeviceAddressNV	vertexBuffer()
VkClusterAccelerationStructureInstantiateClusterInfoNV	vertexBuffer(@NotNull VkStridedDeviceAddressNV value)
VkClusterAccelerationStructureInstantiateClusterInfoNV	vertexBuffer(Consumer<@NotNull VkStridedDeviceAddressNV> consumer)

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$clusterIdOffset

public static final MemoryLayout.PathElement PATH$clusterIdOffset

PATH$bitfield$geometryIndexOffset$reserved

public static final MemoryLayout.PathElement PATH$bitfield$geometryIndexOffset$reserved

PATH$clusterTemplateAddress

public static final MemoryLayout.PathElement PATH$clusterTemplateAddress

PATH$vertexBuffer

public static final MemoryLayout.PathElement PATH$vertexBuffer

LAYOUT$clusterIdOffset

public static final ValueLayout.OfInt LAYOUT$clusterIdOffset

LAYOUT$bitfield$geometryIndexOffset$reserved

public static final ValueLayout.OfInt LAYOUT$bitfield$geometryIndexOffset$reserved

LAYOUT$clusterTemplateAddress

public static final ValueLayout.OfLong LAYOUT$clusterTemplateAddress

LAYOUT$vertexBuffer

public static final StructLayout LAYOUT$vertexBuffer

SIZE$clusterIdOffset

public static final long SIZE$clusterIdOffset

SIZE$clusterTemplateAddress

public static final long SIZE$clusterTemplateAddress

SIZE$vertexBuffer

public static final long SIZE$vertexBuffer

OFFSET$clusterIdOffset

public static final long OFFSET$clusterIdOffset

OFFSET$bitfield$geometryIndexOffset$reserved

public static final long OFFSET$bitfield$geometryIndexOffset$reserved

OFFSET$clusterTemplateAddress

public static final long OFFSET$clusterTemplateAddress

OFFSET$vertexBuffer

public static final long OFFSET$vertexBuffer

Constructor Details

VkClusterAccelerationStructureInstantiateClusterInfoNV

public VkClusterAccelerationStructureInstantiateClusterInfoNV(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkClusterAccelerationStructureInstantiateClusterInfoNV record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkClusterAccelerationStructureInstantiateClusterInfoNV allocate(Arena arena)

allocate

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

clone

public static VkClusterAccelerationStructureInstantiateClusterInfoNV clone(Arena arena,
 VkClusterAccelerationStructureInstantiateClusterInfoNV src)

clusterIdOffset

@Unsigned
public int clusterIdOffset()

clusterIdOffset

public VkClusterAccelerationStructureInstantiateClusterInfoNV clusterIdOffset(@Unsigned
 int value)

geometryIndexOffset

@Unsigned
public int geometryIndexOffset()

geometryIndexOffset

public VkClusterAccelerationStructureInstantiateClusterInfoNV geometryIndexOffset(@Unsigned
 int value)

clusterTemplateAddress

@NativeType("VkDeviceAddress")
@Unsigned
public long clusterTemplateAddress()

clusterTemplateAddress

public VkClusterAccelerationStructureInstantiateClusterInfoNV clusterTemplateAddress(@NativeType("VkDeviceAddress") @Unsigned
 long value)

vertexBuffer

@NotNull
public @NotNull VkStridedDeviceAddressNV vertexBuffer()

vertexBuffer

public VkClusterAccelerationStructureInstantiateClusterInfoNV vertexBuffer(@NotNull
 @NotNull VkStridedDeviceAddressNV value)

vertexBuffer

public VkClusterAccelerationStructureInstantiateClusterInfoNV vertexBuffer(Consumer<@NotNull VkStridedDeviceAddressNV> 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