Skip to content

docs: update tone mapping examples and props table #345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: update tone mapping examples and props table #345

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 24 additions & 10 deletions docs/effects/tone-mapping.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,19 @@ nav: 1

A tone mapping effect.

```jsx
import { ToneMapping } from '@react-three/postprocessing'
import { ToneMappingMode } from 'postprocessing'

return (
<ToneMapping
mode={ToneMappingMode.ACES_FILMIC} // tone mapping mode
/>
)
```

OR

```jsx
import { ToneMapping } from '@react-three/postprocessing'
import { BlendFunction } from 'postprocessing'
Expand All @@ -28,13 +41,14 @@ return (

## Props

| Name | Type | Default | Description |
| ---------------- | ------------- | ------- | ------------------------------------------------------------------- |
| resolution | Number | 256 | The resolution of the luminance texture. Must be a power of two. |
| adaptive | boolean | true | Toggle adaptive luminance map usage |
| blendFunction | BlendFunction | | The blend function of this effect. |
| middleGrey | Number | 0.6 | The middle grey factor. |
| maxLuminance | Number | 16 | Maximum luminance |
| minLuminance | Number | 0.01 | The minimum luminance. Prevents very high exposure in dark scenes. |
| averageLuminance | Number | 1 | The average luminance. Used for the non-adaptive Reinhard operator. |
| adaptationRate | Number | 1 | The luminance adaptation rate. |
| Name | Type | Default | Description |
| ---------------- | --------------- | ------- | ------------------------------------------------------------------- |
| mode | ToneMappingMode | | The tone mapping algorithm |
| resolution | Number | 256 | The resolution of the luminance texture. Must be a power of two. |
| adaptive | boolean | true | Toggle adaptive luminance map usage |
| blendFunction | BlendFunction | | The blend function of this effect. |
| middleGrey | Number | 0.6 | The middle grey factor. |
| maxLuminance | Number | 16 | Maximum luminance |
| minLuminance | Number | 0.01 | The minimum luminance. Prevents very high exposure in dark scenes. |
| averageLuminance | Number | 1 | The average luminance. Used for the non-adaptive Reinhard operator. |
| adaptationRate | Number | 1 | The luminance adaptation rate. |