DriftEngine

In-game tools · function

paintOverlay

Draw the overlay, or draw nothing because it is closed.

Explained in In-game tools.

function paintOverlay(painter: OverlayPainter, overlay: ToolsOverlay): void
import { paintOverlay } from '@driftengine/tools';

Parameters

ParameterTypeDescription
painterOverlayPainter
overlayToolsOverlay

In depth

A free function rather than a method, so the overlay itself never holds a painter and a host may draw the same overlay into two surfaces — a screen and a capture — without either knowing.