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:

  • 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