core/io.github.themeanimator/ThemeAnimationFormat

ThemeAnimationFormat

interface ThemeAnimationFormat

Defines the visual format and behavior of theme transition animations.

Implementations of this interface determine how the theme change is animated, including clipping shapes, masking, and visual effects. Each format provides a unique way to transition between light and dark themes.

The implementations contained in this file are some commonly-used formats. Implement your own ThemeAnimationFormat to further customize animation behavior.

Inheritors

CircularAroundPress

Types

object Circular : ThemeAnimationFormat

A circular reveal animation format that expands from the center of the screen.

CircularAroundPress

object CircularAroundPress : ThemeAnimationFormat

A circular reveal animation format that expands from the button press position.

object Crossfade : ThemeAnimationFormat

A crossfade animation format that gradually fades between themes.

value class Sliding(val mode: SlidingMode) : ThemeAnimationFormat

A sliding animation format that reveals the new theme from left to right.

Functions

drawAnimationLayer

abstract fun ContentDrawScope.drawAnimationLayer(image: ImageBitmap, progress: Float, pressPosition: Offset?, useDynamicContent: Boolean)

Draws the animated layer during a theme transition.