Skip to main content

Module overlay_plan

Module overlay_plan 

Source
Expand description

Animation-renderer-visible types.

Part of the transparent-overlay animation architecture. These types describe the per-icon rendering plan the engine hands to the backend at the start of every animation, plus the outcome of the final Shell commit.

Everything in this module is plain data (no callbacks, no COM types) so it is safe to build on any thread. Backends turn it into platform-specific overlay resources on the worker thread.

§Field responsibilities

The IconRenderPlan is a shared build target — the engine fills in the fields it knows about, and the backend enriches the ones it knows how to source from the platform. Specifically:

FieldWritten by
idEngine (from IconAnimationSpec)
source_positionEngine (from list_icons snapshot)
final_positionEngine (from IconAnimationSpec::target)
size_pxEngine sets a fallback; backend refines
imageBackend — None if not resolvable
labelBackend — None if not resolvable
selectedBackend
focusedBackend

Structs§

FinalCommitOutcome
Outcome of the final Shell commit issued by DesktopBackend::finalize_overlay_session.
IconBitmap
Premultiplied BGRA icon bitmap the renderer can upload directly to a GPU texture / Direct2D bitmap.
IconLabel
Label metadata for an icon.
IconRenderPlan
Per-icon rendering plan the engine hands to DesktopBackend::begin_overlay_session.
OverlayRenderOptions
Global feature toggles for the overlay renderer, so callers can request a minimal / stylised look without patching the backend. All fields default to true — draw everything Explorer does.
SnapshotFrame
Off-screen render output from DesktopBackend::render_overlay_snapshot.
SnapshotIconGeometry
Per-icon paint geometry captured during SnapshotFrame rendering.