# RenderParams

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

*** ** * ** ***


```
class RenderParams : Parcelable
```

<br />

*** ** * ** ***

The set of parameters that will be used to render the page of a PDF Document. It can be tuned to set the render mode, render flags and render form content mode.

Note: `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#renderFlags()` defaults to `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#FLAG_RENDER_NONE()` which means that no annotations will be rendered on the bitmap. `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#renderFormContentMode()` defaults to `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#RENDER_FORM_CONTENT_ENABLED()` which means that PDF form widgets (if present) will be rendered on the bitmap.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams.RenderMode` |   |
| `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams.RenderFlags` |   |
| `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams.RenderFormContentMode` |   |

## Summary

| ### Constants |
|---|---|
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#FLAG_RENDER_FREETEXT()` Flag to enable rendering of freetext annotation on the page. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#FLAG_RENDER_HIGHLIGHT_ANNOTATIONS()` Flag to enable rendering of highlight annotation on the page. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#FLAG_RENDER_NONE() = 0` Flag to disable rendering of all types of annotations on the page. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#FLAG_RENDER_STAMP_ANNOTATIONS()` Flag to enable rendering of stamp annotation on the page. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#FLAG_RENDER_TEXT_ANNOTATIONS()` Flag to enable rendering of text annotation on the page. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#RENDER_FORM_CONTENT_DISABLED() = 2` Mode to exclude PDF form content in rendered PDF bitmaps. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#RENDER_FORM_CONTENT_ENABLED() = 1` Mode to include PDF form content in rendered PDF bitmaps. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#RENDER_MODE_FOR_DISPLAY() = 1` Mode to render the content for display on a screen. |
| `const https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#RENDER_MODE_FOR_PRINT() = 2` Mode to render the content for printing. |

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/android/os/Parcelable.Creator.html<https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams>` | `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#CREATOR()` |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#RenderParams(kotlin.Int,kotlin.Int,kotlin.Int)(renderMode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, renderFlags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, renderFormContentMode: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` |

| ### Public functions |
|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#describeContents()()` |
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#writeToParcel(android.os.Parcel,kotlin.Int)(dest: https://developer.android.com/reference/android/os/Parcel.html, flags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#renderFlags()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#renderFormContentMode()` |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/pdf/RenderParams#renderMode()` |

## Constants

### FLAG_RENDER_FREETEXT

```
const val FLAG_RENDER_FREETEXT: Int
```

Flag to enable rendering of freetext annotation on the page.

### FLAG_RENDER_HIGHLIGHT_ANNOTATIONS

```
const val FLAG_RENDER_HIGHLIGHT_ANNOTATIONS: Int
```

Flag to enable rendering of highlight annotation on the page.

### FLAG_RENDER_NONE

```
const val FLAG_RENDER_NONE = 0: Int
```

Flag to disable rendering of all types of annotations on the page.

### FLAG_RENDER_STAMP_ANNOTATIONS

```
const val FLAG_RENDER_STAMP_ANNOTATIONS: Int
```

Flag to enable rendering of stamp annotation on the page.

### FLAG_RENDER_TEXT_ANNOTATIONS

```
const val FLAG_RENDER_TEXT_ANNOTATIONS: Int
```

Flag to enable rendering of text annotation on the page.

### RENDER_FORM_CONTENT_DISABLED

```
const val RENDER_FORM_CONTENT_DISABLED = 2: Int
```

Mode to exclude PDF form content in rendered PDF bitmaps.

### RENDER_FORM_CONTENT_ENABLED

```
const val RENDER_FORM_CONTENT_ENABLED = 1: Int
```

Mode to include PDF form content in rendered PDF bitmaps.

### RENDER_MODE_FOR_DISPLAY

```
const val RENDER_MODE_FOR_DISPLAY = 1: Int
```

Mode to render the content for display on a screen.

### RENDER_MODE_FOR_PRINT

```
const val RENDER_MODE_FOR_PRINT = 2: Int
```

Mode to render the content for printing.

## Public companion properties

### CREATOR

```
val CREATOR: Parcelable.Creator<RenderParams>
```

## Public constructors

### RenderParams

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

```
RenderParams(
    renderMode: Int,
    renderFlags: Int = FLAG_RENDER_NONE,
    renderFormContentMode: Int = RENDER_FORM_CONTENT_ENABLED
)
```

## Public functions

### describeContents

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

```
open fun describeContents(): Int
```

### equals

```
open operator fun equals(other: Any?): Boolean
```

### hashCode

```
open fun hashCode(): Int
```

### writeToParcel

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

```
open fun writeToParcel(dest: Parcel, flags: Int): Unit
```

## Public properties

### renderFlags

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

```
val renderFlags: Int
```

Value is either `0` or a combination of the following:

- `0`
- `2`
- `4`
- `8`
- `16`

<br />

### renderFormContentMode

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

```
val renderFormContentMode: Int
```

Value is one of the following:

- `1`
- `2`

<br />

### renderMode

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

```
val renderMode: Int
```

Value is one of the following:

- `1`
- `2`

<br />