VkStencilOpState (LWJGL 3.2.4 SNAPSHOT

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

All Implemented Interfaces:

java.lang.AutoCloseable, org.lwjgl.system.NativeResource, org.lwjgl.system.Pointer
```
public class VkStencilOpState
extends org.lwjgl.system.Struct
implements org.lwjgl.system.NativeResource
```
Structure specifying stencil operation state.
Valid Usage (Implicit)
- 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
See Also

VkPipelineDepthStencilStateCreateInfo

Member documentation
- failOp – a VkStencilOp value specifying the action performed on samples that fail the stencil test.
- passOp – a VkStencilOp value specifying the action performed on samples that pass both the depth and stencil tests.
- depthFailOp – a VkStencilOp value specifying the action performed on samples that pass the stencil test and fail the depth test.
- compareOp – a VkCompareOp value specifying the comparison operator used in the stencil test.
- 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
  org.lwjgl.system.Pointer.Default

Nested Classes
Modifier and Type	Class and Description
`static class`	`VkStencilOpState.Buffer` An array of `VkStencilOpState` structs.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALIGNOF` The struct alignment in bytes.
`static int`	`COMPAREMASK` The struct member offsets.
`static int`	`COMPAREOP` The struct member offsets.
`static int`	`DEPTHFAILOP` The struct member offsets.
`static int`	`FAILOP` The struct member offsets.
`static int`	`PASSOP` The struct member offsets.
`static int`	`REFERENCE` The struct member offsets.
`static int`	`SIZEOF` The struct size in bytes.
`static int`	`WRITEMASK` The struct member offsets.

Fields inherited from interface org.lwjgl.system.Pointer
BITS32, BITS64, CLONG_SHIFT, CLONG_SIZE, 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.

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, org.lwjgl.system.MemoryStack stack)` Returns a new `VkStencilOpState.Buffer` instance allocated on the specified `MemoryStack` and initializes all its bits to zero.
`static VkStencilOpState`	`callocStack(org.lwjgl.system.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.
`static VkStencilOpState.Buffer`	`create(long address, int capacity)` Create a `VkStencilOpState.Buffer` instance at the specified memory.
`static VkStencilOpState`	`createSafe(long address)` Like `create`, but returns `null` if `address` is `NULL`.
`static VkStencilOpState.Buffer`	`createSafe(long address, int capacity)` Like `create`, but returns `null` if `address` is `NULL`.
`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, org.lwjgl.system.MemoryStack stack)` Returns a new `VkStencilOpState.Buffer` instance allocated on the specified `MemoryStack`.
`static VkStencilOpState`	`mallocStack(org.lwjgl.system.MemoryStack stack)` Returns a new `VkStencilOpState` instance allocated on the specified `MemoryStack`.
`static int`	`ncompareMask(long struct)` Unsafe version of `compareMask()`.
`static void`	`ncompareMask(long struct, int value)` Unsafe version of `compareMask`.
`static int`	`ncompareOp(long struct)` Unsafe version of `compareOp()`.
`static void`	`ncompareOp(long struct, int value)` Unsafe version of `compareOp`.
`static int`	`ndepthFailOp(long struct)` Unsafe version of `depthFailOp()`.
`static void`	`ndepthFailOp(long struct, int value)` Unsafe version of `depthFailOp`.
`static int`	`nfailOp(long struct)` Unsafe version of `failOp()`.
`static void`	`nfailOp(long struct, int value)` Unsafe version of `failOp`.
`static int`	`npassOp(long struct)` Unsafe version of `passOp()`.
`static void`	`npassOp(long struct, int value)` Unsafe version of `passOp`.
`static int`	`nreference(long struct)` Unsafe version of `reference()`.
`static void`	`nreference(long struct, int value)` Unsafe version of `reference`.
`static int`	`nwriteMask(long struct)` Unsafe version of `writeMask()`.
`static void`	`nwriteMask(long struct, int value)` Unsafe version of `writeMask`.
`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()`
`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, isNull

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, free

- Field Detail
  - SIZEOF
```
public static final int SIZEOF
```
    The struct size in bytes.
  - ALIGNOF
```
public static final int ALIGNOF
```
    The struct alignment in bytes.
  - FAILOP
```
public static final int FAILOP
```
    The struct member offsets.
  - PASSOP
```
public static final int PASSOP
```
    The struct member offsets.
  - DEPTHFAILOP
```
public static final int DEPTHFAILOP
```
    The struct member offsets.
  - COMPAREOP
```
public static final int COMPAREOP
```
    The struct member offsets.
  - COMPAREMASK
```
public static final int COMPAREMASK
```
    The struct member offsets.
  - WRITEMASK
```
public static final int WRITEMASK
```
    The struct member offsets.
  - REFERENCE
```
public static final int REFERENCE
```
    The struct member offsets.
- 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()
```
    Specified by:
    
    sizeof in class org.lwjgl.system.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.
  - 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.
  - createSafe
```
@Nullable
public static VkStencilOpState createSafe(long address)
```
    Like create, but returns null if 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
  - createSafe
```
@Nullable
public static VkStencilOpState.Buffer createSafe(long address,
                                                           int capacity)
```
    Like create, but returns null if address is NULL.
  - 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(org.lwjgl.system.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(org.lwjgl.system.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,
                                                  org.lwjgl.system.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,
                                                  org.lwjgl.system.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
  - nfailOp
```
public static int nfailOp(long struct)
```
    Unsafe version of failOp().
  - npassOp
```
public static int npassOp(long struct)
```
    Unsafe version of passOp().
  - ndepthFailOp
```
public static int ndepthFailOp(long struct)
```
    Unsafe version of depthFailOp().
  - ncompareOp
```
public static int ncompareOp(long struct)
```
    Unsafe version of compareOp().
  - ncompareMask
```
public static int ncompareMask(long struct)
```
    Unsafe version of compareMask().
  - nwriteMask
```
public static int nwriteMask(long struct)
```
    Unsafe version of writeMask().
  - nreference
```
public static int nreference(long struct)
```
    Unsafe version of reference().
  - nfailOp
```
public static void nfailOp(long struct,
                           int value)
```
    Unsafe version of failOp.
  - npassOp
```
public static void npassOp(long struct,
                           int value)
```
    Unsafe version of passOp.
  - ndepthFailOp
```
public static void ndepthFailOp(long struct,
                                int value)
```
    Unsafe version of depthFailOp.
  - ncompareOp
```
public static void ncompareOp(long struct,
                              int value)
```
    Unsafe version of compareOp.
  - ncompareMask
```
public static void ncompareMask(long struct,
                                int value)
```
    Unsafe version of compareMask.
  - nwriteMask
```
public static void nwriteMask(long struct,
                              int value)
```
    Unsafe version of writeMask.
  - nreference
```
public static void nreference(long struct,
                              int value)
```
    Unsafe version of reference.

Class VkStencilOpState

Valid Usage (Implicit)

See Also

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

ALIGNOF

FAILOP

PASSOP

DEPTHFAILOP

COMPAREOP

COMPAREMASK

WRITEMASK

REFERENCE

Constructor Detail

VkStencilOpState

Method Detail

sizeof

failOp

passOp

depthFailOp

compareOp

compareMask

writeMask

reference

failOp

passOp

depthFailOp

compareOp

compareMask

writeMask

reference

set

set

malloc

calloc

create

create

createSafe

malloc

calloc

create

create

createSafe

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

mallocStack

callocStack

nfailOp

npassOp

ndepthFailOp

ncompareOp

ncompareMask

nwriteMask

nreference

nfailOp

npassOp

ndepthFailOp

ncompareOp

ncompareMask

nwriteMask

nreference