Record Class VkCopyImageInfo2

java.lang.Object

java.lang.Record

club.doki7.vulkan.datatype.VkCopyImageInfo2

All Implemented Interfaces:

IPointer, IVkCopyImageInfo2

@ValueBasedCandidate
@UnsafeConstructor
public record VkCopyImageInfo2(@NotNull MemorySegment segment)
extends Record
implements IVkCopyImageInfo2

Represents a pointer to a VkCopyImageInfo2 structure in native memory.

Structure

typedef struct VkCopyImageInfo2 {
    VkStructureType sType;
    void const* pNext; // optional
    VkImage srcImage;
    VkImageLayout srcImageLayout;
    VkImage dstImage;
    VkImageLayout dstImageLayout;
    uint32_t regionCount;
    VkImageCopy2 const* pRegions;
} VkCopyImageInfo2;

Auto initialization

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

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

• VkCopyImageInfo2

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	VkCopyImageInfo2.Ptr	Represents a pointer to / an array of VkCopyImageInfo2 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$dstImage
static final ValueLayout.OfInt	LAYOUT$dstImageLayout
static final AddressLayout	LAYOUT$pNext
static final AddressLayout	LAYOUT$pRegions
static final ValueLayout.OfInt	LAYOUT$regionCount
static final AddressLayout	LAYOUT$srcImage
static final ValueLayout.OfInt	LAYOUT$srcImageLayout
static final ValueLayout.OfInt	LAYOUT$sType
static final long	OFFSET$dstImage
static final long	OFFSET$dstImageLayout
static final long	OFFSET$pNext
static final long	OFFSET$pRegions
static final long	OFFSET$regionCount
static final long	OFFSET$srcImage
static final long	OFFSET$srcImageLayout
static final long	OFFSET$sType
static final MemoryLayout.PathElement	PATH$dstImage
static final MemoryLayout.PathElement	PATH$dstImageLayout
static final MemoryLayout.PathElement	PATH$pNext
static final MemoryLayout.PathElement	PATH$pRegions
static final MemoryLayout.PathElement	PATH$regionCount
static final MemoryLayout.PathElement	PATH$srcImage
static final MemoryLayout.PathElement	PATH$srcImageLayout
static final MemoryLayout.PathElement	PATH$sType
static final long	SIZE$dstImage
static final long	SIZE$dstImageLayout
static final long	SIZE$pNext
static final long	SIZE$pRegions
static final long	SIZE$regionCount
static final long	SIZE$srcImage
static final long	SIZE$srcImageLayout
static final long	SIZE$sType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static VkCopyImageInfo2	allocate(Arena arena)
static VkCopyImageInfo2.Ptr	allocate(Arena arena, long count)
void	autoInit()
static VkCopyImageInfo2	clone(Arena arena, VkCopyImageInfo2 src)
@Nullable VkImage	dstImage()
VkCopyImageInfo2	dstImage(@Nullable VkImage value)
int	dstImageLayout()
VkCopyImageInfo2	dstImageLayout(int 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.
MemorySegment	pNext()
VkCopyImageInfo2	pNext(@Nullable IPointer pointer)
void	pNext(MemorySegment value)
@Nullable VkImageCopy2	pRegions()
VkImageCopy2.Ptr	pRegions(int assumedCount)
VkCopyImageInfo2	pRegions(@Nullable IVkImageCopy2 value)
MemorySegment	pRegionsRaw()
void	pRegionsRaw(MemorySegment value)
int	regionCount()
VkCopyImageInfo2	regionCount(int value)
@NotNull MemorySegment	segment()	Returns the value of the segment record component.
@Nullable VkImage	srcImage()
VkCopyImageInfo2	srcImage(@Nullable VkImage value)
int	srcImageLayout()
VkCopyImageInfo2	srcImageLayout(int value)
int	sType()
VkCopyImageInfo2	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$srcImage

public static final MemoryLayout.PathElement PATH$srcImage

PATH$srcImageLayout

public static final MemoryLayout.PathElement PATH$srcImageLayout

PATH$dstImage

public static final MemoryLayout.PathElement PATH$dstImage

PATH$dstImageLayout

public static final MemoryLayout.PathElement PATH$dstImageLayout

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$srcImage

public static final AddressLayout LAYOUT$srcImage

LAYOUT$srcImageLayout

public static final ValueLayout.OfInt LAYOUT$srcImageLayout

LAYOUT$dstImage

public static final AddressLayout LAYOUT$dstImage

LAYOUT$dstImageLayout

public static final ValueLayout.OfInt LAYOUT$dstImageLayout

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$srcImage

public static final long SIZE$srcImage

SIZE$srcImageLayout

public static final long SIZE$srcImageLayout

SIZE$dstImage

public static final long SIZE$dstImage

SIZE$dstImageLayout

public static final long SIZE$dstImageLayout

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$srcImage

public static final long OFFSET$srcImage

OFFSET$srcImageLayout

public static final long OFFSET$srcImageLayout

OFFSET$dstImage

public static final long OFFSET$dstImage

OFFSET$dstImageLayout

public static final long OFFSET$dstImageLayout

OFFSET$regionCount

public static final long OFFSET$regionCount

OFFSET$pRegions

public static final long OFFSET$pRegions

Constructor Details

VkCopyImageInfo2

public VkCopyImageInfo2(@NotNull
 @NotNull MemorySegment segment)

Creates an instance of a VkCopyImageInfo2 record class.

Parameters:

segment - the value for the segment record component

Method Details

allocate

public static VkCopyImageInfo2 allocate(Arena arena)

allocate

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

clone

public static VkCopyImageInfo2 clone(Arena arena,
 VkCopyImageInfo2 src)

autoInit

public void autoInit()

sType

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

sType

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

pNext

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

pNext

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

pNext

public VkCopyImageInfo2 pNext(@Nullable
 @Nullable IPointer pointer)

srcImage

@Nullable
public @Nullable VkImage srcImage()

srcImage

public VkCopyImageInfo2 srcImage(@Nullable
 @Nullable VkImage value)

srcImageLayout

@EnumType(VkImageLayout.class)
public int srcImageLayout()

srcImageLayout

public VkCopyImageInfo2 srcImageLayout(@EnumType(VkImageLayout.class)
 int value)

dstImage

@Nullable
public @Nullable VkImage dstImage()

dstImage

public VkCopyImageInfo2 dstImage(@Nullable
 @Nullable VkImage value)

dstImageLayout

@EnumType(VkImageLayout.class)
public int dstImageLayout()

dstImageLayout

public VkCopyImageInfo2 dstImageLayout(@EnumType(VkImageLayout.class)
 int value)

regionCount

@Unsigned
public int regionCount()

regionCount

public VkCopyImageInfo2 regionCount(@Unsigned
 int value)

pRegions

public VkCopyImageInfo2 pRegions(@Nullable
 @Nullable IVkImageCopy2 value)

pRegions

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

pRegions

@Nullable
public @Nullable VkImageCopy2 pRegions()

pRegionsRaw

@Pointer(target=VkImageCopy2.class)
public MemorySegment pRegionsRaw()

pRegionsRaw

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