Lens Scripting API

    Class StencilState

    The stencil test state for Pass.

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Properties

    depthFailureOperation: StencilOperation

    Specifies the stencil action when the stencil test passes, but the depth test fails. The initial value is "Keep".

    depthStencilPassOperation: StencilOperation

    Specifies the stencil action when both the stencil test and the depth test pass, or when the stencil test passes and either there is no depth buffer or depth testing is not enabled. The initial value is "Keep".

    enabled: boolean

    Enable or disable the stencil test for pass. The initial value is false.

    Specifies whether the front and/or back face stencil test will be applied. The initial value is "FrontAndBack"

    readMask: number

    Specifies a mask that is ANDed with both the reference value and the stored stencil value when the test is done. The initial value is 0xFF.

    referenceValue: number

    Specifies the reference value for the stencil test. It is clamped to the range [0..pow(2, n)1], where n is the number of bitplanes in the stencil buffer. The initial value is 0.

    stencilCompareFunction: StencilFunction

    Specifies the stencil test function. The initial value is "Always".

    stencilFailureOperation: StencilOperation

    Specifies the action to take when the stencil test fails. The initial value is "Keep".

    writeMask: number

    Specifies a bit mask to enable and disable writing of individual bits in the stencil planes. Initially, the mask is 0xFF.

    Methods

    • Returns true if the object matches or derives from the passed in type.

      Parameters

      • type: string

      Returns boolean

    • Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

      Parameters

      Returns boolean

    MMNEPVFCICPMFPCPTTAAATR