Record Class VkImageCopy2

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkImageCopy2

All Implemented Interfaces:

IPointer, IVkImageCopy2

@ValueBasedCandidate
@UnsafeConstructor
public record VkImageCopy2(@NotNull MemorySegment segment)
extends Record
implements IVkImageCopy2

Represents a pointer to a VkImageCopy2 structure in native memory.

Structure

typedef struct VkImageCopy2 {
    VkStructureType sType;
    void const* pNext; // optional
    VkImageSubresourceLayers srcSubresource;
    VkOffset3D srcOffset;
    VkImageSubresourceLayers dstSubresource;
    VkOffset3D dstOffset;
    VkExtent3D extent;
} VkImageCopy2;

Auto initialization

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

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

• VkImageCopy2

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final StructLayout	LAYOUT$dstOffset
static final StructLayout	LAYOUT$dstSubresource
static final StructLayout	LAYOUT$extent
static final AddressLayout	LAYOUT$pNext
static final StructLayout	LAYOUT$srcOffset
static final StructLayout	LAYOUT$srcSubresource
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$dstOffset
static final long	OFFSET$dstSubresource
static final long	OFFSET$extent
static final long	OFFSET$pNext
static final long	OFFSET$srcOffset
static final long	OFFSET$srcSubresource
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$dstOffset
static final MemoryLayout.PathElement	PATH$dstSubresource
static final MemoryLayout.PathElement	PATH$extent
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$srcOffset
static final MemoryLayout.PathElement	PATH$srcSubresource
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$dstOffset
static final long	SIZE$dstSubresource
static final long	SIZE$extent
static final long	SIZE$pNext
static final long	SIZE$srcOffset
static final long	SIZE$srcSubresource
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkImageCopy2	allocate(Arena arena)
static VkImageCopy2.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkImageCopy2	clone(Arena arena, VkImageCopy2 src)
@NotNull VkOffset3D	dstOffset()
VkImageCopy2	dstOffset(@NotNull VkOffset3D value)
VkImageCopy2	dstOffset(Consumer<@NotNull VkOffset3D> consumer)
@NotNull VkImageSubresourceLayers	dstSubresource()
VkImageCopy2	dstSubresource(@NotNull VkImageSubresourceLayers value)
VkImageCopy2	dstSubresource(Consumer<@NotNull VkImageSubresourceLayers> consumer)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull VkExtent3D	extent()
VkImageCopy2	extent(@NotNull VkExtent3D value)
VkImageCopy2	extent(Consumer<@NotNull VkExtent3D> consumer)
final int	hashCode()	Returns a hash code value for this object.
@NotNull MemorySegment	pNext()
VkImageCopy2	pNext(@Nullable IPointer pointer)
VkImageCopy2	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@NotNull VkOffset3D	srcOffset()
VkImageCopy2	srcOffset(@NotNull VkOffset3D value)
VkImageCopy2	srcOffset(Consumer<@NotNull VkOffset3D> consumer)
@NotNull VkImageSubresourceLayers	srcSubresource()
VkImageCopy2	srcSubresource(@NotNull VkImageSubresourceLayers value)
VkImageCopy2	srcSubresource(Consumer<@NotNull VkImageSubresourceLayers> consumer)
int	sType()
VkImageCopy2	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$srcSubresource

public static final MemoryLayout.PathElement PATH$srcSubresource

PATH$srcOffset

public static final MemoryLayout.PathElement PATH$srcOffset

PATH$dstSubresource

public static final MemoryLayout.PathElement PATH$dstSubresource

PATH$dstOffset

public static final MemoryLayout.PathElement PATH$dstOffset

PATH$extent

public static final MemoryLayout.PathElement PATH$extent

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$srcSubresource

public static final StructLayout LAYOUT$srcSubresource

LAYOUT$srcOffset

public static final StructLayout LAYOUT$srcOffset

LAYOUT$dstSubresource

public static final StructLayout LAYOUT$dstSubresource

LAYOUT$dstOffset

public static final StructLayout LAYOUT$dstOffset

LAYOUT$extent

public static final StructLayout LAYOUT$extent

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$srcSubresource

public static final long SIZE$srcSubresource

SIZE$srcOffset

public static final long SIZE$srcOffset

SIZE$dstSubresource

public static final long SIZE$dstSubresource

SIZE$dstOffset

public static final long SIZE$dstOffset

SIZE$extent

public static final long SIZE$extent

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$srcSubresource

public static final long OFFSET$srcSubresource

OFFSET$srcOffset

public static final long OFFSET$srcOffset

OFFSET$dstSubresource

public static final long OFFSET$dstSubresource

OFFSET$dstOffset

public static final long OFFSET$dstOffset

OFFSET$extent

public static final long OFFSET$extent

Constructor Details

VkImageCopy2

public VkImageCopy2(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkImageCopy2 record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkImageCopy2 allocate(Arena arena)

allocate

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

clone

public static VkImageCopy2 clone(Arena arena,
 VkImageCopy2 src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkImageCopy2 pNext(@Nullable
 @Nullable IPointer pointer)

srcSubresource

@NotNull
public @NotNull VkImageSubresourceLayers srcSubresource()

srcSubresource

public VkImageCopy2 srcSubresource(@NotNull
 @NotNull VkImageSubresourceLayers value)

srcSubresource

public VkImageCopy2 srcSubresource(Consumer<@NotNull VkImageSubresourceLayers> consumer)

srcOffset

@NotNull
public @NotNull VkOffset3D srcOffset()

srcOffset

public VkImageCopy2 srcOffset(@NotNull
 @NotNull VkOffset3D value)

srcOffset

public VkImageCopy2 srcOffset(Consumer<@NotNull VkOffset3D> consumer)

dstSubresource

@NotNull
public @NotNull VkImageSubresourceLayers dstSubresource()

dstSubresource

public VkImageCopy2 dstSubresource(@NotNull
 @NotNull VkImageSubresourceLayers value)

dstSubresource

public VkImageCopy2 dstSubresource(Consumer<@NotNull VkImageSubresourceLayers> consumer)

dstOffset

@NotNull
public @NotNull VkOffset3D dstOffset()

dstOffset

public VkImageCopy2 dstOffset(@NotNull
 @NotNull VkOffset3D value)

dstOffset

public VkImageCopy2 dstOffset(Consumer<@NotNull VkOffset3D> consumer)

extent

@NotNull
public @NotNull VkExtent3D extent()

extent

public VkImageCopy2 extent(@NotNull
 @NotNull VkExtent3D value)

extent

public VkImageCopy2 extent(Consumer<@NotNull VkExtent3D> consumer)

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