Merge "Update docs for Painter and Shadow Modifiers" into androidx-main am: d14097942d
Original change: https://android-review.googlesource.com/c/platform/frameworks/support/+/3063453
Change-Id: I818800acfebd183f3a586a36e6c79a5cb1f9c9f0
Signed-off-by: Automerger Merge Worker <[email protected]>
diff --git a/compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/draw/PainterModifier.kt b/compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/draw/PainterModifier.kt
index e9a8947..f387981 100644
--- a/compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/draw/PainterModifier.kt
+++ b/compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/draw/PainterModifier.kt
@@ -49,6 +49,7 @@
/**
* Paint the content using [painter].
*
+ * @param painter [Painter] to be drawn by this [Modifier]
* @param sizeToIntrinsics `true` to size the element relative to [Painter.intrinsicSize]
* @param alignment specifies alignment of the [painter] relative to content
* @param contentScale strategy for scaling [painter] if its size does not match the content size
diff --git a/compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/draw/Shadow.kt b/compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/draw/Shadow.kt
index f3703e0..e48553d 100644
--- a/compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/draw/Shadow.kt
+++ b/compose/ui/ui/src/commonMain/kotlin/androidx/compose/ui/draw/Shadow.kt
@@ -82,6 +82,9 @@
* Use a [androidx.compose.ui.zIndex] modifier if you want to draw the elements with larger
* [elevation] after all the elements with a smaller one.
*
+ * Note that this parameter is only supported on Android 9 (Pie) and above. On older versions,
+ * this property always returns [Color.Black] and setting new values is ignored.
+ *
* Usage of this API renders this composable into a separate graphics layer
* @see graphicsLayer
*
@@ -92,6 +95,8 @@
* @param elevation The elevation for the shadow in pixels
* @param shape Defines a shape of the physical object
* @param clip When active, the content drawing clips to the shape.
+ * @param ambientColor Color of the ambient shadow drawn when [elevation] > 0f
+ * @param spotColor Color of the spot shadow that is drawn when [elevation] > 0f
*/
@Stable
fun Modifier.shadow(
