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	focalLength: Number this get was deprecated. Renamed to focusRange. The focal length.
public set	focalLength
public get	focusDistance: Number The focus distance.
public set	focusDistance
public get	focusRange: Number The focus range.
public set	focusRange
public	needsUpdate: boolean
public get	worldFocusDistance: Number The focus distance in world units.
public set	worldFocusDistance
public get	worldFocusRange: Number The focus range in world units.
public set	worldFocusRange

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	getFocusDistance(value: *): Number 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	setFocalLength(value: Number) this method was deprecated. Use focusRange instead. Sets the focal length.
public	setFocusDistance(value: Number) this method was deprecated. Use focusDistance instead. Sets the focus distance.

Public Constructors

public constructor(camera: Camera) source

Constructs a new CoC material.

Params:

Name	Type	Attribute	Description
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:

Name	Type	Attribute	Description
camera	Camera		A camera.

public copyCameraSettings(camera: Camera) source

Copies the settings of the given camera.

Params:

Name	Type	Attribute	Description
camera	Camera		A camera.

public getFocalLength(value: *): Number source

this method was deprecated. Use focusRange instead.

Returns the focal length.

Params:

Name	Type	Attribute	Description
value	*

Return:

Number

The focal length.

public getFocusDistance(value: *): Number source

this method was deprecated. Use focusDistance instead.

Returns the focus distance.

Params:

Name	Type	Attribute	Description
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:

Name	Type	Attribute	Description
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:

Name	Type	Attribute	Description
value	Number		The focal length.

public setFocusDistance(value: Number) source

this method was deprecated. Use focusDistance instead.

Sets the focus distance.

Params:

Name	Type	Attribute	Description
value	Number		The focus distance.