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

*** ** * ** ***


```
public final class RenderParams implements 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/androidx/pdf/RenderParams#renderFlags()` defaults to `https://developer.android.com/reference/androidx/pdf/RenderParams#FLAG_RENDER_NONE()` which means that no annotations will be rendered on the bitmap. `https://developer.android.com/reference/androidx/pdf/RenderParams#renderFormContentMode()` defaults to `https://developer.android.com/reference/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/androidx/pdf/RenderParams.RenderMode` |   |
| `https://developer.android.com/reference/androidx/pdf/RenderParams.RenderFlags` |   |
| `https://developer.android.com/reference/androidx/pdf/RenderParams.RenderFormContentMode` |   |

## Summary

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

| ### Public fields |
|---|---|
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Parcelable.Creator.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/pdf/RenderParams>` | `https://developer.android.com/reference/androidx/pdf/RenderParams#CREATOR()` |

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/pdf/RenderParams#RenderParams(kotlin.Int,kotlin.Int,kotlin.Int)(int renderMode, int renderFlags, int renderFormContentMode)` |

| ### Public methods |
|---|---|
| `int` | `https://developer.android.com/reference/androidx/pdf/RenderParams#describeContents()()` |
| `boolean` | `https://developer.android.com/reference/androidx/pdf/RenderParams#equals(kotlin.Any)(https://developer.android.com/reference/java/lang/Object.html other)` |
| `final int` | `https://developer.android.com/reference/androidx/pdf/RenderParams#getRenderFlags()()` |
| `final int` | `https://developer.android.com/reference/androidx/pdf/RenderParams#getRenderFormContentMode()()` |
| `final int` | `https://developer.android.com/reference/androidx/pdf/RenderParams#getRenderMode()()` |
| `int` | `https://developer.android.com/reference/androidx/pdf/RenderParams#hashCode()()` |
| `void` | `https://developer.android.com/reference/androidx/pdf/RenderParams#writeToParcel(android.os.Parcel,kotlin.Int)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/os/Parcel.html dest, int flags)` |

## Constants

### FLAG_RENDER_FREETEXT

```
public static final int FLAG_RENDER_FREETEXT
```

Flag to enable rendering of freetext annotation on the page.

### FLAG_RENDER_HIGHLIGHT_ANNOTATIONS

```
public static final int FLAG_RENDER_HIGHLIGHT_ANNOTATIONS
```

Flag to enable rendering of highlight annotation on the page.

### FLAG_RENDER_NONE

```
public static final int FLAG_RENDER_NONE = 0
```

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

### FLAG_RENDER_STAMP_ANNOTATIONS

```
public static final int FLAG_RENDER_STAMP_ANNOTATIONS
```

Flag to enable rendering of stamp annotation on the page.

### FLAG_RENDER_TEXT_ANNOTATIONS

```
public static final int FLAG_RENDER_TEXT_ANNOTATIONS
```

Flag to enable rendering of text annotation on the page.

### RENDER_FORM_CONTENT_DISABLED

```
public static final int RENDER_FORM_CONTENT_DISABLED = 2
```

Mode to exclude PDF form content in rendered PDF bitmaps.

### RENDER_FORM_CONTENT_ENABLED

```
public static final int RENDER_FORM_CONTENT_ENABLED = 1
```

Mode to include PDF form content in rendered PDF bitmaps.

### RENDER_MODE_FOR_DISPLAY

```
public static final int RENDER_MODE_FOR_DISPLAY = 1
```

Mode to render the content for display on a screen.

### RENDER_MODE_FOR_PRINT

```
public static final int RENDER_MODE_FOR_PRINT = 2
```

Mode to render the content for printing.

## Public fields

### CREATOR

```
public static final @NonNull Parcelable.Creator<@NonNull RenderParams> CREATOR
```

## Public constructors

### RenderParams

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

```
public RenderParams(int renderMode, int renderFlags, int renderFormContentMode)
```

## Public methods

### describeContents

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

```
public int describeContents()
```

### equals

```
public boolean equals(Object other)
```

### getRenderFlags

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

```
public final int getRenderFlags()
```

### getRenderFormContentMode

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

```
public final int getRenderFormContentMode()
```

### getRenderMode

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

```
public final int getRenderMode()
```

### hashCode

```
public int hashCode()
```

### writeToParcel

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

```
public void writeToParcel(@NonNull Parcel dest, int flags)
```