@animech-public/playcanvas
Version:
PlayCanvas WebGL game engine
74 lines (73 loc) • 3.86 kB
TypeScript
/**
* A render pass used render a set of layers using a camera.
*
* @ignore
*/
export class RenderPassForward extends RenderPass {
constructor(device: any, layerComposition: any, scene: any, renderer: any);
/**
* @type {import('../composition/layer-composition.js').LayerComposition}
*/
layerComposition: import("../composition/layer-composition.js").LayerComposition;
/**
* @type {import('../scene.js').Scene}
*/
scene: import("../scene.js").Scene;
/**
* @type {import('./renderer.js').Renderer}
*/
renderer: import("./renderer.js").Renderer;
/**
* @type {import('../composition/render-action.js').RenderAction[]}
*/
renderActions: import("../composition/render-action.js").RenderAction[];
/**
* If true, do not clear the depth buffer before rendering, as it was already primed by a depth
* pre-pass.
*
* @type {boolean}
*/
noDepthClear: boolean;
addRenderAction(renderAction: any): void;
/**
* Adds a layer to be rendered by this render pass.
*
* @param {import('../../framework/components/camera/component.js').CameraComponent} cameraComponent -
* The camera component that is used to render the layers.
* @param {import('../layer.js').Layer} layer - The layer to be added.
* @param {boolean} transparent - True if the layer is transparent.
* @param {boolean} autoClears - True if the render target should be cleared based on the camera
* and layer clear flags. Defaults to true.
*/
addLayer(cameraComponent: import("../../framework/components/camera/component.js").CameraComponent, layer: import("../layer.js").Layer, transparent: boolean, autoClears?: boolean): void;
/**
* Adds layers to be rendered by this render pass, starting from the given index of the layer
* in the layer composition, till the end of the layer list, or till the last layer with the
* given id and transparency is reached (inclusive). Note that only layers that are enabled
* and are rendered by the specified camera are added.
*
* @param {import('../composition/layer-composition.js').LayerComposition} composition - The
* layer composition containing the layers to be added, typically the scene layer composition.
* @param {import('../../framework/components/camera/component.js').CameraComponent} cameraComponent -
* The camera component that is used to render the layers.
* @param {number} startIndex - The index of the first layer to be considered for adding.
* @param {boolean} firstLayerClears - True if the first layer added should clear the render
* target.
* @param {number} [lastLayerId] - The id of the last layer to be added. If not specified, all
* layers till the end of the layer list are added.
* @param {boolean} [lastLayerIsTransparent] - True if the last layer to be added is transparent.
* Defaults to true.
* @returns {number} Returns the index of last layer added.
*/
addLayers(composition: import("../composition/layer-composition.js").LayerComposition, cameraComponent: import("../../framework/components/camera/component.js").CameraComponent, startIndex: number, firstLayerClears: boolean, lastLayerId?: number, lastLayerIsTransparent?: boolean): number;
updateDirectionalShadows(): void;
updateClears(): void;
/**
* @param {import('../composition/render-action.js').RenderAction} renderAction - The render
* action.
* @param {boolean} firstRenderAction - True if this is the first render action in the render pass.
*/
renderRenderAction(renderAction: import("../composition/render-action.js").RenderAction, firstRenderAction: boolean): void;
log(device: any, index: any): void;
}
import { RenderPass } from '../../platform/graphics/render-pass.js';