rusty_desktop_icons¶

Exceptions¶

`AnimationBusy`	Raised when a caller asks for exclusive animation access but another animation is already running.
`BackendUnavailable`	Raised when the desktop backend could not be initialised or acquired.
`ComError`	Raised when a COM / Win32 call returned a failure HRESULT.
`IconNotFound`	Raised when a requested icon id is not present on the desktop.
`InvalidCurve`	Raised when a curve fails validation or a sampled Python callable returned an unusable value.
`InvalidDuration`	Raised when a Duration policy cannot be resolved.
`InvalidEffect`	Invalid shader source or effect configuration.
`InvalidGrid`	Unavailable grid geometry or no collision-free destination.
`RustyDesktopError`	Base class for all errors raised by rusty-desktop-icons.
`UnsupportedPlatform`	Raised when no compiled backend supports the current OS.
`WorkerCrashed`	Raised when the animation worker thread has stopped unexpectedly.

Classes¶

`AnimationHandle`	Handle returned by [DesktopController.animate].
`AnimationOptions`	Global animation options.
`AnimationPreset`	Platform-independent movement, strength envelope and duration values.
`BuiltinShader`	Built-in shader sources; compilation requires Windows.
`Canvas`	Off-screen dimensions in physical pixels; icon_size is the baseline DIP slot size.
`CapturedFrame`	Owned, tightly packed premultiplied BGRA pixels. Convert alpha before saving PNG.
`Curve`	Animation curve.
`CurveKind`	Representation of an animation curve.
`DesktopController`	Top-level entry point for animating the current user's desktop.
`DesktopInfo`
`Duration`	Duration policy for an animation.
`DurationKind`	How an animation duration is resolved.
`Effect`
`EffectParameter`
`FinalCommitOutcome`	Result of the Shell-side final commit at the end of an animation.
`FinishReason`	Why an animation ended.
`FinishReasonKind`	Discriminator of an animation's finish reason.
`FolderFlag`	Combinable Windows flags accepted by all integer flag APIs.
`FolderFlagOp`	Folder-flag mutation mode used in
`FolderFlagOpKind`	Folder-flag operation discriminator for dict and tuple inputs.
`IconAnimationSpec`	Per-icon animation description.
`IconAnimationState`	Per-icon animation state captured by [AnimationHandle.snapshot].
`IconGrid`
`IconSnapshot`	Read-only snapshot of a single desktop icon.
`KeyframeInterp`	Interpolation between sampled or explicit keyframes.
`LogTarget`	Destination for native tracing events.
`MonitorInfo`	A single connected display in the virtual-screen coordinate system.
`MotionContext`	Read-only view of the motion metadata handed to a
`PlaybackHandle`
`PlaybackOutcome`
`PreparedAnimation`
`ProceduralSource`
`Rect`	Axis-aligned pixel rectangle in virtual-screen coordinates.
`RenderPass`
`RenderSession`	Prepared off-screen scene. No window, Shell position writes or visibility changes.
`RenderTarget`
`Shader`
`ShaderPipeline`	Geometry pipeline used by a shader source.
`ShaderSource`
`StartContext`	Argument passed to on_start callbacks.
`StopMode`	How an animation should leave the desktop when
`TickContext`	Argument passed to on_tick callbacks.
`TimelineCloseMode`
`TimelineSession`	Persistent, seekable playback opened by `PreparedAnimation.open_timeline`.
`TimelineState`

Package Contents¶

rusty_desktop_icons.init_logging(level: str | None = None, target: LogTarget | str = 'loguru') → bool¶

Route this library’s diagnostics somewhere useful.

Called automatically at import time with the defaults, so configuring a loguru sink is usually all you need. Call this explicitly to change the level or switch sinks.

rusty_desktop_icons.LOGGER_NAME: str¶