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.NativeResource
Structure specifying parameters of a newly created pipeline depth stencil state.Valid Usage
- If the depth bounds testing feature is not enabled,
depthBoundsTestEnable
must beFALSE
Valid Usage (Implicit)
sType
must beSTRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO
pNext
must beNULL
flags
must be 0depthCompareOp
must be a validVkCompareOp
valuefront
must be a validVkStencilOpState
structureback
must be a validVkStencilOpState
structure
See Also
VkGraphicsPipelineCreateInfo
,VkStencilOpState
Member documentation
sType
– the type of this structure.pNext
–NULL
or 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 whendepthTestEnable
isTRUE
. Depth writes are always disabled whendepthTestEnable
isFALSE
.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
–front
andback
control the parameters of the stencil test.back
– seefront
minDepthBounds
–minDepthBounds
andmaxDepthBounds
define 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;
VkStencilOpState
front;VkStencilOpState
back; float minDepthBounds; float maxDepthBounds; }
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
VkPipelineDepthStencilStateCreateInfo.Buffer
An array ofVkPipelineDepthStencilStateCreateInfo
structs.
-
Field Summary
Fields Modifier and Type Field Description static int
ALIGNOF
The struct alignment in bytes.static int
BACK
DEPTHBOUNDSTESTENABLE
DEPTHCOMPAREOP
DEPTHTESTENABLE
DEPTHWRITEENABLE
FLAGS
FRONT
MAXDEPTHBOUNDS
MINDEPTHBOUNDS
PNEXTThe struct member offsets.static int
SIZEOF
The struct size in bytes.static int
STENCILTESTENABLE
STYPEThe struct member offsets.
-
Constructor Summary
Constructors Constructor Description VkPipelineDepthStencilStateCreateInfo(java.nio.ByteBuffer container)
Creates aVkPipelineDepthStencilStateCreateInfo
instance at the current position of the specifiedByteBuffer
container.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description VkStencilOpState
back()
Returns aVkStencilOpState
view of theback
field.VkPipelineDepthStencilStateCreateInfo
back(java.util.function.Consumer<VkStencilOpState> consumer)
Passes theback
field to the specifiedConsumer
.VkPipelineDepthStencilStateCreateInfo
back(VkStencilOpState value)
Copies the specifiedVkStencilOpState
to theback
field.static VkPipelineDepthStencilStateCreateInfo
calloc()
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated withmemCalloc
.static VkPipelineDepthStencilStateCreateInfo.Buffer
calloc(int capacity)
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated withmemCalloc
.static VkPipelineDepthStencilStateCreateInfo
callocStack()
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineDepthStencilStateCreateInfo.Buffer
callocStack(int capacity)
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.static VkPipelineDepthStencilStateCreateInfo.Buffer
callocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineDepthStencilStateCreateInfo
callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineDepthStencilStateCreateInfo
create()
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated withBufferUtils
.static VkPipelineDepthStencilStateCreateInfo.Buffer
create(int capacity)
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated withBufferUtils
.static VkPipelineDepthStencilStateCreateInfo
create(long address)
Returns a newVkPipelineDepthStencilStateCreateInfo
instance for the specified memory address.static VkPipelineDepthStencilStateCreateInfo.Buffer
create(long address, int capacity)
Create aVkPipelineDepthStencilStateCreateInfo.Buffer
instance at the specified memory.static VkPipelineDepthStencilStateCreateInfo
createSafe(long address)
static VkPipelineDepthStencilStateCreateInfo.Buffer
createSafe(long address, int capacity)
boolean
depthBoundsTestEnable()
Returns the value of thedepthBoundsTestEnable
field.VkPipelineDepthStencilStateCreateInfo
depthBoundsTestEnable(boolean value)
Sets the specified value to thedepthBoundsTestEnable
field.int
depthCompareOp()
Returns the value of thedepthCompareOp
field.VkPipelineDepthStencilStateCreateInfo
depthCompareOp(int value)
Sets the specified value to thedepthCompareOp
field.boolean
depthTestEnable()
Returns the value of thedepthTestEnable
field.VkPipelineDepthStencilStateCreateInfo
depthTestEnable(boolean value)
Sets the specified value to thedepthTestEnable
field.boolean
depthWriteEnable()
Returns the value of thedepthWriteEnable
field.VkPipelineDepthStencilStateCreateInfo
depthWriteEnable(boolean value)
Sets the specified value to thedepthWriteEnable
field.int
flags()
Returns the value of theflags
field.VkPipelineDepthStencilStateCreateInfo
flags(int value)
Sets the specified value to theflags
field.VkStencilOpState
front()
Returns aVkStencilOpState
view of thefront
field.VkPipelineDepthStencilStateCreateInfo
front(java.util.function.Consumer<VkStencilOpState> consumer)
Passes thefront
field to the specifiedConsumer
.VkPipelineDepthStencilStateCreateInfo
front(VkStencilOpState value)
Copies the specifiedVkStencilOpState
to thefront
field.static VkPipelineDepthStencilStateCreateInfo
malloc()
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated withmemAlloc
.static VkPipelineDepthStencilStateCreateInfo.Buffer
malloc(int capacity)
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated withmemAlloc
.static VkPipelineDepthStencilStateCreateInfo
mallocStack()
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated on the thread-localMemoryStack
.static VkPipelineDepthStencilStateCreateInfo.Buffer
mallocStack(int capacity)
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
.static VkPipelineDepthStencilStateCreateInfo.Buffer
mallocStack(int capacity, org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkPipelineDepthStencilStateCreateInfo
mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated on the specifiedMemoryStack
.float
maxDepthBounds()
Returns the value of themaxDepthBounds
field.VkPipelineDepthStencilStateCreateInfo
maxDepthBounds(float value)
Sets the specified value to themaxDepthBounds
field.float
minDepthBounds()
Returns the value of theminDepthBounds
field.VkPipelineDepthStencilStateCreateInfo
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()
Returns the value of thepNext
field.VkPipelineDepthStencilStateCreateInfo
pNext(long value)
Sets the specified value to thepNext
field.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.VkPipelineDepthStencilStateCreateInfo
set(VkPipelineDepthStencilStateCreateInfo src)
Copies the specified struct data to this struct.int
sizeof()
boolean
stencilTestEnable()
Returns the value of thestencilTestEnable
field.VkPipelineDepthStencilStateCreateInfo
stencilTestEnable(boolean value)
Sets the specified value to thestencilTestEnable
field.int
sType()
Returns the value of thesType
field.VkPipelineDepthStencilStateCreateInfo
sType(int value)
Sets the specified value to thesType
field.
-
-
-
Constructor Detail
-
VkPipelineDepthStencilStateCreateInfo
public VkPipelineDepthStencilStateCreateInfo(java.nio.ByteBuffer container)
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 Detail
-
sizeof
public int sizeof()
- Specified by:
sizeof
in classorg.lwjgl.system.Struct
-
sType
public int sType()
Returns the value of thesType
field.
-
pNext
public long pNext()
Returns the value of thepNext
field.
-
flags
public int flags()
Returns the value of theflags
field.
-
depthTestEnable
public boolean depthTestEnable()
Returns the value of thedepthTestEnable
field.
-
depthWriteEnable
public boolean depthWriteEnable()
Returns the value of thedepthWriteEnable
field.
-
depthCompareOp
public int depthCompareOp()
Returns the value of thedepthCompareOp
field.
-
depthBoundsTestEnable
public boolean depthBoundsTestEnable()
Returns the value of thedepthBoundsTestEnable
field.
-
stencilTestEnable
public boolean stencilTestEnable()
Returns the value of thestencilTestEnable
field.
-
front
public VkStencilOpState front()
Returns aVkStencilOpState
view of thefront
field.
-
back
public VkStencilOpState back()
Returns aVkStencilOpState
view of theback
field.
-
minDepthBounds
public float minDepthBounds()
Returns the value of theminDepthBounds
field.
-
maxDepthBounds
public float maxDepthBounds()
Returns the value of themaxDepthBounds
field.
-
sType
public VkPipelineDepthStencilStateCreateInfo sType(int value)
Sets the specified value 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 specifiedVkStencilOpState
to 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 specifiedVkStencilOpState
to 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 newVkPipelineDepthStencilStateCreateInfo
instance allocated withmemAlloc
. The instance must be explicitly freed.
-
calloc
public static VkPipelineDepthStencilStateCreateInfo calloc()
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated withmemCalloc
. The instance must be explicitly freed.
-
create
public static VkPipelineDepthStencilStateCreateInfo create()
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated withBufferUtils
.
-
create
public static VkPipelineDepthStencilStateCreateInfo create(long address)
Returns a newVkPipelineDepthStencilStateCreateInfo
instance for the specified memory address.
-
createSafe
@Nullable public static VkPipelineDepthStencilStateCreateInfo createSafe(long address)
-
malloc
public static VkPipelineDepthStencilStateCreateInfo.Buffer malloc(int capacity)
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated withmemAlloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
calloc
public static VkPipelineDepthStencilStateCreateInfo.Buffer calloc(int capacity)
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated withmemCalloc
. The instance must be explicitly freed.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineDepthStencilStateCreateInfo.Buffer create(int capacity)
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated withBufferUtils
.- Parameters:
capacity
- the buffer capacity
-
create
public static VkPipelineDepthStencilStateCreateInfo.Buffer create(long address, int capacity)
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
public static VkPipelineDepthStencilStateCreateInfo mallocStack()
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated on the thread-localMemoryStack
.
-
callocStack
public static VkPipelineDepthStencilStateCreateInfo callocStack()
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated on the thread-localMemoryStack
and initializes all its bits to zero.
-
mallocStack
public static VkPipelineDepthStencilStateCreateInfo mallocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPipelineDepthStencilStateCreateInfo callocStack(org.lwjgl.system.MemoryStack stack)
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated on the specifiedMemoryStack
and 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.Buffer
instance allocated on the thread-localMemoryStack
.- Parameters:
capacity
- the buffer capacity
-
callocStack
public static VkPipelineDepthStencilStateCreateInfo.Buffer callocStack(int capacity)
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated on the thread-localMemoryStack
and 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.Buffer
instance 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.Buffer
instance allocated on the specifiedMemoryStack
and 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
.
-
-