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
Valid Usage (Implicit)
sTypemust beSTRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFOpNextmust beNULLflagsmust be 0depthCompareOpmust be a validVkCompareOpvaluefrontmust be a validVkStencilOpStatestructurebackmust be a validVkStencilOpStatestructure
See Also
VkGraphicsPipelineCreateInfo,VkStencilOpStateMember documentation
sType– the type of this structure.pNext–NULLor a pointer to an extension-specific structure.flags– reserved for future use.depthTestEnable– controls whether depth testing is enabled.depthWriteEnable– controls whether depth writes are enabled whendepthTestEnableisTRUE. Depth writes are always disabled whendepthTestEnableisFALSE.depthCompareOp– the comparison operator used in the depth test.depthBoundsTestEnable– controls whether depth bounds testing is enabled.stencilTestEnable– controls whether stencil testing is enabled.front–frontandbackcontrol the parameters of the stencil test.back– seefrontminDepthBounds–minDepthBoundsandmaxDepthBoundsdefine the range of values used in the depth bounds test.maxDepthBounds– seeminDepthBounds
Layout
struct VkPipelineDepthStencilStateCreateInfo { VkStructureType sType; void const * pNext; VkPipelineDepthStencilStateCreateFlags flags; VkBool32 depthTestEnable; VkBool32 depthWriteEnable; VkCompareOp depthCompareOp; VkBool32 depthBoundsTestEnable; VkBool32 stencilTestEnable;VkStencilOpStatefront;VkStencilOpStateback; float minDepthBounds; float maxDepthBounds; }
-
-
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 Modifier and Type Method Description VkStencilOpStateback()Returns aVkStencilOpStateview of thebackfield.VkPipelineDepthStencilStateCreateInfoback(java.util.function.Consumer<VkStencilOpState> consumer)Passes thebackfield to the specifiedConsumer.VkPipelineDepthStencilStateCreateInfoback(VkStencilOpState value)Copies the specifiedVkStencilOpStateto thebackfield.static VkPipelineDepthStencilStateCreateInfocalloc()Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated withmemCalloc.static VkPipelineDepthStencilStateCreateInfo.Buffercalloc(int capacity)Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated withmemCalloc.static VkPipelineDepthStencilStateCreateInfocallocStack()Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPipelineDepthStencilStateCreateInfo.BuffercallocStack(int capacity)Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.static VkPipelineDepthStencilStateCreateInfo.BuffercallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.static VkPipelineDepthStencilStateCreateInfocallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated on the specifiedMemoryStackand initializes all its bits to zero.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()Returns the value of thedepthBoundsTestEnablefield.VkPipelineDepthStencilStateCreateInfodepthBoundsTestEnable(boolean value)Sets the specified value to thedepthBoundsTestEnablefield.intdepthCompareOp()Returns the value of thedepthCompareOpfield.VkPipelineDepthStencilStateCreateInfodepthCompareOp(int value)Sets the specified value to thedepthCompareOpfield.booleandepthTestEnable()Returns the value of thedepthTestEnablefield.VkPipelineDepthStencilStateCreateInfodepthTestEnable(boolean value)Sets the specified value to thedepthTestEnablefield.booleandepthWriteEnable()Returns the value of thedepthWriteEnablefield.VkPipelineDepthStencilStateCreateInfodepthWriteEnable(boolean value)Sets the specified value to thedepthWriteEnablefield.intflags()Returns the value of theflagsfield.VkPipelineDepthStencilStateCreateInfoflags(int value)Sets the specified value to theflagsfield.VkStencilOpStatefront()Returns aVkStencilOpStateview of thefrontfield.VkPipelineDepthStencilStateCreateInfofront(java.util.function.Consumer<VkStencilOpState> consumer)Passes thefrontfield to the specifiedConsumer.VkPipelineDepthStencilStateCreateInfofront(VkStencilOpState value)Copies the specifiedVkStencilOpStateto thefrontfield.static VkPipelineDepthStencilStateCreateInfomalloc()Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated withmemAlloc.static VkPipelineDepthStencilStateCreateInfo.Buffermalloc(int capacity)Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated withmemAlloc.static VkPipelineDepthStencilStateCreateInfomallocStack()Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated on the thread-localMemoryStack.static VkPipelineDepthStencilStateCreateInfo.BuffermallocStack(int capacity)Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.static VkPipelineDepthStencilStateCreateInfo.BuffermallocStack(int capacity, org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated on the specifiedMemoryStack.static VkPipelineDepthStencilStateCreateInfomallocStack(org.lwjgl.system.MemoryStack stack)Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated on the specifiedMemoryStack.floatmaxDepthBounds()Returns the value of themaxDepthBoundsfield.VkPipelineDepthStencilStateCreateInfomaxDepthBounds(float value)Sets the specified value to themaxDepthBoundsfield.floatminDepthBounds()Returns the value of theminDepthBoundsfield.VkPipelineDepthStencilStateCreateInfominDepthBounds(float value)Sets the specified value to theminDepthBoundsfield.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()Returns the value of thepNextfield.VkPipelineDepthStencilStateCreateInfopNext(long value)Sets the specified value to thepNextfield.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()Returns the value of thestencilTestEnablefield.VkPipelineDepthStencilStateCreateInfostencilTestEnable(boolean value)Sets the specified value to thestencilTestEnablefield.intsType()Returns the value of thesTypefield.VkPipelineDepthStencilStateCreateInfosType(int value)Sets the specified value to thesTypefield.
-
-
-
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()
Returns the value of thesTypefield.
-
pNext
public long pNext()
Returns the value of thepNextfield.
-
flags
public int flags()
Returns the value of theflagsfield.
-
depthTestEnable
public boolean depthTestEnable()
Returns the value of thedepthTestEnablefield.
-
depthWriteEnable
public boolean depthWriteEnable()
Returns the value of thedepthWriteEnablefield.
-
depthCompareOp
public int depthCompareOp()
Returns the value of thedepthCompareOpfield.
-
depthBoundsTestEnable
public boolean depthBoundsTestEnable()
Returns the value of thedepthBoundsTestEnablefield.
-
stencilTestEnable
public boolean stencilTestEnable()
Returns the value of thestencilTestEnablefield.
-
front
public VkStencilOpState front()
Returns aVkStencilOpStateview of thefrontfield.
-
back
public VkStencilOpState back()
Returns aVkStencilOpStateview of thebackfield.
-
minDepthBounds
public float minDepthBounds()
Returns the value of theminDepthBoundsfield.
-
maxDepthBounds
public float maxDepthBounds()
Returns the value of themaxDepthBoundsfield.
-
sType
public VkPipelineDepthStencilStateCreateInfo sType(int value)
Sets the specified value to thesTypefield.
-
pNext
public VkPipelineDepthStencilStateCreateInfo pNext(long value)
Sets the specified value to thepNextfield.
-
flags
public VkPipelineDepthStencilStateCreateInfo flags(int value)
Sets the specified value to theflagsfield.
-
depthTestEnable
public VkPipelineDepthStencilStateCreateInfo depthTestEnable(boolean value)
Sets the specified value to thedepthTestEnablefield.
-
depthWriteEnable
public VkPipelineDepthStencilStateCreateInfo depthWriteEnable(boolean value)
Sets the specified value to thedepthWriteEnablefield.
-
depthCompareOp
public VkPipelineDepthStencilStateCreateInfo depthCompareOp(int value)
Sets the specified value to thedepthCompareOpfield.
-
depthBoundsTestEnable
public VkPipelineDepthStencilStateCreateInfo depthBoundsTestEnable(boolean value)
Sets the specified value to thedepthBoundsTestEnablefield.
-
stencilTestEnable
public VkPipelineDepthStencilStateCreateInfo stencilTestEnable(boolean value)
Sets the specified value to thestencilTestEnablefield.
-
front
public VkPipelineDepthStencilStateCreateInfo front(VkStencilOpState value)
Copies the specifiedVkStencilOpStateto thefrontfield.
-
front
public VkPipelineDepthStencilStateCreateInfo front(java.util.function.Consumer<VkStencilOpState> consumer)
Passes thefrontfield to the specifiedConsumer.
-
back
public VkPipelineDepthStencilStateCreateInfo back(VkStencilOpState value)
Copies the specifiedVkStencilOpStateto thebackfield.
-
back
public VkPipelineDepthStencilStateCreateInfo back(java.util.function.Consumer<VkStencilOpState> consumer)
Passes thebackfield to the specifiedConsumer.
-
minDepthBounds
public VkPipelineDepthStencilStateCreateInfo minDepthBounds(float value)
Sets the specified value to theminDepthBoundsfield.
-
maxDepthBounds
public VkPipelineDepthStencilStateCreateInfo maxDepthBounds(float value)
Sets the specified value to themaxDepthBoundsfield.
-
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
public static VkPipelineDepthStencilStateCreateInfo mallocStack()
Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated on the thread-localMemoryStack.
-
callocStack
public static VkPipelineDepthStencilStateCreateInfo callocStack()
Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.
-
mallocStack
public static VkPipelineDepthStencilStateCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineDepthStencilStateCreateInfoinstance allocated on the specifiedMemoryStack.- Parameters:
stack- the stack from which to allocate
-
callocStack
public static VkPipelineDepthStencilStateCreateInfo callocStack(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
-
mallocStack
public static VkPipelineDepthStencilStateCreateInfo.Buffer mallocStack(int capacity)
Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStack.- Parameters:
capacity- the buffer capacity
-
callocStack
public static VkPipelineDepthStencilStateCreateInfo.Buffer callocStack(int capacity)
Returns a newVkPipelineDepthStencilStateCreateInfo.Bufferinstance allocated on the thread-localMemoryStackand initializes all its bits to zero.- Parameters:
capacity- the buffer capacity
-
mallocStack
public static VkPipelineDepthStencilStateCreateInfo.Buffer mallocStack(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
-
callocStack
public static VkPipelineDepthStencilStateCreateInfo.Buffer callocStack(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.
-
-