Record Class VkPipelineDepthStencilStateCreateInfo

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

Represents a pointer to a VkPipelineDepthStencilStateCreateInfo structure in native memory.

Structure

typedef struct VkPipelineDepthStencilStateCreateInfo {
    VkStructureType sType;
    void const* pNext; // optional
    VkPipelineDepthStencilStateCreateFlags flags; // optional
    VkBool32 depthTestEnable;
    VkBool32 depthWriteEnable;
    VkCompareOp depthCompareOp;
    VkBool32 depthBoundsTestEnable;
    VkBool32 stencilTestEnable;
    VkStencilOpState front;
    VkStencilOpState back;
    float minDepthBounds;
    float maxDepthBounds;
} VkPipelineDepthStencilStateCreateInfo;

Auto initialization

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

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