Package org.lwjgl.vulkan

Class VkStencilOpState

java.lang.Object
org.lwjgl.system.Pointer.Default
org.lwjgl.system.Struct<VkStencilOpState>
org.lwjgl.vulkan.VkStencilOpState
All Implemented Interfaces:
AutoCloseable, NativeResource, Pointer
public class VkStencilOpState extends Struct<VkStencilOpState> implements 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

Layout


 struct VkStencilOpState {
     VkStencilOp failOp();
     VkStencilOp passOp();
     VkStencilOp depthFailOp();
     VkCompareOp compareOp();
     uint32_t compareMask();
     uint32_t writeMask();
     uint32_t reference();
 }

  • Field Details

    • 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 Details

    • VkStencilOpState

      public VkStencilOpState(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 Details

    • sizeof

      public int sizeof()
      Description copied from class: Struct
      Returns sizeof(struct).
      Specified by:
      sizeof in class Struct<VkStencilOpState>

    • failOp

      public int failOp()
      a VkStencilOp value specifying the action performed on samples that fail the stencil test.

    • passOp

      public int passOp()
      a VkStencilOp value specifying the action performed on samples that pass both the depth and stencil tests.

    • depthFailOp

      public int depthFailOp()
      a VkStencilOp value specifying the action performed on samples that pass the stencil test and fail the depth test.

    • compareOp

      public int compareOp()
      a VkCompareOp value specifying the comparison operator used in the stencil test.

    • compareMask

      public int compareMask()
      selects the bits of the unsigned integer stencil values participating in the stencil test.

    • writeMask

      public int writeMask()
      selects the bits of the unsigned integer stencil values updated by the stencil test in the stencil framebuffer attachment.

    • reference

      public int reference()
      an integer stencil reference value that is used in the unsigned stencil comparison.

    • 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

      @Deprecated public static VkStencilOpState mallocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static VkStencilOpState callocStack()
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkStencilOpState mallocStack(MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(MemoryStack) instead.

    • callocStack

      @Deprecated public static VkStencilOpState callocStack(MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkStencilOpState.Buffer mallocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static VkStencilOpState.Buffer callocStack(int capacity)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • mallocStack

      @Deprecated public static VkStencilOpState.Buffer mallocStack(int capacity, MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use malloc(int, MemoryStack) instead.

    • callocStack

      @Deprecated public static VkStencilOpState.Buffer callocStack(int capacity, MemoryStack stack)
      Deprecated.
      Deprecated for removal in 3.4.0. Use calloc(int, MemoryStack) instead.

    • malloc

      public static VkStencilOpState malloc(MemoryStack stack)
      Returns a new VkStencilOpState instance allocated on the specified MemoryStack.
      Parameters:
      stack - the stack from which to allocate

    • calloc

      public static VkStencilOpState calloc(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

    • malloc

      public static VkStencilOpState.Buffer malloc(int capacity, MemoryStack stack)
      Returns a new VkStencilOpState.Buffer instance allocated on the specified MemoryStack.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • calloc

      public static VkStencilOpState.Buffer calloc(int capacity, MemoryStack stack)
      Returns a new VkStencilOpState.Buffer instance allocated on the specified MemoryStack and initializes all its bits to zero.
      Parameters:
      capacity - the buffer capacity
      stack - the stack from which to allocate

    • 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.