# PdfDocument.BitmapSource

Artifact: [androidx.pdf:pdf-core](https://developer.android.com/jetpack/androidx/releases/pdf) [View Source](https://cs.android.com/search?q=file:androidx/pdf/PdfDocument.kt+class:androidx.pdf.PdfDocument.BitmapSource) Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

*** ** * ** ***


```
interface PdfDocument.BitmapSource : Closeable
```

<br />

*** ** * ** ***

A source for retrieving bitmap representations of PDF pages.

## Summary

| ### Public functions |
|---|---|
| `suspend https://developer.android.com/reference/android/graphics/Bitmap.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/PdfDocument.BitmapSource#getBitmap(android.util.Size,android.graphics.Rect)(scaledPageSizePx: https://developer.android.com/reference/android/util/Size.html, tileRegion: https://developer.android.com/reference/android/graphics/Rect.html?)` Asynchronously retrieves a bitmap representation of the page, optionally constrained to a specific tile region. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/PdfDocument.BitmapSource#pageNumber()` |

### Inherited functions

From [java.io.Closeable](https://developer.android.com/reference/java/io/Closeable.html) `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` `https://developer.android.com/reference/java/io/Closeable.html#close()()`

## Public functions

### getBitmap

```
suspend fun getBitmap(scaledPageSizePx: Size, tileRegion: Rect? = null): Bitmap
```

Asynchronously retrieves a bitmap representation of the page, optionally constrained to a specific tile region. `https://developer.android.com/reference/kotlin/androidx/pdf/PdfDocument#renderParams()` is used to determine what contents are rendered on the bitmap.

| Parameters |
|---|---|
| `scaledPageSizePx: https://developer.android.com/reference/android/util/Size.html` | The scaled page size in pixels, representing the page size in case of no zoom, and scaled page size in case of zooming. |
| `tileRegion: https://developer.android.com/reference/android/graphics/Rect.html? = null` | (Optional) The region of the page to include in the bitmap, in pixels within the `scaledPageSizePx`. This identifies the tile. If null, the entire page is included. |

| Returns |
|---|---|
| `https://developer.android.com/reference/android/graphics/Bitmap.html` | The bitmap representation of the page. |

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/pdf/PdfDocument#renderParams()` |   |

## Public properties

### pageNumber

Added in [1.0.0-beta01](https://developer.android.com/jetpack/androidx/releases/pdf#1.0.0-beta01)

```
val pageNumber: Int
```