Record Class VkImageMemoryBarrier

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

Represents a pointer to a VkImageMemoryBarrier structure in native memory.

Structure

typedef struct VkImageMemoryBarrier {
    VkStructureType sType;
    void const* pNext; // optional
    VkAccessFlags srcAccessMask;
    VkAccessFlags dstAccessMask;
    VkImageLayout oldLayout;
    VkImageLayout newLayout;
    uint32_t srcQueueFamilyIndex;
    uint32_t dstQueueFamilyIndex;
    VkImage image;
    VkImageSubresourceRange subresourceRange;
} VkImageMemoryBarrier;

Auto initialization

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

  • sType = VK_STRUCTURE_TYPE_IMAGE_MEMORY_BARRIER

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$srcAccessMask

      public static final MemoryLayout.PathElement PATH$srcAccessMask

    • PATH$dstAccessMask

      public static final MemoryLayout.PathElement PATH$dstAccessMask

    • PATH$oldLayout

      public static final MemoryLayout.PathElement PATH$oldLayout

    • PATH$newLayout

      public static final MemoryLayout.PathElement PATH$newLayout

    • PATH$srcQueueFamilyIndex

      public static final MemoryLayout.PathElement PATH$srcQueueFamilyIndex

    • PATH$dstQueueFamilyIndex

      public static final MemoryLayout.PathElement PATH$dstQueueFamilyIndex

    • PATH$image

      public static final MemoryLayout.PathElement PATH$image

    • PATH$subresourceRange

      public static final MemoryLayout.PathElement PATH$subresourceRange

    • LAYOUT$sType

      public static final ValueLayout.OfInt LAYOUT$sType

    • LAYOUT$pNext

      public static final AddressLayout LAYOUT$pNext

    • LAYOUT$srcAccessMask

      public static final ValueLayout.OfInt LAYOUT$srcAccessMask

    • LAYOUT$dstAccessMask

      public static final ValueLayout.OfInt LAYOUT$dstAccessMask

    • LAYOUT$oldLayout

      public static final ValueLayout.OfInt LAYOUT$oldLayout

    • LAYOUT$newLayout

      public static final ValueLayout.OfInt LAYOUT$newLayout

    • LAYOUT$srcQueueFamilyIndex

      public static final ValueLayout.OfInt LAYOUT$srcQueueFamilyIndex

    • LAYOUT$dstQueueFamilyIndex

      public static final ValueLayout.OfInt LAYOUT$dstQueueFamilyIndex

    • LAYOUT$image

      public static final AddressLayout LAYOUT$image

    • LAYOUT$subresourceRange

      public static final StructLayout LAYOUT$subresourceRange

    • SIZE$sType

      public static final long SIZE$sType

    • SIZE$pNext

      public static final long SIZE$pNext

    • SIZE$srcAccessMask

      public static final long SIZE$srcAccessMask

    • SIZE$dstAccessMask

      public static final long SIZE$dstAccessMask

    • SIZE$oldLayout

      public static final long SIZE$oldLayout

    • SIZE$newLayout

      public static final long SIZE$newLayout

    • SIZE$srcQueueFamilyIndex

      public static final long SIZE$srcQueueFamilyIndex

    • SIZE$dstQueueFamilyIndex

      public static final long SIZE$dstQueueFamilyIndex

    • SIZE$image

      public static final long SIZE$image

    • SIZE$subresourceRange

      public static final long SIZE$subresourceRange

    • OFFSET$sType

      public static final long OFFSET$sType

    • OFFSET$pNext

      public static final long OFFSET$pNext

    • OFFSET$srcAccessMask

      public static final long OFFSET$srcAccessMask

    • OFFSET$dstAccessMask

      public static final long OFFSET$dstAccessMask

    • OFFSET$oldLayout

      public static final long OFFSET$oldLayout

    • OFFSET$newLayout

      public static final long OFFSET$newLayout

    • OFFSET$srcQueueFamilyIndex

      public static final long OFFSET$srcQueueFamilyIndex

    • OFFSET$dstQueueFamilyIndex

      public static final long OFFSET$dstQueueFamilyIndex

    • OFFSET$image

      public static final long OFFSET$image

    • OFFSET$subresourceRange

      public static final long OFFSET$subresourceRange

  • Constructor Details

    • VkImageMemoryBarrier

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

  • Method Details