Class DepthOfFieldPluginPass<Tid>

Type Parameters

Tid extends IPassID

Hierarchy

ExtendedShaderPass
- DepthOfFieldPluginPass

Implements

IPipelinePass<Tid>

Constructors

constructor

new DepthOfFieldPluginPass<Tid extends string>(
pid: Tid,
): DepthOfFieldPluginPass<Tid>
Type Parameters
- Tid extends string
Parameters
- pid: Tid
Returns DepthOfFieldPluginPass<Tid>
Overrides ExtendedShaderPass.constructor
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/DepthOfFieldPlugin.ts:351

Properties

after

after: string[] = ...

Passes that should run before this pass

before

before: string[] = ...

Passes that should run after this pass

computeCocMaterial

computeCocMaterial: ExtendedShaderMaterial

crossAlpha

crossAlpha: number = 1

crossCenter

crossCenter: Vector2 = ...

crossColor

crossColor: Color = ...

crossRadius

crossRadius: number = 0.04

depthRange

depthRange: number

dofBlurMaterial

dofBlurMaterial: ExtendedShaderMaterial = dofBlurMaterialPoisson

enabled

enabled: boolean = true

expandCocMaterial

expandCocMaterial: ExtendedShaderMaterial

farBlurScale

farBlurScale: number

focalDepthRange

focalDepthRange: Vector2 = ...

`Readonly`isExtendedShaderPass

isExtendedShaderPass: true

material

material: ShaderMaterial2

nearBlurScale

nearBlurScale: number

nearFarBlurScale

nearFarBlurScale: Vector2 = ...

onDirty

onDirty: (() => void)[] = []

overrideReadBuffer

overrideReadBuffer: { texture?: Texture<TextureEventMap> } | null = null

`Readonly`passId

passId: Tid

Unique id for the pass. Used to determine the order of passes in the pipeline.

required

required: string[] = ...

Passes that are required to be present in the pipeline to run this pass.

`Optional`uiConfig

uiConfig?: UiObjectConfig<any, string, any> = undefined

`Static` `Readonly`DEFAULT_TEX_ID

DEFAULT_TEX_ID: "tDiffuse" = 'tDiffuse'

Accessors

isShaderPass2

get isShaderPass2(): boolean
Returns boolean
Deprecated
renamed to isExtendedShaderPass
Inherited from ExtendedShaderPass.isShaderPass2
- Defined in src/postprocessing/ExtendedShaderPass.ts:67

Methods

dispose

dispose(): void
Returns void
Implementation of IPipelinePass.dispose
Inherited from ExtendedShaderPass.dispose
- Defined in src/postprocessing/ExtendedShaderPass.ts:50

render

render(
    renderer: IWebGLRenderer,
    writeBuffer?: WebGLRenderTarget<Texture<TextureEventMap>> | null,
    readBuffer?: WebGLRenderTarget<Texture<TextureEventMap>>,
    deltaTime?: number,
    maskActive?: boolean,
): void
Parameters
- renderer: IWebGLRenderer
- OptionalwriteBuffer: WebGLRenderTarget<Texture<TextureEventMap>> | null
- OptionalreadBuffer: WebGLRenderTarget<Texture<TextureEventMap>>
- OptionaldeltaTime: number
- OptionalmaskActive: boolean
Returns void
Implementation of IPipelinePass.render
Overrides ExtendedShaderPass.render
- Defined in plugins/webgi-plugins/src/plugins/postprocessing/DepthOfFieldPlugin.ts:393

setDirty

setDirty(): void
Set the pass as dirty. This is implementation specific to the pass/plugin. It generally calls all onDirty and set the viewer dirty.

Returns void
Implementation of IPipelinePass.setDirty
Inherited from ExtendedShaderPass.setDirty
- Defined in src/postprocessing/ExtendedShaderPass.ts:56

updateShaderProperties

updateShaderProperties(
    updater?:
        | IShaderPropertiesUpdater
        | (IShaderPropertiesUpdater | undefined)[],
): void
to be called from beforeRender or onObjectRender or similar.
Parameters
- Optionalupdater: IShaderPropertiesUpdater | (IShaderPropertiesUpdater | undefined)[]
Returns void
Inherited from ExtendedShaderPass.updateShaderProperties
- Defined in src/postprocessing/ExtendedShaderPass.ts:43

Class DepthOfFieldPluginPass<Tid>

Type Parameters

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns DepthOfFieldPluginPass<Tid>

Properties

after

before

computeCocMaterial

crossAlpha

crossCenter

crossColor

crossRadius

depthRange

dofBlurMaterial

enabled

expandCocMaterial

farBlurScale

focalDepthRange

ReadonlyisExtendedShaderPass

material

nearBlurScale

nearFarBlurScale

onDirty

overrideReadBuffer

ReadonlypassId

required

OptionaluiConfig

Static ReadonlyDEFAULT_TEX_ID

Accessors

isShaderPass2

Returns boolean

Deprecated

Methods

dispose

Returns void

render

Parameters

Returns void

setDirty

Returns void

updateShaderProperties

Parameters

Returns void

Settings

On This Page

`Readonly`isExtendedShaderPass

`Readonly`passId

`Optional`uiConfig

`Static` `Readonly`DEFAULT_TEX_ID