Record Class VkAttachmentDescriptionStencilLayout

java.lang.Object
java.lang.Record
club.doki7.vulkan.datatype.VkAttachmentDescriptionStencilLayout
All Implemented Interfaces:
IPointer, IVkAttachmentDescriptionStencilLayout

@ValueBasedCandidate @UnsafeConstructor public record VkAttachmentDescriptionStencilLayout(@NotNull MemorySegment segment) extends Record implements IVkAttachmentDescriptionStencilLayout

Represents a pointer to a VkAttachmentDescriptionStencilLayout structure in native memory.

Structure

typedef struct VkAttachmentDescriptionStencilLayout {
    VkStructureType sType;
    void* pNext; // optional
    VkImageLayout stencilInitialLayout;
    VkImageLayout stencilFinalLayout;
} VkAttachmentDescriptionStencilLayout;

Auto initialization

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

  • sType = VK_STRUCTURE_TYPE_ATTACHMENT_DESCRIPTION_STENCIL_LAYOUT

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: