diff options
Diffstat (limited to 'doc/classes')
| -rw-r--r-- | doc/classes/CPUParticles2D.xml | 11 | ||||
| -rw-r--r-- | doc/classes/CPUParticles3D.xml | 13 | ||||
| -rw-r--r-- | doc/classes/ParticlesMaterial.xml | 13 | ||||
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 7 |
4 files changed, 25 insertions, 19 deletions
diff --git a/doc/classes/CPUParticles2D.xml b/doc/classes/CPUParticles2D.xml index 4a7ffe1536..dacdca1cee 100644 --- a/doc/classes/CPUParticles2D.xml +++ b/doc/classes/CPUParticles2D.xml @@ -313,18 +313,21 @@ All particles will be emitted from a single point. </constant> <constant name="EMISSION_SHAPE_SPHERE" value="1" enum="EmissionShape"> + Particles will be emitted in the volume of a sphere flattened to two dimensions. + </constant> + <constant name="EMISSION_SHAPE_SPHERE_SURFACE" value="2" enum="EmissionShape"> Particles will be emitted on the surface of a sphere flattened to two dimensions. </constant> - <constant name="EMISSION_SHAPE_RECTANGLE" value="2" enum="EmissionShape"> + <constant name="EMISSION_SHAPE_RECTANGLE" value="3" enum="EmissionShape"> Particles will be emitted in the area of a rectangle. </constant> - <constant name="EMISSION_SHAPE_POINTS" value="3" enum="EmissionShape"> + <constant name="EMISSION_SHAPE_POINTS" value="4" enum="EmissionShape"> Particles will be emitted at a position chosen randomly among [member emission_points]. Particle color will be modulated by [member emission_colors]. </constant> - <constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape"> + <constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="5" enum="EmissionShape"> Particles will be emitted at a position chosen randomly among [member emission_points]. Particle velocity and rotation will be set based on [member emission_normals]. Particle color will be modulated by [member emission_colors]. </constant> - <constant name="EMISSION_SHAPE_MAX" value="5" enum="EmissionShape"> + <constant name="EMISSION_SHAPE_MAX" value="6" enum="EmissionShape"> Represents the size of the [enum EmissionShape] enum. </constant> </constants> diff --git a/doc/classes/CPUParticles3D.xml b/doc/classes/CPUParticles3D.xml index 7152f67f48..f2a0040ed4 100644 --- a/doc/classes/CPUParticles3D.xml +++ b/doc/classes/CPUParticles3D.xml @@ -370,19 +370,22 @@ <constant name="EMISSION_SHAPE_SPHERE" value="1" enum="EmissionShape"> Particles will be emitted in the volume of a sphere. </constant> - <constant name="EMISSION_SHAPE_BOX" value="2" enum="EmissionShape"> + <constant name="EMISSION_SHAPE_SPHERE_SURFACE" value="2" enum="EmissionShape"> + Particles will be emitted on the surface of a sphere. + </constant> + <constant name="EMISSION_SHAPE_BOX" value="3" enum="EmissionShape"> Particles will be emitted in the volume of a box. </constant> - <constant name="EMISSION_SHAPE_POINTS" value="3" enum="EmissionShape"> + <constant name="EMISSION_SHAPE_POINTS" value="4" enum="EmissionShape"> Particles will be emitted at a position chosen randomly among [member emission_points]. Particle color will be modulated by [member emission_colors]. </constant> - <constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape"> + <constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="5" enum="EmissionShape"> Particles will be emitted at a position chosen randomly among [member emission_points]. Particle velocity and rotation will be set based on [member emission_normals]. Particle color will be modulated by [member emission_colors]. </constant> - <constant name="EMISSION_SHAPE_RING" value="5" enum="EmissionShape"> + <constant name="EMISSION_SHAPE_RING" value="6" enum="EmissionShape"> Particles will be emitted in a ring or cylinder. </constant> - <constant name="EMISSION_SHAPE_MAX" value="6" enum="EmissionShape"> + <constant name="EMISSION_SHAPE_MAX" value="7" enum="EmissionShape"> Represents the size of the [enum EmissionShape] enum. </constant> </constants> diff --git a/doc/classes/ParticlesMaterial.xml b/doc/classes/ParticlesMaterial.xml index e05853e816..885bedbc04 100644 --- a/doc/classes/ParticlesMaterial.xml +++ b/doc/classes/ParticlesMaterial.xml @@ -325,19 +325,22 @@ <constant name="EMISSION_SHAPE_SPHERE" value="1" enum="EmissionShape"> Particles will be emitted in the volume of a sphere. </constant> - <constant name="EMISSION_SHAPE_BOX" value="2" enum="EmissionShape"> + <constant name="EMISSION_SHAPE_SPHERE_SURFACE" value="2" enum="EmissionShape"> + Particles will be emitted on the surface of a sphere. + </constant> + <constant name="EMISSION_SHAPE_BOX" value="3" enum="EmissionShape"> Particles will be emitted in the volume of a box. </constant> - <constant name="EMISSION_SHAPE_POINTS" value="3" enum="EmissionShape"> + <constant name="EMISSION_SHAPE_POINTS" value="4" enum="EmissionShape"> Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle color will be modulated by [member emission_color_texture]. </constant> - <constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="4" enum="EmissionShape"> + <constant name="EMISSION_SHAPE_DIRECTED_POINTS" value="5" enum="EmissionShape"> Particles will be emitted at a position determined by sampling a random point on the [member emission_point_texture]. Particle velocity and rotation will be set based on [member emission_normal_texture]. Particle color will be modulated by [member emission_color_texture]. </constant> - <constant name="EMISSION_SHAPE_RING" value="5" enum="EmissionShape"> + <constant name="EMISSION_SHAPE_RING" value="6" enum="EmissionShape"> Particles will be emitted in a ring or cylinder. </constant> - <constant name="EMISSION_SHAPE_MAX" value="6" enum="EmissionShape"> + <constant name="EMISSION_SHAPE_MAX" value="7" enum="EmissionShape"> Represents the size of the [enum EmissionShape] enum. </constant> <constant name="SUB_EMITTER_DISABLED" value="0" enum="SubEmitterMode"> diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml index 068b2c7757..a8b4129061 100644 --- a/doc/classes/ProjectSettings.xml +++ b/doc/classes/ProjectSettings.xml @@ -1655,11 +1655,8 @@ <member name="rendering/environment/ssao/fadeout_to" type="float" setter="" getter="" default="300.0"> Distance at which the screen-space ambient occlusion is fully faded out. Use this hide ambient occlusion at great distances. </member> - <member name="rendering/environment/ssao/half_size" type="bool" setter="" getter="" default="false"> - If [code]true[/code], screen-space ambient occlusion will be rendered at half size and then upscaled before being added to the scene. This is significantly faster but may miss small details. - </member> - <member name="rendering/environment/ssao/half_size.mobile" type="bool" setter="" getter="" default="true"> - Lower-end override for [member rendering/environment/ssao/half_size] on mobile devices, due to performance concerns. + <member name="rendering/environment/ssao/half_size" type="bool" setter="" getter="" default="true"> + If [code]true[/code], screen-space ambient occlusion will be rendered at half size and then upscaled before being added to the scene. This is significantly faster but may miss small details. If [code]false[/code], screen-space ambient occlusion will be rendered at full size. </member> <member name="rendering/environment/ssao/quality" type="int" setter="" getter="" default="2"> Sets the quality of the screen-space ambient occlusion effect. Higher values take more samples and so will result in better quality, at the cost of performance. Setting to [code]ULTRA[/code] will use the [member rendering/environment/ssao/adaptive_target] setting. |