Record Class VkAccelerationStructureGeometryAabbsDataKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkAccelerationStructureGeometryAabbsDataKHR

All Implemented Interfaces:

IPointer, IVkAccelerationStructureGeometryAabbsDataKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkAccelerationStructureGeometryAabbsDataKHR(@NotNull MemorySegment segment)
extends Record
implements IVkAccelerationStructureGeometryAabbsDataKHR

Represents a pointer to a VkAccelerationStructureGeometryAabbsDataKHR structure in native memory.

Structure

typedef struct VkAccelerationStructureGeometryAabbsDataKHR {
    VkStructureType sType;
    void const* pNext; // optional
    VkDeviceOrHostAddressConstKHR data;
    VkDeviceSize stride;
} VkAccelerationStructureGeometryAabbsDataKHR;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_ACCELERATION_STRUCTURE_GEOMETRY_AABBS_DATA_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:

• VkAccelerationStructureGeometryAabbsDataKHR

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final UnionLayout	LAYOUT$data
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfLong	LAYOUT$stride
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$data
static final long	OFFSET$pNext
static final long	OFFSET$stride
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$data
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$stride
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$data
static final long	SIZE$pNext
static final long	SIZE$stride
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkAccelerationStructureGeometryAabbsDataKHR	allocate(Arena arena)
static VkAccelerationStructureGeometryAabbsDataKHR.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkAccelerationStructureGeometryAabbsDataKHR	clone(Arena arena, VkAccelerationStructureGeometryAabbsDataKHR src)
@NotNull VkDeviceOrHostAddressConstKHR	data()
VkAccelerationStructureGeometryAabbsDataKHR	data(@NotNull VkDeviceOrHostAddressConstKHR value)
VkAccelerationStructureGeometryAabbsDataKHR	data(Consumer<@NotNull VkDeviceOrHostAddressConstKHR> 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	pNext()
VkAccelerationStructureGeometryAabbsDataKHR	pNext(@Nullable IPointer pointer)
VkAccelerationStructureGeometryAabbsDataKHR	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	stride()
VkAccelerationStructureGeometryAabbsDataKHR	stride(long value)
int	sType()
VkAccelerationStructureGeometryAabbsDataKHR	sType(int value)
final String	toString()	Returns a string representation of this record class.

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

public static final MemoryLayout.PathElement PATH$sType

PATH$pNext

public static final MemoryLayout.PathElement PATH$pNext

PATH$data

public static final MemoryLayout.PathElement PATH$data

PATH$stride

public static final MemoryLayout.PathElement PATH$stride

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$data

public static final UnionLayout LAYOUT$data

LAYOUT$stride

public static final ValueLayout.OfLong LAYOUT$stride

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$data

public static final long SIZE$data

SIZE$stride

public static final long SIZE$stride

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$data

public static final long OFFSET$data

OFFSET$stride

public static final long OFFSET$stride

Constructor Details

VkAccelerationStructureGeometryAabbsDataKHR

public VkAccelerationStructureGeometryAabbsDataKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkAccelerationStructureGeometryAabbsDataKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkAccelerationStructureGeometryAabbsDataKHR allocate(Arena arena)

allocate

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

clone

public static VkAccelerationStructureGeometryAabbsDataKHR clone(Arena arena,
 VkAccelerationStructureGeometryAabbsDataKHR src)

autoInit

public void autoInit()

sType

@EnumType(VkStructureType.class)
public int sType()

sType

public VkAccelerationStructureGeometryAabbsDataKHR sType(@EnumType(VkStructureType.class)
 int value)

pNext

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

pNext

public VkAccelerationStructureGeometryAabbsDataKHR pNext(@Pointer(comment="void*") @NotNull
 @NotNull MemorySegment value)

pNext

public VkAccelerationStructureGeometryAabbsDataKHR pNext(@Nullable
 @Nullable IPointer pointer)

data

@NotNull
public @NotNull VkDeviceOrHostAddressConstKHR data()

data

public VkAccelerationStructureGeometryAabbsDataKHR data(@NotNull
 @NotNull VkDeviceOrHostAddressConstKHR value)

data

public VkAccelerationStructureGeometryAabbsDataKHR data(Consumer<@NotNull VkDeviceOrHostAddressConstKHR> consumer)

stride

@NativeType("VkDeviceSize")
@Unsigned
public long stride()

stride

public VkAccelerationStructureGeometryAabbsDataKHR stride(@NativeType("VkDeviceSize") @Unsigned
 long 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