# 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)

*** ** * ** ***


```
public interface PdfDocument.BitmapSource extends Closeable
```

<br />

*** ** * ** ***

A source for retrieving bitmap representations of PDF pages.

## Summary

| ### Public methods |
|---|---|
| `abstract @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/graphics/Bitmap.html` | `https://developer.android.com/reference/androidx/pdf/PdfDocument.BitmapSource#getBitmap(android.util.Size,android.graphics.Rect)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/util/Size.html scaledPageSizePx, https://developer.android.com/reference/android/graphics/Rect.html tileRegion)` Asynchronously retrieves a bitmap representation of the page, optionally constrained to a specific tile region. |
| `abstract int` | `https://developer.android.com/reference/androidx/pdf/PdfDocument.BitmapSource#getPageNumber()()` |

### Inherited methods

From [java.io.Closeable](https://developer.android.com/reference/java/io/Closeable.html) `abstract void` `https://developer.android.com/reference/java/io/Closeable.html#close()()`

## Public methods

### getBitmap

```
abstract @NonNull Bitmap getBitmap(@NonNull Size scaledPageSizePx, Rect tileRegion)
```

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

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/util/Size.html scaledPageSizePx` | The scaled page size in pixels, representing the page size in case of no zoom, and scaled page size in case of zooming. |
| `https://developer.android.com/reference/android/graphics/Rect.html tileRegion` | (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/androidx/annotation/NonNull https://developer.android.com/reference/android/graphics/Bitmap.html` | The bitmap representation of the page. |

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

### getPageNumber

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

```
abstract int getPageNumber()
```