Class LensFlareEffect

镜头炫光后处理效果

Export

Date

2025.10.24

Author

lyx

Hierarchy

Constructors

constructor

Properties

blendMode defines extensions name renderer selection uniforms

Accessors

additionalStreaks anamorphic animated colorGain enabled flareShape flareSize flareSpeed ghostScale glareSize haloScale inputColorSpace lensPosition mainCamera mainScene opacity outputColorSpace secondaryGhosts starBurst starPoints

Methods

addEventListener disableOcclusionDetection dispatchEvent dispose enableOcclusionDetection getAttributes getBlendMode getDefines getExtensions getFragmentShader getName getUniforms getVertexShader hasEventListener initialize removeEventListener setAttributes setChanged setDepthTexture setFragmentShader setRenderer setSize setVertexShader toggleOcclusionDetection update

Constructors

constructor

Properties

Readonly blendMode

blendMode: BlendMode

The blend mode of this effect.

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.

name

name: string

The name of this effect.

Protected renderer

renderer: WebGLRenderer

The renderer.

Deprecated

selection

selection: Selection

遮挡检测选择器

Memberof

LensFlareEffect

Readonly uniforms

uniforms: Map<string, Uniform<any>>

Shader uniforms.

Call setChanged after adding or removing uniforms.

Accessors

additionalStreaks

  • set additionalStreaks(value): void

  • 设置是否显示额外的光束/条纹。

    Parameters

    • value: boolean

    Returns void

    Memberof

    LensFlareEffect

anamorphic

  • set anamorphic(value): void

  • 设置是否启用“变形”效果（电影感）。启用后，星芒会变成水平条纹。

    Parameters

    • value: boolean

    Returns void

    Memberof

    LensFlareEffect

animated

  • set animated(value): void

  • 设置是否启用内部动画（闪烁）。

    Parameters

    • value: boolean

    Returns void

    Memberof

    LensFlareEffect

colorGain

  • set colorGain(value): void

  • 设置炫光的增益颜色。

    注：必须使用RGB格式颜色，即颜色的取值区间在[0 ~ 255]

    Parameters

    • value: Color

    Returns void

    Memberof

    LensFlareEffect

enabled

  • set enabled(value): void

  • 设置是否启用炫光效果。

    Parameters

    • value: boolean

    Returns void

    Memberof

    LensFlareEffect

flareShape

  • set flareShape(value): void

  • 设置炫光光束的形状因子。影响星芒的拉伸感。

    Parameters

    • value: number

    Returns void

    Memberof

    LensFlareEffect

flareSize

  • set flareSize(value): void

  • 设置整体炫光的强度/大小。

    Parameters

    • value: number

    Returns void

    Memberof

    LensFlareEffect

flareSpeed

  • set flareSpeed(value): void

  • 设置炫光内部动画的速度。需要将animated设置为true才会生效。

    Parameters

    • value: number

    Returns void

    Memberof

    LensFlareEffect

ghostScale

  • set ghostScale(value): void

  • 设置“鬼影”（次级光斑）的缩放 。控制沿中心分布的那些小光斑的大小。

    Parameters

    • value: number

    Returns void

    Memberof

    LensFlareEffect

glareSize

  • set glareSize(value): void

  • 设置光斑的大小。

    Parameters

    • value: number

    Returns void

    Memberof

    LensFlareEffect

haloScale

  • set haloScale(value): void

  • 设置光晕的缩放 。控制中心光斑周围大光环的半径。

    Parameters

    • value: number

    Returns void

    Memberof

    LensFlareEffect

inputColorSpace

  • get inputColorSpace(): ColorSpace
  • Experimental

    The input color space.

    Returns ColorSpace

  • set inputColorSpace(arg): void
  • Protected Experimental

    Parameters

    • arg: ColorSpace

    Returns void

lensPosition

  • set lensPosition(value): void

  • 设置炫光在3D 世界中的位置。

    Parameters

    • value: number[] | Vector3

    Returns void

    Memberof

    LensFlareEffect

mainCamera

  • set mainCamera(value): void

  • 设置主相机。

    Parameters

    • value: Camera

    Returns void

    Memberof

    LensFlareEffect

mainScene

  • set mainScene(value): void

  • 设置主场景。

    Parameters

    • value: Scene<Object3DEventMap>

    Returns void

    Memberof

    LensFlareEffect

opacity

  • set opacity(value): void

  • 设置不透明度。

    Parameters

    • value: number

    Returns void

    Memberof

    LensFlareEffect

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

secondaryGhosts

  • set secondaryGhosts(value): void

  • 设置是否显示次级鬼影。

    Parameters

    • value: boolean

    Returns void

    Memberof

    LensFlareEffect

starBurst

  • set starBurst(value): void

  • 设置是否显示星芒爆发效果。

    Parameters

    • value: boolean

    Returns void

    Memberof

    LensFlareEffect

starPoints

  • set starPoints(value): void

  • 设置星芒的点数（角数）。

    Parameters

    • value: number

    Returns void

    Memberof

    LensFlareEffect

Methods

addEventListener

  • 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, LensFlareEffect>

      The function that gets called when the event is fired.

    Returns void

disableOcclusionDetection

  • 禁用指定渲染组件的遮挡检测

    Parameters

    • renderable: Renderable

      渲染组件

    • recursive: boolean

      是否递归

    Returns void

    Memberof

    LensFlareEffect

  • 禁用指定实体的遮挡检测

    Parameters

    • entity: Entity

      实体对象

    • recursive: boolean

      是否递归

    Returns void

    Memberof

    LensFlareEffect

dispatchEvent

  • Fire an event type.

    Type Parameters

    • T extends "change"

    Parameters

    • event: BaseEvent<T> & BaseEventMap[T]

      The event that gets fired.

    Returns void

dispose

  • 释放接口

    Returns void

    Memberof

    LensFlareEffect

enableOcclusionDetection

  • 启用指定渲染组件的遮挡检测

    Parameters

    • renderable: Renderable

      渲染组件

    • recursive: boolean

      是否递归

    Returns void

    Memberof

    LensFlareEffect

  • 启用指定实体的遮挡检测

    Parameters

    • entity: Entity

      实体对象

    • recursive: boolean

      是否递归

    Returns void

    Memberof

    LensFlareEffect

getAttributes

getBlendMode

  • 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.

getDefines

  • Returns the preprocessor macro definitions.

    Returns Map<string, string>

    The extensions.

    Deprecated

    Use defines instead.

getExtensions

getFragmentShader

  • Returns the fragment shader.

    Returns string

    The fragment shader.

getName

  • Returns the name of this effect.

    Returns string

    The name.

    Deprecated

    Use name instead.

getUniforms

  • Returns the uniforms of this effect.

    Returns Map<string, Uniform<any>>

    The extensions.

    Deprecated

    Use uniforms instead.

getVertexShader

  • Returns the vertex shader.

    Returns string

    The vertex shader.

hasEventListener

  • 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, LensFlareEffect>

      The function that gets called when the event is fired.

    Returns boolean

initialize

  • 初始化效果

    Parameters

    • renderer: WebGLRenderer

      渲染器

    • alpha: boolean

      是否使用透明通道

    • frameBufferType: number

      帧缓冲区类型

    Returns void

    Memberof

    LensFlareEffect

removeEventListener

  • 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, LensFlareEffect>

      The listener function that gets removed.

    Returns void

Protected setAttributes

  • 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

    Returns void

Protected setChanged

  • 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

setDepthTexture

  • 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

Protected setFragmentShader

  • Protected

    Sets the fragment shader.

    Parameters

    • fragmentShader: string

      The fragment shader.

    Returns void

setRenderer

  • Sets the renderer.

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    Returns void

    Deprecated

setSize

  • 设置效果尺寸

    Parameters

    • width: number

      宽度（单位：像素）

    • height: number

      高度（单位：像素）

    Returns void

    Memberof

    LensFlareEffect

Protected setVertexShader

  • Protected

    Sets the vertex shader.

    Parameters

    • vertexShader: string

      The vertex shader.

    Returns void

toggleOcclusionDetection

  • 切换指定渲染组件的遮挡检测状态

    Parameters

    • renderable: Renderable

      渲染组件

    • recursive: boolean

      是否递归

    Returns void

    Memberof

    LensFlareEffect

  • 切换指定实体的遮挡检测状态

    Parameters

    • entity: Entity

      实体对象

    • recursive: boolean

      是否递归

    Returns void

    Memberof

    LensFlareEffect

update

  • 更新效果

    Parameters

    • renderer: WebGLRenderer

      渲染器

    • inputBuffer: WebGLRenderTarget<Texture<unknown>>

      输入缓冲

    • Optional deltaTime: number

      距离上一帧的时间间隔（单位：秒）

    Returns void

    Memberof

    LensFlareEffect

Settings

Member Visibility

Theme

On This Page