ui:foundation/com.pico.spatial.ui.foundation.vibrant/terminateVibrantEffect

terminateVibrantEffect

fun Modifier.terminateVibrantEffect(): Modifier

Terminate the current vibrant effect. Terminate effect means that current node and its subsequent node and child views will be rendered in normal android mode. Calling this method is equivalent to call Modifier.vibrantEffect with Vibrant.Termination.

Return

Modifier.

Samples

import androidx.compose.foundation.background
import androidx.compose.foundation.layout.Box
import androidx.compose.foundation.layout.Column
import androidx.compose.foundation.layout.size
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.setValue
import androidx.compose.ui.Modifier
import androidx.compose.ui.graphics.Color
import androidx.compose.ui.unit.dp
import com.pico.spatial.ui.foundation.vibrant.Vibrant
import com.pico.spatial.ui.foundation.vibrant.background
import com.pico.spatial.ui.foundation.vibrant.observeCurrentVibrantEffect
import com.pico.spatial.ui.foundation.vibrant.terminateVibrantEffect
import com.pico.spatial.ui.foundation.vibrant.vibrantEffect
import com.pico.spatial.ui.graphics.Vibrant

fun main() { 
   //sampleStart 
   Column {
    // sample 1: Vibrant is inheritable
    Box(
        modifier =
            Modifier.size(200.dp)
                // 1. Set a Vibrant Dark effect
                .vibrantEffect(Vibrant.Dark)
                .background(Color.Vibrant)
    ) {
        // because vibrant effect is inheritable, and last vibrant effect is Vibrant.Dark,
        // so text rendered in Vibrant.Dark mixed with Color.White.
        Text("Hello", color = Color.White)
    }

    // sample 2: Terminate the effect.
    Box(
        modifier =
            Modifier.size(200.dp)
                // 1. Set a Vibrant Dark effect
                .vibrantEffect(Vibrant.Dark)
                .background(Color.Vibrant)
                // 2. Terminate the effect.
                .terminateVibrantEffect()
    ) {
        // because vibrant effect is terminated, so text is in white color.
        Text("Hello", color = Color.White)
    }
} 
   //sampleEnd
}