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, NativeResource, Pointer
public class VkPipelineDepthStencilStateCreateInfo extends Struct
Khronos Reference Page
Vulkan SpecificationContains information about depth bounds tests, stencil test and depth test as part of graphics pipeline creation.
Valid Usage
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- If the depth bounds testing feature is not enabled,
depthBoundsTestEnable
must beFALSE
Member documentation
sType
– the type of this structure. Must be:STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO
pNext
– reserved for use by extensionsflags
– reserved for future usedepthTestEnable
– controls whether depth testing is enableddepthWriteEnable
– controls whether depth writes are enableddepthCompareOp
– the comparison operator used in the depth test. One of:COMPARE_OP_ALWAYS
COMPARE_OP_EQUAL
COMPARE_OP_GREATER
COMPARE_OP_GREATER_OR_EQUAL
COMPARE_OP_LESS
COMPARE_OP_LESS_OR_EQUAL
COMPARE_OP_NEVER
COMPARE_OP_NOT_EQUAL
depthBoundsTestEnable
– controls whether depth bounds testing is enabledstencilTestEnable
– controls whether stencil testing is enabledfront
– control the parameters of the stencil test for front facing primitivesback
– control the parameters of the stencil test for back facing primitivesminDepthBounds
– the minimum depths bounds test valuemaxDepthBounds
– the maximum depths bounds test value
Layout
struct VkPipelineDepthStencilStateCreateInfo { VkStructureType sType; const void * 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 and Description static class
VkPipelineDepthStencilStateCreateInfo.Buffer
An array ofVkPipelineDepthStencilStateCreateInfo
structs.-
Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer
Pointer.Default
-
-
Field Summary
Fields Modifier and Type Field and Description static int
SIZEOF
The struct size in bytes.-
Fields inherited from interface org.lwjgl.system.Pointer
POINTER_SHIFT, POINTER_SIZE
-
-
Constructor Summary
Constructors Constructor and 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 and Description VkStencilOpState
back()
Returns aVkStencilOpState
view of theback
field.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, MemoryStack stack)
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
and initializes all its bits to zero.static VkPipelineDepthStencilStateCreateInfo
callocStack(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 ornull
if the address isNULL
.static VkPipelineDepthStencilStateCreateInfo.Buffer
create(long address, int capacity)
Create aVkPipelineDepthStencilStateCreateInfo.Buffer
instance at the specified memory.int
depthBoundsTestEnable()
Returns the value of thedepthBoundsTestEnable
field.VkPipelineDepthStencilStateCreateInfo
depthBoundsTestEnable(int 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.int
depthTestEnable()
Returns the value of thedepthTestEnable
field.VkPipelineDepthStencilStateCreateInfo
depthTestEnable(int value)
Sets the specified value to thedepthTestEnable
field.int
depthWriteEnable()
Returns the value of thedepthWriteEnable
field.VkPipelineDepthStencilStateCreateInfo
depthWriteEnable(int 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(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, MemoryStack stack)
Returns a newVkPipelineDepthStencilStateCreateInfo.Buffer
instance allocated on the specifiedMemoryStack
.static VkPipelineDepthStencilStateCreateInfo
mallocStack(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.VkPipelineDepthStencilStateCreateInfo
nset(long struct)
Unsafe version ofset
.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, int depthTestEnable, int depthWriteEnable, int depthCompareOp, int depthBoundsTestEnable, int 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()
Returns thesizeof(struct)
.int
stencilTestEnable()
Returns the value of thestencilTestEnable
field.VkPipelineDepthStencilStateCreateInfo
stencilTestEnable(int 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.-
Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString
-
Methods inherited from interface org.lwjgl.system.NativeResource
close
-
-
-
-
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()
Description copied from class:Struct
Returns thesizeof(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 int depthTestEnable()
Returns the value of thedepthTestEnable
field.
-
depthWriteEnable
public int depthWriteEnable()
Returns the value of thedepthWriteEnable
field.
-
depthCompareOp
public int depthCompareOp()
Returns the value of thedepthCompareOp
field.
-
depthBoundsTestEnable
public int depthBoundsTestEnable()
Returns the value of thedepthBoundsTestEnable
field.
-
stencilTestEnable
public int 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(int value)
Sets the specified value to thedepthTestEnable
field.
-
depthWriteEnable
public VkPipelineDepthStencilStateCreateInfo depthWriteEnable(int 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(int value)
Sets the specified value to thedepthBoundsTestEnable
field.
-
stencilTestEnable
public VkPipelineDepthStencilStateCreateInfo stencilTestEnable(int value)
Sets the specified value to thestencilTestEnable
field.
-
front
public VkPipelineDepthStencilStateCreateInfo front(VkStencilOpState value)
Copies the specifiedVkStencilOpState
to thefront
field.
-
back
public VkPipelineDepthStencilStateCreateInfo back(VkStencilOpState value)
Copies the specifiedVkStencilOpState
to theback
field.
-
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, int depthTestEnable, int depthWriteEnable, int depthCompareOp, int depthBoundsTestEnable, int stencilTestEnable, VkStencilOpState front, VkStencilOpState back, float minDepthBounds, float maxDepthBounds)
Initializes this struct with the specified values.
-
nset
public VkPipelineDepthStencilStateCreateInfo nset(long struct)
Unsafe version ofset
.
-
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 ornull
if the address isNULL
.
-
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
-
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(MemoryStack stack)
Returns a newVkPipelineDepthStencilStateCreateInfo
instance allocated on the specifiedMemoryStack
.- Parameters:
stack
- the stack from which to allocate
-
callocStack
public static VkPipelineDepthStencilStateCreateInfo callocStack(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, 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, 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
-
-