Skip to content
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

docs(Mask): mention enabling stencil in the Canvas component #2287

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

docs(Mask): mention enabling stencil in the Canvas component #2287

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
8 changes: 8 additions & 0 deletions docs/portals/mask.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,14 @@ return (
<meshStandardMaterial {...stencil} />
```

You must unable stencil in your `<Canvas>` component to use the mask without `depthWrite` set to `true`.

```jsx
<Canvas gl={{ stencil: true }}>
{/** Your scene **/}
</Canvas>
```

You can build compound masks with multiple shapes by re-using an id. You can also use the mask as a normal mesh by providing `colorWrite` and `depthWrite` props.

```jsx
Expand Down
Loading