Renderer · interface
SurfaceOverlay
What a draw lays over its surface beyond its material, for setSurfaceOverlay: a rim, a dissolve
and wrinkles, each optional, and the atlas their images are regions of.
Explained in Hello world.
interface SurfaceOverlayimport type { SurfaceOverlay } from '@driftengine/core';Properties
| Name | Type | Description |
|---|---|---|
mapsreadonlyoptional | SurfaceTextureHandle | The atlas every image above is a region of. Absent: no image is read whatever regions are named — rims are smooth, nothing dissolves and nothing wrinkles — because the slot then holds a stand-in whose colour would read as a noise and a mask. |
rimreadonlyoptional | SurfaceRim | |
dissolvereadonlyoptional | SurfaceDissolve | |
wrinklereadonlyoptional | SurfaceWrinkle |