Log inGet started
Package

watercolorBlocks.package

This package holds more than this page lists. See all of its files in its world.

README.md

Fade to paper (styleBlock, Fill)

Lifts far things, fog and the sky toward the bare paper (a pale air wash at most) instead of toward grey, with clouds lifted out of the sky and an optional ragged unpainted margin at the sheet's edges: watercolor aerial perspective and a picture-book border.

Settings: near (15), far (120), amount (0.95), sky (0.6), fog (0.5), air (0.15), skyClouds (0.6), cloudSize (0.55), margin (0), marginSoft (0.12), marginRough (0.5). Low quality changes no setting; like every block it runs at half resolution there.

It reads the frame, depth and the scene's pigment set. Between near and far metres things are mixed as pigment toward a pale air wash (the pigment set's air colour, or bare paper with none); greyed, foggy distance lifts further (fog). The sky is lifted by sky, more toward the horizon, and patches of it are lifted back to bare paper as clouds (skyClouds, cloudSize). With margin above 0 the painting stops at a still, ragged edge of bare paper around the sheet. It sits after the light in the Fill chain (rank 50, stacking chain), so granulation, dry brush and rims come after it and are paler where it lifted.

What it gives up in motion

The fade follows view distance, so things lift and come back smoothly as the camera moves toward and away from them. The lifted clouds are laid on the view direction and stay put in the sky as the camera turns. The margin belongs to the sheet, not to the world: it stays on the screen on purpose and does not move with the camera.

How it treats content

  • Opaque things: lift toward the paper with distance; near things are untouched.
  • Transparent things (glass, water): they lift by the distance of the surface behind them, so a near window over a far view lifts like the view.
  • Particles and smoke: they lift by the distance of what is behind them, so near smoke against the sky lifts as much as the sky.
  • Sky: lifted by sky, paler toward the horizon, with clouds lifted out; at sky 1 it is bare paper.
  • Fog: greyed, low-colour distance lifts further by fog, so the engine's fog becomes mist on paper instead of grey.
  • Skinned characters: lift only when they are far away; a player close to the camera is never faded.
  • Foliage: far trees lift into pale silhouettes, which reads as a painted landscape.
  • World text: far text lifts and loses contrast like anything far; exclude labels a player must read from distance. The margin covers whatever is under it, so keep world labels away from the sheet's edges.
  • Black stays black: it returns through sk_finish, so an unlit pixel is never lifted toward paper, the margin included.

Known limits

  • It runs on the whole frame after antialiasing, so offscreen captures, mirrors and render-to-texture cameras do not show it (#17427).
  • Per-object settings (a style channel or a game role) reach it through the shared object mask, at most eight distinct settings a scene. A per-object value cannot reach a geometry pass, so a per-object look that needs one draws passes of its own (#24549).
  • Its passes are queued again every frame, even when nothing changed (#24548).

The package README's Known limits lists the rest.