Clarify clipToCompositionBounds docs for Compose (#2473)

Fixes #2446
airbnb · Mar 3, 2024 · 7090c19 · 7090c19
1 parent fef8d36
commit 7090c19
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/lottie-compose/src/main/java/com/airbnb/lottie/compose/LottieAnimation.kt b/lottie-compose/src/main/java/com/airbnb/lottie/compose/LottieAnimation.kt
@@ -64,6 +64,7 @@ import kotlin.math.roundToInt
  *                  size than this composable.
  * @param contentScale Define how the animation should be scaled if it has a different size than this Composable.
  * @param clipToCompositionBounds Determines whether or not Lottie will clip the animation to the original animation composition bounds.
+ *                                The composition bounds refers to the Lottie animation composition, not the Compose composition.
  * @param clipTextToBoundingBox When true, if there is a bounding box set on a text layer (paragraph text), any text
  *                              that overflows past its height will not be drawn.
  * @param fontMap A map of keys to Typefaces. The key can be: "fName", "fFamily", or "fFamily-fStyle" as specified in your Lottie file.