Record Class VkTraceRaysIndirectCommandKHR

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkTraceRaysIndirectCommandKHR

All Implemented Interfaces:

IPointer, IVkTraceRaysIndirectCommandKHR

@ValueBasedCandidate
@UnsafeConstructor
public record VkTraceRaysIndirectCommandKHR(@NotNull MemorySegment segment)
extends Record
implements IVkTraceRaysIndirectCommandKHR

Represents a pointer to a VkTraceRaysIndirectCommandKHR structure in native memory.

Structure

typedef struct VkTraceRaysIndirectCommandKHR {
    uint32_t width;
    uint32_t height;
    uint32_t depth;
} VkTraceRaysIndirectCommandKHR;

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:

• VkTraceRaysIndirectCommandKHR

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkTraceRaysIndirectCommandKHR.Ptr	Represents a pointer to / an array of VkTraceRaysIndirectCommandKHR 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$depth
static final ValueLayout.OfInt	LAYOUT$height
static final ValueLayout.OfInt	LAYOUT$width
static final long	OFFSET$depth
static final long	OFFSET$height
static final long	OFFSET$width
static final MemoryLayout.PathElement	PATH$depth
static final MemoryLayout.PathElement	PATH$height
static final MemoryLayout.PathElement	PATH$width
static final long	SIZE$depth
static final long	SIZE$height
static final long	SIZE$width

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkTraceRaysIndirectCommandKHR	allocate(Arena arena)
static VkTraceRaysIndirectCommandKHR.Ptr	allocate(Arena arena, long count)
static VkTraceRaysIndirectCommandKHR	clone(Arena arena, VkTraceRaysIndirectCommandKHR src)
int	depth()
VkTraceRaysIndirectCommandKHR	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()
VkTraceRaysIndirectCommandKHR	height(int 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()
VkTraceRaysIndirectCommandKHR	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$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$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$width

public static final long SIZE$width

SIZE$height

public static final long SIZE$height

SIZE$depth

public static final long SIZE$depth

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

VkTraceRaysIndirectCommandKHR

public VkTraceRaysIndirectCommandKHR(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkTraceRaysIndirectCommandKHR record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkTraceRaysIndirectCommandKHR allocate(Arena arena)

allocate

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

clone

public static VkTraceRaysIndirectCommandKHR clone(Arena arena,
 VkTraceRaysIndirectCommandKHR src)

width

@Unsigned
public int width()

width

public VkTraceRaysIndirectCommandKHR width(@Unsigned
 int value)

height

@Unsigned
public int height()

height

public VkTraceRaysIndirectCommandKHR height(@Unsigned
 int value)

depth

@Unsigned
public int depth()

depth

public VkTraceRaysIndirectCommandKHR 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