From c6a44b08b3bc9b119318674cd65f747ecc2ccf5d Mon Sep 17 00:00:00 2001 From: Aaron Date: Mon, 11 Nov 2024 15:03:06 +0000 Subject: [PATCH] Reformat warning about animations. --- docs/docs/documentation/theming/background.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/docs/documentation/theming/background.md b/docs/docs/documentation/theming/background.md index 77c3ede7f..7be992936 100644 --- a/docs/docs/documentation/theming/background.md +++ b/docs/docs/documentation/theming/background.md @@ -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