Class VkStencilOpState

  • All Implemented Interfaces:
    java.lang.AutoCloseable, NativeResource, Pointer

    public class VkStencilOpState
    extends Struct
    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

    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;
     }
    • Field Detail

      • SIZEOF

        The struct size in bytes.
      • ALIGNOF

        The struct alignment in bytes.
      • FAILOP, PASSOP, DEPTHFAILOP, COMPAREOP, COMPAREMASK, WRITEMASK, 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()
        Description copied from class: Struct
        Returns 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.
      • set

        public VkStencilOpState set​(VkStencilOpState src)
        Copies the specified struct data to this struct.
        Parameters:
        src - the source struct
        Returns:
        this struct
      • createSafe

        @Nullable
        public static VkStencilOpState createSafe​(long address)
        Like create, but returns null if address is NULL.
      • createSafe

        @Nullable
        public static VkStencilOpState.Buffer createSafe​(long address,
                                                         int capacity)
        Like create, but returns null if address is NULL.
      • 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.