Skip to main content

StencilFunction

Enum

Specifies the stencil test function.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Since Lens Scripting v272

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

Index

Enumeration Members

Always

Always: number

Always passes.

Since

Lens Scripting Version 272


Equal

Equal: number

Passes if (referenceValue & readMask) = (stencil buffer value & readMask).

Since

Lens Scripting Version 272


Greater

Greater: number

Passes if (referenceValue & readMask) > (stencil buffer value & readMask).

Since

Lens Scripting Version 272


GreaterEqual

GreaterEqual: number

Passes if (referenceValue & readMask) >= (stencil buffer value & readMask).

Since

Lens Scripting Version 272


Less

Less: number

Passes if (referenceValue & readMask) < (stencil buffer value & readMask).

Since

Lens Scripting Version 272


LessEqual

LessEqual: number

Passes if (referenceValue & readMask) <= (stencil buffer value & readMask).

Since

Lens Scripting Version 272


Never

Never: number

Always fails.

Since

Lens Scripting Version 272


NotEqual

NotEqual: number

Passes if (referenceValue & readMask) != (stencil buffer value & readMask).

Since

Lens Scripting Version 272