Record Class VkCopyBufferInfo2

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

Represents a pointer to a VkCopyBufferInfo2 structure in native memory.

Structure

typedef struct VkCopyBufferInfo2 {
    VkStructureType sType;
    void const* pNext; // optional
    VkBuffer srcBuffer;
    VkBuffer dstBuffer;
    uint32_t regionCount;
    VkBufferCopy2 const* pRegions;
} VkCopyBufferInfo2;

Auto initialization

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

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

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

      public static final MemoryLayout.PathElement PATH$srcBuffer

    • PATH$dstBuffer

      public static final MemoryLayout.PathElement PATH$dstBuffer

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

      public static final AddressLayout LAYOUT$srcBuffer

    • LAYOUT$dstBuffer

      public static final AddressLayout LAYOUT$dstBuffer

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

      public static final long SIZE$srcBuffer

    • SIZE$dstBuffer

      public static final long SIZE$dstBuffer

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

      public static final long OFFSET$srcBuffer

    • OFFSET$dstBuffer

      public static final long OFFSET$dstBuffer

    • OFFSET$regionCount

      public static final long OFFSET$regionCount

    • OFFSET$pRegions

      public static final long OFFSET$pRegions

  • Constructor Details

    • VkCopyBufferInfo2

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

  • Method Details