Record Class VkImageToMemoryCopy

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

Represents a pointer to a VkImageToMemoryCopy structure in native memory.

Structure

typedef struct VkImageToMemoryCopy {
    VkStructureType sType;
    void const* pNext; // optional
    void* pHostPointer;
    uint32_t memoryRowLength;
    uint32_t memoryImageHeight;
    VkImageSubresourceLayers imageSubresource;
    VkOffset3D imageOffset;
    VkExtent3D imageExtent;
} VkImageToMemoryCopy;

Auto initialization

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

  • sType = VK_STRUCTURE_TYPE_IMAGE_TO_MEMORY_COPY

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:

  • 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$pHostPointer

      public static final MemoryLayout.PathElement PATH$pHostPointer

    • PATH$memoryRowLength

      public static final MemoryLayout.PathElement PATH$memoryRowLength

    • PATH$memoryImageHeight

      public static final MemoryLayout.PathElement PATH$memoryImageHeight

    • 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$pHostPointer

      public static final AddressLayout LAYOUT$pHostPointer

    • LAYOUT$memoryRowLength

      public static final ValueLayout.OfInt LAYOUT$memoryRowLength

    • LAYOUT$memoryImageHeight

      public static final ValueLayout.OfInt LAYOUT$memoryImageHeight

    • 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$pHostPointer

      public static final long SIZE$pHostPointer

    • SIZE$memoryRowLength

      public static final long SIZE$memoryRowLength

    • SIZE$memoryImageHeight

      public static final long SIZE$memoryImageHeight

    • 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$pHostPointer

      public static final long OFFSET$pHostPointer

    • OFFSET$memoryRowLength

      public static final long OFFSET$memoryRowLength

    • OFFSET$memoryImageHeight

      public static final long OFFSET$memoryImageHeight

    • 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

    • VkImageToMemoryCopy

      public VkImageToMemoryCopy(@NotNull @NotNull MemorySegment segment)
      Creates an instance of a VkImageToMemoryCopy record class.
      Parameters:
      segment - the value for the segment record component

  • Method Details