Record Class VkImageCopy

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkImageCopy

All Implemented Interfaces:

IPointer, IVkImageCopy

@ValueBasedCandidate
@UnsafeConstructor
public record VkImageCopy(@NotNull MemorySegment segment)
extends Record
implements IVkImageCopy

Represents a pointer to a VkImageCopy structure in native memory.

Structure

typedef struct VkImageCopy {
    VkImageSubresourceLayers srcSubresource;
    VkOffset3D srcOffset;
    VkImageSubresourceLayers dstSubresource;
    VkOffset3D dstOffset;
    VkExtent3D extent;
} VkImageCopy;

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:

• VkImageCopy

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkImageCopy.Ptr	Represents a pointer to / an array of VkImageCopy 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 StructLayout	LAYOUT$srcOffset
static final StructLayout	LAYOUT$srcSubresource
static final long	OFFSET$dstOffset
static final long	OFFSET$dstSubresource
static final long	OFFSET$extent
static final long	OFFSET$srcOffset
static final long	OFFSET$srcSubresource
static final MemoryLayout.PathElement	PATH$dstOffset
static final MemoryLayout.PathElement	PATH$dstSubresource
static final MemoryLayout.PathElement	PATH$extent
static final MemoryLayout.PathElement	PATH$srcOffset
static final MemoryLayout.PathElement	PATH$srcSubresource
static final long	SIZE$dstOffset
static final long	SIZE$dstSubresource
static final long	SIZE$extent
static final long	SIZE$srcOffset
static final long	SIZE$srcSubresource

Constructor Summary

Constructors

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

Method Summary

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

VkImageCopy

public VkImageCopy(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkImageCopy record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkImageCopy allocate(Arena arena)

allocate

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

clone

public static VkImageCopy clone(Arena arena,
 VkImageCopy src)

srcSubresource

@NotNull
public @NotNull VkImageSubresourceLayers srcSubresource()

srcSubresource

public VkImageCopy srcSubresource(@NotNull
 @NotNull VkImageSubresourceLayers value)

srcSubresource

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

srcOffset

@NotNull
public @NotNull VkOffset3D srcOffset()

srcOffset

public VkImageCopy srcOffset(@NotNull
 @NotNull VkOffset3D value)

srcOffset

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

dstSubresource

@NotNull
public @NotNull VkImageSubresourceLayers dstSubresource()

dstSubresource

public VkImageCopy dstSubresource(@NotNull
 @NotNull VkImageSubresourceLayers value)

dstSubresource

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

dstOffset

@NotNull
public @NotNull VkOffset3D dstOffset()

dstOffset

public VkImageCopy dstOffset(@NotNull
 @NotNull VkOffset3D value)

dstOffset

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

extent

@NotNull
public @NotNull VkExtent3D extent()

extent

public VkImageCopy extent(@NotNull
 @NotNull VkExtent3D value)

extent

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