hakowork/rojo
3
0
Fork 0
mirror of https://github.com/rojo-rbx/rojo.git synced 2026-10-24 06:34:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update rules

Browse source
This commit is contained in:
Joe 2026-02-02 14:05:11 -06:00
parent 4c390fdd37
commit d5522b2fef
8549 changed files with 11783 additions and 1888 deletions
Download patch file Download diff file Expand all files Collapse all files

131
.cursor/rules/roblox/en-us/environment/post-processing-effects.md Normal file
View file

@ -0,0 +1,131 @@
---
title: Post-processing effects
description: Post-processing effects are customizable filters that quickly enrich the visuals of an experience.
---
**Post-processing effects** are customizable filters that allow you to quickly enrich the visuals of your experience. Using the post-processing effect objects in the `Class.Lighting` service or `Class.Camera`, you can:
- Simulate a camera viewing a bright light and exaggerate its glow ([bloom](#bloom)).
- Apply a Gaussian [blur](#blur) to the entirety of your experience, or add a blur to parts of your experience that aren't in focus ([depth‑of‑field](#depth-of-field)).
- Enhance an environment's appearance to create a specific mood through hue ([color correction](#color-correction)).
- Render a halo of light that moves with the sun ([sun rays](#sun-rays)).
<figure>
<img src="../assets/lighting-and-effects/post-processing/DepthOfFieldEffect-With.jpg" width="100%" alt="Landscape with depth-of-field effect applied, simulating distance blur" />
<figcaption>Landscape with depth-of-field effect applied, simulating distance blur</figcaption>
</figure>
## Add post-processing effects
When you add post-processing effects to the `Class.Lighting` service, they display to **all players** who enter the experience. This is useful for effects
that affect the global environment, such as [sun rays](#sun-rays).
When you add post-processing effects to the `Class.Camera` object, they only display to a **specific player**. This is useful for effects that should only pertain to that player based on their actions, such as blurring the 3D world view when they have a UI menu open.
To add post-processing effects to either the `Class.Lighting` service or `Class.Camera`:
1. In the **Explorer** window, hover over the `Class.Lighting` service or `Class.Camera`,
then click the &CirclePlus; button. A contextual menu displays.
1. From the menu, insert one or more of the following post-processing effects:
- **BloomEffect**
- **BlurEffect**
- **ColorCorrectionEffect**
- **DepthOfFieldEffect**
- **SunRaysEffect**
- **ColorGradingEffect**
1. Depending on your Studio settings, some effects may not appear. To increase
your rendering quality level:
1. Open [Studio Settings](../studio/setup.md#customization).
2. In the left-side navigation, select **Rendering**, then the **Editor Quality Level** dropdown menu.
3. Set it to the highest level.
## Bloom
The `Class.BloomEffect` effect exaggerates lights within your experience by simulating a camera viewing a bright light. When this effect has a high value, parts with light colors glow.
<Tabs>
<TabItem label="Default">
<img src="../assets/lighting-and-effects/post-processing/BloomEffect-Without.jpg" width="800" height="450" alt="Experience without any effects applied" />
</TabItem>
<TabItem label="Bloom Effect">
<img src="../assets/lighting-and-effects/post-processing/BloomEffect-With.jpg" width="800" height="450" alt="Experience with BloomEffect applied" />
</TabItem>
</Tabs>
## Blur
The `Class.BlurEffect` effect applies a Gaussian blur to the entirety of the 3D world view. You can use this effect to blur the background when a player has a menu open, allowing them to focus on the most important details.
<Tabs>
<TabItem label="Default">
<img src="../assets/lighting-and-effects/post-processing/BlurEffect-Without.jpg" width="800" height="450" alt="Experience without any effects applied" />
</TabItem>
<TabItem label="Blur Effect">
<img src="../assets/lighting-and-effects/post-processing/BlurEffect-With.jpg" width="800" height="450" alt="Experience with BlurEffect applied" />
</TabItem>
</Tabs>
## Color correction
The `Class.ColorCorrectionEffect` effect adjusts color properties to enhance an environment's appearance. You can also use this effect to provide player feedback, such as tinting the screen red when their character's health is low.
The following list describes the primary `Class.ColorCorrectionEffect` properties:
- `Class.ColorCorrectionEffect.Brightness|Brightness` — Sets the brightness of pixels.
- `Class.ColorCorrectionEffect.Contrast|Contrast` — Sets the change in separation between dark and light colors.
- `Class.ColorCorrectionEffect.Saturation|Saturation` — Sets the intensity of colors.
- `Class.ColorCorrectionEffect.TintColor|TintColor` — Determines how much the RGB channels of pixels scale.
<Tabs>
<TabItem label="Default">
<img src="../assets/lighting-and-effects/post-processing/ColorCorrectionEffect-Without.jpg" width="800" height="450" alt="Experience without any effects applied" />
</TabItem>
<TabItem label="Color Correction Effect">
<img src="../assets/lighting-and-effects/post-processing/ColorCorrectionEffect-With.jpg" width="800" height="450" alt="Experience with ColorCorrectionEffect applied" />
</TabItem>
</Tabs>
## Depth-of-field
The `Class.DepthOfFieldEffect` effect blurs parts of your experience that aren't in focus. You can use this effect to blur distant objects or to focus a player on specific parts of your experience, such as an item in a shop.
<Tabs>
<TabItem label="Default">
<img src="../assets/lighting-and-effects/post-processing/DepthOfFieldEffect-Without.jpg" width="800" height="450" alt="Experience without any effects applied" />
</TabItem>
<TabItem label="Depth-of-Field Effect">
<img src="../assets/lighting-and-effects/post-processing/DepthOfFieldEffect-With.jpg" width="800" height="450" alt="Experience with DepthOfFieldEffect applied" />
</TabItem>
</Tabs>
<img src="../assets/engine-api/classes/DepthOfFieldEffect/Depth-Of-Field-Diagram.svg" width="80%" />
## Sun rays
The `Class.SunRaysEffect` effect creates a halo of light with rays around the sun that move based on the `Class.Lighting.ClockTime|ClockTime`
or `Class.Lighting.TimeOfDay|TimeOfDay` property. Objects between the player's camera and the sun shape this effect, allowing for realistic visuals of light and shadow.
<video src="../assets/lighting-and-effects/post-processing/Sun-Rays-Effect.mp4" controls width="800" alt="Video showing sun rays as the sun moves across the sky" ></video>
## Color grading
The `Class.ColorGradingEffect` effect modifies how color values calculated by the renderer should be converted to the screen's color range, impacting the mood and appearance of your place.
This effect's primary property is `Class.ColorGradingEffect.TonemapperPreset|TonemapperPreset`. The following values are available:
- `Enum.TonemapperPreset.Default` &mdash; Sets the tone mapper to use the post‑2019 Roblox appearance which provides vivid colors and high contrasts.
- `Enum.TonemapperPreset.Retro` &mdash; Sets the tone mapper to imitate the pre‑2019 Roblox appearance. Colors look less saturated and there's less contrast between them.
If you wish to recreate a full pre‑2019 Roblox look for your experience, experiment with `Enum.TonemapperPreset.Retro` and set the brightness of all lights to a maximum of `1.0`.
<Tabs>
<TabItem label="Default">
<img src="../assets/lighting-and-effects/post-processing/ColorGrading-Default.jpg" width="800" height="450" alt="Experience without any effects applied" />
</TabItem>
<TabItem label="Retro">
<img src="../assets/lighting-and-effects/post-processing/ColorGrading-Retro.jpg" width="800" height="450" alt="Experience with retro ColorGrading applied" />
</TabItem>
</Tabs>