Skip to content

docs: add example links for ASCII and N8AO #379

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kvvasuu merged 1 commit into from
Sep 2, 2026
Merged

docs: add example links for ASCII and N8AO #379

Show file tree
Hide file tree
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
20 changes: 12 additions & 8 deletions docs/effects/ascii.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,17 @@ return (
)
```

## Example

[![ASCII demo](https://pmndrs.github.io/examples/ascii/thumbnail.webp)](https://pmndrs.github.io/examples/ascii)

## Props

| Name | Type | Default | Description |
| ---------- | ------- | ----------------------- | ------------------------------------------------------------------ |
| font | String | 'arial' | The font family used to draw the character atlas. |
| characters | String | ` .:,'-^=*+?!\|0#X%WM@` | The characters to sample from, ordered from "empty" to "dense". |
| fontSize | Number | 54 | The font size used to draw the character atlas. |
| cellSize | Number | 16 | The size of each character cell, in pixels. |
| color | ColorRepresentation | '#ffffff' | The color of the characters. |
| invert | Boolean | false | Inverts which characters map to bright vs dark pixels. |
| Name | Type | Default | Description |
| ---------- | ------------------- | ----------------------- | --------------------------------------------------------------- |
| font | String | 'arial' | The font family used to draw the character atlas. |
| characters | String | ` .:,'-^=*+?!\|0#X%WM@` | The characters to sample from, ordered from "empty" to "dense". |
| fontSize | Number | 54 | The font size used to draw the character atlas. |
| cellSize | Number | 16 | The size of each character cell, in pixels. |
| color | ColorRepresentation | '#ffffff' | The color of the characters. |
| invert | Boolean | false | Inverts which characters map to bright vs dark pixels. |
6 changes: 5 additions & 1 deletion docs/passes/n8ao.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,18 @@ return (
)
```

## Example

[![N8AO demo](https://pmndrs.github.io/examples/n8ao/thumbnail.webp)](https://pmndrs.github.io/examples/n8ao)

## Props

| Name | Type | Default | Description |
| -------------------- | ------------------------------------------------------- | ------------- | --------------------------------------------------------- |
| enabled | Boolean | true | Toggles the pass without unmounting it. |
| aoRadius | Number | 5 | The ambient occlusion sampling radius. |
| distanceFalloff | Number | 1 | The distance falloff. |
| intensity | Number | 1 | The AO intensity. |
| intensity | Number | 1 | The AO intensity. |
| quality | 'performance' \| 'low' \| 'medium' \| 'high' \| 'ultra' | 'performance' | The quality preset. |
| aoSamples | Number | 16 | The amount of ambient occlusion samples per frame. |
| denoiseSamples | Number | 4 | The amount of denoise samples per frame. |
Expand Down
Loading