FilmPass
Extends:
Indirect Implements:
A film pass.
Provides various cinematic effects.
Constructor Summary
Public Constructor | ||
public |
constructor(options: Object) Constructs a new film pass. |
Member Summary
Private Members | ||
private |
The grid line width. |
|
private |
The grid scale, relative to the screen height. |
|
private |
resolution: Vector2 The original resolution. |
|
private |
The amount of scanlines, relative to the screen height. |
Method Summary
Public Methods | ||
public |
Returns the current grid line width. |
|
public |
Returns the current grid scale. |
|
public |
Returns the current scanline density. |
|
public |
render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, delta: Number, stencilTest: Boolean) Renders the effect. |
|
public |
setGridLineWidth(lineWidth: Number) Sets the grid line width. |
|
public |
setGridScale(scale: Number) Sets the grid scale. |
|
public |
setScanlineDensity(density: Number) Sets the scanline density. |
|
public |
Updates the size of this pass. |
Inherited Summary
From class Pass | ||
public get |
material: Material this get was deprecated. Use getFullscreenMaterial() instead.
The fullscreen material. |
|
protected set |
material: Material this set was deprecated. Use setFullscreenMaterial(Material) instead.
|
|
public |
[key]: * |
|
public |
Indicates whether this pass should be executed. |
|
public |
The name of this pass. |
|
public |
Indicates whether the EffectComposer should swap the frame buffers after this pass has finished rendering. |
|
public |
Indicates whether this pass should render to screen. |
|
protected |
camera: Camera The camera. |
|
protected |
scene: Scene The scene to render. |
|
private |
quad: Mesh A quad mesh that fills the screen. |
|
public |
dispose() Performs a shallow search for disposable properties and deletes them. |
|
public |
getFullscreenMaterial(): Material Returns the current fullscreen material. |
|
public |
initialize(renderer: WebGLRenderer, alpha: Boolean) Performs initialization tasks. |
|
public abstract |
render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, delta: Number, stencilTest: Boolean) Renders the effect. |
|
public |
Updates this pass with the renderer's size. You may override this method in case you want to be informed about the main render size. The EffectComposer calls this method before this pass is initialized and every time its own size is updated. |
|
protected |
setFullscreenMaterial(material: Material) Sets the fullscreen material. |
Public Constructors
public constructor(options: Object) source
Constructs a new film pass.
Override:
Pass#constructorParams:
Name | Type | Attribute | Description |
options | Object |
|
The options. See FilmMaterial for more options. |
options.scanlineDensity | Number |
|
The scanline density, relative to the screen height. |
options.gridScale | Number |
|
The grid scale, relative to the screen height. |
options.gridLineWidth | Number |
|
The grid line width. This value will be added to the base line width. |
Private Members
Public Methods
public render(renderer: WebGLRenderer, inputBuffer: WebGLRenderTarget, outputBuffer: WebGLRenderTarget, delta: Number, stencilTest: Boolean) source
Renders the effect.
Override:
Pass#renderParams:
Name | Type | Attribute | Description |
renderer | WebGLRenderer | The renderer. |
|
inputBuffer | WebGLRenderTarget | A frame buffer that contains the result of the previous pass. |
|
outputBuffer | WebGLRenderTarget | A frame buffer that serves as the output render target unless this pass renders to screen. |
|
delta | Number |
|
The time between the last frame and the current one in seconds. |
stencilTest | Boolean |
|
Indicates whether a stencil mask is active. |
public setGridLineWidth(lineWidth: Number) source
Sets the grid line width.
Params:
Name | Type | Attribute | Description |
lineWidth | Number | The new grid line width. |
public setGridScale(scale: Number) source
Sets the grid scale.
Params:
Name | Type | Attribute | Description |
scale | Number | The new grid scale. |