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

CircleOfConfusionMaterial

Extends:

three~ShaderMaterial → CircleOfConfusionMaterial

A Circle of Confusion shader material.

Constructor Summary

Public Constructor
public

constructor(camera: Camera)

Constructs a new CoC material.

Member Summary

Public Members
public set

depthBuffer: Texture

The depth buffer.

public set

depthPacking: DepthPackingStrategies

The depth packing strategy.

public get
this get was deprecated. Renamed to focusRange.

The focal length.

public set
public get

The focus distance.

public set
public get

The focus range.

public set
public
public get

The focus distance in world units.

public set
public get

The focus range in world units.

public set

Method Summary

Public Methods
public

adoptCameraSettings(camera: Camera)

this method was deprecated. Use copyCameraSettings instead.

Copies the settings of the given camera.

public

copyCameraSettings(camera: Camera)

Copies the settings of the given camera.

public

getFocalLength(value: *): Number

this method was deprecated. Use focusRange instead.

Returns the focal length.

public
this method was deprecated. Use focusDistance instead.

Returns the focus distance.

public

setDepthBuffer(buffer: Texture, depthPacking: DepthPackingStrategies)

this method was deprecated. Use depthBuffer and depthPacking instead.

Sets the depth buffer.

public
this method was deprecated. Use focusRange instead.

Sets the focal length.

public
this method was deprecated. Use focusDistance instead.

Sets the focus distance.

Public Constructors

public constructor(camera: Camera) source

Constructs a new CoC material.

Params:

NameTypeAttributeDescription
camera Camera

A camera.

Public Members

public set depthBuffer: Texture source

The depth buffer.

public set depthPacking: DepthPackingStrategies source

The depth packing strategy.

public get focalLength: Number source

this get was deprecated. Renamed to focusRange.

The focal length.

public set focalLength source

public get focusDistance: Number source

The focus distance. Range: [0.0, 1.0].

public set focusDistance source

public get focusRange: Number source

The focus range. Range: [0.0, 1.0].

public set focusRange source

public needsUpdate: boolean source

public get worldFocusDistance: Number source

The focus distance in world units.

public set worldFocusDistance source

public get worldFocusRange: Number source

The focus range in world units.

public set worldFocusRange source

Public Methods

public adoptCameraSettings(camera: Camera) source

this method was deprecated. Use copyCameraSettings instead.

Copies the settings of the given camera.

Params:

NameTypeAttributeDescription
camera Camera

A camera.

public copyCameraSettings(camera: Camera) source

Copies the settings of the given camera.

Params:

NameTypeAttributeDescription
camera Camera

A camera.

public getFocalLength(value: *): Number source

this method was deprecated. Use focusRange instead.

Returns the focal length.

Params:

NameTypeAttributeDescription
value *

Return:

Number

The focal length.

public getFocusDistance(value: *): Number source

this method was deprecated. Use focusDistance instead.

Returns the focus distance.

Params:

NameTypeAttributeDescription
value *

Return:

Number

The focus distance.

public setDepthBuffer(buffer: Texture, depthPacking: DepthPackingStrategies) source

this method was deprecated. Use depthBuffer and depthPacking instead.

Sets the depth buffer.

Params:

NameTypeAttributeDescription
buffer Texture

The depth texture.

depthPacking DepthPackingStrategies
  • optional
  • default: BasicDepthPacking

The depth packing strategy.

public setFocalLength(value: Number) source

this method was deprecated. Use focusRange instead.

Sets the focal length.

Params:

NameTypeAttributeDescription
value Number

The focal length.

public setFocusDistance(value: Number) source

this method was deprecated. Use focusDistance instead.

Sets the focus distance.

Params:

NameTypeAttributeDescription
value Number

The focus distance.