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 Specification
Contains information about depth bounds tests, stencil test and depth test as part of graphics pipeline creation.

Valid Usage
- sType must be STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO
- pNext must be NULL
- flags must be 0
- depthCompareOp must be a valid VkCompareOp value
- front must be a valid VkStencilOpState structure
- back must be a valid VkStencilOpState structure
- If the depth bounds testing feature is not enabled, depthBoundsTestEnable must be FALSE
Member documentation
- sType – the type of this structure. Must be: STRUCTURE_TYPE_PIPELINE_DEPTH_STENCIL_STATE_CREATE_INFO
- pNext – reserved for use by extensions
- flags – reserved for future use
- depthTestEnable – controls whether depth testing is enabled
- depthWriteEnable – controls whether depth writes are enabled
- depthCompareOp – 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 enabled
- stencilTestEnable – controls whether stencil testing is enabled
- front – control the parameters of the stencil test for front facing primitives
- back – control the parameters of the stencil test for back facing primitives
- minDepthBounds – the minimum depths bounds test value
- maxDepthBounds – 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 of VkPipelineDepthStencilStateCreateInfo 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 a `VkPipelineDepthStencilStateCreateInfo` instance at the current position of the specified `ByteBuffer` container.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VkStencilOpState`	`back()` Returns a `VkStencilOpState` view of the `back` field.
`VkPipelineDepthStencilStateCreateInfo`	`back(VkStencilOpState value)` Copies the specified `VkStencilOpState` to the `back` field.
`static VkPipelineDepthStencilStateCreateInfo`	`calloc()` Returns a new `VkPipelineDepthStencilStateCreateInfo` instance allocated with `memCalloc`.
`static VkPipelineDepthStencilStateCreateInfo.Buffer`	`calloc(int capacity)` Returns a new `VkPipelineDepthStencilStateCreateInfo.Buffer` instance allocated with `memCalloc`.
`static VkPipelineDepthStencilStateCreateInfo`	`callocStack()` Returns a new `VkPipelineDepthStencilStateCreateInfo` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineDepthStencilStateCreateInfo.Buffer`	`callocStack(int capacity)` Returns a new `VkPipelineDepthStencilStateCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkPipelineDepthStencilStateCreateInfo.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkPipelineDepthStencilStateCreateInfo.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineDepthStencilStateCreateInfo`	`callocStack(MemoryStack stack)` Returns a new `VkPipelineDepthStencilStateCreateInfo` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkPipelineDepthStencilStateCreateInfo`	`create()` Returns a new `VkPipelineDepthStencilStateCreateInfo` instance allocated with `BufferUtils`.
`static VkPipelineDepthStencilStateCreateInfo.Buffer`	`create(int capacity)` Returns a new `VkPipelineDepthStencilStateCreateInfo.Buffer` instance allocated with `BufferUtils`.
`static VkPipelineDepthStencilStateCreateInfo`	`create(long address)` Returns a new `VkPipelineDepthStencilStateCreateInfo` instance for the specified memory address or `null` if the address is `NULL`.
`static VkPipelineDepthStencilStateCreateInfo.Buffer`	`create(long address, int capacity)` Create a `VkPipelineDepthStencilStateCreateInfo.Buffer` instance at the specified memory.
`int`	`depthBoundsTestEnable()` Returns the value of the `depthBoundsTestEnable` field.
`VkPipelineDepthStencilStateCreateInfo`	`depthBoundsTestEnable(int value)` Sets the specified value to the `depthBoundsTestEnable` field.
`int`	`depthCompareOp()` Returns the value of the `depthCompareOp` field.
`VkPipelineDepthStencilStateCreateInfo`	`depthCompareOp(int value)` Sets the specified value to the `depthCompareOp` field.
`int`	`depthTestEnable()` Returns the value of the `depthTestEnable` field.
`VkPipelineDepthStencilStateCreateInfo`	`depthTestEnable(int value)` Sets the specified value to the `depthTestEnable` field.
`int`	`depthWriteEnable()` Returns the value of the `depthWriteEnable` field.
`VkPipelineDepthStencilStateCreateInfo`	`depthWriteEnable(int value)` Sets the specified value to the `depthWriteEnable` field.
`int`	`flags()` Returns the value of the `flags` field.
`VkPipelineDepthStencilStateCreateInfo`	`flags(int value)` Sets the specified value to the `flags` field.
`VkStencilOpState`	`front()` Returns a `VkStencilOpState` view of the `front` field.
`VkPipelineDepthStencilStateCreateInfo`	`front(VkStencilOpState value)` Copies the specified `VkStencilOpState` to the `front` field.
`static VkPipelineDepthStencilStateCreateInfo`	`malloc()` Returns a new `VkPipelineDepthStencilStateCreateInfo` instance allocated with `memAlloc`.
`static VkPipelineDepthStencilStateCreateInfo.Buffer`	`malloc(int capacity)` Returns a new `VkPipelineDepthStencilStateCreateInfo.Buffer` instance allocated with `memAlloc`.
`static VkPipelineDepthStencilStateCreateInfo`	`mallocStack()` Returns a new `VkPipelineDepthStencilStateCreateInfo` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineDepthStencilStateCreateInfo.Buffer`	`mallocStack(int capacity)` Returns a new `VkPipelineDepthStencilStateCreateInfo.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkPipelineDepthStencilStateCreateInfo.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkPipelineDepthStencilStateCreateInfo.Buffer` instance allocated on the specified `MemoryStack`.
`static VkPipelineDepthStencilStateCreateInfo`	`mallocStack(MemoryStack stack)` Returns a new `VkPipelineDepthStencilStateCreateInfo` instance allocated on the specified `MemoryStack`.
`float`	`maxDepthBounds()` Returns the value of the `maxDepthBounds` field.
`VkPipelineDepthStencilStateCreateInfo`	`maxDepthBounds(float value)` Sets the specified value to the `maxDepthBounds` field.
`float`	`minDepthBounds()` Returns the value of the `minDepthBounds` field.
`VkPipelineDepthStencilStateCreateInfo`	`minDepthBounds(float value)` Sets the specified value to the `minDepthBounds` field.
`VkPipelineDepthStencilStateCreateInfo`	`nset(long struct)` Unsafe version of `set`.
`long`	`pNext()` Returns the value of the `pNext` field.
`VkPipelineDepthStencilStateCreateInfo`	`pNext(long value)` Sets the specified value to the `pNext` 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 the `sizeof(struct)`.
`int`	`stencilTestEnable()` Returns the value of the `stencilTestEnable` field.
`VkPipelineDepthStencilStateCreateInfo`	`stencilTestEnable(int value)` Sets the specified value to the `stencilTestEnable` field.
`int`	`sType()` Returns the value of the `sType` field.
`VkPipelineDepthStencilStateCreateInfo`	`sType(int value)` Sets the specified value to the `sType` field.

Methods inherited from class org.lwjgl.system.Struct
clear, free

Methods inherited from class org.lwjgl.system.Pointer.Default
address, equals, hashCode, toString

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.lwjgl.system.NativeResource
close

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
- Constructor Detail
  - VkPipelineDepthStencilStateCreateInfo
```
public VkPipelineDepthStencilStateCreateInfo(java.nio.ByteBuffer container)
```
    Creates a VkPipelineDepthStencilStateCreateInfo instance at the current position of the specified ByteBuffer 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 the sizeof(struct).
    
    Specified by:
    
    sizeof in class Struct
  - sType
```
public int sType()
```
    Returns the value of the sType field.
  - pNext
```
public long pNext()
```
    Returns the value of the pNext field.
  - flags
```
public int flags()
```
    Returns the value of the flags field.
  - depthTestEnable
```
public int depthTestEnable()
```
    Returns the value of the depthTestEnable field.
  - depthWriteEnable
```
public int depthWriteEnable()
```
    Returns the value of the depthWriteEnable field.
  - depthCompareOp
```
public int depthCompareOp()
```
    Returns the value of the depthCompareOp field.
  - depthBoundsTestEnable
```
public int depthBoundsTestEnable()
```
    Returns the value of the depthBoundsTestEnable field.
  - stencilTestEnable
```
public int stencilTestEnable()
```
    Returns the value of the stencilTestEnable field.
  - front
```
public VkStencilOpState front()
```
    Returns a VkStencilOpState view of the front field.
  - back
```
public VkStencilOpState back()
```
    Returns a VkStencilOpState view of the back field.
  - minDepthBounds
```
public float minDepthBounds()
```
    Returns the value of the minDepthBounds field.
  - maxDepthBounds
```
public float maxDepthBounds()
```
    Returns the value of the maxDepthBounds field.
  - sType
```
public VkPipelineDepthStencilStateCreateInfo sType(int value)
```
    Sets the specified value to the sType field.
  - pNext
```
public VkPipelineDepthStencilStateCreateInfo pNext(long value)
```
    Sets the specified value to the pNext field.
  - flags
```
public VkPipelineDepthStencilStateCreateInfo flags(int value)
```
    Sets the specified value to the flags field.
  - depthTestEnable
```
public VkPipelineDepthStencilStateCreateInfo depthTestEnable(int value)
```
    Sets the specified value to the depthTestEnable field.
  - depthWriteEnable
```
public VkPipelineDepthStencilStateCreateInfo depthWriteEnable(int value)
```
    Sets the specified value to the depthWriteEnable field.
  - depthCompareOp
```
public VkPipelineDepthStencilStateCreateInfo depthCompareOp(int value)
```
    Sets the specified value to the depthCompareOp field.
  - depthBoundsTestEnable
```
public VkPipelineDepthStencilStateCreateInfo depthBoundsTestEnable(int value)
```
    Sets the specified value to the depthBoundsTestEnable field.
  - stencilTestEnable
```
public VkPipelineDepthStencilStateCreateInfo stencilTestEnable(int value)
```
    Sets the specified value to the stencilTestEnable field.
  - front
```
public VkPipelineDepthStencilStateCreateInfo front(VkStencilOpState value)
```
    Copies the specified VkStencilOpState to the front field.
  - back
```
public VkPipelineDepthStencilStateCreateInfo back(VkStencilOpState value)
```
    Copies the specified VkStencilOpState to the back field.
  - minDepthBounds
```
public VkPipelineDepthStencilStateCreateInfo minDepthBounds(float value)
```
    Sets the specified value to the minDepthBounds field.
  - maxDepthBounds
```
public VkPipelineDepthStencilStateCreateInfo maxDepthBounds(float value)
```
    Sets the specified value to the maxDepthBounds 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 of set.
  - 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 new VkPipelineDepthStencilStateCreateInfo instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkPipelineDepthStencilStateCreateInfo calloc()
```
    Returns a new VkPipelineDepthStencilStateCreateInfo instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkPipelineDepthStencilStateCreateInfo create()
```
    Returns a new VkPipelineDepthStencilStateCreateInfo instance allocated with BufferUtils.
  - create
```
public static VkPipelineDepthStencilStateCreateInfo create(long address)
```
    Returns a new VkPipelineDepthStencilStateCreateInfo instance for the specified memory address or null if the address is NULL.
  - malloc
```
public static VkPipelineDepthStencilStateCreateInfo.Buffer malloc(int capacity)
```
    Returns a new VkPipelineDepthStencilStateCreateInfo.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkPipelineDepthStencilStateCreateInfo.Buffer calloc(int capacity)
```
    Returns a new VkPipelineDepthStencilStateCreateInfo.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPipelineDepthStencilStateCreateInfo.Buffer create(int capacity)
```
    Returns a new VkPipelineDepthStencilStateCreateInfo.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkPipelineDepthStencilStateCreateInfo.Buffer create(long address,
                                                                  int capacity)
```
    Create a VkPipelineDepthStencilStateCreateInfo.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkPipelineDepthStencilStateCreateInfo mallocStack()
```
    Returns a new VkPipelineDepthStencilStateCreateInfo instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkPipelineDepthStencilStateCreateInfo callocStack()
```
    Returns a new VkPipelineDepthStencilStateCreateInfo instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkPipelineDepthStencilStateCreateInfo mallocStack(MemoryStack stack)
```
    Returns a new VkPipelineDepthStencilStateCreateInfo instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkPipelineDepthStencilStateCreateInfo callocStack(MemoryStack stack)
```
    Returns a new VkPipelineDepthStencilStateCreateInfo instance allocated on the specified MemoryStack 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 new VkPipelineDepthStencilStateCreateInfo.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPipelineDepthStencilStateCreateInfo.Buffer callocStack(int capacity)
```
    Returns a new VkPipelineDepthStencilStateCreateInfo.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkPipelineDepthStencilStateCreateInfo.Buffer mallocStack(int capacity,
                                                                       MemoryStack stack)
```
    Returns a new VkPipelineDepthStencilStateCreateInfo.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkPipelineDepthStencilStateCreateInfo.Buffer callocStack(int capacity,
                                                                       MemoryStack stack)
```
    Returns a new VkPipelineDepthStencilStateCreateInfo.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity

`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`

Class VkPipelineDepthStencilStateCreateInfo

Valid Usage

Member documentation

Layout

Nested Class Summary

Nested classes/interfaces inherited from interface org.lwjgl.system.Pointer

Field Summary

Fields inherited from interface org.lwjgl.system.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.lwjgl.system.Struct

Methods inherited from class org.lwjgl.system.Pointer.Default

Methods inherited from class java.lang.Object

Methods inherited from interface org.lwjgl.system.NativeResource

Field Detail

SIZEOF

Constructor Detail

VkPipelineDepthStencilStateCreateInfo

Method Detail

sizeof

sType

pNext

flags

depthTestEnable

depthWriteEnable

depthCompareOp

depthBoundsTestEnable

stencilTestEnable

front

back

minDepthBounds

maxDepthBounds

sType

pNext

flags

depthTestEnable

depthWriteEnable

depthCompareOp

depthBoundsTestEnable

stencilTestEnable

front

back

minDepthBounds

maxDepthBounds

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack