Log inGet started
Package

inkPaper.styleBlock

README.md

Ink paper (styleBlock, Ground)

Lays the whole picture on a warm white paper with a fine tooth, so light areas read as bare paper and every wash and line above shows the grain.

Settings: paper (warm white), tooth (0.35), fibre (0.3), grainSize (40 cells per metre). As the stack's first Ground block it also publishes the shared ground (paper colour and grain height), which a wash reads to granulate and a line reads to break like dry brush.

What it gives up in motion

The grain is laid in surface coordinates, so it stays on walls and floors as the camera pans and dollies instead of sliding like a screen overlay. The price: on a moving skinned character the grain is taken from world position, so it slides across the body as it moves; and on surfaces seen edge-on the grain stretches. The sky takes its grain from the view direction.

How it treats content

  • Opaque things: multiplied onto paper, grain on their surface.
  • Transparent things (glass, water): multiplied as they appear; the grain is that of the opaque surface behind.
  • Particles and smoke: multiplied; their grain is that of what is behind them.
  • Sky: becomes paper tinted by the sky colour; grain by view direction.
  • Fog: multiplied; fogged distance reads as paper showing through.
  • Skinned characters: multiplied; grain slides on the moving body (see above).
  • Foliage: multiplied like any surface.
  • World text: multiplied; dark text on light stays readable, light text loses a little brightness.
  • Black stays black: paper multiplies the light, it never adds any.

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.