Record Class VkBufferCopy2

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkBufferCopy2

All Implemented Interfaces:

IPointer, IVkBufferCopy2

@ValueBasedCandidate
@UnsafeConstructor
public record VkBufferCopy2(@NotNull MemorySegment segment)
extends Record
implements IVkBufferCopy2

Represents a pointer to a VkBufferCopy2 structure in native memory.

Structure

typedef struct VkBufferCopy2 {
    VkStructureType sType;
    void const* pNext; // optional
    VkDeviceSize srcOffset;
    VkDeviceSize dstOffset;
    VkDeviceSize size;
} VkBufferCopy2;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_BUFFER_COPY_2

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:

• VkBufferCopy2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkBufferCopy2.Ptr	Represents a pointer to / an array of VkBufferCopy2 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$dstOffset
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfLong	LAYOUT$size
static final ValueLayout.OfLong	LAYOUT$srcOffset
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$dstOffset
static final long	OFFSET$pNext
static final long	OFFSET$size
static final long	OFFSET$srcOffset
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$dstOffset
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$size
static final MemoryLayout.PathElement	PATH$srcOffset
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$dstOffset
static final long	SIZE$pNext
static final long	SIZE$size
static final long	SIZE$srcOffset
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkBufferCopy2	allocate(Arena arena)
static VkBufferCopy2.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkBufferCopy2	clone(Arena arena, VkBufferCopy2 src)
long	dstOffset()
VkBufferCopy2	dstOffset(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	pNext()
VkBufferCopy2	pNext(@Nullable IPointer pointer)
VkBufferCopy2	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
long	size()
VkBufferCopy2	size(long value)
long	srcOffset()
VkBufferCopy2	srcOffset(long value)
int	sType()
VkBufferCopy2	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$srcOffset

public static final MemoryLayout.PathElement PATH$srcOffset

PATH$dstOffset

public static final MemoryLayout.PathElement PATH$dstOffset

PATH$size

public static final MemoryLayout.PathElement PATH$size

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$srcOffset

public static final ValueLayout.OfLong LAYOUT$srcOffset

LAYOUT$dstOffset

public static final ValueLayout.OfLong LAYOUT$dstOffset

LAYOUT$size

public static final ValueLayout.OfLong LAYOUT$size

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$srcOffset

public static final long SIZE$srcOffset

SIZE$dstOffset

public static final long SIZE$dstOffset

SIZE$size

public static final long SIZE$size

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$srcOffset

public static final long OFFSET$srcOffset

OFFSET$dstOffset

public static final long OFFSET$dstOffset

OFFSET$size

public static final long OFFSET$size

Constructor Details

VkBufferCopy2

public VkBufferCopy2(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkBufferCopy2 record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkBufferCopy2 allocate(Arena arena)

allocate

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

clone

public static VkBufferCopy2 clone(Arena arena,
 VkBufferCopy2 src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkBufferCopy2 pNext(@Nullable
 @Nullable IPointer pointer)

srcOffset

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

srcOffset

public VkBufferCopy2 srcOffset(@NativeType("VkDeviceSize") @Unsigned
 long value)

dstOffset

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

dstOffset

public VkBufferCopy2 dstOffset(@NativeType("VkDeviceSize") @Unsigned
 long value)

size

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

size

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