mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-23 14:01:37 +00:00
53 lines
1.7 KiB
YAML
53 lines
1.7 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: BlurEffect
|
|
type: class
|
|
memory_category: Instances
|
|
summary: |
|
|
Applies a blur to the entire game world.
|
|
description: |
|
|
The **BlurEffect** applies a Gaussian blur to the entire rendered game world.
|
|
The strength of the blur is controlled by the `Class.BlurEffect.Size`. Only
|
|
one **BlurEffect** can be applied at once (the instance with the greatest
|
|
`Class.BlurEffect.Size|Size` takes priority).
|
|
|
|
Like other post-processing effects, **BlurEffect** will only work while
|
|
`Class.PostEffect.Enabled|Enabled` and when parented to `Class.Lighting` or
|
|
`Class.Workspace.CurrentCamera`. Also, it may render differently on low-end
|
|
devices and/or depending on your Studio settings (see the **Quality Level**
|
|
settings in **Rendering** → **Performance**).
|
|
|
|
For more details on this effect and others, see
|
|
[Post-Processing Effects](../../../environment/post-processing-effects.md).
|
|
code_samples: []
|
|
inherits:
|
|
- PostEffect
|
|
descendants: []
|
|
tags: []
|
|
deprecation_message: ''
|
|
properties:
|
|
- name: BlurEffect.Size
|
|
summary: |
|
|
Determines the blur radius.
|
|
description: |
|
|
Size controls the blur radius, measured in pixels. The larger the size,
|
|
the blurrier the screen will become.
|
|
code_samples: []
|
|
type: float
|
|
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: []
|