Record Class VkCopyMemoryIndirectCommandNV

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkCopyMemoryIndirectCommandNV

All Implemented Interfaces:

IPointer, IVkCopyMemoryIndirectCommandNV

@ValueBasedCandidate
@UnsafeConstructor
public record VkCopyMemoryIndirectCommandNV(@NotNull MemorySegment segment)
extends Record
implements IVkCopyMemoryIndirectCommandNV

Represents a pointer to a VkCopyMemoryIndirectCommandNV structure in native memory.

Structure

typedef struct VkCopyMemoryIndirectCommandNV {
    VkDeviceAddress srcAddress;
    VkDeviceAddress dstAddress;
    VkDeviceSize size;
} VkCopyMemoryIndirectCommandNV;

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:

• VkCopyMemoryIndirectCommandNV

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

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

public static final MemoryLayout.PathElement PATH$srcAddress

PATH$dstAddress

public static final MemoryLayout.PathElement PATH$dstAddress

PATH$size

public static final MemoryLayout.PathElement PATH$size

LAYOUT$srcAddress

public static final ValueLayout.OfLong LAYOUT$srcAddress

LAYOUT$dstAddress

public static final ValueLayout.OfLong LAYOUT$dstAddress

LAYOUT$size

public static final ValueLayout.OfLong LAYOUT$size

SIZE$srcAddress

public static final long SIZE$srcAddress

SIZE$dstAddress

public static final long SIZE$dstAddress

SIZE$size

public static final long SIZE$size

OFFSET$srcAddress

public static final long OFFSET$srcAddress

OFFSET$dstAddress

public static final long OFFSET$dstAddress

OFFSET$size

public static final long OFFSET$size

Constructor Details

VkCopyMemoryIndirectCommandNV

public VkCopyMemoryIndirectCommandNV(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkCopyMemoryIndirectCommandNV record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkCopyMemoryIndirectCommandNV allocate(Arena arena)

allocate

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

clone

public static VkCopyMemoryIndirectCommandNV clone(Arena arena,
 VkCopyMemoryIndirectCommandNV src)

srcAddress

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

srcAddress

public VkCopyMemoryIndirectCommandNV srcAddress(@NativeType("VkDeviceAddress") @Unsigned
 long value)

dstAddress

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

dstAddress

public VkCopyMemoryIndirectCommandNV dstAddress(@NativeType("VkDeviceAddress") @Unsigned
 long value)

size

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

size

public VkCopyMemoryIndirectCommandNV size(@NativeType("VkDeviceSize") @Unsigned
 long 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