Remove redundant info on the enum types used
This commit is contained in:
Haoyu Qiu
@ -72,7 +72,7 @@
|
||||
<return type="void" />
|
||||
<param index="0" name="shape" type="int" enum="RenderingServer.DOFBokehShape" />
|
||||
<description>
|
||||
Sets the shape of the DOF bokeh pattern. Different shapes may be used to achieve artistic effect, or to meet performance targets. For more detail on available options see [enum DOFBokehShape].
|
||||
Sets the shape of the DOF bokeh pattern to [param shape]. Different shapes may be used to achieve artistic effect, or to meet performance targets.
|
||||
</description>
|
||||
</method>
|
||||
<method name="camera_attributes_set_dof_blur_quality">
|
||||
@ -80,7 +80,7 @@
|
||||
<param index="0" name="quality" type="int" enum="RenderingServer.DOFBlurQuality" />
|
||||
<param index="1" name="use_jitter" type="bool" />
|
||||
<description>
|
||||
Sets the quality level of the DOF blur effect to one of the options in [enum DOFBlurQuality]. [param use_jitter] can be used to jitter samples taken during the blur pass to hide artifacts at the cost of looking more fuzzy.
|
||||
Sets the quality level of the DOF blur effect to [param quality]. [param use_jitter] can be used to jitter samples taken during the blur pass to hide artifacts at the cost of looking more fuzzy.
|
||||
</description>
|
||||
</method>
|
||||
<method name="camera_attributes_set_exposure">
|
||||
@ -791,7 +791,7 @@
|
||||
<param index="0" name="light" type="RID" />
|
||||
<param index="1" name="mode" type="int" enum="RenderingServer.CanvasLightBlendMode" />
|
||||
<description>
|
||||
Sets the blend mode for the given canvas light. See [enum CanvasLightBlendMode] for options. Equivalent to [member Light2D.blend_mode].
|
||||
Sets the blend mode for the given canvas light to [param mode]. Equivalent to [member Light2D.blend_mode].
|
||||
</description>
|
||||
</method>
|
||||
<method name="canvas_light_set_color">
|
||||
@ -864,7 +864,7 @@
|
||||
<param index="0" name="light" type="RID" />
|
||||
<param index="1" name="mode" type="int" enum="RenderingServer.CanvasLightMode" />
|
||||
<description>
|
||||
The mode of the light, see [enum CanvasLightMode] constants.
|
||||
Sets the mode of the canvas light.
|
||||
</description>
|
||||
</method>
|
||||
<method name="canvas_light_set_shadow_color">
|
||||
@ -888,7 +888,7 @@
|
||||
<param index="0" name="light" type="RID" />
|
||||
<param index="1" name="filter" type="int" enum="RenderingServer.CanvasLightShadowFilter" />
|
||||
<description>
|
||||
Sets the canvas light's shadow's filter, see [enum CanvasLightShadowFilter] constants.
|
||||
Sets the canvas light's shadow's filter.
|
||||
</description>
|
||||
</method>
|
||||
<method name="canvas_light_set_shadow_smooth">
|
||||
@ -962,7 +962,7 @@
|
||||
<param index="0" name="occluder_polygon" type="RID" />
|
||||
<param index="1" name="mode" type="int" enum="RenderingServer.CanvasOccluderPolygonCullMode" />
|
||||
<description>
|
||||
Sets an occluder polygons cull mode. See [enum CanvasOccluderPolygonCullMode] constants.
|
||||
Sets an occluder polygon's cull mode.
|
||||
</description>
|
||||
</method>
|
||||
<method name="canvas_occluder_polygon_set_shape">
|
||||
@ -1629,7 +1629,7 @@
|
||||
<return type="int" />
|
||||
<param index="0" name="info" type="int" enum="RenderingServer.RenderingInfo" />
|
||||
<description>
|
||||
Returns a statistic about the rendering engine which can be used for performance profiling. See [enum RenderingServer.RenderingInfo] for a list of values that can be queried. See also [method viewport_get_render_info], which returns information specific to a viewport.
|
||||
Returns a statistic about the rendering engine which can be used for performance profiling. See also [method viewport_get_render_info], which returns information specific to a viewport.
|
||||
[b]Note:[/b] Only 3D rendering is currently taken into account by some of these values, such as the number of draw calls.
|
||||
[b]Note:[/b] Rendering information is not available until at least 2 frames have been rendered by the engine. If rendering information is not available, [method get_rendering_info] returns [code]0[/code]. To print rendering information in [code]_ready()[/code] successfully, use the following:
|
||||
[codeblock]
|
||||
@ -1853,7 +1853,7 @@
|
||||
<param index="0" name="instance" type="RID" />
|
||||
<param index="1" name="shadow_casting_setting" type="int" enum="RenderingServer.ShadowCastingSetting" />
|
||||
<description>
|
||||
Sets the shadow casting setting to one of [enum ShadowCastingSetting]. Equivalent to [member GeometryInstance3D.cast_shadow].
|
||||
Sets the shadow casting setting. Equivalent to [member GeometryInstance3D.cast_shadow].
|
||||
</description>
|
||||
</method>
|
||||
<method name="instance_geometry_set_flag">
|
||||
@ -1862,7 +1862,7 @@
|
||||
<param index="1" name="flag" type="int" enum="RenderingServer.InstanceFlags" />
|
||||
<param index="2" name="enabled" type="bool" />
|
||||
<description>
|
||||
Sets the flag for a given [enum InstanceFlags]. See [enum InstanceFlags] for more details.
|
||||
Sets the [param flag] for a given [param instance] to [param enabled].
|
||||
</description>
|
||||
</method>
|
||||
<method name="instance_geometry_set_lightmap">
|
||||
@ -2084,7 +2084,7 @@
|
||||
<param index="0" name="light" type="RID" />
|
||||
<param index="1" name="mode" type="int" enum="RenderingServer.LightDirectionalShadowMode" />
|
||||
<description>
|
||||
Sets the shadow mode for this directional light. Equivalent to [member DirectionalLight3D.directional_shadow_mode]. See [enum LightDirectionalShadowMode] for options.
|
||||
Sets the shadow mode for this directional light. Equivalent to [member DirectionalLight3D.directional_shadow_mode].
|
||||
</description>
|
||||
</method>
|
||||
<method name="light_directional_set_sky_mode">
|
||||
@ -2167,7 +2167,7 @@
|
||||
<param index="1" name="param" type="int" enum="RenderingServer.LightParam" />
|
||||
<param index="2" name="value" type="float" />
|
||||
<description>
|
||||
Sets the specified 3D light parameter. See [enum LightParam] for options. Equivalent to [method Light3D.set_param].
|
||||
Sets the specified 3D light parameter. Equivalent to [method Light3D.set_param].
|
||||
</description>
|
||||
</method>
|
||||
<method name="light_set_projector" keywords="light_set_cookie">
|
||||
@ -3020,7 +3020,7 @@
|
||||
<param index="0" name="particles" type="RID" />
|
||||
<param index="1" name="order" type="int" enum="RenderingServer.ParticlesDrawOrder" />
|
||||
<description>
|
||||
Sets the draw order of the particles to one of the named enums from [enum ParticlesDrawOrder]. See [enum ParticlesDrawOrder] for options. Equivalent to [member GPUParticles3D.draw_order].
|
||||
Sets the draw order of the particles. Equivalent to [member GPUParticles3D.draw_order].
|
||||
</description>
|
||||
</method>
|
||||
<method name="particles_set_draw_pass_mesh">
|
||||
@ -3339,7 +3339,7 @@
|
||||
<param index="0" name="probe" type="RID" />
|
||||
<param index="1" name="mode" type="int" enum="RenderingServer.ReflectionProbeUpdateMode" />
|
||||
<description>
|
||||
Sets how often the reflection probe updates. Can either be once or every frame. See [enum ReflectionProbeUpdateMode] for options.
|
||||
Sets how often the reflection probe updates. Can either be once or every frame.
|
||||
</description>
|
||||
</method>
|
||||
<method name="request_frame_drawn_callback">
|
||||
@ -3878,7 +3878,7 @@
|
||||
<param index="1" name="type" type="int" enum="RenderingServer.ViewportRenderInfoType" />
|
||||
<param index="2" name="info" type="int" enum="RenderingServer.ViewportRenderInfo" />
|
||||
<description>
|
||||
Returns a statistic about the rendering engine which can be used for performance profiling. This is separated into render pass [param type]s, each of them having the same [param info]s you can query (different passes will return different values). See [enum RenderingServer.ViewportRenderInfoType] for a list of render pass types and [enum RenderingServer.ViewportRenderInfo] for a list of information that can be queried.
|
||||
Returns a statistic about the rendering engine which can be used for performance profiling. This is separated into render pass [param type]s, each of them having the same [param info]s you can query (different passes will return different values).
|
||||
See also [method get_rendering_info], which returns global information across all viewports.
|
||||
[b]Note:[/b] Viewport rendering information is not available until at least 2 frames have been rendered by the engine. If rendering information is not available, [method viewport_get_render_info] returns [code]0[/code]. To print rendering information in [code]_ready()[/code] successfully, use the following:
|
||||
[codeblock]
|
||||
@ -3912,7 +3912,7 @@
|
||||
<return type="int" enum="RenderingServer.ViewportUpdateMode" />
|
||||
<param index="0" name="viewport" type="RID" />
|
||||
<description>
|
||||
Returns the viewport's update mode. See [enum ViewportUpdateMode] constants for options.
|
||||
Returns the viewport's update mode.
|
||||
[b]Warning:[/b] Calling this from any thread other than the rendering thread will be detrimental to performance.
|
||||
</description>
|
||||
</method>
|
||||
@ -3976,7 +3976,7 @@
|
||||
<param index="0" name="viewport" type="RID" />
|
||||
<param index="1" name="clear_mode" type="int" enum="RenderingServer.ViewportClearMode" />
|
||||
<description>
|
||||
Sets the clear mode of a viewport. See [enum ViewportClearMode] for options.
|
||||
Sets the clear mode of a viewport.
|
||||
</description>
|
||||
</method>
|
||||
<method name="viewport_set_debug_draw">
|
||||
@ -3984,7 +3984,7 @@
|
||||
<param index="0" name="viewport" type="RID" />
|
||||
<param index="1" name="draw" type="int" enum="RenderingServer.ViewportDebugDraw" />
|
||||
<description>
|
||||
Sets the debug draw mode of a viewport. See [enum ViewportDebugDraw] for options.
|
||||
Sets the debug draw mode of a viewport.
|
||||
</description>
|
||||
</method>
|
||||
<method name="viewport_set_default_canvas_item_texture_filter">
|
||||
@ -3992,7 +3992,7 @@
|
||||
<param index="0" name="viewport" type="RID" />
|
||||
<param index="1" name="filter" type="int" enum="RenderingServer.CanvasItemTextureFilter" />
|
||||
<description>
|
||||
Sets the default texture filtering mode for the specified [param viewport] RID. See [enum CanvasItemTextureFilter] for options.
|
||||
Sets the default texture filtering mode for the specified [param viewport] RID.
|
||||
</description>
|
||||
</method>
|
||||
<method name="viewport_set_default_canvas_item_texture_repeat">
|
||||
@ -4000,7 +4000,7 @@
|
||||
<param index="0" name="viewport" type="RID" />
|
||||
<param index="1" name="repeat" type="int" enum="RenderingServer.CanvasItemTextureRepeat" />
|
||||
<description>
|
||||
Sets the default texture repeat mode for the specified [param viewport] RID. See [enum CanvasItemTextureRepeat] for options.
|
||||
Sets the default texture repeat mode for the specified [param viewport] RID.
|
||||
</description>
|
||||
</method>
|
||||
<method name="viewport_set_disable_2d">
|
||||
@ -4056,7 +4056,7 @@
|
||||
<param index="0" name="viewport" type="RID" />
|
||||
<param index="1" name="msaa" type="int" enum="RenderingServer.ViewportMSAA" />
|
||||
<description>
|
||||
Sets the multisample antialiasing mode for 2D/Canvas on the specified [param viewport] RID. See [enum ViewportMSAA] for options. Equivalent to [member ProjectSettings.rendering/anti_aliasing/quality/msaa_2d] or [member Viewport.msaa_2d].
|
||||
Sets the multisample antialiasing mode for 2D/Canvas on the specified [param viewport] RID. Equivalent to [member ProjectSettings.rendering/anti_aliasing/quality/msaa_2d] or [member Viewport.msaa_2d].
|
||||
</description>
|
||||
</method>
|
||||
<method name="viewport_set_msaa_3d">
|
||||
@ -4064,7 +4064,7 @@
|
||||
<param index="0" name="viewport" type="RID" />
|
||||
<param index="1" name="msaa" type="int" enum="RenderingServer.ViewportMSAA" />
|
||||
<description>
|
||||
Sets the multisample antialiasing mode for 3D on the specified [param viewport] RID. See [enum ViewportMSAA] for options. Equivalent to [member ProjectSettings.rendering/anti_aliasing/quality/msaa_3d] or [member Viewport.msaa_3d].
|
||||
Sets the multisample antialiasing mode for 3D on the specified [param viewport] RID. Equivalent to [member ProjectSettings.rendering/anti_aliasing/quality/msaa_3d] or [member Viewport.msaa_3d].
|
||||
</description>
|
||||
</method>
|
||||
<method name="viewport_set_occlusion_culling_build_quality">
|
||||
@ -4205,7 +4205,7 @@
|
||||
<param index="0" name="viewport" type="RID" />
|
||||
<param index="1" name="update_mode" type="int" enum="RenderingServer.ViewportUpdateMode" />
|
||||
<description>
|
||||
Sets when the viewport should be updated. See [enum ViewportUpdateMode] constants for options.
|
||||
Sets when the viewport should be updated.
|
||||
</description>
|
||||
</method>
|
||||
<method name="viewport_set_use_debanding">
|
||||
|
||||
Reference in New Issue
Block a user