Record Class VkPhysicalDeviceAccelerationStructurePropertiesKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkPhysicalDeviceAccelerationStructurePropertiesKHR

All Implemented Interfaces:

IPointer, IVkPhysicalDeviceAccelerationStructurePropertiesKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkPhysicalDeviceAccelerationStructurePropertiesKHR(@NotNull MemorySegment segment)
extends Record
implements IVkPhysicalDeviceAccelerationStructurePropertiesKHR

Represents a pointer to a VkPhysicalDeviceAccelerationStructurePropertiesKHR structure in native memory.

Structure

typedef struct VkPhysicalDeviceAccelerationStructurePropertiesKHR {
    VkStructureType sType;
    void* pNext; // optional
    uint64_t maxGeometryCount;
    uint64_t maxInstanceCount;
    uint64_t maxPrimitiveCount;
    uint32_t maxPerStageDescriptorAccelerationStructures;
    uint32_t maxPerStageDescriptorUpdateAfterBindAccelerationStructures;
    uint32_t maxDescriptorSetAccelerationStructures;
    uint32_t maxDescriptorSetUpdateAfterBindAccelerationStructures;
    uint32_t minAccelerationStructureScratchOffsetAlignment;
} VkPhysicalDeviceAccelerationStructurePropertiesKHR;

Auto initialization

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

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

• VkPhysicalDeviceAccelerationStructurePropertiesKHR

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkPhysicalDeviceAccelerationStructurePropertiesKHR.Ptr	Represents a pointer to / an array of VkPhysicalDeviceAccelerationStructurePropertiesKHR 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$maxDescriptorSetAccelerationStructures
static final ValueLayout.OfInt	LAYOUT$maxDescriptorSetUpdateAfterBindAccelerationStructures
static final ValueLayout.OfLong	LAYOUT$maxGeometryCount
static final ValueLayout.OfLong	LAYOUT$maxInstanceCount
static final ValueLayout.OfInt	LAYOUT$maxPerStageDescriptorAccelerationStructures
static final ValueLayout.OfInt	LAYOUT$maxPerStageDescriptorUpdateAfterBindAccelerationStructures
static final ValueLayout.OfLong	LAYOUT$maxPrimitiveCount
static final ValueLayout.OfInt	LAYOUT$minAccelerationStructureScratchOffsetAlignment
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$maxDescriptorSetAccelerationStructures
static final long	OFFSET$maxDescriptorSetUpdateAfterBindAccelerationStructures
static final long	OFFSET$maxGeometryCount
static final long	OFFSET$maxInstanceCount
static final long	OFFSET$maxPerStageDescriptorAccelerationStructures
static final long	OFFSET$maxPerStageDescriptorUpdateAfterBindAccelerationStructures
static final long	OFFSET$maxPrimitiveCount
static final long	OFFSET$minAccelerationStructureScratchOffsetAlignment
static final long	OFFSET$pNext
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$maxDescriptorSetAccelerationStructures
static final MemoryLayout.PathElement	PATH$maxDescriptorSetUpdateAfterBindAccelerationStructures
static final MemoryLayout.PathElement	PATH$maxGeometryCount
static final MemoryLayout.PathElement	PATH$maxInstanceCount
static final MemoryLayout.PathElement	PATH$maxPerStageDescriptorAccelerationStructures
static final MemoryLayout.PathElement	PATH$maxPerStageDescriptorUpdateAfterBindAccelerationStructures
static final MemoryLayout.PathElement	PATH$maxPrimitiveCount
static final MemoryLayout.PathElement	PATH$minAccelerationStructureScratchOffsetAlignment
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$maxDescriptorSetAccelerationStructures
static final long	SIZE$maxDescriptorSetUpdateAfterBindAccelerationStructures
static final long	SIZE$maxGeometryCount
static final long	SIZE$maxInstanceCount
static final long	SIZE$maxPerStageDescriptorAccelerationStructures
static final long	SIZE$maxPerStageDescriptorUpdateAfterBindAccelerationStructures
static final long	SIZE$maxPrimitiveCount
static final long	SIZE$minAccelerationStructureScratchOffsetAlignment
static final long	SIZE$pNext
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceAccelerationStructurePropertiesKHR	allocate(Arena arena)
static VkPhysicalDeviceAccelerationStructurePropertiesKHR.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkPhysicalDeviceAccelerationStructurePropertiesKHR	clone(Arena arena, VkPhysicalDeviceAccelerationStructurePropertiesKHR 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	maxDescriptorSetAccelerationStructures()
VkPhysicalDeviceAccelerationStructurePropertiesKHR	maxDescriptorSetAccelerationStructures(int value)
int	maxDescriptorSetUpdateAfterBindAccelerationStructures()
VkPhysicalDeviceAccelerationStructurePropertiesKHR	maxDescriptorSetUpdateAfterBindAccelerationStructures(int value)
long	maxGeometryCount()
VkPhysicalDeviceAccelerationStructurePropertiesKHR	maxGeometryCount(long value)
long	maxInstanceCount()
VkPhysicalDeviceAccelerationStructurePropertiesKHR	maxInstanceCount(long value)
int	maxPerStageDescriptorAccelerationStructures()
VkPhysicalDeviceAccelerationStructurePropertiesKHR	maxPerStageDescriptorAccelerationStructures(int value)
int	maxPerStageDescriptorUpdateAfterBindAccelerationStructures()
VkPhysicalDeviceAccelerationStructurePropertiesKHR	maxPerStageDescriptorUpdateAfterBindAccelerationStructures(int value)
long	maxPrimitiveCount()
VkPhysicalDeviceAccelerationStructurePropertiesKHR	maxPrimitiveCount(long value)
int	minAccelerationStructureScratchOffsetAlignment()
VkPhysicalDeviceAccelerationStructurePropertiesKHR	minAccelerationStructureScratchOffsetAlignment(int value)
MemorySegment	pNext()
VkPhysicalDeviceAccelerationStructurePropertiesKHR	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkPhysicalDeviceAccelerationStructurePropertiesKHR	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$maxGeometryCount

public static final MemoryLayout.PathElement PATH$maxGeometryCount

PATH$maxInstanceCount

public static final MemoryLayout.PathElement PATH$maxInstanceCount

PATH$maxPrimitiveCount

public static final MemoryLayout.PathElement PATH$maxPrimitiveCount

PATH$maxPerStageDescriptorAccelerationStructures

public static final MemoryLayout.PathElement PATH$maxPerStageDescriptorAccelerationStructures

PATH$maxPerStageDescriptorUpdateAfterBindAccelerationStructures

public static final MemoryLayout.PathElement PATH$maxPerStageDescriptorUpdateAfterBindAccelerationStructures

PATH$maxDescriptorSetAccelerationStructures

public static final MemoryLayout.PathElement PATH$maxDescriptorSetAccelerationStructures

PATH$maxDescriptorSetUpdateAfterBindAccelerationStructures

public static final MemoryLayout.PathElement PATH$maxDescriptorSetUpdateAfterBindAccelerationStructures

PATH$minAccelerationStructureScratchOffsetAlignment

public static final MemoryLayout.PathElement PATH$minAccelerationStructureScratchOffsetAlignment

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$maxGeometryCount

public static final ValueLayout.OfLong LAYOUT$maxGeometryCount

LAYOUT$maxInstanceCount

public static final ValueLayout.OfLong LAYOUT$maxInstanceCount

LAYOUT$maxPrimitiveCount

public static final ValueLayout.OfLong LAYOUT$maxPrimitiveCount

LAYOUT$maxPerStageDescriptorAccelerationStructures

public static final ValueLayout.OfInt LAYOUT$maxPerStageDescriptorAccelerationStructures

LAYOUT$maxPerStageDescriptorUpdateAfterBindAccelerationStructures

public static final ValueLayout.OfInt LAYOUT$maxPerStageDescriptorUpdateAfterBindAccelerationStructures

LAYOUT$maxDescriptorSetAccelerationStructures

public static final ValueLayout.OfInt LAYOUT$maxDescriptorSetAccelerationStructures

LAYOUT$maxDescriptorSetUpdateAfterBindAccelerationStructures

public static final ValueLayout.OfInt LAYOUT$maxDescriptorSetUpdateAfterBindAccelerationStructures

LAYOUT$minAccelerationStructureScratchOffsetAlignment

public static final ValueLayout.OfInt LAYOUT$minAccelerationStructureScratchOffsetAlignment

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$maxGeometryCount

public static final long SIZE$maxGeometryCount

SIZE$maxInstanceCount

public static final long SIZE$maxInstanceCount

SIZE$maxPrimitiveCount

public static final long SIZE$maxPrimitiveCount

SIZE$maxPerStageDescriptorAccelerationStructures

public static final long SIZE$maxPerStageDescriptorAccelerationStructures

SIZE$maxPerStageDescriptorUpdateAfterBindAccelerationStructures

public static final long SIZE$maxPerStageDescriptorUpdateAfterBindAccelerationStructures

SIZE$maxDescriptorSetAccelerationStructures

public static final long SIZE$maxDescriptorSetAccelerationStructures

SIZE$maxDescriptorSetUpdateAfterBindAccelerationStructures

public static final long SIZE$maxDescriptorSetUpdateAfterBindAccelerationStructures

SIZE$minAccelerationStructureScratchOffsetAlignment

public static final long SIZE$minAccelerationStructureScratchOffsetAlignment

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$maxGeometryCount

public static final long OFFSET$maxGeometryCount

OFFSET$maxInstanceCount

public static final long OFFSET$maxInstanceCount

OFFSET$maxPrimitiveCount

public static final long OFFSET$maxPrimitiveCount

OFFSET$maxPerStageDescriptorAccelerationStructures

public static final long OFFSET$maxPerStageDescriptorAccelerationStructures

OFFSET$maxPerStageDescriptorUpdateAfterBindAccelerationStructures

public static final long OFFSET$maxPerStageDescriptorUpdateAfterBindAccelerationStructures

OFFSET$maxDescriptorSetAccelerationStructures

public static final long OFFSET$maxDescriptorSetAccelerationStructures

OFFSET$maxDescriptorSetUpdateAfterBindAccelerationStructures

public static final long OFFSET$maxDescriptorSetUpdateAfterBindAccelerationStructures

OFFSET$minAccelerationStructureScratchOffsetAlignment

public static final long OFFSET$minAccelerationStructureScratchOffsetAlignment

Constructor Details

VkPhysicalDeviceAccelerationStructurePropertiesKHR

public VkPhysicalDeviceAccelerationStructurePropertiesKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkPhysicalDeviceAccelerationStructurePropertiesKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkPhysicalDeviceAccelerationStructurePropertiesKHR allocate(Arena arena)

allocate

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

clone

public static VkPhysicalDeviceAccelerationStructurePropertiesKHR clone(Arena arena,
 VkPhysicalDeviceAccelerationStructurePropertiesKHR src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkPhysicalDeviceAccelerationStructurePropertiesKHR pNext(@Nullable
 @Nullable IPointer pointer)

maxGeometryCount

@Unsigned
public long maxGeometryCount()

maxGeometryCount

public VkPhysicalDeviceAccelerationStructurePropertiesKHR maxGeometryCount(@Unsigned
 long value)

maxInstanceCount

@Unsigned
public long maxInstanceCount()

maxInstanceCount

public VkPhysicalDeviceAccelerationStructurePropertiesKHR maxInstanceCount(@Unsigned
 long value)

maxPrimitiveCount

@Unsigned
public long maxPrimitiveCount()

maxPrimitiveCount

public VkPhysicalDeviceAccelerationStructurePropertiesKHR maxPrimitiveCount(@Unsigned
 long value)

maxPerStageDescriptorAccelerationStructures

@Unsigned
public int maxPerStageDescriptorAccelerationStructures()

maxPerStageDescriptorAccelerationStructures

public VkPhysicalDeviceAccelerationStructurePropertiesKHR maxPerStageDescriptorAccelerationStructures(@Unsigned
 int value)

maxPerStageDescriptorUpdateAfterBindAccelerationStructures

@Unsigned
public int maxPerStageDescriptorUpdateAfterBindAccelerationStructures()

maxPerStageDescriptorUpdateAfterBindAccelerationStructures

public VkPhysicalDeviceAccelerationStructurePropertiesKHR maxPerStageDescriptorUpdateAfterBindAccelerationStructures(@Unsigned
 int value)

maxDescriptorSetAccelerationStructures

@Unsigned
public int maxDescriptorSetAccelerationStructures()

maxDescriptorSetAccelerationStructures

public VkPhysicalDeviceAccelerationStructurePropertiesKHR maxDescriptorSetAccelerationStructures(@Unsigned
 int value)

maxDescriptorSetUpdateAfterBindAccelerationStructures

@Unsigned
public int maxDescriptorSetUpdateAfterBindAccelerationStructures()

maxDescriptorSetUpdateAfterBindAccelerationStructures

public VkPhysicalDeviceAccelerationStructurePropertiesKHR maxDescriptorSetUpdateAfterBindAccelerationStructures(@Unsigned
 int value)

minAccelerationStructureScratchOffsetAlignment

@Unsigned
public int minAccelerationStructureScratchOffsetAlignment()

minAccelerationStructureScratchOffsetAlignment

public VkPhysicalDeviceAccelerationStructurePropertiesKHR minAccelerationStructureScratchOffsetAlignment(@Unsigned
 int 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