Class OutlineEffectAlternative

自定义描边后处理效果（不通过深度对比可以描边片元着色物体）

Export

Date

2025.10.16

Author

lyx

Hierarchy

Effect
- OutlineEffectAlternative

Constructors

constructor

new OutlineEffectAlternative(__namedParameters?): OutlineEffectAlternative
Parameters
- __namedParameters: {
      blendFunction: BlendFunction;
      blur: boolean;
      edgeDetectionAlpha: number;
      edgeStrength: number;
      hiddenEdgeColor: number;
      kernelSize: KernelSize;
      multisampling: number;
      patternScale: number;
      patternTexture: any;
      pulseSpeed: number;
      resolutionScale: number;
      resolutionX: number;
      resolutionY: number;
      visibleEdgeColor: number;
      xRay: boolean;
  } = {}
  - blendFunction: BlendFunction
  - blur: boolean
  - edgeDetectionAlpha: number
  - edgeStrength: number
  - hiddenEdgeColor: number
  - kernelSize: KernelSize
  - multisampling: number
  - patternScale: number
  - patternTexture: any
  - pulseSpeed: number
  - resolutionScale: number
  - resolutionX: number
  - resolutionY: number
  - visibleEdgeColor: number
  - xRay: boolean
Returns OutlineEffectAlternative

Overrides Effect.constructor

Properties

`Readonly` blendMode

blendMode: BlendMode

The blend mode of this effect.

blurPass

blurPass: KawaseBlurPass

模糊通道

Memberof

OutlineEffectAlternative

camera

camera: Camera

主相机

Memberof

OutlineEffectAlternative

clearPass

clearPass: ClearPass

清理通道

Memberof

OutlineEffectAlternative

`Readonly` defines

defines: Map<string, string>

Preprocessor macro definitions.

Call setChanged after changing macro definitions.

`Readonly` extensions

extensions: Set<WebGLExtension>

WebGL extensions that are required by this effect.

Call setChanged after adding or removing extensions.

maskPass

maskPass: RenderPass

遮罩通道1

Memberof

OutlineEffectAlternative

maskPass2

maskPass2: ShaderPass

遮罩通道2

Memberof

OutlineEffectAlternative

name

name: string

The name of this effect.

outlinePass

outlinePass: ShaderPass

描边通道

Memberof

OutlineEffectAlternative

pulseSpeed

pulseSpeed: number

闪烁间隔

Memberof

OutlineEffectAlternative

renderTargetMask

renderTargetMask: WebGLRenderTarget<Texture<unknown>>

渲染目标图层

Memberof

OutlineEffectAlternative

renderTargetMask2

renderTargetMask2: WebGLRenderTarget<Texture<unknown>>

修改颜色值

Memberof

OutlineEffectAlternative

renderTargetOutline

renderTargetOutline: WebGLRenderTarget<Texture<unknown>>

渲染描边

Memberof

OutlineEffectAlternative

`Protected` renderer

renderer: WebGLRenderer

The renderer.

Deprecated

scene

scene: Scene<Object3DEventMap>

主场景

Memberof

OutlineEffectAlternative

selection

selection: Selection

选择器

Memberof

OutlineEffectAlternative

time

time: number

时间

Memberof

OutlineEffectAlternative

`Readonly` uniforms

uniforms: Map<string, Uniform<any>>

Shader uniforms.

Call setChanged after adding or removing uniforms.

Accessors

edgeStrength

get edgeStrength(): number
获取边强度

Returns number

Memberof
OutlineEffectAlternative
set edgeStrength(value): void
设置边强度
Parameters
- value: number
Returns void

Memberof
OutlineEffectAlternative

hiddenEdgeColor

get hiddenEdgeColor(): Color
获取不可见边颜色

Returns Color

Memberof
OutlineEffectAlternative
set hiddenEdgeColor(value): void
设置不可见边颜色
Parameters
- value: Color
Returns void

Memberof
OutlineEffectAlternative

inputColorSpace

get inputColorSpace(): ColorSpace
Experimental
The input color space.

Returns ColorSpace

Inherited from Effect.inputColorSpace
set inputColorSpace(arg): void
Protected Experimental
Parameters
- arg: ColorSpace
Returns void

Inherited from Effect.inputColorSpace

mainCamera

set mainCamera(camera): void
设置主相机
Parameters
- camera: Camera
Returns void

Memberof
OutlineEffectAlternative

Overrides Effect.mainCamera

mainScene

set mainScene(scene): void
设置主场景
Parameters
- scene: Scene<Object3DEventMap>
Returns void

Memberof
OutlineEffectAlternative

Overrides Effect.mainScene

multisampling

get multisampling(): number
获取多重采样次数

Returns number

Memberof
OutlineEffectAlternative
set multisampling(value): void
设置多重采样次数
Parameters
- value: number
Returns void

Memberof
OutlineEffectAlternative

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

Inherited from Effect.outputColorSpace
set outputColorSpace(arg): void
Protected Experimental
Parameters
- arg: ColorSpace
Returns void

Inherited from Effect.outputColorSpace

patternScale

get patternScale(): number
获取描边图案缩放

Returns number

Memberof
OutlineEffectAlternative
set patternScale(value): void
设置描边图案缩放
Parameters
- value: number
Returns void

Memberof
OutlineEffectAlternative

patternTexture

get patternTexture(): Texture<unknown>
获取描边图案纹理

Returns Texture<unknown>

Memberof
OutlineEffectAlternative
set patternTexture(value): void
设置描边图案纹理
Parameters
- value: Texture<unknown>
Returns void

Memberof
OutlineEffectAlternative

resolution

get resolution(): Resolution
获取分辨率

Returns Resolution

Memberof
OutlineEffectAlternative

visibleEdgeColor

get visibleEdgeColor(): Color
获取可见边颜色

Returns Color

Memberof
OutlineEffectAlternative
set visibleEdgeColor(value): void
设置可见边颜色
Parameters
- value: Color
Returns void

Memberof
OutlineEffectAlternative

xRay

get xRay(): boolean
获取是否开启X-Ray模式

Returns boolean

Memberof
OutlineEffectAlternative
set xRay(value): void
设置是否开启X-Ray模式
Parameters
- value: boolean
Returns void

Memberof
OutlineEffectAlternative

Methods

addEventListener

addEventListener<T>(type, listener): void
Adds a listener to an event type.
Type Parameters
- T extends "change"
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<BaseEventMap[T], T, OutlineEffectAlternative>
  
  The function that gets called when the event is fired.
Returns void

Inherited from Effect.addEventListener

disableOutline

disableOutline(renderable, recursive): void
关闭指定渲染组件的描边效果
Parameters
- renderable: Renderable
  
  待关闭描边的渲染组件
- recursive: boolean
  
  是否递归
Returns void

Memberof
OutlineEffectAlternative
disableOutline(entity, recursive): void
关闭指定实体的描边效果
Parameters
- entity: Entity
  
  待关闭描边的实体
- recursive: boolean
  
  是否递归
Returns void

Memberof
OutlineEffectAlternative

dispatchEvent

dispatchEvent<T>(event): void
Fire an event type.
Type Parameters
- T extends "change"
Parameters
- event: BaseEvent<T> & BaseEventMap[T]
  
  The event that gets fired.
Returns void

Inherited from Effect.dispatchEvent

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

Inherited from Effect.dispose

enableOutline

enableOutline(renderable, recursive): void
描边指定渲染组件
Parameters
- renderable: Renderable
  
  待描边的渲染组件
- recursive: boolean
  
  是否递归
Returns void

Memberof
OutlineEffectAlternative
enableOutline(entity, recursive): void
描边指定的实体
Parameters
- entity: Entity
  
  待描边的实体
- recursive: boolean
  
  是否递归
Returns void

Memberof
OutlineEffectAlternative

getAttributes

getAttributes(): EffectAttribute
Returns the effect attributes.

Returns EffectAttribute
The attributes.

Inherited from Effect.getAttributes

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.

Inherited from Effect.getBlendMode

getDefines

getDefines(): Map<string, string>
Returns the preprocessor macro definitions.

Returns Map<string, string>
The extensions.

Deprecated
Use defines instead.

Inherited from Effect.getDefines

getExtensions

getExtensions(): Set<WebGLExtension>
Returns the WebGL extensions that are required by this effect.

Returns Set<WebGLExtension>
The extensions.

Deprecated
Use extensions instead.

Inherited from Effect.getExtensions

getFragmentShader

getFragmentShader(): string
Returns the fragment shader.

Returns string
The fragment shader.

Inherited from Effect.getFragmentShader

getName

getName(): string
Returns the name of this effect.

Returns string
The name.

Deprecated
Use name instead.

Inherited from Effect.getName

getUniforms

getUniforms(): Map<string, Uniform<any>>
Returns the uniforms of this effect.

Returns Map<string, Uniform<any>>
The extensions.

Deprecated
Use uniforms instead.

Inherited from Effect.getUniforms

getVertexShader

getVertexShader(): string
Returns the vertex shader.

Returns string
The vertex shader.

Inherited from Effect.getVertexShader

hasEventListener

hasEventListener<T>(type, listener): boolean
Checks if listener is added to an event type.
Type Parameters
- T extends "change"
Parameters
- type: T
  
  The type of event to listen to.
- listener: EventListener<BaseEventMap[T], T, OutlineEffectAlternative>
  
  The function that gets called when the event is fired.
Returns boolean

Inherited from Effect.hasEventListener

initialize

initialize(renderer, alpha, frameBufferType): void
初始化
Parameters
- renderer: WebGLRenderer
- alpha: boolean
- frameBufferType: number
Returns void

Memberof
OutlineEffectAlternative

Overrides Effect.initialize

removeEventListener

removeEventListener<T>(type, listener): void
Removes a listener from an event type.
Type Parameters
- T extends "change"
Parameters
- type: T
  
  The type of the listener that gets removed.
- listener: EventListener<BaseEventMap[T], T, OutlineEffectAlternative>
  
  The listener function that gets removed.
Returns void

Inherited from Effect.removeEventListener

`Protected` setAttributes

setAttributes(attributes): void
Protected
Sets the effect attributes.

Effects that have the same attributes will be executed in the order in which they were registered. Some attributes imply a higher priority.
Parameters
- attributes: EffectAttribute
  
  The attributes.
Returns void

Inherited from Effect.setAttributes

`Protected` setChanged

setChanged(): void
Protected
Informs the associated EffectPass that this effect requires a shader recompilation.

Should be called after changing macros or extensions and after adding/removing uniforms.

Returns void

Inherited from Effect.setChanged

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<unknown>
  
  A depth texture.
- Optional depthPacking: DepthPackingStrategies
  
  The depth packing.
Returns void

Inherited from Effect.setDepthTexture

`Protected` setFragmentShader

setFragmentShader(fragmentShader): void
Protected
Sets the fragment shader.
Parameters
- fragmentShader: string
  
  The fragment shader.
Returns void

Inherited from Effect.setFragmentShader

setRenderer

setRenderer(renderer): void
Sets the renderer.
Parameters
- renderer: WebGLRenderer
  
  The renderer.
Returns void

Deprecated

Inherited from Effect.setRenderer

setSize

setSize(width, height): void
设置尺寸
Parameters
- width: number
  
  宽度
- height: number
  
  高度
Returns void

Memberof
OutlineEffectAlternative

Overrides Effect.setSize

`Protected` setVertexShader

setVertexShader(vertexShader): void
Protected
Sets the vertex shader.
Parameters
- vertexShader: string
  
  The vertex shader.
Returns void

Inherited from Effect.setVertexShader

toggleOutline

toggleOutline(renderable, recursive): void
切换指定渲染组件的描边效果
Parameters
- renderable: Renderable
  
  待切换描边效果的渲染组件
- recursive: boolean
  
  是否递归
Returns void

Memberof
OutlineEffectAlternative
toggleOutline(entity, recursive): void
切换指定实体的描边效果
Parameters
- entity: Entity
  
  待切换描边效果的实体
- recursive: boolean
  
  是否递归
Returns void

Memberof
OutlineEffectAlternative

update

update(renderer, inputBuffer, deltaTime?): void
更新效果
Parameters
- renderer: WebGLRenderer
- inputBuffer: WebGLRenderTarget<Texture<unknown>>
- Optional deltaTime: number
Returns void

Memberof
OutlineEffectAlternative

Overrides Effect.update

Class OutlineEffectAlternative

Export

Date

Author

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

blendFunction: BlendFunction

blur: boolean

edgeDetectionAlpha: number

edgeStrength: number

hiddenEdgeColor: number

kernelSize: KernelSize

multisampling: number

patternScale: number

patternTexture: any

pulseSpeed: number

resolutionScale: number

resolutionX: number

resolutionY: number

visibleEdgeColor: number

xRay: boolean

Returns OutlineEffectAlternative

Properties

Readonly blendMode

blurPass

Memberof

camera

Memberof

clearPass

Memberof

Readonly defines

Readonly extensions

maskPass

Memberof

maskPass2

Memberof

name

outlinePass

Memberof

pulseSpeed

Memberof

renderTargetMask

Memberof

renderTargetMask2

Memberof

renderTargetOutline

Memberof

Protected renderer

Deprecated

scene

Memberof

selection

Memberof

time

Memberof

Readonly uniforms

Accessors

edgeStrength

Returns number

Memberof

Parameters

value: number

Returns void

Memberof

hiddenEdgeColor

Returns Color

Memberof

Parameters

value: Color

Returns void

Memberof

inputColorSpace

Returns ColorSpace

`Readonly` blendMode

`Readonly` defines

`Readonly` extensions

`Protected` renderer

`Readonly` uniforms