Record Class VkGeometryAABBNV

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkGeometryAABBNV

All Implemented Interfaces:

IPointer, IVkGeometryAABBNV

@ValueBasedCandidate
@UnsafeConstructor
public record VkGeometryAABBNV(@NotNull MemorySegment segment)
extends Record
implements IVkGeometryAABBNV

Represents a pointer to a VkGeometryAABBNV structure in native memory.

Structure

typedef struct VkGeometryAABBNV {
    VkStructureType sType;
    void const* pNext; // optional
    VkBuffer aabbData; // optional
    uint32_t numAABBs;
    uint32_t stride;
    VkDeviceSize offset;
} VkGeometryAABBNV;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_GEOMETRY_AABB_NV

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:

• VkGeometryAABBNV

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
@Nullable VkBuffer	aabbData()
VkGeometryAABBNV	aabbData(@Nullable VkBuffer value)
static VkGeometryAABBNV	allocate(Arena arena)
static VkGeometryAABBNV.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkGeometryAABBNV	clone(Arena arena, VkGeometryAABBNV 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.
int	numAABBs()
VkGeometryAABBNV	numAABBs(int value)
long	offset()
VkGeometryAABBNV	offset(long value)
@NotNull MemorySegment	pNext()
VkGeometryAABBNV	pNext(@Nullable IPointer pointer)
VkGeometryAABBNV	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	stride()
VkGeometryAABBNV	stride(int value)
int	sType()
VkGeometryAABBNV	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$aabbData

public static final MemoryLayout.PathElement PATH$aabbData

PATH$numAABBs

public static final MemoryLayout.PathElement PATH$numAABBs

PATH$stride

public static final MemoryLayout.PathElement PATH$stride

PATH$offset

public static final MemoryLayout.PathElement PATH$offset

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$aabbData

public static final AddressLayout LAYOUT$aabbData

LAYOUT$numAABBs

public static final ValueLayout.OfInt LAYOUT$numAABBs

LAYOUT$stride

public static final ValueLayout.OfInt LAYOUT$stride

LAYOUT$offset

public static final ValueLayout.OfLong LAYOUT$offset

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$aabbData

public static final long SIZE$aabbData

SIZE$numAABBs

public static final long SIZE$numAABBs

SIZE$stride

public static final long SIZE$stride

SIZE$offset

public static final long SIZE$offset

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$aabbData

public static final long OFFSET$aabbData

OFFSET$numAABBs

public static final long OFFSET$numAABBs

OFFSET$stride

public static final long OFFSET$stride

OFFSET$offset

public static final long OFFSET$offset

Constructor Details

VkGeometryAABBNV

public VkGeometryAABBNV(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkGeometryAABBNV record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkGeometryAABBNV allocate(Arena arena)

allocate

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

clone

public static VkGeometryAABBNV clone(Arena arena,
 VkGeometryAABBNV src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkGeometryAABBNV pNext(@Nullable
 @Nullable IPointer pointer)

aabbData

@Nullable
public @Nullable VkBuffer aabbData()

aabbData

public VkGeometryAABBNV aabbData(@Nullable
 @Nullable VkBuffer value)

numAABBs

@Unsigned
public int numAABBs()

numAABBs

public VkGeometryAABBNV numAABBs(@Unsigned
 int value)

stride

@Unsigned
public int stride()

stride

public VkGeometryAABBNV stride(@Unsigned
 int value)

offset

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

offset

public VkGeometryAABBNV offset(@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