Back to Node List

Reveal

reveal

Progressively reveals an image using a grayscale progress map

Reviewed
Guide available
The node name and summary are available in English. Port, parameter, and article details are currently shown in Japanese.

Input Ports

NameTypeDescription
画像
image
Image
Required
表示するソース画像
プログレスマップ
map
Image
Required
グレースケールマップ: 暗いピクセルが先に表示、明るいピクセルが後に表示

Output Ports

NameTypeDescription
画像
output
Image
リビール結果(未表示部分は透明)

Parameters

NameTypeDefaultRangeDescription / Options
進行度
progress
Float
0.50–1 / step 0.01

表示の進行度(0 = 非表示、1 = 完全表示)

境界ぼかし
edge_softness
Float
00–0.2 / step 0.005

表示境界のぼかし量(0 = くっきり、0.2 = かなりぼかし)

反転
invert
Bool
false

マップを反転(明るいピクセルが先に表示されます)

モード
mode
Enum
Reveal

表示モード

  • リビールReveal
    マップ値 ≤ 進行度 のピクセルを表示
  • トレイルTrail
    進行度の境界付近のピクセルのみ表示(光る玉の軌跡)
トレイル幅
trail_width
Float
0.050.01–0.3 / step 0.01

トレイルの帯幅(トレイルモードのみ適用)

Overview

Progressively reveals an image according to a grayscale display-order map. Pixels appear from darker map areas to lighter ones, so one progress value can drive animation such as wipes, replayed drawing order, or an unfolding magic circle.

Usage tips

  • The basic setup is: image + map → Reveal; promote progress to an input pin 📌 and connect Time Source → Animation Render. The map determines the entire effect.
  • Example maps: left-to-right gradient = wipe, radial gradient from the center = circular expansion, noise = dissolve, hand-drawn map = any desired reveal order.
  • Trail mode displays only a band at the boundary, turning the result into an effect like light tracing a path. trail_width controls the band thickness.
  • For stepped, pixel-art-like progress with N steps, quantize it as floor(progress × N) ÷ N. Applying Floor directly to a 0–1 value leaves almost the entire range at zero.
  • In Reveal mode, progress = 0 is fully transparent and progress = 1 is an exact input-image result. edge_softness does not turn either endpoint into a partial reveal.

Common pitfalls

  • Confusing it with a mask: the map is not binary black and white; brightness = display order. A binary map reveals everything at once. If that is the desired result, use mask.

Related nodes

  • gradient generators in the gradient_map family / noise_generate — map sources
  • animation_render — bake into animation
  • opacity — fade the whole image uniformly
  • mask — a simple cutout with no order

Modes

Value Name Description
Reveal Reveal Cumulatively displays pixels whose map value ≤ progress
Trail Trail Displays only pixels near the progress boundary (a moving band of light)

Examples

  • Completed image + grayscale map → Reveal (Reveal) → Animation Render — drawing-order animation
  • Same setup with mode=Trail → a glowing orb moving along a path
  • Use a Solid Color black-to-white gradient as the map → left-to-right wipe
  • Hand-draw a map in Pixel Canvas → animation appearing in any order

Notes

  • Reveal reads a progress map with a display order, not a black-and-white mask.
  • Even if it looks black and white, the relative brightness itself carries meaning, so treat it as a Map rather than a Mask.
  • The map is sampled at its original size from the top-left. Areas beyond a smaller map are black, or white after invert is applied.
Back to Node List
Reveal — PixPipeline Node Reference