Record Class VkImageBlit2

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

Represents a pointer to a VkImageBlit2 structure in native memory.

Structure

typedef struct VkImageBlit2 {
    VkStructureType sType;
    void const* pNext; // optional
    VkImageSubresourceLayers srcSubresource;
    VkOffset3D[2] srcOffsets;
    VkImageSubresourceLayers dstSubresource;
    VkOffset3D[2] dstOffsets;
} VkImageBlit2;

Auto initialization

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

  • sType = VK_STRUCTURE_TYPE_IMAGE_BLIT_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$srcSubresource

      public static final MemoryLayout.PathElement PATH$srcSubresource

    • PATH$srcOffsets

      public static final MemoryLayout.PathElement PATH$srcOffsets

    • PATH$dstSubresource

      public static final MemoryLayout.PathElement PATH$dstSubresource

    • PATH$dstOffsets

      public static final MemoryLayout.PathElement PATH$dstOffsets

    • LAYOUT$sType

      public static final ValueLayout.OfInt LAYOUT$sType

    • LAYOUT$pNext

      public static final AddressLayout LAYOUT$pNext

    • LAYOUT$srcSubresource

      public static final StructLayout LAYOUT$srcSubresource

    • LAYOUT$srcOffsets

      public static final SequenceLayout LAYOUT$srcOffsets

    • LAYOUT$dstSubresource

      public static final StructLayout LAYOUT$dstSubresource

    • LAYOUT$dstOffsets

      public static final SequenceLayout LAYOUT$dstOffsets

    • SIZE$sType

      public static final long SIZE$sType

    • SIZE$pNext

      public static final long SIZE$pNext

    • SIZE$srcSubresource

      public static final long SIZE$srcSubresource

    • SIZE$srcOffsets

      public static final long SIZE$srcOffsets

    • SIZE$dstSubresource

      public static final long SIZE$dstSubresource

    • SIZE$dstOffsets

      public static final long SIZE$dstOffsets

    • OFFSET$sType

      public static final long OFFSET$sType

    • OFFSET$pNext

      public static final long OFFSET$pNext

    • OFFSET$srcSubresource

      public static final long OFFSET$srcSubresource

    • OFFSET$srcOffsets

      public static final long OFFSET$srcOffsets

    • OFFSET$dstSubresource

      public static final long OFFSET$dstSubresource

    • OFFSET$dstOffsets

      public static final long OFFSET$dstOffsets

  • Constructor Details

    • VkImageBlit2

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

  • Method Details