Options
All
  • Public
  • Public/Protected
  • All
Menu

Class OutlineOverlayFilter

A filter which implements an outline. Inspired from https://github.com/pixijs/filters/tree/main/filters/outline

license

MIT

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

padding

padding: number = 3
override

autoFit

autoFit: boolean = false
override

animate

animate: boolean = true

If the filter is animated or not.

Private #thickness

#thickness: number = 3

Static defaultUniforms

defaultUniforms: { outlineColor: number[]; thickness: number[]; alphaThreshold: number; knockout: boolean; wave: boolean } = ...

The default uniforms used by the filter

Type declaration

  • outlineColor: number[]
  • thickness: number[]
  • alphaThreshold: number
  • knockout: boolean
  • wave: boolean

Static vertexShader

vertexShader: string = ...

The vertex shader which renders this filter.

Static fragmentShader

fragmentShader: string = undefined

The fragment shader which renders this filter.

Accessors

thickness

  • get thickness(): number
  • set thickness(value: number): void

  • The thickness of the outline.

    Returns number

  • The thickness of the outline.

    Parameters

    • value: number

    Returns void

resolution

  • get resolution(): number
  • set resolution(value: number): void

  • Always target the resolution of the render texture or renderer

    Returns number

  • Always target the resolution of the render texture or renderer

    Parameters

    • value: number

    Returns void

multisample

  • get multisample(): MSAA_QUALITY
  • set multisample(value: MSAA_QUALITY): void

  • Always target the MSAA level of the render texture or renderer

    Returns MSAA_QUALITY

  • Always target the MSAA level of the render texture or renderer

    Parameters

    • value: MSAA_QUALITY

    Returns void

Static Private #quality

  • get #quality(): number

  • Quality of the outline according to performance mode.

    Returns number

Methods

apply

  • apply(filterManager: any, input: any, output: any, clear: any): void
  • override

    Parameters

    • filterManager: any
    • input: any
    • output: any
    • clear: any

    Returns void

Static createFragmentShader

  • createFragmentShader(): string
  • inheritdoc

    Returns string

Static create