Home Reference Source
import {TiltShiftBlurPass} from 'postprocessing'
public class | source

TiltShiftBlurPass

Extends:

PassKawaseBlurPass → TiltShiftBlurPass

Indirect Implements:

A tilt shift blur pass.

Constructor Summary

Public Constructor
public

constructor(options: Object)

Constructs a new Kawase blur pass.

Member Summary

Public Members
public

Inherited Summary

From class Pass
public get

fullscreenMaterial: Material

The fullscreen material.

public set
public set

mainCamera: Camera

Sets the main camera.

public set

mainScene: Scene

Sets the main scene.

public get

Sets the render to screen flag.

public set
public

Indicates whether this pass is enabled.

public

The name of this pass.

public

Only relevant for subclassing.

public

Only relevant for subclassing.

protected

camera: Camera

The camera.

protected

renderer: WebGLRenderer

this member was deprecated.

The renderer.

protected

scene: Scene

The scene to render.

public

Performs a shallow search for disposable properties and deletes them.

public

getDepthTexture(): Texture

Returns the current depth texture.

public

getFullscreenMaterial(): Material

this method was deprecated. Use fullscreenMaterial instead.

Returns the current fullscreen material.

public

initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number)

Performs initialization tasks.

public
this method was deprecated. Use enabled instead.

Indicates whether this pass is enabled.

public abstract

render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean)

Renders this pass.

public

setDepthTexture(depthTexture: Texture, depthPacking: DepthPackingStrategy)

Sets the depth texture.

public
this method was deprecated. Use enabled instead.

Enables or disables this pass.

public

setRenderer(renderer: WebGLRenderer)

this method was deprecated.

Sets the renderer

public

setSize(width: Number, height: Number)

Sets the size.

protected

setFullscreenMaterial(value: Material)

this method was deprecated. Use fullscreenMaterial instead.

Sets the fullscreen material.

From class KawaseBlurPass
public static get
this get was deprecated. Use {@link Resolution.AUTO_SIZE} instead.

An auto sizing flag.

public get

The blur material.

public get
this get was deprecated. Use copyMaterial.dithering instead.

Indicates whether dithering is enabled.

public set
public get
this get was deprecated. Use resolution.height instead.

The current height of the internal render targets.

public set
this set was deprecated. Use resolution.preferredHeight instead.

Sets the render height.

public get
this get was deprecated. Use blurMaterial.kernelSize instead.

The kernel size.

public set
public get
this get was deprecated. Use blurMaterial.scale instead.

The current blur scale.

public set
public get
this get was deprecated. Use resolution.width instead.

The current width of the internal render targets.

public set
this set was deprecated. Use resolution.preferredWidth instead.

Sets the render width.

protected set

The blur material.

public

A copy material.

public
public
this method was deprecated. Use blurMaterial.kernelSize instead.

Returns the kernel size.

public
this method was deprecated. Use resolution instead.

Returns the resolution settings.

public
this method was deprecated. Use resolution instead.

Returns the current resolution scale.

public
this method was deprecated. Use blurMaterial.scale instead.

Returns the current blur scale.

public

initialize(renderer: WebGLRenderer, alpha: Boolean, frameBufferType: Number)

Performs initialization tasks.

public

render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, deltaTime: Number, stencilTest: Boolean)

Renders the blur.

public
this method was deprecated. Use blurMaterial.kernelSize instead.

Sets the kernel size.

public
this method was deprecated. Use resolution instead.

Sets the resolution scale.

public

setScale(value: Number)

this method was deprecated. Use blurMaterial.scale instead.

Sets the blur scale.

public

setSize(width: Number, height: Number)

Updates the size of this pass.

Public Constructors

public constructor(options: Object) source

Constructs a new Kawase blur pass.

Override:

KawaseBlurPass#constructor

Params:

NameTypeAttributeDescription
options Object
  • optional

The options.

options.offset Number
  • optional
  • default: 0.0

The relative offset of the focus area.

options.rotation Number
  • optional
  • default: 0.0

The rotation of the focus area in radians.

options.focusArea Number
  • optional
  • default: 0.4

The relative size of the focus area.

options.feather Number
  • optional
  • default: 0.3

The softness of the focus area edges.

options.kernelSize KernelSize
  • optional
  • default: KernelSize.MEDIUM

The blur kernel size.

options.resolutionScale Number
  • optional
  • default: 0.5

The resolution scale.

options.resolutionX Number
  • optional
  • default: Resolution.AUTO_SIZE

The horizontal resolution.

options.resolutionY Number
  • optional
  • default: Resolution.AUTO_SIZE

The vertical resolution.

Public Members

public blurMaterial: * source

The blur material.

Override:

KawaseBlurPass#blurMaterial