Skip to content

Commit

Permalink
doc: Update reference to post-process effects (#2336)
Browse files Browse the repository at this point in the history
  • Loading branch information
felixpalmer authored Feb 18, 2025
1 parent 9ca6f80 commit ba8b85e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Image Processing

Screen space effects packaged as reusable shader modules in `@luma.gl/shadertools` based on the [glfx library](http://evanw.github.io/glfx.js/).
Screen space effects packaged as reusable shader modules in `@luma.gl/effects` based on the [glfx library](http://evanw.github.io/glfx.js/).

:::caution
> luma.gl shader modules can be used directly with [deck.gl](https://deck.gl)'s post processing system.
Expand All @@ -13,10 +13,10 @@ Most of these image post processing effects (and this documentation page) are fo

## Usage

Import the shader module(s) you would like to use from `@luma.gl/shadertools`, e.g:
Import the shader module(s) you would like to use from `@luma.gl/effects`, e.g:

```typescript
import {brightnessContrast} from '@luma.gl/shadertools';
import {brightnessContrast} from '@luma.gl/effects';
```

## Shader Modules
Expand Down
4 changes: 4 additions & 0 deletions docs/upgrade-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,10 @@ v9.1 continues to build out WebGPU support. Some additional deprecations and bre
| `getDependencyGraph()` | Removed | `getShaderModuleDependencies(module)` . | Interact directly with the shader module |
| `glsl` template string | Removed | `/* glsl */` comment | Enable syntax highlighting in vscode using comment |

**@luma.gl/effects**

New module. All postprocessing effects that were previously in `@luma.gl/shadertools` are now exported from `@luma.gl/effects`.

**@luma.gl/webgl**

- `WebGLDeviceContext` - Note that luma.gl v9.1 and onwards set `DeviceProps.webgl.preserveDrawingBuffers` to `true` by default. This can be disabled for some (potential) memory savings and a (potential) minor performance boost on resource limited devices, such as mobile phones, at the cost of not being able to take screenshots or rendering to the screen without clearing it.
Expand Down

0 comments on commit ba8b85e

Please sign in to comment.