Package org.lwjgl.vulkan
Class VkPipelineDepthStencilStateCreateInfo
- java.lang.Object
-
- org.lwjgl.system.Pointer.Default
-
- org.lwjgl.system.Struct
-
- org.lwjgl.vulkan.VkPipelineDepthStencilStateCreateInfo
-
- All Implemented Interfaces:
java.lang.AutoCloseable,org.lwjgl.system.NativeResource,org.lwjgl.system.Pointer
public class VkPipelineDepthStencilStateCreateInfo extends org.lwjgl.system.Struct implements org.lwjgl.system.NativeResourceStructure specifying parameters of a newly created pipeline depth stencil state.Valid Usage
- If the depth bounds testing feature is not enabled,
depthBoundsTestEnablemust beFALSE - If the
VK_KHR_portability_subsetextension is enabled, andVkPhysicalDevicePortabilitySubsetFeaturesKHR::separateStencilMaskRefisFALSE, and the value ofVkPipelineDepthStencilStateCreateInfo::stencilTestEnableisTRUE, and the value ofVkPipelineRasterizationStateCreateInfo::cullModeisCULL_MODE_NONE, the value ofreferencein each of theVkStencilOpStatestructs infrontandbackmust be the same - If the
rasterizationOrderDepthAttachmentAccessfeature is not enabled,flagsmust not includePIPELINE_DEPTH_STENCIL_STATE_CREATE_RASTERIZATION_ORDER_ATTACHMENT_DEPTH_ACCESS_BIT_ARM - If the
rasterizationOrderStencilAttachmentAccessfeature is not enabled,flagsmust not includePIPELINE_DEPTH_STENCIL_STATE_CREATE_RASTERIZATION_ORDER_ATTACHMENT_STENCIL_ACCESS_BIT_ARM
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFOpNextmust beNULLflagsmust be a valid combination ofVkPipelineDepthStencilStateCreateFlagBitsvaluesdepthCompareOpmust be a validVkCompareOpvaluefrontmust be a validVkStencilOpStatestructurebackmust be a validVkStencilOpStatestructure
See Also
VkGraphicsPipelineCreateInfo,VkStencilOpStateLayout
struct VkPipelineDepthStencilStateCreateInfo { VkStructureTypesType(); void const *pNext(); VkPipelineDepthStencilStateCreateFlagsflags(); VkBool32depthTestEnable(); VkBool32depthWriteEnable(); VkCompareOpdepthCompareOp(); VkBool32depthBoundsTestEnable(); VkBool32stencilTestEnable();VkStencilOpStatefront();VkStencilOpStateback(); floatminDepthBounds(); floatmaxDepthBounds(); }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classVkPipelineDepthStencilStateCreateInfo.BufferAn array ofVkPipelineDepthStencilStateCreateInfostructs.
-
Field Summary
Fields Modifier and Type Field Description static intALIGNOFThe struct alignment in bytes.static intBACK
DEPTHBOUNDSTESTENABLE
DEPTHCOMPAREOP
DEPTHTESTENABLE
DEPTHWRITEENABLE
FLAGS
FRONT
MAXDEPTHBOUNDS
MINDEPTHBOUNDS
PNEXTThe struct member offsets.static intSIZEOFThe struct size in bytes.static intSTENCILTESTENABLE
STYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkPipelineDepthStencilStateCreateInfo(java.nio.ByteBuffer container)Creates aVkPipelineDepthStencilStateCreateInfoinstance at the current position of the specifiedByteBuffercontainer.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description VkStencilOpStateback()seefrontVkPipelineDepthStencilStateCreateInfoback(java.util.function.Consumer<VkStencilOpState> consumer)Passes theback()field to the specifiedConsumer.VkPipelineDepthStencilStateCreateInfoback(VkStencilOpState value)Copies the specifiedVkStencilOpStateto theback()field.static VkPipelineDepthStencilStateCreateInfocalloc()Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated withmemCalloc.static VkPipelineDepthStencilStateCreateInfo.Buffercalloc(int capacity)Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated withmemCalloc.static VkPipelineDepthStencilStateCreateInfo.Buffercalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineDepthStencilStateCreateInfocalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineDepthStencilStateCreateInfocallocStack()Deprecated.static VkPipelineDepthStencilStateCreateInfo.BuffercallocStack(int capacity)Deprecated.static VkPipelineDepthStencilStateCreateInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkPipelineDepthStencilStateCreateInfocallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.static VkPipelineDepthStencilStateCreateInfocreate()Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated withBufferUtils.static VkPipelineDepthStencilStateCreateInfo.Buffercreate(int capacity)Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated withBufferUtils.static VkPipelineDepthStencilStateCreateInfocreate(long address)Returns a newVkPipelineDepthStencilStateCreateInfoinstance for the specified memory address.static VkPipelineDepthStencilStateCreateInfo.Buffercreate(long address, int capacity)Create aVkPipelineDepthStencilStateCreateInfo.Bufferinstance at the specified memory.static VkPipelineDepthStencilStateCreateInfocreateSafe(long address)static VkPipelineDepthStencilStateCreateInfo.BuffercreateSafe(long address, int capacity)booleandepthBoundsTestEnable()controls whether depth bounds testing is enabled.VkPipelineDepthStencilStateCreateInfodepthBoundsTestEnable(boolean value)Sets the specified value to thedepthBoundsTestEnable()field.intdepthCompareOp()the comparison operator used in the depth test.VkPipelineDepthStencilStateCreateInfodepthCompareOp(int value)Sets the specified value to thedepthCompareOp()field.booleandepthTestEnable()controls whether depth testing is enabled.VkPipelineDepthStencilStateCreateInfodepthTestEnable(boolean value)Sets the specified value to thedepthTestEnable()field.booleandepthWriteEnable()VkPipelineDepthStencilStateCreateInfodepthWriteEnable(boolean value)Sets the specified value to thedepthWriteEnable()field.intflags()a bitmask ofVkPipelineDepthStencilStateCreateFlagBitsspecifying additional depth/stencil state information.VkPipelineDepthStencilStateCreateInfoflags(int value)Sets the specified value to theflags()field.VkStencilOpStatefront()VkPipelineDepthStencilStateCreateInfofront(java.util.function.Consumer<VkStencilOpState> consumer)Passes thefront()field to the specifiedConsumer.VkPipelineDepthStencilStateCreateInfofront(VkStencilOpState value)Copies the specifiedVkStencilOpStateto thefront()field.static VkPipelineDepthStencilStateCreateInfomalloc()Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated withmemAlloc.static VkPipelineDepthStencilStateCreateInfo.Buffermalloc(int capacity)Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated withmemAlloc.static VkPipelineDepthStencilStateCreateInfo.Buffermalloc(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkPipelineDepthStencilStateCreateInfomalloc(org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated on the specifiedMemoryStack.static VkPipelineDepthStencilStateCreateInfomallocStack()Deprecated.static VkPipelineDepthStencilStateCreateInfo.BuffermallocStack(int capacity)Deprecated.static VkPipelineDepthStencilStateCreateInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Deprecated.static VkPipelineDepthStencilStateCreateInfomallocStack(org.lwjgl.system.MemoryStack stack)Deprecated.floatmaxDepthBounds()the maximum depth bound used in the depth bounds test.VkPipelineDepthStencilStateCreateInfomaxDepthBounds(float value)Sets the specified value to themaxDepthBounds()field.floatminDepthBounds()the minimum depth bound used in the depth bounds test.VkPipelineDepthStencilStateCreateInfominDepthBounds(float value)Sets the specified value to theminDepthBounds()field.static VkStencilOpStatenback(long struct)Unsafe version ofback().static voidnback(long struct, VkStencilOpState value)Unsafe version ofback.static intndepthBoundsTestEnable(long struct)Unsafe version ofdepthBoundsTestEnable().static voidndepthBoundsTestEnable(long struct, int value)Unsafe version ofdepthBoundsTestEnable.static intndepthCompareOp(long struct)Unsafe version ofdepthCompareOp().static voidndepthCompareOp(long struct, int value)Unsafe version ofdepthCompareOp.static intndepthTestEnable(long struct)Unsafe version ofdepthTestEnable().static voidndepthTestEnable(long struct, int value)Unsafe version ofdepthTestEnable.static intndepthWriteEnable(long struct)Unsafe version ofdepthWriteEnable().static voidndepthWriteEnable(long struct, int value)Unsafe version ofdepthWriteEnable.static intnflags(long struct)Unsafe version offlags().static voidnflags(long struct, int value)Unsafe version offlags.static VkStencilOpStatenfront(long struct)Unsafe version offront().static voidnfront(long struct, VkStencilOpState value)Unsafe version offront.static floatnmaxDepthBounds(long struct)Unsafe version ofmaxDepthBounds().static voidnmaxDepthBounds(long struct, float value)Unsafe version ofmaxDepthBounds.static floatnminDepthBounds(long struct)Unsafe version ofminDepthBounds().static voidnminDepthBounds(long struct, float value)Unsafe version ofminDepthBounds.static longnpNext(long struct)Unsafe version ofpNext().static voidnpNext(long struct, long value)Unsafe version ofpNext.static intnstencilTestEnable(long struct)Unsafe version ofstencilTestEnable().static voidnstencilTestEnable(long struct, int value)Unsafe version ofstencilTestEnable.static intnsType(long struct)Unsafe version ofsType().static voidnsType(long struct, int value)Unsafe version ofsType.longpNext()NULLor a pointer to a structure extending this structure.VkPipelineDepthStencilStateCreateInfopNext(long value)Sets the specified value to thepNext()field.VkPipelineDepthStencilStateCreateInfoset(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.VkPipelineDepthStencilStateCreateInfoset(VkPipelineDepthStencilStateCreateInfo src)Copies the specified struct data to this struct.intsizeof()booleanstencilTestEnable()controls whether stencil testing is enabled.VkPipelineDepthStencilStateCreateInfostencilTestEnable(boolean value)Sets the specified value to thestencilTestEnable()field.intsType()the type of this structure.VkPipelineDepthStencilStateCreateInfosType(int value)Sets the specified value to thesType()field.VkPipelineDepthStencilStateCreateInfosType$Default()Sets theSTRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFOvalue to thesType()field.
-
-
-
Constructor Detail
-
VkPipelineDepthStencilStateCreateInfo
public VkPipelineDepthStencilStateCreateInfo(java.nio.ByteBuffer container)
Creates aVkPipelineDepthStencilStateCreateInfoinstance at the current position of the specifiedByteBuffercontainer. Changes to the buffer's content will be visible to the struct instance and vice versa.The created instance holds a strong reference to the container object.
-
-
Method Detail
-
sizeof
public int sizeof()
- Specified by:
sizeofin classorg.lwjgl.system.Struct
-
sType
public int sType()
the type of this structure.
-
pNext
public long pNext()
NULLor a pointer to a structure extending this structure.
-
flags
public int flags()
a bitmask ofVkPipelineDepthStencilStateCreateFlagBitsspecifying additional depth/stencil state information.
-
depthTestEnable
public boolean depthTestEnable()
controls whether depth testing is enabled.
-
depthWriteEnable
public boolean depthWriteEnable()
controls whether depth writes are enabled whendepthTestEnableisTRUE. Depth writes are always disabled whendepthTestEnableisFALSE.
-
depthCompareOp
public int depthCompareOp()
the comparison operator used in the depth test.
-
depthBoundsTestEnable
public boolean depthBoundsTestEnable()
controls whether depth bounds testing is enabled.
-
stencilTestEnable
public boolean stencilTestEnable()
controls whether stencil testing is enabled.
-
front
public VkStencilOpState front()
-
back
public VkStencilOpState back()
seefront
-
minDepthBounds
public float minDepthBounds()
the minimum depth bound used in the depth bounds test.
-
maxDepthBounds
public float maxDepthBounds()
the maximum depth bound used in the depth bounds test.
-
sType
public VkPipelineDepthStencilStateCreateInfo sType(int value)
Sets the specified value to thesType()field.
-
sType$Default
public VkPipelineDepthStencilStateCreateInfo sType$Default()
Sets theSTRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFOvalue to thesType()field.
-
pNext
public VkPipelineDepthStencilStateCreateInfo pNext(long value)
Sets the specified value to thepNext()field.
-
flags
public VkPipelineDepthStencilStateCreateInfo flags(int value)
Sets the specified value to theflags()field.
-
depthTestEnable
public VkPipelineDepthStencilStateCreateInfo depthTestEnable(boolean value)
Sets the specified value to thedepthTestEnable()field.
-
depthWriteEnable
public VkPipelineDepthStencilStateCreateInfo depthWriteEnable(boolean value)
Sets the specified value to thedepthWriteEnable()field.
-
depthCompareOp
public VkPipelineDepthStencilStateCreateInfo depthCompareOp(int value)
Sets the specified value to thedepthCompareOp()field.
-
depthBoundsTestEnable
public VkPipelineDepthStencilStateCreateInfo depthBoundsTestEnable(boolean value)
Sets the specified value to thedepthBoundsTestEnable()field.
-
stencilTestEnable
public VkPipelineDepthStencilStateCreateInfo stencilTestEnable(boolean value)
Sets the specified value to thestencilTestEnable()field.
-
front
public VkPipelineDepthStencilStateCreateInfo front(VkStencilOpState value)
Copies the specifiedVkStencilOpStateto thefront()field.
-
front
public VkPipelineDepthStencilStateCreateInfo front(java.util.function.Consumer<VkStencilOpState> consumer)
Passes thefront()field to the specifiedConsumer.
-
back
public VkPipelineDepthStencilStateCreateInfo back(VkStencilOpState value)
Copies the specifiedVkStencilOpStateto theback()field.
-
back
public VkPipelineDepthStencilStateCreateInfo back(java.util.function.Consumer<VkStencilOpState> consumer)
Passes theback()field to the specifiedConsumer.
-
minDepthBounds
public VkPipelineDepthStencilStateCreateInfo minDepthBounds(float value)
Sets the specified value to theminDepthBounds()field.
-
maxDepthBounds
public VkPipelineDepthStencilStateCreateInfo maxDepthBounds(float value)
Sets the specified value to themaxDepthBounds()field.
-
set
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.
-
set
public VkPipelineDepthStencilStateCreateInfo set(VkPipelineDepthStencilStateCreateInfo src)
Copies the specified struct data to this struct.- Parameters:
src- the source struct- Returns:
- this struct
-
malloc
public static VkPipelineDepthStencilStateCreateInfo malloc()
Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated withmemAlloc. The instance must be explicitly freed.
-
calloc
public static VkPipelineDepthStencilStateCreateInfo calloc()
Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated withmemCalloc. The instance must be explicitly freed.
-
create
public static VkPipelineDepthStencilStateCreateInfo create()
Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated withBufferUtils.
-
create
public static VkPipelineDepthStencilStateCreateInfo create(long address)
Returns a newVkPipelineDepthStencilStateCreateInfoinstance for the specified memory address.
-
createSafe
@Nullable public static VkPipelineDepthStencilStateCreateInfo createSafe(long address)
-
malloc
public static VkPipelineDepthStencilStateCreateInfo.Buffer malloc(int capacity)
Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated withmemAlloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
calloc
public static VkPipelineDepthStencilStateCreateInfo.Buffer calloc(int capacity)
Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated withmemCalloc. The instance must be explicitly freed.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineDepthStencilStateCreateInfo.Buffer create(int capacity)
Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated withBufferUtils.- Parameters:
capacity- the buffer capacity
-
create
public static VkPipelineDepthStencilStateCreateInfo.Buffer create(long address, int capacity)
Create aVkPipelineDepthStencilStateCreateInfo.Bufferinstance at the specified memory.- Parameters:
address- the memory addresscapacity- the buffer capacity
-
createSafe
@Nullable public static VkPipelineDepthStencilStateCreateInfo.Buffer createSafe(long address, int capacity)
-
mallocStack
@Deprecated public static VkPipelineDepthStencilStateCreateInfo mallocStack()
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkPipelineDepthStencilStateCreateInfo callocStack()
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkPipelineDepthStencilStateCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)instead.
-
callocStack
@Deprecated public static VkPipelineDepthStencilStateCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)instead.
-
mallocStack
@Deprecated public static VkPipelineDepthStencilStateCreateInfo.Buffer mallocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkPipelineDepthStencilStateCreateInfo.Buffer callocStack(int capacity)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
mallocStack
@Deprecated public static VkPipelineDepthStencilStateCreateInfo.Buffer mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)instead.
-
callocStack
@Deprecated public static VkPipelineDepthStencilStateCreateInfo.Buffer callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)instead.
-
malloc
public static VkPipelineDepthStencilStateCreateInfo malloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
calloc
public static VkPipelineDepthStencilStateCreateInfo calloc(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocate
-
malloc
public static VkPipelineDepthStencilStateCreateInfo.Buffer malloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
calloc
public static VkPipelineDepthStencilStateCreateInfo.Buffer calloc(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.- Parameters:
stack- the stack from which to allocatecapacity- the buffer capacity
-
nsType
public static int nsType(long struct)
Unsafe version ofsType().
-
npNext
public static long npNext(long struct)
Unsafe version ofpNext().
-
nflags
public static int nflags(long struct)
Unsafe version offlags().
-
ndepthTestEnable
public static int ndepthTestEnable(long struct)
Unsafe version ofdepthTestEnable().
-
ndepthWriteEnable
public static int ndepthWriteEnable(long struct)
Unsafe version ofdepthWriteEnable().
-
ndepthCompareOp
public static int ndepthCompareOp(long struct)
Unsafe version ofdepthCompareOp().
-
ndepthBoundsTestEnable
public static int ndepthBoundsTestEnable(long struct)
Unsafe version ofdepthBoundsTestEnable().
-
nstencilTestEnable
public static int nstencilTestEnable(long struct)
Unsafe version ofstencilTestEnable().
-
nfront
public static VkStencilOpState nfront(long struct)
Unsafe version offront().
-
nback
public static VkStencilOpState nback(long struct)
Unsafe version ofback().
-
nminDepthBounds
public static float nminDepthBounds(long struct)
Unsafe version ofminDepthBounds().
-
nmaxDepthBounds
public static float nmaxDepthBounds(long struct)
Unsafe version ofmaxDepthBounds().
-
nsType
public static void nsType(long struct, int value)Unsafe version ofsType.
-
npNext
public static void npNext(long struct, long value)Unsafe version ofpNext.
-
nflags
public static void nflags(long struct, int value)Unsafe version offlags.
-
ndepthTestEnable
public static void ndepthTestEnable(long struct, int value)Unsafe version ofdepthTestEnable.
-
ndepthWriteEnable
public static void ndepthWriteEnable(long struct, int value)Unsafe version ofdepthWriteEnable.
-
ndepthCompareOp
public static void ndepthCompareOp(long struct, int value)Unsafe version ofdepthCompareOp.
-
ndepthBoundsTestEnable
public static void ndepthBoundsTestEnable(long struct, int value)Unsafe version ofdepthBoundsTestEnable.
-
nstencilTestEnable
public static void nstencilTestEnable(long struct, int value)Unsafe version ofstencilTestEnable.
-
nfront
public static void nfront(long struct, VkStencilOpState value)Unsafe version offront.
-
nback
public static void nback(long struct, VkStencilOpState value)Unsafe version ofback.
-
nminDepthBounds
public static void nminDepthBounds(long struct, float value)Unsafe version ofminDepthBounds.
-
nmaxDepthBounds
public static void nmaxDepthBounds(long struct, float value)Unsafe version ofmaxDepthBounds.
-
-