Record Class VkTraceRaysIndirectCommand2KHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkTraceRaysIndirectCommand2KHR

All Implemented Interfaces:

IPointer, IVkTraceRaysIndirectCommand2KHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkTraceRaysIndirectCommand2KHR(@NotNull MemorySegment segment)
extends Record
implements IVkTraceRaysIndirectCommand2KHR

Represents a pointer to a VkTraceRaysIndirectCommand2KHR structure in native memory.

Structure

typedef struct VkTraceRaysIndirectCommand2KHR {
    VkDeviceAddress raygenShaderRecordAddress;
    VkDeviceSize raygenShaderRecordSize;
    VkDeviceAddress missShaderBindingTableAddress;
    VkDeviceSize missShaderBindingTableSize;
    VkDeviceSize missShaderBindingTableStride;
    VkDeviceAddress hitShaderBindingTableAddress;
    VkDeviceSize hitShaderBindingTableSize;
    VkDeviceSize hitShaderBindingTableStride;
    VkDeviceAddress callableShaderBindingTableAddress;
    VkDeviceSize callableShaderBindingTableSize;
    VkDeviceSize callableShaderBindingTableStride;
    uint32_t width;
    uint32_t height;
    uint32_t depth;
} VkTraceRaysIndirectCommand2KHR;

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:

• VkTraceRaysIndirectCommand2KHR

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfLong	LAYOUT$callableShaderBindingTableAddress
static final ValueLayout.OfLong	LAYOUT$callableShaderBindingTableSize
static final ValueLayout.OfLong	LAYOUT$callableShaderBindingTableStride
static final ValueLayout.OfInt	LAYOUT$depth
static final ValueLayout.OfInt	LAYOUT$height
static final ValueLayout.OfLong	LAYOUT$hitShaderBindingTableAddress
static final ValueLayout.OfLong	LAYOUT$hitShaderBindingTableSize
static final ValueLayout.OfLong	LAYOUT$hitShaderBindingTableStride
static final ValueLayout.OfLong	LAYOUT$missShaderBindingTableAddress
static final ValueLayout.OfLong	LAYOUT$missShaderBindingTableSize
static final ValueLayout.OfLong	LAYOUT$missShaderBindingTableStride
static final ValueLayout.OfLong	LAYOUT$raygenShaderRecordAddress
static final ValueLayout.OfLong	LAYOUT$raygenShaderRecordSize
static final ValueLayout.OfInt	LAYOUT$width
static final long	OFFSET$callableShaderBindingTableAddress
static final long	OFFSET$callableShaderBindingTableSize
static final long	OFFSET$callableShaderBindingTableStride
static final long	OFFSET$depth
static final long	OFFSET$height
static final long	OFFSET$hitShaderBindingTableAddress
static final long	OFFSET$hitShaderBindingTableSize
static final long	OFFSET$hitShaderBindingTableStride
static final long	OFFSET$missShaderBindingTableAddress
static final long	OFFSET$missShaderBindingTableSize
static final long	OFFSET$missShaderBindingTableStride
static final long	OFFSET$raygenShaderRecordAddress
static final long	OFFSET$raygenShaderRecordSize
static final long	OFFSET$width
static final MemoryLayout.PathElement	PATH$callableShaderBindingTableAddress
static final MemoryLayout.PathElement	PATH$callableShaderBindingTableSize
static final MemoryLayout.PathElement	PATH$callableShaderBindingTableStride
static final MemoryLayout.PathElement	PATH$depth
static final MemoryLayout.PathElement	PATH$height
static final MemoryLayout.PathElement	PATH$hitShaderBindingTableAddress
static final MemoryLayout.PathElement	PATH$hitShaderBindingTableSize
static final MemoryLayout.PathElement	PATH$hitShaderBindingTableStride
static final MemoryLayout.PathElement	PATH$missShaderBindingTableAddress
static final MemoryLayout.PathElement	PATH$missShaderBindingTableSize
static final MemoryLayout.PathElement	PATH$missShaderBindingTableStride
static final MemoryLayout.PathElement	PATH$raygenShaderRecordAddress
static final MemoryLayout.PathElement	PATH$raygenShaderRecordSize
static final MemoryLayout.PathElement	PATH$width
static final long	SIZE$callableShaderBindingTableAddress
static final long	SIZE$callableShaderBindingTableSize
static final long	SIZE$callableShaderBindingTableStride
static final long	SIZE$depth
static final long	SIZE$height
static final long	SIZE$hitShaderBindingTableAddress
static final long	SIZE$hitShaderBindingTableSize
static final long	SIZE$hitShaderBindingTableStride
static final long	SIZE$missShaderBindingTableAddress
static final long	SIZE$missShaderBindingTableSize
static final long	SIZE$missShaderBindingTableStride
static final long	SIZE$raygenShaderRecordAddress
static final long	SIZE$raygenShaderRecordSize
static final long	SIZE$width

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkTraceRaysIndirectCommand2KHR	allocate(Arena arena)
static VkTraceRaysIndirectCommand2KHR.Ptr	allocate(Arena arena, long count)
long	callableShaderBindingTableAddress()
VkTraceRaysIndirectCommand2KHR	callableShaderBindingTableAddress(long value)
long	callableShaderBindingTableSize()
VkTraceRaysIndirectCommand2KHR	callableShaderBindingTableSize(long value)
long	callableShaderBindingTableStride()
VkTraceRaysIndirectCommand2KHR	callableShaderBindingTableStride(long value)
static VkTraceRaysIndirectCommand2KHR	clone(Arena arena, VkTraceRaysIndirectCommand2KHR src)
int	depth()
VkTraceRaysIndirectCommand2KHR	depth(int value)
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	height()
VkTraceRaysIndirectCommand2KHR	height(int value)
long	hitShaderBindingTableAddress()
VkTraceRaysIndirectCommand2KHR	hitShaderBindingTableAddress(long value)
long	hitShaderBindingTableSize()
VkTraceRaysIndirectCommand2KHR	hitShaderBindingTableSize(long value)
long	hitShaderBindingTableStride()
VkTraceRaysIndirectCommand2KHR	hitShaderBindingTableStride(long value)
long	missShaderBindingTableAddress()
VkTraceRaysIndirectCommand2KHR	missShaderBindingTableAddress(long value)
long	missShaderBindingTableSize()
VkTraceRaysIndirectCommand2KHR	missShaderBindingTableSize(long value)
long	missShaderBindingTableStride()
VkTraceRaysIndirectCommand2KHR	missShaderBindingTableStride(long value)
long	raygenShaderRecordAddress()
VkTraceRaysIndirectCommand2KHR	raygenShaderRecordAddress(long value)
long	raygenShaderRecordSize()
VkTraceRaysIndirectCommand2KHR	raygenShaderRecordSize(long value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
final String	toString()	Returns a string representation of this record class.
int	width()
VkTraceRaysIndirectCommand2KHR	width(int value)

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

public static final MemoryLayout.PathElement PATH$raygenShaderRecordAddress

PATH$raygenShaderRecordSize

public static final MemoryLayout.PathElement PATH$raygenShaderRecordSize

PATH$missShaderBindingTableAddress

public static final MemoryLayout.PathElement PATH$missShaderBindingTableAddress

PATH$missShaderBindingTableSize

public static final MemoryLayout.PathElement PATH$missShaderBindingTableSize

PATH$missShaderBindingTableStride

public static final MemoryLayout.PathElement PATH$missShaderBindingTableStride

PATH$hitShaderBindingTableAddress

public static final MemoryLayout.PathElement PATH$hitShaderBindingTableAddress

PATH$hitShaderBindingTableSize

public static final MemoryLayout.PathElement PATH$hitShaderBindingTableSize

PATH$hitShaderBindingTableStride

public static final MemoryLayout.PathElement PATH$hitShaderBindingTableStride

PATH$callableShaderBindingTableAddress

public static final MemoryLayout.PathElement PATH$callableShaderBindingTableAddress

PATH$callableShaderBindingTableSize

public static final MemoryLayout.PathElement PATH$callableShaderBindingTableSize

PATH$callableShaderBindingTableStride

public static final MemoryLayout.PathElement PATH$callableShaderBindingTableStride

PATH$width

public static final MemoryLayout.PathElement PATH$width

PATH$height

public static final MemoryLayout.PathElement PATH$height

PATH$depth

public static final MemoryLayout.PathElement PATH$depth

LAYOUT$raygenShaderRecordAddress

public static final ValueLayout.OfLong LAYOUT$raygenShaderRecordAddress

LAYOUT$raygenShaderRecordSize

public static final ValueLayout.OfLong LAYOUT$raygenShaderRecordSize

LAYOUT$missShaderBindingTableAddress

public static final ValueLayout.OfLong LAYOUT$missShaderBindingTableAddress

LAYOUT$missShaderBindingTableSize

public static final ValueLayout.OfLong LAYOUT$missShaderBindingTableSize

LAYOUT$missShaderBindingTableStride

public static final ValueLayout.OfLong LAYOUT$missShaderBindingTableStride

LAYOUT$hitShaderBindingTableAddress

public static final ValueLayout.OfLong LAYOUT$hitShaderBindingTableAddress

LAYOUT$hitShaderBindingTableSize

public static final ValueLayout.OfLong LAYOUT$hitShaderBindingTableSize

LAYOUT$hitShaderBindingTableStride

public static final ValueLayout.OfLong LAYOUT$hitShaderBindingTableStride

LAYOUT$callableShaderBindingTableAddress

public static final ValueLayout.OfLong LAYOUT$callableShaderBindingTableAddress

LAYOUT$callableShaderBindingTableSize

public static final ValueLayout.OfLong LAYOUT$callableShaderBindingTableSize

LAYOUT$callableShaderBindingTableStride

public static final ValueLayout.OfLong LAYOUT$callableShaderBindingTableStride

LAYOUT$width

public static final ValueLayout.OfInt LAYOUT$width

LAYOUT$height

public static final ValueLayout.OfInt LAYOUT$height

LAYOUT$depth

public static final ValueLayout.OfInt LAYOUT$depth

SIZE$raygenShaderRecordAddress

public static final long SIZE$raygenShaderRecordAddress

SIZE$raygenShaderRecordSize

public static final long SIZE$raygenShaderRecordSize

SIZE$missShaderBindingTableAddress

public static final long SIZE$missShaderBindingTableAddress

SIZE$missShaderBindingTableSize

public static final long SIZE$missShaderBindingTableSize

SIZE$missShaderBindingTableStride

public static final long SIZE$missShaderBindingTableStride

SIZE$hitShaderBindingTableAddress

public static final long SIZE$hitShaderBindingTableAddress

SIZE$hitShaderBindingTableSize

public static final long SIZE$hitShaderBindingTableSize

SIZE$hitShaderBindingTableStride

public static final long SIZE$hitShaderBindingTableStride

SIZE$callableShaderBindingTableAddress

public static final long SIZE$callableShaderBindingTableAddress

SIZE$callableShaderBindingTableSize

public static final long SIZE$callableShaderBindingTableSize

SIZE$callableShaderBindingTableStride

public static final long SIZE$callableShaderBindingTableStride

SIZE$width

public static final long SIZE$width

SIZE$height

public static final long SIZE$height

SIZE$depth

public static final long SIZE$depth

OFFSET$raygenShaderRecordAddress

public static final long OFFSET$raygenShaderRecordAddress

OFFSET$raygenShaderRecordSize

public static final long OFFSET$raygenShaderRecordSize

OFFSET$missShaderBindingTableAddress

public static final long OFFSET$missShaderBindingTableAddress

OFFSET$missShaderBindingTableSize

public static final long OFFSET$missShaderBindingTableSize

OFFSET$missShaderBindingTableStride

public static final long OFFSET$missShaderBindingTableStride

OFFSET$hitShaderBindingTableAddress

public static final long OFFSET$hitShaderBindingTableAddress

OFFSET$hitShaderBindingTableSize

public static final long OFFSET$hitShaderBindingTableSize

OFFSET$hitShaderBindingTableStride

public static final long OFFSET$hitShaderBindingTableStride

OFFSET$callableShaderBindingTableAddress

public static final long OFFSET$callableShaderBindingTableAddress

OFFSET$callableShaderBindingTableSize

public static final long OFFSET$callableShaderBindingTableSize

OFFSET$callableShaderBindingTableStride

public static final long OFFSET$callableShaderBindingTableStride

OFFSET$width

public static final long OFFSET$width

OFFSET$height

public static final long OFFSET$height

OFFSET$depth

public static final long OFFSET$depth

Constructor Details

VkTraceRaysIndirectCommand2KHR

public VkTraceRaysIndirectCommand2KHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkTraceRaysIndirectCommand2KHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkTraceRaysIndirectCommand2KHR allocate(Arena arena)

allocate

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

clone

public static VkTraceRaysIndirectCommand2KHR clone(Arena arena,
 VkTraceRaysIndirectCommand2KHR src)

raygenShaderRecordAddress

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

raygenShaderRecordAddress

public VkTraceRaysIndirectCommand2KHR raygenShaderRecordAddress(@NativeType("VkDeviceAddress") @Unsigned
 long value)

raygenShaderRecordSize

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

raygenShaderRecordSize

public VkTraceRaysIndirectCommand2KHR raygenShaderRecordSize(@NativeType("VkDeviceSize") @Unsigned
 long value)

missShaderBindingTableAddress

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

missShaderBindingTableAddress

public VkTraceRaysIndirectCommand2KHR missShaderBindingTableAddress(@NativeType("VkDeviceAddress") @Unsigned
 long value)

missShaderBindingTableSize

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

missShaderBindingTableSize

public VkTraceRaysIndirectCommand2KHR missShaderBindingTableSize(@NativeType("VkDeviceSize") @Unsigned
 long value)

missShaderBindingTableStride

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

missShaderBindingTableStride

public VkTraceRaysIndirectCommand2KHR missShaderBindingTableStride(@NativeType("VkDeviceSize") @Unsigned
 long value)

hitShaderBindingTableAddress

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

hitShaderBindingTableAddress

public VkTraceRaysIndirectCommand2KHR hitShaderBindingTableAddress(@NativeType("VkDeviceAddress") @Unsigned
 long value)

hitShaderBindingTableSize

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

hitShaderBindingTableSize

public VkTraceRaysIndirectCommand2KHR hitShaderBindingTableSize(@NativeType("VkDeviceSize") @Unsigned
 long value)

hitShaderBindingTableStride

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

hitShaderBindingTableStride

public VkTraceRaysIndirectCommand2KHR hitShaderBindingTableStride(@NativeType("VkDeviceSize") @Unsigned
 long value)

callableShaderBindingTableAddress

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

callableShaderBindingTableAddress

public VkTraceRaysIndirectCommand2KHR callableShaderBindingTableAddress(@NativeType("VkDeviceAddress") @Unsigned
 long value)

callableShaderBindingTableSize

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

callableShaderBindingTableSize

public VkTraceRaysIndirectCommand2KHR callableShaderBindingTableSize(@NativeType("VkDeviceSize") @Unsigned
 long value)

callableShaderBindingTableStride

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

callableShaderBindingTableStride

public VkTraceRaysIndirectCommand2KHR callableShaderBindingTableStride(@NativeType("VkDeviceSize") @Unsigned
 long value)

width

@Unsigned
public int width()

width

public VkTraceRaysIndirectCommand2KHR width(@Unsigned
 int value)

height

@Unsigned
public int height()

height

public VkTraceRaysIndirectCommand2KHR height(@Unsigned
 int value)

depth

@Unsigned
public int depth()

depth

public VkTraceRaysIndirectCommand2KHR depth(@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