Class: RenderEngine
- Last UpdatedMay 21, 2025
- 3 minute read
This is an abstract class representing a render engine. Render engines are used to render the geographical position from a view model on the screen (viewport element). The rendered result may be different for different engines, because every engine uses its own capabilities and specific implementation to present the current view model data in best possible way. For example, P2D engine creates a two-dimensional flat map composed of raster tiles, while WEBGL engine can render 3D scene based on vector tiles.
A RenderEngine
is responsible for managing the rendering loop
as well as for synchronizing rendered data with the view model and the data model.
It manages what is rendered inside the current viewport and how.
Extends
Implements
Members
-
This object defines the modifiers to use for
H.map.ViewPort#startInteraction
.Properties:
Methods
-
addEventListener (type, handler, opt_capture, opt_scope) inherited
-
This method adds a listener for a specific event.
Note that to prevent potential memory leaks, you must either call
removeEventListener
ordispose
on the given object when you no longer need it. -
addOnDisposeCallback (callback, opt_scope) inherited
-
This method adds a callback which is triggered when the
EventTarget
object is being disposed.Name Type Description callback
function The callback function.
opt_scope
Object optional An optional scope for the callback function
-
dispatchEvent (evt) inherited
-
This method dispatches an event on the
EventTarget
object.Name Type Description evt
H.util.Event | string An object representing the event or a string with the event name
-
dispose () inherited
-
This method removes listeners from the given object. Classes that extend
EventTarget
may need to override this method in order to remove references to DOM Elements and additional listeners. -
removeEventListener (type, handler, opt_capture, opt_scope) inherited
-
This method removes a previously added listener from the
EventTarget
instance.
Type Definitions
-
Options which may be used to initialize new RenderEngine instance.
Properties:
Name Type Description pixelRatio
number The pixelRatio to use for over-sampling in cases of high-resolution displays
Events
-
Fired when one of the layers or the engine (all layers) has been rendered completely. The event target references either the completed layer or the render engine itself.
Type: