# CarouselParallaxScrollEffectState

Artifact: [androidx.compose.material3:material3](https://developer.android.com/jetpack/androidx/releases/compose-material3) [View Source](https://cs.android.com/search?q=file:androidx/compose/material3/carousel/CarouselParallaxScrollEffect.kt+class:androidx.compose.material3.carousel.CarouselParallaxScrollEffectState) Common/All
- Cmn

  ```
  @ExperimentalMaterial3Api
  interface CarouselParallaxScrollEffectState
  ```

*** ** * ** ***

A state holder for scrollable items to track effect values that are applied by the `https://developer.android.com/reference/kotlin/androidx/compose/material3/carousel/carouselParallaxScrollEffect.composable#(androidx.compose.ui.Modifier).carouselParallaxScrollEffect(kotlin.Int,androidx.compose.material3.carousel.CarouselParallaxScrollEffectState,androidx.compose.ui.graphics.Shape,androidx.compose.foundation.BorderStroke)` modifier.

Use one of the `https://developer.android.com/reference/kotlin/androidx/compose/material3/carousel/CarouselParallaxScrollEffectState` functions to create an instance of this interface using `https://developer.android.com/reference/kotlin/androidx/compose/foundation/lazy/LazyListState` or `https://developer.android.com/reference/kotlin/androidx/compose/foundation/lazy/grid/LazyGridState`, or implement the interface directly for a custom layout.

## Summary

| ### Public functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/material3/carousel/CarouselParallaxScrollEffectItemInfo` | `@https://developer.android.com/reference/kotlin/androidx/compose/runtime/annotation/FrequentlyChangingValue https://developer.android.com/reference/kotlin/androidx/compose/material3/carousel/CarouselParallaxScrollEffectState#calculateItemInfo(kotlin.Int)(index: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Returns visual effect values (`https://developer.android.com/reference/kotlin/androidx/compose/material3/carousel/CarouselParallaxScrollEffectItemInfo`) for the item at `https://developer.android.com/reference/kotlin/androidx/compose/material3/carousel/CarouselParallaxScrollEffectState#calculateItemInfo(kotlin.Int)`. | Cmn |

| ### Public properties |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/compose/foundation/gestures/Orientation` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/carousel/CarouselParallaxScrollEffectState#orientation()` The scroll orientation of the container. | Cmn |

## Public functions

### calculateItemInfo

Cmn

```
@FrequentlyChangingValue
fun calculateItemInfo(index: Int): CarouselParallaxScrollEffectItemInfo
```

Returns visual effect values (`https://developer.android.com/reference/kotlin/androidx/compose/material3/carousel/CarouselParallaxScrollEffectItemInfo`) for the item at `https://developer.android.com/reference/kotlin/androidx/compose/material3/carousel/CarouselParallaxScrollEffectState#calculateItemInfo(kotlin.Int)`.

Note that this function should not be called during composition. Make sure to call getItemInfo from a graphics, layout, or other Modifier.Node where changes to the underlying info will not cause unwanted recompositions.

## Public properties

### orientation

Cmn

```
val orientation: Orientation
```

The scroll orientation of the container.