java.lang.Object
- org.lwjgl.system.Pointer.Default
- - org.lwjgl.system.Struct
  - - org.lwjgl.vulkan.VkStencilOpState

All Implemented Interfaces:

java.lang.AutoCloseable, NativeResource, Pointer
```
public class VkStencilOpState
extends Struct
```
Khronos Reference Page
Vulkan Specification
Contains information about the stencil test as part of graphics pipeline creation.

Valid Usage
- failOp must be a valid VkStencilOp value
- passOp must be a valid VkStencilOp value
- depthFailOp must be a valid VkStencilOp value
- compareOp must be a valid VkCompareOp value
Member documentation
- failOp – the action performed on samples that fail the stencil test. One of:
  STENCIL_OP_DECREMENT_AND_CLAMP STENCIL_OP_DECREMENT_AND_WRAP STENCIL_OP_INCREMENT_AND_CLAMP
  STENCIL_OP_INCREMENT_AND_WRAP STENCIL_OP_INVERT STENCIL_OP_KEEP
  STENCIL_OP_REPLACE STENCIL_OP_ZERO
- passOp – the action performed on samples that pass both the depth and stencil tests
- depthFailOp – the action performed on samples that pass the stencil test and fail the depth test
- compareOp – the comparison operator used in the stencil 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
- compareMask – selects the bits of the unsigned integer stencil values participating in the stencil test
- writeMask – selects the bits of the unsigned integer stencil values updated by the stencil test in the stencil framebuffer attachment
- reference – an integer reference value that is used in the unsigned stencil comparison
Layout
```
struct VkStencilOpState {
    VkStencilOp failOp;
    VkStencilOp passOp;
    VkStencilOp depthFailOp;
    VkCompareOp compareOp;
    uint32_t compareMask;
    uint32_t writeMask;
    uint32_t reference;
}
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VkStencilOpState.Buffer
An array of VkStencilOpState 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

VkStencilOpState(java.nio.ByteBuffer container)
Creates a VkStencilOpState 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
`static VkStencilOpState`	`calloc()` Returns a new `VkStencilOpState` instance allocated with `memCalloc`.
`static VkStencilOpState.Buffer`	`calloc(int capacity)` Returns a new `VkStencilOpState.Buffer` instance allocated with `memCalloc`.
`static VkStencilOpState`	`callocStack()` Returns a new `VkStencilOpState` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkStencilOpState.Buffer`	`callocStack(int capacity)` Returns a new `VkStencilOpState.Buffer` instance allocated on the thread-local `MemoryStack` and initializes all its bits to zero.
`static VkStencilOpState.Buffer`	`callocStack(int capacity, MemoryStack stack)` Returns a new `VkStencilOpState.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkStencilOpState`	`callocStack(MemoryStack stack)` Returns a new `VkStencilOpState` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`int`	`compareMask()` Returns the value of the `compareMask` field.
`VkStencilOpState`	`compareMask(int value)` Sets the specified value to the `compareMask` field.
`int`	`compareOp()` Returns the value of the `compareOp` field.
`VkStencilOpState`	`compareOp(int value)` Sets the specified value to the `compareOp` field.
`static VkStencilOpState`	`create()` Returns a new `VkStencilOpState` instance allocated with `BufferUtils`.
`static VkStencilOpState.Buffer`	`create(int capacity)` Returns a new `VkStencilOpState.Buffer` instance allocated with `BufferUtils`.
`static VkStencilOpState`	`create(long address)` Returns a new `VkStencilOpState` instance for the specified memory address or `null` if the address is `NULL`.
`static VkStencilOpState.Buffer`	`create(long address, int capacity)` Create a `VkStencilOpState.Buffer` instance at the specified memory.
`int`	`depthFailOp()` Returns the value of the `depthFailOp` field.
`VkStencilOpState`	`depthFailOp(int value)` Sets the specified value to the `depthFailOp` field.
`int`	`failOp()` Returns the value of the `failOp` field.
`VkStencilOpState`	`failOp(int value)` Sets the specified value to the `failOp` field.
`static VkStencilOpState`	`malloc()` Returns a new `VkStencilOpState` instance allocated with `memAlloc`.
`static VkStencilOpState.Buffer`	`malloc(int capacity)` Returns a new `VkStencilOpState.Buffer` instance allocated with `memAlloc`.
`static VkStencilOpState`	`mallocStack()` Returns a new `VkStencilOpState` instance allocated on the thread-local `MemoryStack`.
`static VkStencilOpState.Buffer`	`mallocStack(int capacity)` Returns a new `VkStencilOpState.Buffer` instance allocated on the thread-local `MemoryStack`.
`static VkStencilOpState.Buffer`	`mallocStack(int capacity, MemoryStack stack)` Returns a new `VkStencilOpState.Buffer` instance allocated on the specified `MemoryStack`.
`static VkStencilOpState`	`mallocStack(MemoryStack stack)` Returns a new `VkStencilOpState` instance allocated on the specified `MemoryStack`.
`VkStencilOpState`	`nset(long struct)` Unsafe version of `set`.
`int`	`passOp()` Returns the value of the `passOp` field.
`VkStencilOpState`	`passOp(int value)` Sets the specified value to the `passOp` field.
`int`	`reference()` Returns the value of the `reference` field.
`VkStencilOpState`	`reference(int value)` Sets the specified value to the `reference` field.
`VkStencilOpState`	`set(int failOp, int passOp, int depthFailOp, int compareOp, int compareMask, int writeMask, int reference)` Initializes this struct with the specified values.
`VkStencilOpState`	`set(VkStencilOpState src)` Copies the specified struct data to this struct.
`int`	`sizeof()` Returns the `sizeof(struct)`.
`int`	`writeMask()` Returns the value of the `writeMask` field.
`VkStencilOpState`	`writeMask(int value)` Sets the specified value to the `writeMask` 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
  - VkStencilOpState
```
public VkStencilOpState(java.nio.ByteBuffer container)
```
    Creates a VkStencilOpState 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
  - failOp
```
public int failOp()
```
    Returns the value of the failOp field.
  - passOp
```
public int passOp()
```
    Returns the value of the passOp field.
  - depthFailOp
```
public int depthFailOp()
```
    Returns the value of the depthFailOp field.
  - compareOp
```
public int compareOp()
```
    Returns the value of the compareOp field.
  - compareMask
```
public int compareMask()
```
    Returns the value of the compareMask field.
  - writeMask
```
public int writeMask()
```
    Returns the value of the writeMask field.
  - reference
```
public int reference()
```
    Returns the value of the reference field.
  - failOp
```
public VkStencilOpState failOp(int value)
```
    Sets the specified value to the failOp field.
  - passOp
```
public VkStencilOpState passOp(int value)
```
    Sets the specified value to the passOp field.
  - depthFailOp
```
public VkStencilOpState depthFailOp(int value)
```
    Sets the specified value to the depthFailOp field.
  - compareOp
```
public VkStencilOpState compareOp(int value)
```
    Sets the specified value to the compareOp field.
  - compareMask
```
public VkStencilOpState compareMask(int value)
```
    Sets the specified value to the compareMask field.
  - writeMask
```
public VkStencilOpState writeMask(int value)
```
    Sets the specified value to the writeMask field.
  - reference
```
public VkStencilOpState reference(int value)
```
    Sets the specified value to the reference field.
  - set
```
public VkStencilOpState set(int failOp,
                            int passOp,
                            int depthFailOp,
                            int compareOp,
                            int compareMask,
                            int writeMask,
                            int reference)
```
    Initializes this struct with the specified values.
  - nset
```
public VkStencilOpState nset(long struct)
```
    Unsafe version of set.
  - set
```
public VkStencilOpState set(VkStencilOpState src)
```
    Copies the specified struct data to this struct.
    
    Parameters:
    
    src - the source struct
    
    Returns:
    
    this struct
  - malloc
```
public static VkStencilOpState malloc()
```
    Returns a new VkStencilOpState instance allocated with memAlloc. The instance must be explicitly freed.
  - calloc
```
public static VkStencilOpState calloc()
```
    Returns a new VkStencilOpState instance allocated with memCalloc. The instance must be explicitly freed.
  - create
```
public static VkStencilOpState create()
```
    Returns a new VkStencilOpState instance allocated with BufferUtils.
  - create
```
public static VkStencilOpState create(long address)
```
    Returns a new VkStencilOpState instance for the specified memory address or null if the address is NULL.
  - malloc
```
public static VkStencilOpState.Buffer malloc(int capacity)
```
    Returns a new VkStencilOpState.Buffer instance allocated with memAlloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - calloc
```
public static VkStencilOpState.Buffer calloc(int capacity)
```
    Returns a new VkStencilOpState.Buffer instance allocated with memCalloc. The instance must be explicitly freed.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkStencilOpState.Buffer create(int capacity)
```
    Returns a new VkStencilOpState.Buffer instance allocated with BufferUtils.
    
    Parameters:
    
    capacity - the buffer capacity
  - create
```
public static VkStencilOpState.Buffer create(long address,
                                             int capacity)
```
    Create a VkStencilOpState.Buffer instance at the specified memory.
    
    Parameters:
    
    address - the memory address
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkStencilOpState mallocStack()
```
    Returns a new VkStencilOpState instance allocated on the thread-local MemoryStack.
  - callocStack
```
public static VkStencilOpState callocStack()
```
    Returns a new VkStencilOpState instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
  - mallocStack
```
public static VkStencilOpState mallocStack(MemoryStack stack)
```
    Returns a new VkStencilOpState instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
  - callocStack
```
public static VkStencilOpState callocStack(MemoryStack stack)
```
    Returns a new VkStencilOpState instance allocated on the specified MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    stack - the stack from which to allocate
  - mallocStack
```
public static VkStencilOpState.Buffer mallocStack(int capacity)
```
    Returns a new VkStencilOpState.Buffer instance allocated on the thread-local MemoryStack.
    
    Parameters:
    
    capacity - the buffer capacity
  - callocStack
```
public static VkStencilOpState.Buffer callocStack(int capacity)
```
    Returns a new VkStencilOpState.Buffer instance allocated on the thread-local MemoryStack and initializes all its bits to zero.
    
    Parameters:
    
    capacity - the buffer capacity
  - mallocStack
```
public static VkStencilOpState.Buffer mallocStack(int capacity,
                                                  MemoryStack stack)
```
    Returns a new VkStencilOpState.Buffer instance allocated on the specified MemoryStack.
    
    Parameters:
    
    stack - the stack from which to allocate
    
    capacity - the buffer capacity
  - callocStack
```
public static VkStencilOpState.Buffer callocStack(int capacity,
                                                  MemoryStack stack)
```
    Returns a new VkStencilOpState.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

`STENCIL_OP_DECREMENT_AND_CLAMP`	`STENCIL_OP_DECREMENT_AND_WRAP`	`STENCIL_OP_INCREMENT_AND_CLAMP`
`STENCIL_OP_INCREMENT_AND_WRAP`	`STENCIL_OP_INVERT`	`STENCIL_OP_KEEP`
`STENCIL_OP_REPLACE`	`STENCIL_OP_ZERO`

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

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

VkStencilOpState

Method Detail

sizeof

failOp

passOp

depthFailOp

compareOp

compareMask

writeMask

reference

failOp

passOp

depthFailOp

compareOp

compareMask

writeMask

reference

set

nset

set

malloc

calloc

create

create

malloc

calloc

create

create

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack