Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TiltShiftEffect

A tilt shift effect.

Hierarchy

Index

Constructors

  • new TiltShiftEffect([options]?: { bias?: number; blendFunction?: BlendFunction; feather?: number; focusArea?: number; kernelSize?: KernelSize; offset?: number; resolutionScale?: number; resolutionX?: number; resolutionY?: number; rotation?: number }): TiltShiftEffect
  • Constructs a new tilt shift Effect

    Parameters

    • Optional [options]: { bias?: number; blendFunction?: BlendFunction; feather?: number; focusArea?: number; kernelSize?: KernelSize; offset?: number; resolutionScale?: number; resolutionX?: number; resolutionY?: number; rotation?: number }

      The options.

      • Optional bias?: number
      • Optional blendFunction?: BlendFunction
      • Optional feather?: number
      • Optional focusArea?: number
      • Optional kernelSize?: KernelSize
      • Optional offset?: number
      • Optional resolutionScale?: number
      • Optional resolutionX?: number
      • Optional resolutionY?: number
      • Optional rotation?: number

    Returns TiltShiftEffect

Properties

blendMode: BlendMode

The blend mode of this effect.

blurPass: KawaseBlurPass

A blur pass.

defines: Map<string, string>

Preprocessor macro definitions.

Call Effect.setChanged after changing macro definitions.

extensions: Set<WebGLExtension>

WebGL extensions that are required by this effect.

Call Effect.setChanged after adding or removing extensions.

name: string

The name of this effect.

renderer: WebGLRenderer

The renderer.

deprecated
uniforms: Map<string, Uniform<any>>

Shader uniforms.

Call Effect.setChanged after adding or removing uniforms.

Accessors

  • get bias(): number
  • set bias(arg: number): void
  • A blend bias.

    deprecated

    Returns number

  • A blend bias.

    deprecated

    Parameters

    • arg: number

    Returns void

  • get feather(): number
  • set feather(arg: number): void
  • The softness of the focus area edges.

    Returns number

  • The softness of the focus area edges.

    Parameters

    • arg: number

    Returns void

  • get focusArea(): number
  • set focusArea(arg: number): void
  • The relative size of the focus area.

    Returns number

  • The relative size of the focus area.

    Parameters

    • arg: number

    Returns void

  • get inputColorSpace(): ColorSpace
  • set inputColorSpace(arg: ColorSpace): void
  • The input color space.

    experimental

    Returns ColorSpace

  • The input color space.

    experimental

    Parameters

    • arg: ColorSpace

    Returns void

  • set mainCamera(arg: Camera): void
  • Sets the main camera.

    Parameters

    • arg: Camera

    Returns void

  • set mainScene(arg: Scene): void
  • Sets the main scene.

    Parameters

    • arg: Scene

    Returns void

  • get offset(): number
  • set offset(arg: number): void
  • The relative offset of the focus area.

    Returns number

  • The relative offset of the focus area.

    Parameters

    • arg: number

    Returns void

  • get outputColorSpace(): ColorSpace
  • set outputColorSpace(arg: ColorSpace): void
  • The output color space.

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

    experimental

    Returns ColorSpace

  • The output color space.

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

    experimental

    Parameters

    • arg: ColorSpace

    Returns void

  • get rotation(): number
  • set rotation(arg: number): void
  • The rotation of the focus area in radians.

    Returns number

  • The rotation of the focus area in radians.

    Parameters

    • arg: number

    Returns void

Methods

  • addEventListener<T>(type: T, listener: EventListener<Event<string, unknown>[T], T, TiltShiftEffect>): void
  • addEventListener<T>(type: T, listener: EventListener<{}, T, TiltShiftEffect>): 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, TiltShiftEffect>

      The function that gets called when the event is fired.

    Returns void

  • Type Parameters

    • T extends string

    Parameters

    Returns void

  • dispatchEvent<T>(event: BaseEvent<T> & Event<string, unknown>[T]): 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(): 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(): EffectAttribute
  • Returns the effect attributes.

    Returns EffectAttribute

    The attributes.

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

    deprecated

    Use blendMode instead.

    Returns BlendMode

    The blend mode.

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

    deprecated

    Use defines instead.

    Returns Map<string, string>

    The extensions.

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

    deprecated

    Use extensions instead.

    Returns Set<WebGLExtension>

    The extensions.

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

    deprecated

    Use name instead.

    Returns string

    The name.

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

    deprecated

    Use uniforms instead.

    Returns Map<string, Uniform<any>>

    The extensions.

  • getVertexShader(): string
  • hasEventListener<T>(type: T, listener: EventListener<Event<string, unknown>[T], T, TiltShiftEffect>): boolean
  • hasEventListener<T>(type: T, listener: EventListener<{}, T, TiltShiftEffect>): 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, TiltShiftEffect>

      The function that gets called when the event is fired.

    Returns boolean

  • Type Parameters

    • T extends string

    Parameters

    Returns boolean

  • initialize(renderer: WebGLRenderer, alpha: boolean, frameBufferType: number): void
  • Performs initialization tasks.

    This method is called when the associated {@link EffectPass} is added to an EffectComposer.

    example

    if(!alpha && frameBufferType === UnsignedByteType) { this.myRenderTarget.texture.format = RGBFormat; }

    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

  • removeEventListener<T>(type: T, listener: EventListener<Event<string, unknown>[T], T, TiltShiftEffect>): void
  • removeEventListener<T>(type: T, listener: EventListener<{}, T, TiltShiftEffect>): 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, TiltShiftEffect>

      The listener function that gets removed.

    Returns void

  • Type Parameters

    • T extends string

    Parameters

    Returns void

  • setAttributes(attributes: EffectAttribute): void
  • 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

  • setChanged(): void
  • Informs the associated {@link EffectPass} that this effect requires a shader recompilation.

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

    Returns void

  • setDepthTexture(depthTexture: Texture, depthPacking?: DepthPackingStrategies): 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 {@link EffectPass}.

    Parameters

    • depthTexture: Texture

      A depth texture.

    • Optional depthPacking: DepthPackingStrategies

    Returns void

  • setFragmentShader(fragmentShader: string): void
  • Sets the fragment shader.

    Parameters

    • fragmentShader: string

      The fragment shader.

    Returns void

  • setRenderer(renderer: WebGLRenderer): void
  • Sets the renderer.

    deprecated

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    Returns void

  • setSize(width: number, height: number): void
  • Updates the size of this effect.

    You may override this method if you want to be informed about the size of the backbuffer/canvas. This method is called before initialize and every time the size of the EffectComposer changes.

    Parameters

    • width: number

      The width.

    • height: number

      The height.

    Returns void

  • setVertexShader(vertexShader: string): void
  • Sets the vertex shader.

    Parameters

    • vertexShader: string

      The vertex shader.

    Returns void

  • update(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget<Texture>, deltaTime?: number): void
  • Updates this effect by performing supporting operations.

    This method is called by the {@link EffectPass} right before the main fullscreen render operation, even if the blend function is set to SKIP.

    You may override this method if you need to update custom uniforms or render additional off-screen textures.

    Parameters

    • renderer: WebGLRenderer

      The renderer.

    • inputBuffer: WebGLRenderTarget<Texture>

      A frame buffer that contains the result of the previous pass.

    • Optional deltaTime: number

    Returns void