Record Class VkCopyBufferInfo2

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkCopyBufferInfo2

All Implemented Interfaces:

IPointer, IVkCopyBufferInfo2

@ValueBasedCandidate
@UnsafeConstructor
public record VkCopyBufferInfo2(@NotNull MemorySegment segment)
extends Record
implements IVkCopyBufferInfo2

Represents a pointer to a VkCopyBufferInfo2 structure in native memory.

Structure

typedef struct VkCopyBufferInfo2 {
    VkStructureType sType;
    void const* pNext; // optional
    VkBuffer srcBuffer;
    VkBuffer dstBuffer;
    uint32_t regionCount;
    VkBufferCopy2 const* pRegions;
} VkCopyBufferInfo2;

Auto initialization

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

• sType = VK_STRUCTURE_TYPE_COPY_BUFFER_INFO_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:

• VkCopyBufferInfo2

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final AddressLayout	LAYOUT$dstBuffer
static final AddressLayout	LAYOUT$pNext
static final AddressLayout	LAYOUT$pRegions
static final ValueLayout.OfInt	LAYOUT$regionCount
static final AddressLayout	LAYOUT$srcBuffer
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$dstBuffer
static final long	OFFSET$pNext
static final long	OFFSET$pRegions
static final long	OFFSET$regionCount
static final long	OFFSET$srcBuffer
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$dstBuffer
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$pRegions
static final MemoryLayout.PathElement	PATH$regionCount
static final MemoryLayout.PathElement	PATH$srcBuffer
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$dstBuffer
static final long	SIZE$pNext
static final long	SIZE$pRegions
static final long	SIZE$regionCount
static final long	SIZE$srcBuffer
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkCopyBufferInfo2	allocate(Arena arena)
static VkCopyBufferInfo2.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkCopyBufferInfo2	clone(Arena arena, VkCopyBufferInfo2 src)
@Nullable VkBuffer	dstBuffer()
VkCopyBufferInfo2	dstBuffer(@Nullable VkBuffer 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()
VkCopyBufferInfo2	pNext(@Nullable IPointer pointer)
VkCopyBufferInfo2	pNext(@NotNull MemorySegment value)
@Nullable VkBufferCopy2	pRegions()
VkBufferCopy2.Ptr	pRegions(int assumedCount)
VkCopyBufferInfo2	pRegions(@Nullable IVkBufferCopy2 value)
@NotNull MemorySegment	pRegionsRaw()
void	pRegionsRaw(@NotNull MemorySegment value)
int	regionCount()
VkCopyBufferInfo2	regionCount(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@Nullable VkBuffer	srcBuffer()
VkCopyBufferInfo2	srcBuffer(@Nullable VkBuffer value)
int	sType()
VkCopyBufferInfo2	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$srcBuffer

public static final MemoryLayout.PathElement PATH$srcBuffer

PATH$dstBuffer

public static final MemoryLayout.PathElement PATH$dstBuffer

PATH$regionCount

public static final MemoryLayout.PathElement PATH$regionCount

PATH$pRegions

public static final MemoryLayout.PathElement PATH$pRegions

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$srcBuffer

public static final AddressLayout LAYOUT$srcBuffer

LAYOUT$dstBuffer

public static final AddressLayout LAYOUT$dstBuffer

LAYOUT$regionCount

public static final ValueLayout.OfInt LAYOUT$regionCount

LAYOUT$pRegions

public static final AddressLayout LAYOUT$pRegions

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$srcBuffer

public static final long SIZE$srcBuffer

SIZE$dstBuffer

public static final long SIZE$dstBuffer

SIZE$regionCount

public static final long SIZE$regionCount

SIZE$pRegions

public static final long SIZE$pRegions

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$srcBuffer

public static final long OFFSET$srcBuffer

OFFSET$dstBuffer

public static final long OFFSET$dstBuffer

OFFSET$regionCount

public static final long OFFSET$regionCount

OFFSET$pRegions

public static final long OFFSET$pRegions

Constructor Details

VkCopyBufferInfo2

public VkCopyBufferInfo2(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkCopyBufferInfo2 record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkCopyBufferInfo2 allocate(Arena arena)

allocate

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

clone

public static VkCopyBufferInfo2 clone(Arena arena,
 VkCopyBufferInfo2 src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkCopyBufferInfo2 pNext(@Nullable
 @Nullable IPointer pointer)

srcBuffer

@Nullable
public @Nullable VkBuffer srcBuffer()

srcBuffer

public VkCopyBufferInfo2 srcBuffer(@Nullable
 @Nullable VkBuffer value)

dstBuffer

@Nullable
public @Nullable VkBuffer dstBuffer()

dstBuffer

public VkCopyBufferInfo2 dstBuffer(@Nullable
 @Nullable VkBuffer value)

regionCount

@Unsigned
public int regionCount()

regionCount

public VkCopyBufferInfo2 regionCount(@Unsigned
 int value)

pRegions

public VkCopyBufferInfo2 pRegions(@Nullable
 @Nullable IVkBufferCopy2 value)

pRegions

@Unsafe
@Nullable
public VkBufferCopy2.Ptr pRegions(int assumedCount)

pRegions

@Nullable
public @Nullable VkBufferCopy2 pRegions()

pRegionsRaw

@Pointer(target=VkBufferCopy2.class)
@NotNull
public @NotNull MemorySegment pRegionsRaw()

pRegionsRaw

public void pRegionsRaw(@Pointer(target=VkBufferCopy2.class) @NotNull
 @NotNull MemorySegment 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