Record Class VkRenderingInfo

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

Represents a pointer to a VkRenderingInfo structure in native memory.

Structure

typedef struct VkRenderingInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkRenderingFlags flags; // optional
    VkRect2D renderArea;
    uint32_t layerCount;
    uint32_t viewMask;
    uint32_t colorAttachmentCount; // optional
    VkRenderingAttachmentInfo const* pColorAttachments;
    VkRenderingAttachmentInfo const* pDepthAttachment; // optional
    VkRenderingAttachmentInfo const* pStencilAttachment; // optional
} VkRenderingInfo;

Auto initialization

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

  • sType = VK_STRUCTURE_TYPE_RENDERING_INFO

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: