Record Class VkPhysicalDeviceRayTracingPipelinePropertiesKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkPhysicalDeviceRayTracingPipelinePropertiesKHR

All Implemented Interfaces:

IPointer, IVkPhysicalDeviceRayTracingPipelinePropertiesKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkPhysicalDeviceRayTracingPipelinePropertiesKHR(@NotNull MemorySegment segment)
extends Record
implements IVkPhysicalDeviceRayTracingPipelinePropertiesKHR

Represents a pointer to a VkPhysicalDeviceRayTracingPipelinePropertiesKHR structure in native memory.

Structure

typedef struct VkPhysicalDeviceRayTracingPipelinePropertiesKHR {
    VkStructureType sType;
    void* pNext; // optional
    uint32_t shaderGroupHandleSize;
    uint32_t maxRayRecursionDepth;
    uint32_t maxShaderGroupStride;
    uint32_t shaderGroupBaseAlignment;
    uint32_t shaderGroupHandleCaptureReplaySize;
    uint32_t maxRayDispatchInvocationCount;
    uint32_t shaderGroupHandleAlignment;
    uint32_t maxRayHitAttributeSize;
} VkPhysicalDeviceRayTracingPipelinePropertiesKHR;

Auto initialization

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

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

• VkPhysicalDeviceRayTracingPipelinePropertiesKHR

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Ptr	Represents a pointer to / an array of VkPhysicalDeviceRayTracingPipelinePropertiesKHR 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$maxRayDispatchInvocationCount
static final ValueLayout.OfInt	LAYOUT$maxRayHitAttributeSize
static final ValueLayout.OfInt	LAYOUT$maxRayRecursionDepth
static final ValueLayout.OfInt	LAYOUT$maxShaderGroupStride
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$shaderGroupBaseAlignment
static final ValueLayout.OfInt	LAYOUT$shaderGroupHandleAlignment
static final ValueLayout.OfInt	LAYOUT$shaderGroupHandleCaptureReplaySize
static final ValueLayout.OfInt	LAYOUT$shaderGroupHandleSize
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$maxRayDispatchInvocationCount
static final long	OFFSET$maxRayHitAttributeSize
static final long	OFFSET$maxRayRecursionDepth
static final long	OFFSET$maxShaderGroupStride
static final long	OFFSET$pNext
static final long	OFFSET$shaderGroupBaseAlignment
static final long	OFFSET$shaderGroupHandleAlignment
static final long	OFFSET$shaderGroupHandleCaptureReplaySize
static final long	OFFSET$shaderGroupHandleSize
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$maxRayDispatchInvocationCount
static final MemoryLayout.PathElement	PATH$maxRayHitAttributeSize
static final MemoryLayout.PathElement	PATH$maxRayRecursionDepth
static final MemoryLayout.PathElement	PATH$maxShaderGroupStride
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$shaderGroupBaseAlignment
static final MemoryLayout.PathElement	PATH$shaderGroupHandleAlignment
static final MemoryLayout.PathElement	PATH$shaderGroupHandleCaptureReplaySize
static final MemoryLayout.PathElement	PATH$shaderGroupHandleSize
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$maxRayDispatchInvocationCount
static final long	SIZE$maxRayHitAttributeSize
static final long	SIZE$maxRayRecursionDepth
static final long	SIZE$maxShaderGroupStride
static final long	SIZE$pNext
static final long	SIZE$shaderGroupBaseAlignment
static final long	SIZE$shaderGroupHandleAlignment
static final long	SIZE$shaderGroupHandleCaptureReplaySize
static final long	SIZE$shaderGroupHandleSize
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkPhysicalDeviceRayTracingPipelinePropertiesKHR	allocate(Arena arena)
static VkPhysicalDeviceRayTracingPipelinePropertiesKHR.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkPhysicalDeviceRayTracingPipelinePropertiesKHR	clone(Arena arena, VkPhysicalDeviceRayTracingPipelinePropertiesKHR 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	maxRayDispatchInvocationCount()
VkPhysicalDeviceRayTracingPipelinePropertiesKHR	maxRayDispatchInvocationCount(int value)
int	maxRayHitAttributeSize()
VkPhysicalDeviceRayTracingPipelinePropertiesKHR	maxRayHitAttributeSize(int value)
int	maxRayRecursionDepth()
VkPhysicalDeviceRayTracingPipelinePropertiesKHR	maxRayRecursionDepth(int value)
int	maxShaderGroupStride()
VkPhysicalDeviceRayTracingPipelinePropertiesKHR	maxShaderGroupStride(int value)
@NotNull MemorySegment	pNext()
VkPhysicalDeviceRayTracingPipelinePropertiesKHR	pNext(@Nullable IPointer pointer)
VkPhysicalDeviceRayTracingPipelinePropertiesKHR	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	shaderGroupBaseAlignment()
VkPhysicalDeviceRayTracingPipelinePropertiesKHR	shaderGroupBaseAlignment(int value)
int	shaderGroupHandleAlignment()
VkPhysicalDeviceRayTracingPipelinePropertiesKHR	shaderGroupHandleAlignment(int value)
int	shaderGroupHandleCaptureReplaySize()
VkPhysicalDeviceRayTracingPipelinePropertiesKHR	shaderGroupHandleCaptureReplaySize(int value)
int	shaderGroupHandleSize()
VkPhysicalDeviceRayTracingPipelinePropertiesKHR	shaderGroupHandleSize(int value)
int	sType()
VkPhysicalDeviceRayTracingPipelinePropertiesKHR	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$shaderGroupHandleSize

public static final MemoryLayout.PathElement PATH$shaderGroupHandleSize

PATH$maxRayRecursionDepth

public static final MemoryLayout.PathElement PATH$maxRayRecursionDepth

PATH$maxShaderGroupStride

public static final MemoryLayout.PathElement PATH$maxShaderGroupStride

PATH$shaderGroupBaseAlignment

public static final MemoryLayout.PathElement PATH$shaderGroupBaseAlignment

PATH$shaderGroupHandleCaptureReplaySize

public static final MemoryLayout.PathElement PATH$shaderGroupHandleCaptureReplaySize

PATH$maxRayDispatchInvocationCount

public static final MemoryLayout.PathElement PATH$maxRayDispatchInvocationCount

PATH$shaderGroupHandleAlignment

public static final MemoryLayout.PathElement PATH$shaderGroupHandleAlignment

PATH$maxRayHitAttributeSize

public static final MemoryLayout.PathElement PATH$maxRayHitAttributeSize

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$shaderGroupHandleSize

public static final ValueLayout.OfInt LAYOUT$shaderGroupHandleSize

LAYOUT$maxRayRecursionDepth

public static final ValueLayout.OfInt LAYOUT$maxRayRecursionDepth

LAYOUT$maxShaderGroupStride

public static final ValueLayout.OfInt LAYOUT$maxShaderGroupStride

LAYOUT$shaderGroupBaseAlignment

public static final ValueLayout.OfInt LAYOUT$shaderGroupBaseAlignment

LAYOUT$shaderGroupHandleCaptureReplaySize

public static final ValueLayout.OfInt LAYOUT$shaderGroupHandleCaptureReplaySize

LAYOUT$maxRayDispatchInvocationCount

public static final ValueLayout.OfInt LAYOUT$maxRayDispatchInvocationCount

LAYOUT$shaderGroupHandleAlignment

public static final ValueLayout.OfInt LAYOUT$shaderGroupHandleAlignment

LAYOUT$maxRayHitAttributeSize

public static final ValueLayout.OfInt LAYOUT$maxRayHitAttributeSize

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$shaderGroupHandleSize

public static final long SIZE$shaderGroupHandleSize

SIZE$maxRayRecursionDepth

public static final long SIZE$maxRayRecursionDepth

SIZE$maxShaderGroupStride

public static final long SIZE$maxShaderGroupStride

SIZE$shaderGroupBaseAlignment

public static final long SIZE$shaderGroupBaseAlignment

SIZE$shaderGroupHandleCaptureReplaySize

public static final long SIZE$shaderGroupHandleCaptureReplaySize

SIZE$maxRayDispatchInvocationCount

public static final long SIZE$maxRayDispatchInvocationCount

SIZE$shaderGroupHandleAlignment

public static final long SIZE$shaderGroupHandleAlignment

SIZE$maxRayHitAttributeSize

public static final long SIZE$maxRayHitAttributeSize

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$shaderGroupHandleSize

public static final long OFFSET$shaderGroupHandleSize

OFFSET$maxRayRecursionDepth

public static final long OFFSET$maxRayRecursionDepth

OFFSET$maxShaderGroupStride

public static final long OFFSET$maxShaderGroupStride

OFFSET$shaderGroupBaseAlignment

public static final long OFFSET$shaderGroupBaseAlignment

OFFSET$shaderGroupHandleCaptureReplaySize

public static final long OFFSET$shaderGroupHandleCaptureReplaySize

OFFSET$maxRayDispatchInvocationCount

public static final long OFFSET$maxRayDispatchInvocationCount

OFFSET$shaderGroupHandleAlignment

public static final long OFFSET$shaderGroupHandleAlignment

OFFSET$maxRayHitAttributeSize

public static final long OFFSET$maxRayHitAttributeSize

Constructor Details

VkPhysicalDeviceRayTracingPipelinePropertiesKHR

public VkPhysicalDeviceRayTracingPipelinePropertiesKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkPhysicalDeviceRayTracingPipelinePropertiesKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkPhysicalDeviceRayTracingPipelinePropertiesKHR allocate(Arena arena)

allocate

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

clone

public static VkPhysicalDeviceRayTracingPipelinePropertiesKHR clone(Arena arena,
 VkPhysicalDeviceRayTracingPipelinePropertiesKHR src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkPhysicalDeviceRayTracingPipelinePropertiesKHR pNext(@Nullable
 @Nullable IPointer pointer)

shaderGroupHandleSize

@Unsigned
public int shaderGroupHandleSize()

shaderGroupHandleSize

public VkPhysicalDeviceRayTracingPipelinePropertiesKHR shaderGroupHandleSize(@Unsigned
 int value)

maxRayRecursionDepth

@Unsigned
public int maxRayRecursionDepth()

maxRayRecursionDepth

public VkPhysicalDeviceRayTracingPipelinePropertiesKHR maxRayRecursionDepth(@Unsigned
 int value)

maxShaderGroupStride

@Unsigned
public int maxShaderGroupStride()

maxShaderGroupStride

public VkPhysicalDeviceRayTracingPipelinePropertiesKHR maxShaderGroupStride(@Unsigned
 int value)

shaderGroupBaseAlignment

@Unsigned
public int shaderGroupBaseAlignment()

shaderGroupBaseAlignment

public VkPhysicalDeviceRayTracingPipelinePropertiesKHR shaderGroupBaseAlignment(@Unsigned
 int value)

shaderGroupHandleCaptureReplaySize

@Unsigned
public int shaderGroupHandleCaptureReplaySize()

shaderGroupHandleCaptureReplaySize

public VkPhysicalDeviceRayTracingPipelinePropertiesKHR shaderGroupHandleCaptureReplaySize(@Unsigned
 int value)

maxRayDispatchInvocationCount

@Unsigned
public int maxRayDispatchInvocationCount()

maxRayDispatchInvocationCount

public VkPhysicalDeviceRayTracingPipelinePropertiesKHR maxRayDispatchInvocationCount(@Unsigned
 int value)

shaderGroupHandleAlignment

@Unsigned
public int shaderGroupHandleAlignment()

shaderGroupHandleAlignment

public VkPhysicalDeviceRayTracingPipelinePropertiesKHR shaderGroupHandleAlignment(@Unsigned
 int value)

maxRayHitAttributeSize

@Unsigned
public int maxRayHitAttributeSize()

maxRayHitAttributeSize

public VkPhysicalDeviceRayTracingPipelinePropertiesKHR maxRayHitAttributeSize(@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