StencilFunction

Stencil function used for comparing stencil values.

Type	Name	Interface Description
Enum	Always	• Function: The comparison always passes.
Enum	Equal	• Function: The comparison passes if the reference value is equal to the stored stencil value.
Enum	Greater	• Function: The comparison passes if the reference value is greater than the stored stencil value.
Enum	GreaterOrEqual	• Function: The comparison passes if the reference value is greater than or equal to the stored stencil value.
Enum	Less	• Function: The comparison passes if the reference value is less than the stored stencil value.
Enum	LessOrEqual	• Function: The comparison passes if the reference value is less than or equal to the stored stencil value.
Enum	Never	• Function: The comparison never passes.
Enum	NotEqual	• Function: The comparison passes if the reference value is not equal to the stored stencil value.

Examples

Always

let value = APJS.StencilFunction.Always;

Equal

let value = APJS.StencilFunction.Equal;

Greater

let value = APJS.StencilFunction.Greater;

GreaterOrEqual

let value = APJS.StencilFunction.GreaterOrEqual;

Less

let value = APJS.StencilFunction.Less;

LessOrEqual

let value = APJS.StencilFunction.LessOrEqual;

Never

let value = APJS.StencilFunction.Never;

NotEqual

let value = APJS.StencilFunction.NotEqual;

Use Case

@component()
export class NewBehaviourScript extends APJS.BasicScriptComponent {
  onStart() {
    // TODO: instantiate / use StencilFunction here
  }
  onUpdate(deltaTime: number) {
  }
}