Struct OverlayRenderOptions 

pub struct OverlayRenderOptions {
    pub draw_labels: bool,
    pub draw_shortcut_overlay: bool,
    pub draw_shield_overlay: bool,
}

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.

The engine passes this struct to DesktopBackend::begin_overlay_session exactly once per animation; the backend uses it while enriching IconRenderPlans and building overlay resources. When a decoration is disabled, the backend also skips the associated Shell COM query (cheaper session start, no wasted work).

Consumers on the Rust side normally build this via OverlayRenderOptions::default() and flip individual fields; Python callers pass the same three booleans as keyword arguments on AnimationOptions.

Fields

draw_labels: bool

Draw the icon title text (label) below each icon.

draw_shortcut_overlay: bool

Composite the Shell overlay-slot badge (shortcut arrow, sharing hand, sync-cloud, …) into each icon bitmap. Backed by SHGetFileInfoW(SHGFI_OVERLAYINDEX) + SHIL_JUMBO extraction — disabling this also skips the Shell query.

draw_shield_overlay: bool

Composite the admin-elevation shield badge (SIID_SHIELD) into each icon bitmap when the item’s IExtractIconW::GetIconLocation(GIL_CHECKSHIELD) reports GIL_SHIELD. Disabling this skips both the shield probe and the blend.

Implementations

impl OverlayRenderOptions

pub const fn all_enabled() -> Self

All decorations on — the default.

pub const fn minimal() -> Self

All decorations off — draw only the base icon bitmaps.

Trait Implementations

impl Clone for OverlayRenderOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for OverlayRenderOptions

impl Debug for OverlayRenderOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OverlayRenderOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for OverlayRenderOptions

impl PartialEq for OverlayRenderOptions

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for OverlayRenderOptions