LWJGL 3.3.3 · org.lwjgl.vulkan.VkPipelineDepthStencilStateCreateInfo

Structure specifying parameters of a newly created pipeline depth stencil state.

Valid Usage

If the depthBounds feature is not enabled, depthBoundsTestEnable must be FALSE
If the VK_KHR_portability_subset extension is enabled, and VkPhysicalDevicePortabilitySubsetFeaturesKHR::separateStencilMaskRef is FALSE, and the value of VkPipelineDepthStencilStateCreateInfo::stencilTestEnable is TRUE, and the value of VkPipelineRasterizationStateCreateInfo::cullMode is CULL_MODE_NONE, the value of reference in each of the VkStencilOpState structs in front and back must be the same
If the rasterizationOrderDepthAttachmentAccess feature is not enabled, flags must not include PIPELINE_DEPTH_STENCIL_STATE_CREATE_RASTERIZATION_ORDER_ATTACHMENT_DEPTH_ACCESS_BIT_EXT
If the rasterizationOrderStencilAttachmentAccess feature is not enabled, flags must not include PIPELINE_DEPTH_STENCIL_STATE_CREATE_RASTERIZATION_ORDER_ATTACHMENT_STENCIL_ACCESS_BIT_EXT

Valid Usage (Implicit)

sType must be STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO
pNext must be NULL
flags must be a valid combination of VkPipelineDepthStencilStateCreateFlagBits values
depthCompareOp must be a valid VkCompareOp value
front must be a valid VkStencilOpState structure
back must be a valid VkStencilOpState structure

Layout


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

Modifier and Type	Class and Description
public static class	VkPipelineDepthStencilStateCreateInfo.Buffer An array of `VkPipelineDepthStencilStateCreateInfo` structs.

Modifier and Type	Field and Description
public static final int	ALIGNOF The struct alignment in bytes.
public static final int	BACK The struct member offsets.
public static final int	DEPTHBOUNDSTESTENABLE The struct member offsets.
public static final int	DEPTHCOMPAREOP The struct member offsets.
public static final int	DEPTHTESTENABLE The struct member offsets.
public static final int	DEPTHWRITEENABLE The struct member offsets.
public static final int	FLAGS The struct member offsets.
public static final int	FRONT The struct member offsets.
public static final int	MAXDEPTHBOUNDS The struct member offsets.
public static final int	MINDEPTHBOUNDS The struct member offsets.
public static final int	PNEXT The struct member offsets.
public static final int	SIZEOF The struct size in bytes.
public static final int	STENCILTESTENABLE The struct member offsets.
public static final int	STYPE The struct member offsets.

Access	Constructor and Description
protected	VkPipelineDepthStencilStateCreateInfo(long address, ByteBuffer container)
public	VkPipelineDepthStencilStateCreateInfo(ByteBuffer container) Creates a `VkPipelineDepthStencilStateCreateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

Modifier and Type	Method and Description
public VkStencilOpState	back() see `front`
public VkPipelineDepthStencilStateCreateInfo	back(VkStencilOpState value) Copies the specified `VkStencilOpState` to the `back` field.
public VkPipelineDepthStencilStateCreateInfo	back(Consumer<VkStencilOpState> consumer) Passes the `back` field to the specified `Consumer`.
public static VkPipelineDepthStencilStateCreateInfo	calloc() Returns a new `VkPipelineDepthStencilStateCreateInfo` instance allocated with `memCalloc`.
public static VkPipelineDepthStencilStateCreateInfo.Buffer	calloc(int the buffer capacity capacity) Returns a new `VkPipelineDepthStencilStateCreateInfo.Buffer` instance allocated with `memCalloc`.
public static VkPipelineDepthStencilStateCreateInfo	calloc(MemoryStack the stack from which to allocate stack) Returns a new `VkPipelineDepthStencilStateCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkPipelineDepthStencilStateCreateInfo.Buffer	calloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkPipelineDepthStencilStateCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
public static VkPipelineDepthStencilStateCreateInfo	callocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineDepthStencilStateCreateInfo	callocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineDepthStencilStateCreateInfo.Buffer	callocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineDepthStencilStateCreateInfo.Buffer	callocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
protected VkPipelineDepthStencilStateCreateInfo	create(long the struct memory address address, ByteBuffer an optional container buffer, to be referenced strongly by the struct instance. container) Implements abstract org.lwjgl.system.Struct.create. Similar to `the constructor`, but returns the exact type of the `Struct` subclass.
public static VkPipelineDepthStencilStateCreateInfo	create() Returns a new `VkPipelineDepthStencilStateCreateInfo` instance allocated with `BufferUtils`.
public static VkPipelineDepthStencilStateCreateInfo	create(long address) Returns a new `VkPipelineDepthStencilStateCreateInfo` instance for the specified memory address.
public static VkPipelineDepthStencilStateCreateInfo.Buffer	create(int the buffer capacity capacity) Returns a new `VkPipelineDepthStencilStateCreateInfo.Buffer` instance allocated with `BufferUtils`.
public static VkPipelineDepthStencilStateCreateInfo.Buffer	create(long the memory address address, int the buffer capacity capacity) Create a `VkPipelineDepthStencilStateCreateInfo.Buffer` instance at the specified memory.
public static VkPipelineDepthStencilStateCreateInfo	createSafe(long address) Like `create`, but returns `null` if `address` is `NULL`.
public static VkPipelineDepthStencilStateCreateInfo.Buffer	createSafe(long address, int capacity) Like `create`, but returns `null` if `address` is `NULL`.
public boolean	depthBoundsTestEnable() controls whether depth bounds testing is enabled.
public VkPipelineDepthStencilStateCreateInfo	depthBoundsTestEnable(boolean value) Sets the specified value to the `depthBoundsTestEnable` field.
public int	depthCompareOp() a `VkCompareOp` value specifying the comparison operator to use in the Depth Comparison step of the depth test.
public VkPipelineDepthStencilStateCreateInfo	depthCompareOp(int value) Sets the specified value to the `depthCompareOp` field.
public boolean	depthTestEnable() controls whether depth testing is enabled.
public VkPipelineDepthStencilStateCreateInfo	depthTestEnable(boolean value) Sets the specified value to the `depthTestEnable` field.
public boolean	depthWriteEnable() controls whether depth writes are enabled when `depthTestEnable` is `TRUE`.
public VkPipelineDepthStencilStateCreateInfo	depthWriteEnable(boolean value) Sets the specified value to the `depthWriteEnable` field.
public int	flags() a bitmask of `VkPipelineDepthStencilStateCreateFlagBits` specifying additional depth/stencil state information.
public VkPipelineDepthStencilStateCreateInfo	flags(int value) Sets the specified value to the `flags` field.
public VkStencilOpState	front() `front` and `back` are `VkStencilOpState` values controlling the corresponding parameters of the stencil test.
public VkPipelineDepthStencilStateCreateInfo	front(VkStencilOpState value) Copies the specified `VkStencilOpState` to the `front` field.
public VkPipelineDepthStencilStateCreateInfo	front(Consumer<VkStencilOpState> consumer) Passes the `front` field to the specified `Consumer`.
public static VkPipelineDepthStencilStateCreateInfo	malloc() Returns a new `VkPipelineDepthStencilStateCreateInfo` instance allocated with `memAlloc`.
public static VkPipelineDepthStencilStateCreateInfo.Buffer	malloc(int the buffer capacity capacity) Returns a new `VkPipelineDepthStencilStateCreateInfo.Buffer` instance allocated with `memAlloc`.
public static VkPipelineDepthStencilStateCreateInfo	malloc(MemoryStack the stack from which to allocate stack) Returns a new `VkPipelineDepthStencilStateCreateInfo` instance allocated on the specified `MemoryStack`.
public static VkPipelineDepthStencilStateCreateInfo.Buffer	malloc(int the buffer capacity capacity, MemoryStack the stack from which to allocate stack) Returns a new `VkPipelineDepthStencilStateCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
public static VkPipelineDepthStencilStateCreateInfo	mallocStack() Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineDepthStencilStateCreateInfo	mallocStack(MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineDepthStencilStateCreateInfo.Buffer	mallocStack(int capacity) Deprecated Deprecated for removal in 3.4.0.
public static VkPipelineDepthStencilStateCreateInfo.Buffer	mallocStack(int capacity, MemoryStack stack) Deprecated Deprecated for removal in 3.4.0.
public float	maxDepthBounds() the maximum depth bound used in the depth bounds test.
public VkPipelineDepthStencilStateCreateInfo	maxDepthBounds(float value) Sets the specified value to the `maxDepthBounds` field.
public float	minDepthBounds() the minimum depth bound used in the depth bounds test.
public VkPipelineDepthStencilStateCreateInfo	minDepthBounds(float value) Sets the specified value to the `minDepthBounds` field.
public static VkStencilOpState	nback(long struct) Unsafe version of `back`.
public static void	nback(long struct, VkStencilOpState value) Unsafe version of `back`.
public static int	ndepthBoundsTestEnable(long struct) Unsafe version of `depthBoundsTestEnable`.
public static void	ndepthBoundsTestEnable(long struct, int value) Unsafe version of `depthBoundsTestEnable`.
public static int	ndepthCompareOp(long struct) Unsafe version of `depthCompareOp`.
public static void	ndepthCompareOp(long struct, int value) Unsafe version of `depthCompareOp`.
public static int	ndepthTestEnable(long struct) Unsafe version of `depthTestEnable`.
public static void	ndepthTestEnable(long struct, int value) Unsafe version of `depthTestEnable`.
public static int	ndepthWriteEnable(long struct) Unsafe version of `depthWriteEnable`.
public static void	ndepthWriteEnable(long struct, int value) Unsafe version of `depthWriteEnable`.
public static int	nflags(long struct) Unsafe version of `flags`.
public static void	nflags(long struct, int value) Unsafe version of `flags`.
public static VkStencilOpState	nfront(long struct) Unsafe version of `front`.
public static void	nfront(long struct, VkStencilOpState value) Unsafe version of `front`.
public static float	nmaxDepthBounds(long struct) Unsafe version of `maxDepthBounds`.
public static void	nmaxDepthBounds(long struct, float value) Unsafe version of `maxDepthBounds`.
public static float	nminDepthBounds(long struct) Unsafe version of `minDepthBounds`.
public static void	nminDepthBounds(long struct, float value) Unsafe version of `minDepthBounds`.
public static long	npNext(long struct) Unsafe version of `pNext`.
public static void	npNext(long struct, long value) Unsafe version of `pNext`.
public static int	nstencilTestEnable(long struct) Unsafe version of `stencilTestEnable`.
public static void	nstencilTestEnable(long struct, int value) Unsafe version of `stencilTestEnable`.
public static int	nsType(long struct) Unsafe version of `sType`.
public static void	nsType(long struct, int value) Unsafe version of `sType`.
public long	pNext() `NULL` or a pointer to a structure extending this structure.
public VkPipelineDepthStencilStateCreateInfo	pNext(long value) Sets the specified value to the `pNext` field.
public VkPipelineDepthStencilStateCreateInfo	set(int sType, long pNext, int flags, boolean depthTestEnable, boolean depthWriteEnable, int depthCompareOp, boolean depthBoundsTestEnable, boolean stencilTestEnable, VkStencilOpState front, VkStencilOpState back, float minDepthBounds, float maxDepthBounds) Initializes this struct with the specified values.
public VkPipelineDepthStencilStateCreateInfo	Returns: this struct set(VkPipelineDepthStencilStateCreateInfo the source struct src) Copies the specified struct data to this struct.
public int	sizeof() Implements abstract org.lwjgl.system.Struct.sizeof. Returns `sizeof(struct)`.
public boolean	stencilTestEnable() controls whether stencil testing is enabled.
public VkPipelineDepthStencilStateCreateInfo	stencilTestEnable(boolean value) Sets the specified value to the `stencilTestEnable` field.
public int	sType() a `VkStructureType` value identifying this structure.
public VkPipelineDepthStencilStateCreateInfo	sType(int value) Sets the specified value to the `sType` field.
public VkPipelineDepthStencilStateCreateInfo	sType$Default() Sets the `STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO` value to the `sType` field.

public Class VkPipelineDepthStencilStateCreateInfo

Valid Usage

Valid Usage (Implicit)

See Also

Layout

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary