Alpha.kt
/*
* Copyright 2020 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package androidx.compose.ui.draw
import androidx.compose.runtime.Stable
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.graphicsLayer
import androidx.compose.ui.util.annotation.FloatRange
/**
* Draw content with modified alpha that may be less than 1.
*
* Usage of this API renders this composable into a separate graphics layer
* @see graphicsLayer
*
* Example usage:
* @sample androidx.compose.ui.samples.AlphaSample
*
* @param alpha the fraction of children's alpha value.
*/
@Stable
fun Modifier.alpha(
@FloatRange(from = 0.0, to = 1.0) alpha: Float
) = if (alpha != 1.0f) graphicsLayer(alpha = alpha, clip = true) else this
/**
* Draw content with modified alpha that may be less than 1.
*
* @param opacity the fraction of children's alpha value.
*/
@Deprecated(
"Use alpha instead",
ReplaceWith("alpha(opacity)", "androidx.compose.ui.draw")
)
@Stable
fun Modifier.drawOpacity(@FloatRange(from = 0.0, to = 1.0) opacity: Float) = alpha(opacity)