Record Class VkBufferImageCopy2

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkBufferImageCopy2

All Implemented Interfaces:

IPointer, IVkBufferImageCopy2

@ValueBasedCandidate
@UnsafeConstructor
public record VkBufferImageCopy2(@NotNull MemorySegment segment)
extends Record
implements IVkBufferImageCopy2

Represents a pointer to a VkBufferImageCopy2 structure in native memory.

Structure

typedef struct VkBufferImageCopy2 {
    VkStructureType sType;
    void const* pNext; // optional
    VkDeviceSize bufferOffset;
    uint32_t bufferRowLength;
    uint32_t bufferImageHeight;
    VkImageSubresourceLayers imageSubresource;
    VkOffset3D imageOffset;
    VkExtent3D imageExtent;
} VkBufferImageCopy2;

Auto initialization

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

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

• VkBufferImageCopy2

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
static final long	BYTES
static final StructLayout	LAYOUT
static final ValueLayout.OfInt	LAYOUT$bufferImageHeight
static final ValueLayout.OfLong	LAYOUT$bufferOffset
static final ValueLayout.OfInt	LAYOUT$bufferRowLength
static final StructLayout	LAYOUT$imageExtent
static final StructLayout	LAYOUT$imageOffset
static final StructLayout	LAYOUT$imageSubresource
static final AddressLayout	LAYOUT$pNext
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$bufferImageHeight
static final long	OFFSET$bufferOffset
static final long	OFFSET$bufferRowLength
static final long	OFFSET$imageExtent
static final long	OFFSET$imageOffset
static final long	OFFSET$imageSubresource
static final long	OFFSET$pNext
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$bufferImageHeight
static final MemoryLayout.PathElement	PATH$bufferOffset
static final MemoryLayout.PathElement	PATH$bufferRowLength
static final MemoryLayout.PathElement	PATH$imageExtent
static final MemoryLayout.PathElement	PATH$imageOffset
static final MemoryLayout.PathElement	PATH$imageSubresource
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$bufferImageHeight
static final long	SIZE$bufferOffset
static final long	SIZE$bufferRowLength
static final long	SIZE$imageExtent
static final long	SIZE$imageOffset
static final long	SIZE$imageSubresource
static final long	SIZE$pNext
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkBufferImageCopy2	allocate(Arena arena)
static VkBufferImageCopy2.Ptr	allocate(Arena arena, long count)
void	autoInit()
int	bufferImageHeight()
VkBufferImageCopy2	bufferImageHeight(int value)
long	bufferOffset()
VkBufferImageCopy2	bufferOffset(long value)
int	bufferRowLength()
VkBufferImageCopy2	bufferRowLength(int value)
static VkBufferImageCopy2	clone(Arena arena, VkBufferImageCopy2 src)
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 VkExtent3D	imageExtent()
VkBufferImageCopy2	imageExtent(@NotNull VkExtent3D value)
VkBufferImageCopy2	imageExtent(Consumer<@NotNull VkExtent3D> consumer)
@NotNull VkOffset3D	imageOffset()
VkBufferImageCopy2	imageOffset(@NotNull VkOffset3D value)
VkBufferImageCopy2	imageOffset(Consumer<@NotNull VkOffset3D> consumer)
@NotNull VkImageSubresourceLayers	imageSubresource()
VkBufferImageCopy2	imageSubresource(@NotNull VkImageSubresourceLayers value)
VkBufferImageCopy2	imageSubresource(Consumer<@NotNull VkImageSubresourceLayers> consumer)
@NotNull MemorySegment	pNext()
VkBufferImageCopy2	pNext(@Nullable IPointer pointer)
VkBufferImageCopy2	pNext(@NotNull MemorySegment value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
int	sType()
VkBufferImageCopy2	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$bufferOffset

public static final MemoryLayout.PathElement PATH$bufferOffset

PATH$bufferRowLength

public static final MemoryLayout.PathElement PATH$bufferRowLength

PATH$bufferImageHeight

public static final MemoryLayout.PathElement PATH$bufferImageHeight

PATH$imageSubresource

public static final MemoryLayout.PathElement PATH$imageSubresource

PATH$imageOffset

public static final MemoryLayout.PathElement PATH$imageOffset

PATH$imageExtent

public static final MemoryLayout.PathElement PATH$imageExtent

LAYOUT$sType

public static final ValueLayout.OfInt LAYOUT$sType

LAYOUT$pNext

public static final AddressLayout LAYOUT$pNext

LAYOUT$bufferOffset

public static final ValueLayout.OfLong LAYOUT$bufferOffset

LAYOUT$bufferRowLength

public static final ValueLayout.OfInt LAYOUT$bufferRowLength

LAYOUT$bufferImageHeight

public static final ValueLayout.OfInt LAYOUT$bufferImageHeight

LAYOUT$imageSubresource

public static final StructLayout LAYOUT$imageSubresource

LAYOUT$imageOffset

public static final StructLayout LAYOUT$imageOffset

LAYOUT$imageExtent

public static final StructLayout LAYOUT$imageExtent

SIZE$sType

public static final long SIZE$sType

SIZE$pNext

public static final long SIZE$pNext

SIZE$bufferOffset

public static final long SIZE$bufferOffset

SIZE$bufferRowLength

public static final long SIZE$bufferRowLength

SIZE$bufferImageHeight

public static final long SIZE$bufferImageHeight

SIZE$imageSubresource

public static final long SIZE$imageSubresource

SIZE$imageOffset

public static final long SIZE$imageOffset

SIZE$imageExtent

public static final long SIZE$imageExtent

OFFSET$sType

public static final long OFFSET$sType

OFFSET$pNext

public static final long OFFSET$pNext

OFFSET$bufferOffset

public static final long OFFSET$bufferOffset

OFFSET$bufferRowLength

public static final long OFFSET$bufferRowLength

OFFSET$bufferImageHeight

public static final long OFFSET$bufferImageHeight

OFFSET$imageSubresource

public static final long OFFSET$imageSubresource

OFFSET$imageOffset

public static final long OFFSET$imageOffset

OFFSET$imageExtent

public static final long OFFSET$imageExtent

Constructor Details

VkBufferImageCopy2

public VkBufferImageCopy2(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkBufferImageCopy2 record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkBufferImageCopy2 allocate(Arena arena)

allocate

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

clone

public static VkBufferImageCopy2 clone(Arena arena,
 VkBufferImageCopy2 src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkBufferImageCopy2 pNext(@Nullable
 @Nullable IPointer pointer)

bufferOffset

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

bufferOffset

public VkBufferImageCopy2 bufferOffset(@NativeType("VkDeviceSize") @Unsigned
 long value)

bufferRowLength

@Unsigned
public int bufferRowLength()

bufferRowLength

public VkBufferImageCopy2 bufferRowLength(@Unsigned
 int value)

bufferImageHeight

@Unsigned
public int bufferImageHeight()

bufferImageHeight

public VkBufferImageCopy2 bufferImageHeight(@Unsigned
 int value)

imageSubresource

@NotNull
public @NotNull VkImageSubresourceLayers imageSubresource()

imageSubresource

public VkBufferImageCopy2 imageSubresource(@NotNull
 @NotNull VkImageSubresourceLayers value)

imageSubresource

public VkBufferImageCopy2 imageSubresource(Consumer<@NotNull VkImageSubresourceLayers> consumer)

imageOffset

@NotNull
public @NotNull VkOffset3D imageOffset()

imageOffset

public VkBufferImageCopy2 imageOffset(@NotNull
 @NotNull VkOffset3D value)

imageOffset

public VkBufferImageCopy2 imageOffset(Consumer<@NotNull VkOffset3D> consumer)

imageExtent

@NotNull
public @NotNull VkExtent3D imageExtent()

imageExtent

public VkBufferImageCopy2 imageExtent(@NotNull
 @NotNull VkExtent3D value)

imageExtent

public VkBufferImageCopy2 imageExtent(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