LineShading

TwinfinityPostProcess is the base class that can be used to extend classes for post-process effects.

Hierarchy

• TwinfinityPostProcess
  • LineShading

Index

Constructors

• constructor

Accessors

• affectedCameras
• lineThickness

Methods

• attach
• detach

Constructors

constructor

• new LineShading(lineThickness?: number, strength?: number): LineShading

• Overrides TwinfinityPostProcess.constructor

  Parameters

  • lineThickness: number = 0.3

    Thickness of the lines, value between 0 and 1.

  • strength: number = 0.35

  Returns LineShading

Accessors

affectedCameras

• get affectedCameras(): Set<Camera>

• Inherited from TwinfinityPostProcess.affectedCameras

  Returns a set of all the cameras this post-process effect is attached to.

  ---

  Returns Set<Camera>

publiclineThickness

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

• Returns the current line thickness value.

  ---

  Returns number

• Sets the line thickness and updates the shader with the new value.

  ---

  Parameters

  • thickness: number

    Thickness of the lines, value between 0 and 1.

  Returns void

Methods

attach

• attach(camera: Camera): boolean

• Inherited from TwinfinityPostProcess.attach

  Runs the initialize method if the post-process has not yet been initialized. Then attaches the post-process effect to the specified camera.

  ---

  Parameters

  • camera: Camera

    The camera to attach the post-process effect to.

  Returns boolean

  true if the post-process effect was successfully attached to the camera, otherwise false.

detach

• detach(camera: Camera): boolean

• Overrides TwinfinityPostProcess.detach

  Disables the post-process effect for the specified camera.

  ---

  Parameters

  • camera: Camera

    The camera to detach the post-process effect from.

  Returns boolean

  true if the post-process effect was successfully detached from the camera, otherwise false.