Skip to content

Commit

Permalink
Reformat warning about animations.
Browse files Browse the repository at this point in the history
  • Loading branch information
sirdoombox committed Nov 11, 2024
1 parent 265367e commit c6a44b0
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/docs/documentation/theming/background.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,11 @@ Enabling `BackgroundTransitionsEnabled` will cause any change in the background

## Animation

The background renderer does support animation via `BackgroundAnimationEnabled` and will run at native framerates, however due to the need to invalidate the entire visual tree every frame this can be extremely costly (a bump of roughly 5% CPU utilisation and upwards of 20% GPU utilisation depending on your hardware) - only use this if you are clearly aware of the cost involved.
The background renderer does support animation via `BackgroundAnimationEnabled` and will run at native framerates, all default SukiUI backgrounds support animation out of the box (except for `Flat`).

::: warning
Due to the need for an invalidation and repaint of the entire visual tree, animations can have a significant impact on performance and it is recommended that you only use it if absolutely necessary. In limited testing we see a roughly 5% bump in CPU and 20% bump in GPU utilization _at all times_ when animation is enabled.
:::

## Software fallback

Expand Down

0 comments on commit c6a44b0

Please sign in to comment.