Record Class VkCopyImageToMemoryInfo

java.lang.Object
java.lang.Record
club.doki7.vulkan.datatype.VkCopyImageToMemoryInfo
All Implemented Interfaces:
IPointer, IVkCopyImageToMemoryInfo
@ValueBasedCandidate @UnsafeConstructor public record VkCopyImageToMemoryInfo(@NotNull MemorySegment segment) extends Record implements IVkCopyImageToMemoryInfo

Represents a pointer to a VkCopyImageToMemoryInfo structure in native memory.

Structure

typedef struct VkCopyImageToMemoryInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkHostImageCopyFlags flags; // optional
    VkImage srcImage;
    VkImageLayout srcImageLayout;
    uint32_t regionCount;
    VkImageToMemoryCopy const* pRegions;
} VkCopyImageToMemoryInfo;

Auto initialization

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

  • sType = VK_STRUCTURE_TYPE_COPY_IMAGE_TO_MEMORY_INFO

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: