Preparing search index...

    Class StencilState

    The stencil test state for Pass.

    Hierarchy (View Summary)

    Index

    Properties

    depthFailureOperation: StencilOperation

    Specifies the stencil action when the stencil test passes, but the depth test fails.

    Lens Scripting Version 152

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

    Lens Scripting Version 152

    StencilOperation.Keep
    
    enabled: boolean

    Enable or disable the stencil test for pass.

    false
    

    Specifies whether the front and/or back face stencil test will be applied.

    Lens Scripting Version 152

    StencilFace.FrontAndBack
    
    readMask: number

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

    Lens Scripting Version 152

    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.

    Lens Scripting Version 152

    0
    
    stencilCompareFunction: StencilFunction

    Specifies the stencil test function.

    Lens Scripting Version 152

    StencilFunction.Always
    
    stencilFailureOperation: StencilOperation

    Specifies the action to take when the stencil test fails.

    Lens Scripting Version 152

    StencilOperation.Keep
    
    writeMask: number

    Specifies a bit mask to enable and disable writing of individual bits in the stencil planes.

    Lens Scripting Version 152

    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