Class OutlineEffect

constructor

• new OutlineEffect(scene?, camera?, options?): OutlineEffect

• Constructs a new outline effect.

  Parameters

  • Optionalscene: Scene

    The main scene.
  • Optionalcamera: Camera

    The main camera.
  • Optionaloptions: {
        blendFunction?: BlendFunction;
        blur?: boolean;
        edgeStrength?: number;
        height?: number;
        hiddenEdgeColor?: number;
        kernelSize?: KernelSize;
        multisampling?: number;
        patternScale?: number;
        patternTexture?: Texture;
        pulseSpeed?: number;
        resolutionScale?: number;
        resolutionX?: number;
        resolutionY?: number;
        visibleEdgeColor?: number;
        width?: number;
        xRay?: boolean;
    }

    The options.

    • OptionalblendFunction?: BlendFunction

      The blend function. Use BlendFunction.ALPHA for dark outlines.

    • Optionalblur?: boolean

      Whether the outline should be blurred.

    • OptionaledgeStrength?: number

      The edge strength.

    • Optionalheight?: number

      Deprecated. Use resolutionY instead.

    • OptionalhiddenEdgeColor?: number

      The color of hidden edges.

    • OptionalkernelSize?: KernelSize

      The blur kernel size.

    • Optionalmultisampling?: number

      The number of samples used for multisample antialiasing. Requires WebGL 2.

    • OptionalpatternScale?: number

      The pattern scale.

    • OptionalpatternTexture?: Texture

      A pattern texture.

    • OptionalpulseSpeed?: number

      The pulse speed. A value of zero disables the pulse effect.

    • OptionalresolutionScale?: number

      The resolution scale.

    • OptionalresolutionX?: number

      The horizontal resolution.

    • OptionalresolutionY?: number

      The vertical resolution.

    • OptionalvisibleEdgeColor?: number

      The color of visible edges.

    • Optionalwidth?: number

      Deprecated. Use resolutionX instead.

    • OptionalxRay?: boolean

      Whether occluded parts of selected objects should be visible.

  Returns OutlineEffect

ReadonlyblendMode

blurPass

Readonlydefines

Readonlyextensions

name

pulseSpeed

selection

Readonlyuniforms

blur

• get blur(): boolean

• Indicates whether the outlines should be blurred.

  Returns boolean

  Deprecated

  Use blurPass.enabled instead.

• set blur(arg): void

• Parameters

  • arg: boolean

  Returns void

dithering

• get dithering(): boolean

• Indicates whether dithering is enabled.

  Returns boolean

  Deprecated

• set dithering(arg): void

• Parameters

  • arg: boolean

  Returns void

edgeStrength

• get edgeStrength(): number

• The edge strength.

  Returns number
• set edgeStrength(arg): void

• Parameters

  • arg: number

  Returns void

height

• get height(): number

• The current height of the internal render targets.

  Returns number

  Deprecated

  Use resolution.height instead.

• set height(arg): void

• Parameters

  • arg: number

  Returns void

hiddenEdgeColor

• get hiddenEdgeColor(): Color

• The hidden edge color.

  Returns Color
• set hiddenEdgeColor(arg): void

• Parameters

  • arg: Color

  Returns void

inputColorSpace

• get inputColorSpace(): ColorSpace
• Experimental

  The input color space.

  Returns ColorSpace
• set inputColorSpace(arg): void
• Protected Experimental

  Parameters

  • arg: ColorSpace

  Returns void

kernelSize

• get kernelSize(): KernelSize

• The blur kernel size.

  Returns KernelSize

  Deprecated

  Use blurPass.kernelSize instead.

• set kernelSize(arg): void

• Parameters

  • arg: KernelSize

  Returns void

mainCamera

• set mainCamera(arg): void

• Sets the main camera.

  Parameters

  • arg: Camera

  Returns void

mainScene

• set mainScene(arg): void

• Sets the main scene.

  Parameters

  • arg: Scene

  Returns void

multisampling

• get multisampling(): number
• Experimental

  The amount of MSAA samples.

  Requires WebGL 2. Set to zero to disable multisampling.

  Requires three >= r138.

  Returns number
• set multisampling(arg): void

• Parameters

  • arg: number

  Returns void

outputColorSpace

• get outputColorSpace(): ColorSpace
• Experimental

  The output color space.

  Should only be changed if this effect converts the input colors to a different color space.

  Returns ColorSpace
• set outputColorSpace(arg): void
• Protected Experimental

  Parameters

  • arg: ColorSpace

  Returns void

patternScale

• get patternScale(): number

• The pattern scale.

  Returns number
• set patternScale(arg): void

• Parameters

  • arg: number

  Returns void

patternTexture

• get patternTexture(): Texture

• The pattern texture. Set to null to disable.

  Returns Texture
• set patternTexture(arg): void

• Parameters

  • arg: Texture

  Returns void

resolution

• get resolution(): Resolution

• The resolution of this effect.

  Returns Resolution

selectionLayer

• get selectionLayer(): number

• The selection layer.

  Returns number

  Deprecated

  Use selection.layer instead.

• set selectionLayer(arg): void

• Parameters

  • arg: number

  Returns void

visibleEdgeColor

• get visibleEdgeColor(): Color

• The visible edge color.

  Returns Color
• set visibleEdgeColor(arg): void

• Parameters

  • arg: Color

  Returns void

width

• get width(): number

• The current width of the internal render targets.

  Returns number

  Deprecated

  Use resolution.width instead.

• set width(arg): void

• Parameters

  • arg: number

  Returns void

xRay

• get xRay(): boolean

• Indicates whether X-ray mode is enabled.

  Returns boolean
• set xRay(arg): void

• Parameters

  • arg: boolean

  Returns void

addEventListener

• addEventListener<T>(type, listener): void

• Adds a listener to an event type.

  Type Parameters

  • T extends keyof Event<string, unknown>

  Parameters

  • type: T

    The type of event to listen to.
  • listener: EventListener<Event<string, unknown>[T], T, OutlineEffect>

    The function that gets called when the event is fired.

  Returns void

clearSelection

• clearSelection(): OutlineEffect

• Clears the list of selected objects.

  Returns OutlineEffect

  This pass.

  Deprecated

  Use selection.clear() instead.

deselectObject

• deselectObject(object): OutlineEffect

• Deselects an object.

  Parameters

  • object: Object3D<Object3DEventMap>

    The object that should no longer be outlined.

  Returns OutlineEffect

  This pass.

  Deprecated

  Use selection.delete() instead.

dispatchEvent

• dispatchEvent<T>(event): void

• Fire an event type.

  Type Parameters

  • T extends keyof Event<string, unknown>

  Parameters

  • event: BaseEvent<T> & Event<string, unknown>[T]

    The event that gets fired.

  Returns void

dispose

• dispose(): void

• Performs a shallow search for properties that define a dispose method and deletes them.

  The EffectComposer calls this method when it is being destroyed.

  Returns void

getAttributes

• getAttributes(): EffectAttribute

• Returns the effect attributes.

  Returns EffectAttribute

  The attributes.

getBlendMode

• getBlendMode(): BlendMode

• Returns the blend mode.

  The result of this effect will be blended with the result of the previous effect using this blend mode.

  Returns BlendMode

  The blend mode.

  Deprecated

  Use blendMode instead.

getBlurPass

• getBlurPass(): KawaseBlurPass

• Returns the blur pass.

  Returns KawaseBlurPass

  The blur pass.

  Deprecated

  Use blurPass instead.

getDefines

• getDefines(): Map<string, string>

• Returns the preprocessor macro definitions.

  Returns Map<string, string>

  The extensions.

  Deprecated

  Use defines instead.

getExtensions

• getExtensions(): Set<WebGLExtension>

• Returns the WebGL extensions that are required by this effect.

  Returns Set<WebGLExtension>

  The extensions.

  Deprecated

  Use extensions instead.

getFragmentShader

• getFragmentShader(): string

• Returns the fragment shader.

  Returns string

  The fragment shader.

getName

• getName(): string

• Returns the name of this effect.

  Returns string

  The name.

  Deprecated

  Use name instead.

getPulseSpeed

• getPulseSpeed(): number

• Returns the pulse speed.

  Returns number

  The speed.

  Deprecated

  Use pulseSpeed instead.

getResolution

• getResolution(): Resolution

• Returns the resolution.

  Returns Resolution

  The resolution.

getResolutionScale

• getResolutionScale(): number

• Returns the current resolution scale.

  Returns number

  The resolution scale.

  Deprecated

  Use resolution instead.

getSelection

• getSelection(): Selection

• Returns the selection.

  Returns Selection

  The selection.

  Deprecated

  Use selection instead.

getUniforms

• getUniforms(): Map<string, Uniform<any>>

• Returns the uniforms of this effect.

  Returns Map<string, Uniform<any>>

  The extensions.

  Deprecated

  Use uniforms instead.

getVertexShader

• getVertexShader(): string

• Returns the vertex shader.

  Returns string

  The vertex shader.

hasEventListener

• hasEventListener<T>(type, listener): boolean

• Checks if listener is added to an event type.

  Type Parameters

  • T extends keyof Event<string, unknown>

  Parameters

  • type: T

    The type of event to listen to.
  • listener: EventListener<Event<string, unknown>[T], T, OutlineEffect>

    The function that gets called when the event is fired.

  Returns boolean

initialize

• initialize(renderer, alpha, frameBufferType): void

• Performs initialization tasks.

  Parameters

  • renderer: WebGLRenderer

    The renderer.
  • alpha: boolean

    Whether the renderer uses the alpha channel or not.
  • frameBufferType: number

    The type of the main frame buffers.

  Returns void

isXRayEnabled

• isXRayEnabled(): boolean

• Indicates whether X-ray mode is enabled.

  Returns boolean

  Whether X-ray mode is enabled.

  Deprecated

  Use xRay instead.

removeEventListener

• removeEventListener<T>(type, listener): void

• Removes a listener from an event type.

  Type Parameters

  • T extends keyof Event<string, unknown>

  Parameters

  • type: T

    The type of the listener that gets removed.
  • listener: EventListener<Event<string, unknown>[T], T, OutlineEffect>

    The listener function that gets removed.

  Returns void

selectObject

• selectObject(object): OutlineEffect

• Selects an object.

  Parameters

  • object: Object3D<Object3DEventMap>

    The object that should be outlined.

  Returns OutlineEffect

  This pass.

  Deprecated

  Use selection.add() instead.

setDepthTexture

• setDepthTexture(depthTexture, depthPacking?): void

• Sets the depth texture.

  You may override this method if your effect requires direct access to the depth texture that is bound to the associated EffectPass.

  Parameters

  • depthTexture: Texture

    A depth texture.
  • OptionaldepthPacking: DepthPackingStrategies

    The depth packing.

  Returns void

setPatternTexture

• setPatternTexture(value): void

• Sets the pattern texture.

  Parameters

  • value: Texture

    The new texture.

  Returns void

  Deprecated

  Use patternTexture instead.

setPulseSpeed

• setPulseSpeed(value): void

• Sets the pulse speed. Set to zero to disable.

  Parameters

  • value: number

    The speed.

  Returns void

  Deprecated

  Use pulseSpeed instead.

setRenderer

• setRenderer(renderer): void

• Sets the renderer.

  Parameters

  • renderer: WebGLRenderer

    The renderer.

  Returns void

  Deprecated

setResolutionScale

• setResolutionScale(scale): void

• Sets the resolution scale.

  Parameters

  • scale: number

    The new resolution scale.

  Returns void

  Deprecated

  Use resolution instead.

setSelection

• setSelection(objects): OutlineEffect

• Clears the current selection and selects a list of objects.

  Parameters

  • objects: Object3D<Object3DEventMap>[]

    The objects that should be outlined. This array will be copied.

  Returns OutlineEffect

  This pass.

  Deprecated

  Use selection.set() instead.

setSize

• setSize(width, height): void

• Updates the size of internal render targets.

  Parameters

  • width: number

    The width.
  • height: number

    The height.

  Returns void

setXRayEnabled

• setXRayEnabled(value): void

• Enables or disables X-ray outlines.

  Parameters

  • value: boolean

    Whether X-ray should be enabled.

  Returns void

  Deprecated

  Use xRay instead.

update

• update(renderer, inputBuffer, deltaTime?): void

• Updates this effect.

  Parameters

  • renderer: WebGLRenderer

    The renderer.
  • inputBuffer: WebGLRenderTarget<Texture>

    A frame buffer that contains the result of the previous pass.
  • OptionaldeltaTime: number

    The time between the last frame and the current one in seconds.

  Returns void