mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-24 06:34:09 +00:00
61 lines
2 KiB
YAML
61 lines
2 KiB
YAML
# This file is automatically generated. Please don't edit it manually.
|
|
# To submit a bug report on the content, see
|
|
# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
|
|
|
|
name: PostEffect
|
|
type: class
|
|
memory_category: Instances
|
|
summary: |
|
|
Abstract base class for post-processing effects.
|
|
description: |
|
|
PostEffect is an abstract base class for post-processing effects, such as
|
|
`Class.BloomEffect` and `Class.ColorCorrectionEffect`. They change how the
|
|
world looks **after** it has been rendered. They do not affect
|
|
`Class.GuiObject|GuiObjects`. Objects of this kind should be parented to the
|
|
`Class.Lighting` or the `Class.Workspace.CurrentCamera` in order to work.
|
|
|
|
It should also be noted that some post-processing effects will work
|
|
differently or **not at all** when Roblox is set to a low
|
|
`Class.RenderSettings.QualityLevel|QualityLevel` (or
|
|
`Class.RenderSettings.EditQualityLevel|EditQualityLevel` in Studio). On some
|
|
low-end devices, faster rendering algorithms may be used. By default, these
|
|
quality settings are set to Automatic, so if you aren't seeing post-processing
|
|
effects you should check Roblox's settings under the "Rendering" section. It
|
|
may be necessary to override the automatic behavior temporarily in order to
|
|
preview post-processing effects.
|
|
code_samples: []
|
|
inherits:
|
|
- Instance
|
|
descendants:
|
|
- BloomEffect
|
|
- BlurEffect
|
|
- ColorCorrectionEffect
|
|
- ColorGradingEffect
|
|
- DepthOfFieldEffect
|
|
- SunRaysEffect
|
|
tags:
|
|
- NotCreatable
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: PostEffect.Enabled
|
|
summary: |
|
|
Toggles whether or not the PostEffect is enabled.
|
|
description: |
|
|
Toggles whether or not the PostEffect is enabled.
|
|
code_samples: []
|
|
type: boolean
|
|
tags: []
|
|
deprecation_message: ''
|
|
security:
|
|
read: None
|
|
write: None
|
|
thread_safety: ReadSafe
|
|
category: State
|
|
serialization:
|
|
can_load: true
|
|
can_save: true
|
|
capabilities:
|
|
- Environment
|
|
methods: []
|
|
events: []
|
|
callbacks: []
|