Class GBufferRenderPass<TP, T>

Type Parameters

TP extends IPassID = IPassID
T extends WebGLMultipleRenderTargets | WebGLRenderTarget | undefined = WebGLMultipleRenderTargets | WebGLRenderTarget

Hierarchy

RenderPass
- GBufferRenderPass

Implements

IPipelinePass<TP>

Index

Constructors

Properties

after? before? enabled isGBufferRenderPass passId required? scene? target uiConfig

Methods

beforeRender preprocessMaterial render

Constructors

constructor

new GBufferRenderPass<
    TP extends string = string,
    T extends
        undefined | WebGLRenderTarget | WebGLMultipleRenderTargets =
        | WebGLRenderTarget
        | WebGLMultipleRenderTargets,
>(
    passId: TP,
    target: ValOrFunc<T>,
    material: Material,
    clearColor?: Color,
    clearAlpha?: number,
): GBufferRenderPass<TP, T>
Type Parameters
- TP extends string = string
- T extends undefined | WebGLRenderTarget | WebGLMultipleRenderTargets = WebGLRenderTarget | WebGLMultipleRenderTargets
Parameters
- passId: TP
- target: ValOrFunc<T>
- material: Material
- clearColor: Color = ...
- clearAlpha: number = 1
Returns GBufferRenderPass<TP, T>
Overrides RenderPass.constructor
- Defined in src/postprocessing/GBufferRenderPass.ts:20

Properties

`Optional`after

after?: string[]

Passes that should run before this pass

`Optional`before

before?: string[]

Passes that should run after this pass

enabled

enabled: boolean = true

`Readonly`isGBufferRenderPass

isGBufferRenderPass: true

`Readonly`passId

passId: TP

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

`Optional`required

required?: string[]

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

`Optional`scene

scene?: IScene

target

target: ValOrFunc<T>

uiConfig

uiConfig: UiObjectConfig

Methods

beforeRender

beforeRender(scene: IScene, camera: ICamera, _: IRenderManager): void
This function gets called at the beginning of every frame where this pass would be enabled.
Parameters
- scene: IScene
- camera: ICamera
- _: IRenderManager
Returns void
Implementation of IPipelinePass.beforeRender
- Defined in src/postprocessing/GBufferRenderPass.ts:89

preprocessMaterial

preprocessMaterial(material: IMaterial, renderToGBuffer?: boolean): void
Parameters
- material: IMaterial
- OptionalrenderToGBuffer: boolean
Returns void
- Defined in src/postprocessing/GBufferRenderPass.ts:27

render

render(
    renderer: IWebGLRenderer,
    _?: null | WebGLRenderTarget | WebGLMultipleRenderTargets,
    _1?: WebGLRenderTarget | WebGLMultipleRenderTargets,
    deltaTime?: number,
    maskActive?: boolean,
): void
Renders to target
Parameters
- renderer: IWebGLRenderer
- Optional_: null | WebGLRenderTarget | WebGLMultipleRenderTargets
  this is ignored
- Optional_1: WebGLRenderTarget | WebGLMultipleRenderTargets
  this is ignored
- OptionaldeltaTime: number
- OptionalmaskActive: boolean
Returns void
Implementation of IPipelinePass.render
Overrides RenderPass.render
- Defined in src/postprocessing/GBufferRenderPass.ts:56