Class OutlineMaterial

constructor

• new OutlineMaterial(
      options?: Partial<
          {
              antialias: boolean;
              camera: PerspectiveCamera
              | OrthographicCamera;
              precision: number;
              resolution: Vector2;
              sceneBuffer: Texture;
          },
      >,
  ): OutlineMaterial

• Parameters

  • Optionaloptions: Partial<
        {
            antialias: boolean;
            camera: PerspectiveCamera
            | OrthographicCamera;
            precision: number;
            resolution: Vector2;
            sceneBuffer: Texture;
        },
    >

  Returns OutlineMaterial

material

antialias

• get antialias(): boolean

• Enable antialiasing for the outline. This is actually applied in the rendering composer.

  Returns boolean
• set antialias(value: boolean): void

• Parameters

  • value: boolean

  Returns void

camera

• get camera(): PerspectiveCamera | OrthographicCamera

• Camera used to render the outline.

  Returns PerspectiveCamera | OrthographicCamera
• set camera(value: PerspectiveCamera | OrthographicCamera): void

• Parameters

  • value: PerspectiveCamera | OrthographicCamera

  Returns void

color

• get color(): Color

• Color of the outline.

  Returns Color
• set color(value: Color): void

• Parameters

  • value: Color

  Returns void

depthBuffer

• get depthBuffer(): Texture

• Depth buffer used to render the outline.

  Returns Texture
• set depthBuffer(value: Texture): void

• Parameters

  • value: Texture

  Returns void

precision

• get precision(): number

• Precision of the outline. This is used to scale the resolution of the outline.

  Returns number
• set precision(value: number): void

• Parameters

  • value: number

  Returns void

resolution

• get resolution(): Vector2

• Resolution of the outline. This should match the resolution of screen.

  Returns Vector2
• set resolution(value: Vector2): void

• Parameters

  • value: Vector2

  Returns void

sceneBuffer

• get sceneBuffer(): Texture

• Scene buffer used to render the outline.

  Returns Texture
• set sceneBuffer(value: Texture): void

• Parameters

  • value: Texture

  Returns void

strokeBias

• get strokeBias(): number

• Bias of the outline. This is used to control the strength of the outline.

  Returns number
• set strokeBias(value: number): void

• Parameters

  • value: number

  Returns void

strokeBlur

• get strokeBlur(): number

• Blur of the outline. This is used to smooth the outline.

  Returns number
• set strokeBlur(value: number): void

• Parameters

  • value: number

  Returns void

strokeMultiplier

• get strokeMultiplier(): number

• Multiplier of the outline. This is used to control the strength of the outline.

  Returns number
• set strokeMultiplier(value: number): void

• Parameters

  • value: number

  Returns void

dispose

• dispose(): void

• Dispose of the outline material.

  Returns void