Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "step"

Index

Functions

Const expStep

  • expStep(k: number, n: number, x: number): number
  • Exponential ramp with variable shape

    remarks

    Example configurations:

    • S-curve: k=8, n=4
    • Step near 1.0: k=8, n=20
    • Pulse: k=0.005, n=-10
    • Ease-in: k=0.5, n=0.25

    Interactive graph: https://www.desmos.com/calculator/gcnuyppycz

    Parameters

    • k: number

      -

    • n: number

      -

    • x: number

      -

    Returns number

Const smoothStep

  • smoothStep(edge: number, edge2: number, x: number): number
  • GLSL-style smoothStep threshold function.

    Parameters

    • edge: number

      lower threshold

    • edge2: number

      upper threshold

    • x: number

      test value

    Returns number

    0, if x < edge1, 1 if x > edge2, else S-curve polynomial interpolation

Const smootherStep

  • smootherStep(edge: number, edge2: number, x: number): number
  • Similar to smoothStep but using different, higher degree polynomial.

    Parameters

    • edge: number

      -

    • edge2: number

      -

    • x: number

      -

    Returns number

Const step

  • step(edge: number, x: number): 1 | 0
  • Step/threshold function.

    Parameters

    • edge: number

      threshold

    • x: number

      test value

    Returns 1 | 0

    0, if x < e, else 1

Generated using TypeDoc