Interface IPass

The interface for the Pass class.

Hierarchy

IPass

Implemented by

Index

Properties

Methods

Properties

enabled

enabled: boolean

Whether the Pass instance is active or not.

default: true.

renderToScreen

renderToScreen: boolean

Whether the render method should target a WebGLRenderTarget instance, or the frame buffer.

default: false.

Methods

render

render(renderer: WebGLRenderer, scene: Scene, camera: Camera, writeBuffer: WebGLRenderTarget | null, readBuffer: WebGLRenderTarget | null, delta?: undefined | number): void

- Defined in @here/harp-mapview/lib/composing/Pass.ts:50
The render method to extend in Pass implementations.

remarks

This is the place where the desired effects or render operations are executed.

Parameters
- renderer: WebGLRenderer
  
  The WebGLRenderer instance in use.
- scene: Scene
  
  The scene to render.
- camera: Camera
  
  The camera to render the scene through.
- writeBuffer: WebGLRenderTarget | null
  
  The optional WebGLRenderTarget instance to write to.
- readBuffer: WebGLRenderTarget | null
  
  The optional WebGLRenderTarget instance of a previous pass to write onto.
- Optional delta: undefined | number
  
  The time argument from the requestAnimationFrame.
Returns void

setSize

setSize(width: number, height: number): void

- Defined in @here/harp-mapview/lib/composing/Pass.ts:34
The resize method to extend in Pass implementations.

remarks

It resizes the render targets. Call on resize events.

Parameters
- width: number
  
  Width to resize to.
- height: number
  
  Height to resize to.
Returns void

Generated using TypeDoc