Record Class VkBindIndexBufferIndirectCommandNV

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkBindIndexBufferIndirectCommandNV

All Implemented Interfaces:

IPointer, IVkBindIndexBufferIndirectCommandNV

@ValueBasedCandidate
@UnsafeConstructor
public record VkBindIndexBufferIndirectCommandNV(@NotNull MemorySegment segment)
extends Record
implements IVkBindIndexBufferIndirectCommandNV

Represents a pointer to a VkBindIndexBufferIndirectCommandNV structure in native memory.

Structure

typedef struct VkBindIndexBufferIndirectCommandNV {
    VkDeviceAddress bufferAddress;
    uint32_t size;
    VkIndexType indexType;
} VkBindIndexBufferIndirectCommandNV;

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:

• VkBindIndexBufferIndirectCommandNV

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkBindIndexBufferIndirectCommandNV	allocate(Arena arena)
static VkBindIndexBufferIndirectCommandNV.Ptr	allocate(Arena arena, long count)
long	bufferAddress()
VkBindIndexBufferIndirectCommandNV	bufferAddress(long value)
static VkBindIndexBufferIndirectCommandNV	clone(Arena arena, VkBindIndexBufferIndirectCommandNV 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	indexType()
VkBindIndexBufferIndirectCommandNV	indexType(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	size()
VkBindIndexBufferIndirectCommandNV	size(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$bufferAddress

public static final MemoryLayout.PathElement PATH$bufferAddress

PATH$size

public static final MemoryLayout.PathElement PATH$size

PATH$indexType

public static final MemoryLayout.PathElement PATH$indexType

LAYOUT$bufferAddress

public static final ValueLayout.OfLong LAYOUT$bufferAddress

LAYOUT$size

public static final ValueLayout.OfInt LAYOUT$size

LAYOUT$indexType

public static final ValueLayout.OfInt LAYOUT$indexType

SIZE$bufferAddress

public static final long SIZE$bufferAddress

SIZE$size

public static final long SIZE$size

SIZE$indexType

public static final long SIZE$indexType

OFFSET$bufferAddress

public static final long OFFSET$bufferAddress

OFFSET$size

public static final long OFFSET$size

OFFSET$indexType

public static final long OFFSET$indexType

Constructor Details

VkBindIndexBufferIndirectCommandNV

public VkBindIndexBufferIndirectCommandNV(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkBindIndexBufferIndirectCommandNV record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkBindIndexBufferIndirectCommandNV allocate(Arena arena)

allocate

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

clone

public static VkBindIndexBufferIndirectCommandNV clone(Arena arena,
 VkBindIndexBufferIndirectCommandNV src)

bufferAddress

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

bufferAddress

public VkBindIndexBufferIndirectCommandNV bufferAddress(@NativeType("VkDeviceAddress") @Unsigned
 long value)

size

@Unsigned
public int size()

size

public VkBindIndexBufferIndirectCommandNV size(@Unsigned
 int value)

indexType

@EnumType(VkIndexType.class)
public int indexType()

indexType

public VkBindIndexBufferIndirectCommandNV indexType(@EnumType(VkIndexType.class)
 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