From ee73e4aa24f912b45d085d3678ecba450ec65c7d Mon Sep 17 00:00:00 2001 From: "Andrii Doroshenko (Xrayez)" Date: Sat, 16 Jan 2021 17:13:33 +0200 Subject: [PATCH] Document GPU particles visibility rect/aabb behavior (cherry picked from commit b4675973fd7287c7540a9393649826bf604dbb65) --- doc/classes/Particles.xml | 3 ++- doc/classes/Particles2D.xml | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/classes/Particles.xml b/doc/classes/Particles.xml index e683ed1992a..6acd16e9b7f 100644 --- a/doc/classes/Particles.xml +++ b/doc/classes/Particles.xml @@ -106,7 +106,8 @@ Speed scaling ratio. A value of [code]0[/code] can be used to pause the particles. - The [AABB] that determines the area of the world part of which needs to be visible on screen for the particle system to be active. + The [AABB] that determines the node's region which needs to be visible on screen for the particle system to be active. + Grow the box if particles suddenly appear/disappear when the node enters/exits the screen. The [AABB] can be grown via code or with the [b]Particles → Generate AABB[/b] editor tool. [b]Note:[/b] If the [ParticlesMaterial] in use is configured to cast shadows, you may want to enlarge this AABB to ensure the shadow is updated when particles are off-screen. diff --git a/doc/classes/Particles2D.xml b/doc/classes/Particles2D.xml index 2d45d5fe57e..8f926fb079e 100644 --- a/doc/classes/Particles2D.xml +++ b/doc/classes/Particles2D.xml @@ -78,7 +78,8 @@ Particle texture. If [code]null[/code], particles will be squares. - Editor visibility helper. + The [Rect2] that determines the node's region which needs to be visible on screen for the particle system to be active. + Grow the rect if particles suddenly appear/disappear when the node enters/exits the screen. The [Rect2] can be grown via code or with the [b]Particles → Generate Visibility Rect[/b] editor tool.