Class PostEffectPass

Index

Constructors

Accessors

uniforms backbuffer persistent float size scene

Methods

setUniforms updateCustomUniforms initializeBackbuffer resizeBackbuffer registerBufferUniform getTargetDimensions

Constructors

constructor

new PostEffectPass(
    fragmentShader: string,
    uniforms?: VFXUniforms,
    persistent?: boolean,
    float?: boolean,
    size?: [number, number],
    hasBufferTarget?: boolean,
): PostEffectPass
Parameters
- fragmentShader: string
- Optionaluniforms: VFXUniforms
- Optionalpersistent: boolean
- Optionalfloat: boolean
- Optionalsize: [number, number]
- OptionalhasBufferTarget: boolean
Returns PostEffectPass
- Defined in post-effect-pass.ts:18

Accessors

uniforms

get uniforms(): { [name: string]: IUniform<any> }
Returns { [name: string]: IUniform<any> }
- Defined in post-effect-pass.ts:67

backbuffer

get backbuffer(): undefined | Backbuffer
Returns undefined | Backbuffer
- Defined in post-effect-pass.ts:158

persistent

get persistent(): boolean
Returns boolean
- Defined in post-effect-pass.ts:162

float

get float(): boolean
Returns boolean
- Defined in post-effect-pass.ts:166

size

get size(): undefined | [number, number]
Returns undefined | [number, number]
- Defined in post-effect-pass.ts:170

scene

get scene(): Scene
Returns Scene
- Defined in post-effect-pass.ts:182

Methods

setUniforms

setUniforms(
    tex: Texture,
    pixelRatio: number,
    xywh: GLRect,
    time: number,
    mouseX: number,
    mouseY: number,
): void
Parameters
- tex: Texture
- pixelRatio: number
- xywh: GLRect
- time: number
- mouseX: number
- mouseY: number
Returns void
- Defined in post-effect-pass.ts:71

updateCustomUniforms

updateCustomUniforms(
uniformGenerators?: { [name: string]: () => VFXUniformValue },
): void
Parameters
- OptionaluniformGenerators: { [name: string]: () => VFXUniformValue }
Returns void
- Defined in post-effect-pass.ts:89

initializeBackbuffer

initializeBackbuffer(
    width: number,
    height: number,
    pixelRatio: number,
    floatRTType: TextureDataType,
): void
Parameters
- width: number
- height: number
- pixelRatio: number
- floatRTType: TextureDataType
Returns void
- Defined in post-effect-pass.ts:111

resizeBackbuffer

resizeBackbuffer(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void
- Defined in post-effect-pass.ts:138

registerBufferUniform

registerBufferUniform(name: string): void
Register a named buffer texture as a uniform (for auto-binding).
The texture value will be updated each frame by the render loop.
Parameters
- name: string
Returns void
- Defined in post-effect-pass.ts:152

getTargetDimensions

getTargetDimensions(): undefined | [number, number]
Get target dimensions for this pass.
Returns undefined if no custom size is set (uses viewport resolution).

Returns undefined | [number, number]
- Defined in post-effect-pass.ts:178