# Scroll2DScope

# Scroll2DScope

Artifact:[androidx.compose.foundation:foundation](https://developer.android.com/jetpack/androidx/releases/compose-foundation)  
[View Source](https://cs.android.com/search?q=file:androidx/compose/foundation/gestures/Scrollable2DState.kt+class:androidx.compose.foundation.gestures.Scroll2DScope)  
Added in[1.9.0](https://developer.android.com/jetpack/androidx/releases/compose-foundation#1.9.0)
Common/AllAndroid/JVM
  - Cmn  

  ```
  interface Scroll2DScope
  ```

*** ** * ** ***

Scope used for suspending scroll blocks

## Summary

|                                     ### Public functions                                     |
|----------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|
| [Offset](https://developer.android.com/reference/kotlin/androidx/compose/ui/geometry/Offset) | [scrollBy](https://developer.android.com/reference/kotlin/androidx/compose/foundation/gestures/Scroll2DScope#scrollBy(androidx.compose.ui.geometry.Offset))`(delta: `[Offset](https://developer.android.com/reference/kotlin/androidx/compose/ui/geometry/Offset)`)` Attempts to scroll forward by[delta](https://developer.android.com/reference/kotlin/androidx/compose/foundation/gestures/Scroll2DScope#scrollBy(androidx.compose.ui.geometry.Offset))px. | Cmn |

## Public functions

### scrollBy

Cmn  
Added in[1.10.0-rc01](https://developer.android.com/jetpack/androidx/releases/compose-foundation#1.10.0-rc01)  

```
fun scrollBy(delta: Offset): Offset
```

Attempts to scroll forward by[delta](https://developer.android.com/reference/kotlin/androidx/compose/foundation/gestures/Scroll2DScope#scrollBy(androidx.compose.ui.geometry.Offset))px.  

|                                           Returns                                            |
|----------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|
| [Offset](https://developer.android.com/reference/kotlin/androidx/compose/ui/geometry/Offset) | the amount of the requested scroll that was consumed (that is, how far it scrolled) |