Record Class VkAttachmentDescription2

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

Represents a pointer to a VkAttachmentDescription2 structure in native memory.

Structure

typedef struct VkAttachmentDescription2 {
    VkStructureType sType;
    void const* pNext; // optional
    VkAttachmentDescriptionFlags flags; // optional
    VkFormat format;
    VkSampleCountFlags samples;
    VkAttachmentLoadOp loadOp;
    VkAttachmentStoreOp storeOp;
    VkAttachmentLoadOp stencilLoadOp;
    VkAttachmentStoreOp stencilStoreOp;
    VkImageLayout initialLayout;
    VkImageLayout finalLayout;
} VkAttachmentDescription2;

Auto initialization

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

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