PostFX Layer Component

The PostFx Layer component controls how post-processing effects (PostFX), such as Bloom, Deferred Fog, and Depth of Field, are applied in a scene. For example, you can control how various PostFX blend or set which cameras are affected by the PostFX layer.

Provider

Atom Gem

Dependencies

None

Base properties

Using Layer Categories

Each PostFX Layer component must be assigned to a Layer Category. Each Layer Category is a key-value pair with a 64-bit integer value that ranks its priority, with 0 being the highest priority. When multiple PostFX Layers are active, they are sorted first by Layer Category value, then by their Priority in Default value within their assigned Layer Category.

To update the preset Layer Category list:

1. Open Asset Editor from the Tools menu.

2. In Asset Editor, go to File → Open.

3. Search for default.postfxlayercategories and open it in Asset Editor.

4. Click the Layer Categories Caret to expand the list.

5. Click the Add button.

6. Provide a Layer Category key (name) and choose OK to add a new Layer Category to the list.

7. Modify the Layer Category value if necessary. The default value is 0 which makes this new Layer Category top priority.

8. In Asset Editor, choose Save from the File menu or press Ctrl+S to save your changes.

You can also create a new Layer Category List.

1. In Asset Editor, go to File → New → PostFx Layer Categories.

2. Add a new Layer Categories to the list following the steps above.

3. In Asset Editor, choose Save from the File menu or press Ctrl+S to save your changes.

Using Camera Tags

You can include or exclude Cameras from a PostFX Layer component through Tag components applied to camera entities. The specified tags in the Select Camera Tags Only and Excluded Camera Tags properties must match the camera entity’s Tag component.

In this example, the PostFX Entity has a PostFX Layer component that only affects camera entities that have the tag MainCamera. This affects Camera Entity, which has the MainCamera tag.