Package org.lwjgl.vulkan
Class VkPipelineDepthStencilStateCreateInfo
java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkPipelineDepthStencilStateCreateInfo>
org.lwjgl.vulkan.VkPipelineDepthStencilStateCreateInfo
- All Implemented Interfaces:
AutoCloseable
,NativeResource
,Pointer
public class VkPipelineDepthStencilStateCreateInfo
extends Struct<VkPipelineDepthStencilStateCreateInfo>
implements NativeResource
Structure specifying parameters of a newly created pipeline depth stencil state.
Valid Usage
- If the
depthBounds
feature is not enabled,depthBoundsTestEnable
must beFALSE
- If the
VK_KHR_portability_subset
extension is enabled, andVkPhysicalDevicePortabilitySubsetFeaturesKHR
::separateStencilMaskRef
isFALSE
, and the value ofVkPipelineDepthStencilStateCreateInfo
::stencilTestEnable
isTRUE
, and the value ofVkPipelineRasterizationStateCreateInfo
::cullMode
isCULL_MODE_NONE
, the value ofreference
in each of theVkStencilOpState
structs infront
andback
must be the same - If the
rasterizationOrderDepthAttachmentAccess
feature is not enabled,flags
must not includePIPELINE_DEPTH_STENCIL_STATE_CREATE_RASTERIZATION_ORDER_ATTACHMENT_DEPTH_ACCESS_BIT_EXT
- If the
rasterizationOrderStencilAttachmentAccess
feature is not enabled,flags
must not includePIPELINE_DEPTH_STENCIL_STATE_CREATE_RASTERIZATION_ORDER_ATTACHMENT_STENCIL_ACCESS_BIT_EXT
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO
pNext
must beNULL
flags
must be a valid combination ofVkPipelineDepthStencilStateCreateFlagBits
valuesdepthCompareOp
must be a validVkCompareOp
valuefront
must be a validVkStencilOpState
structureback
must be a validVkStencilOpState
structure
See Also
VkGraphicsPipelineCreateInfo
, VkStencilOpState
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()
;
}
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
An array ofVkPipelineDepthStencilStateCreateInfo
structs.Nested classes/interfaces inherited from class org.lwjgl.system.Struct
Struct.StructValidation
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
The struct alignment in bytes.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct member offsets.static final int
The struct size in bytes.static final int
The struct member offsets.static final int
The struct member offsets.Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, POINTER_SHIFT, POINTER_SIZE
-
Constructor Summary
ConstructorDescriptionVkPipelineDepthStencilStateCreateInfo
(ByteBuffer container) Creates aVkPipelineDepthStencilStateCreateInfo
instance at the current position of the specifiedByteBuffer
container. -
Method Summary
Modifier and TypeMethodDescriptionback()
seefront
back
(Consumer<VkStencilOpState> consumer) back
(VkStencilOpState value) Copies the specifiedVkStencilOpState
to theback()
field.calloc()
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated withmemCalloc
.calloc
(int capacity) Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated withmemCalloc
.calloc
(int capacity, MemoryStack stack) Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.calloc
(MemoryStack stack) Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.Deprecated.callocStack
(int capacity) Deprecated.callocStack
(int capacity, MemoryStack stack) Deprecated.callocStack
(MemoryStack stack) Deprecated.create()
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated withBufferUtils
.create
(int capacity) Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated withBufferUtils
.create
(long address) Returns a newVkPipelineDepthStencilStateCreateInfo
instance for the specified memory address.create
(long address, int capacity) Create aVkPipelineDepthStencilStateCreateInfo.Buffer
instance at the specified memory.createSafe
(long address) createSafe
(long address, int capacity) boolean
controls whether depth bounds testing is enabled.depthBoundsTestEnable
(boolean value) Sets the specified value to thedepthBoundsTestEnable()
field.int
aVkCompareOp
value specifying the comparison operator to use in the Depth Comparison step of the depth test.depthCompareOp
(int value) Sets the specified value to thedepthCompareOp()
field.boolean
controls whether depth testing is enabled.depthTestEnable
(boolean value) Sets the specified value to thedepthTestEnable()
field.boolean
depthWriteEnable
(boolean value) Sets the specified value to thedepthWriteEnable()
field.int
flags()
a bitmask ofVkPipelineDepthStencilStateCreateFlagBits
specifying additional depth/stencil state information.flags
(int value) Sets the specified value to theflags()
field.front()
front
andback
areVkStencilOpState
values controlling the corresponding parameters of the stencil test.front
(Consumer<VkStencilOpState> consumer) front
(VkStencilOpState value) Copies the specifiedVkStencilOpState
to thefront()
field.malloc()
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated withmemAlloc
.malloc
(int capacity) Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated withmemAlloc
.malloc
(int capacity, MemoryStack stack) Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.malloc
(MemoryStack stack) Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated on the specifiedMemoryStack
.Deprecated.mallocStack
(int capacity) Deprecated.mallocStack
(int capacity, MemoryStack stack) Deprecated.mallocStack
(MemoryStack stack) Deprecated.float
the maximum depth bound used in the depth bounds test.maxDepthBounds
(float value) Sets the specified value to themaxDepthBounds()
field.float
the minimum depth bound used in the depth bounds test.minDepthBounds
(float value) Sets the specified value to theminDepthBounds()
field.static VkStencilOpState
nback
(long struct) Unsafe version ofback()
.static void
nback
(long struct, VkStencilOpState value) Unsafe version ofback
.static int
ndepthBoundsTestEnable
(long struct) Unsafe version ofdepthBoundsTestEnable()
.static void
ndepthBoundsTestEnable
(long struct, int value) Unsafe version ofdepthBoundsTestEnable
.static int
ndepthCompareOp
(long struct) Unsafe version ofdepthCompareOp()
.static void
ndepthCompareOp
(long struct, int value) Unsafe version ofdepthCompareOp
.static int
ndepthTestEnable
(long struct) Unsafe version ofdepthTestEnable()
.static void
ndepthTestEnable
(long struct, int value) Unsafe version ofdepthTestEnable
.static int
ndepthWriteEnable
(long struct) Unsafe version ofdepthWriteEnable()
.static void
ndepthWriteEnable
(long struct, int value) Unsafe version ofdepthWriteEnable
.static int
nflags
(long struct) Unsafe version offlags()
.static void
nflags
(long struct, int value) Unsafe version offlags
.static VkStencilOpState
nfront
(long struct) Unsafe version offront()
.static void
nfront
(long struct, VkStencilOpState value) Unsafe version offront
.static float
nmaxDepthBounds
(long struct) Unsafe version ofmaxDepthBounds()
.static void
nmaxDepthBounds
(long struct, float value) Unsafe version ofmaxDepthBounds
.static float
nminDepthBounds
(long struct) Unsafe version ofminDepthBounds()
.static void
nminDepthBounds
(long struct, float value) Unsafe version ofminDepthBounds
.static long
npNext
(long struct) Unsafe version ofpNext()
.static void
npNext
(long struct, long value) Unsafe version ofpNext
.static int
nstencilTestEnable
(long struct) Unsafe version ofstencilTestEnable()
.static void
nstencilTestEnable
(long struct, int value) Unsafe version ofstencilTestEnable
.static int
nsType
(long struct) Unsafe version ofsType()
.static void
nsType
(long struct, int value) Unsafe version ofsType
.long
pNext()
NULL
or a pointer to a structure extending this structure.pNext
(long value) Sets the specified value to thepNext()
field.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.Copies the specified struct data to this struct.int
sizeof()
Returnssizeof(struct)
.boolean
controls whether stencil testing is enabled.stencilTestEnable
(boolean value) Sets the specified value to thestencilTestEnable()
field.int
sType()
aVkStructureType
value identifying this structure.sType
(int value) Sets the specified value to thesType()
field.Sets theSTRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO
value to thesType()
field.Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
Methods inherited from interface org.lwjgl.system.NativeResource
close, free
-
Field Details
-
SIZEOF
public static final int SIZEOFThe struct size in bytes. -
ALIGNOF
public static final int ALIGNOFThe struct alignment in bytes. -
STYPE
public static final int STYPEThe struct member offsets. -
PNEXT
public static final int PNEXTThe struct member offsets. -
FLAGS
public static final int FLAGSThe struct member offsets. -
DEPTHTESTENABLE
public static final int DEPTHTESTENABLEThe struct member offsets. -
DEPTHWRITEENABLE
public static final int DEPTHWRITEENABLEThe struct member offsets. -
DEPTHCOMPAREOP
public static final int DEPTHCOMPAREOPThe struct member offsets. -
DEPTHBOUNDSTESTENABLE
public static final int DEPTHBOUNDSTESTENABLEThe struct member offsets. -
STENCILTESTENABLE
public static final int STENCILTESTENABLEThe struct member offsets. -
FRONT
public static final int FRONTThe struct member offsets. -
BACK
public static final int BACKThe struct member offsets. -
MINDEPTHBOUNDS
public static final int MINDEPTHBOUNDSThe struct member offsets. -
MAXDEPTHBOUNDS
public static final int MAXDEPTHBOUNDSThe struct member offsets.
-
-
Constructor Details
-
VkPipelineDepthStencilStateCreateInfo
Creates aVkPipelineDepthStencilStateCreateInfo
instance at the current position of the specifiedByteBuffer
container. 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 Details
-
sizeof
public int sizeof()Description copied from class:Struct
Returnssizeof(struct)
.- Specified by:
sizeof
in classStruct<VkPipelineDepthStencilStateCreateInfo>
-
sType
public int sType()aVkStructureType
value identifying this structure. -
pNext
public long pNext()NULL
or a pointer to a structure extending this structure. -
flags
public int flags()a bitmask ofVkPipelineDepthStencilStateCreateFlagBits
specifying 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 whendepthTestEnable
isTRUE
. Depth writes are always disabled whendepthTestEnable
isFALSE
. -
depthCompareOp
public int depthCompareOp()aVkCompareOp
value specifying the comparison operator to use in the Depth Comparison step of 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
front
andback
areVkStencilOpState
values controlling the corresponding parameters of the stencil test. -
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
Sets the specified value to thesType()
field. -
sType$Default
Sets theSTRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO
value to thesType()
field. -
pNext
Sets the specified value to thepNext()
field. -
flags
Sets the specified value to theflags()
field. -
depthTestEnable
Sets the specified value to thedepthTestEnable()
field. -
depthWriteEnable
Sets the specified value to thedepthWriteEnable()
field. -
depthCompareOp
Sets the specified value to thedepthCompareOp()
field. -
depthBoundsTestEnable
Sets the specified value to thedepthBoundsTestEnable()
field. -
stencilTestEnable
Sets the specified value to thestencilTestEnable()
field. -
front
Copies the specifiedVkStencilOpState
to thefront()
field. -
front
-
back
Copies the specifiedVkStencilOpState
to theback()
field. -
back
-
minDepthBounds
Sets the specified value to theminDepthBounds()
field. -
maxDepthBounds
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
Copies the specified struct data to this struct.- Parameters:
src
- the source struct- Returns:
- this struct
-
malloc
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed. -
calloc
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed. -
create
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated withBufferUtils
. -
create
Returns a newVkPipelineDepthStencilStateCreateInfo
instance for the specified memory address. -
createSafe
-
malloc
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
Create aVkPipelineDepthStencilStateCreateInfo.Buffer
instance 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.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(MemoryStack)
instead. -
mallocStack
Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
mallocStack
@Deprecated public static VkPipelineDepthStencilStateCreateInfo.Buffer mallocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usemalloc(int, MemoryStack)
instead. -
callocStack
@Deprecated public static VkPipelineDepthStencilStateCreateInfo.Buffer callocStack(int capacity, MemoryStack stack) Deprecated.Deprecated for removal in 3.4.0. Usecalloc(int, MemoryStack)
instead. -
malloc
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
calloc
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
stack
- the stack from which to allocate
-
malloc
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
calloc
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.- Parameters:
capacity
- the buffer capacitystack
- the stack from which to allocate
-
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
Unsafe version offront()
. -
nback
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
Unsafe version offront
. -
nback
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
.
-