copy-paste the docs

huwpascoe · Sep 16, 2024 · cb7e597 · cb7e597
1 parent 6ae6b68
commit cb7e597
Show file tree

Hide file tree

Showing 2 changed files with 46 additions and 0 deletions.
diff --git a/doc/classes/CanvasItem.xml b/doc/classes/CanvasItem.xml
@@ -461,6 +461,13 @@
  Returns the transform from the local coordinate system of this [CanvasItem] to the [Viewport]s coordinate system.
  </description>
  </method>
+ <method name="get_instance_shader_parameter" qualifiers="const">
+ <return type="Variant" />
+ <param index="0" name="name" type="StringName" />
+ <description>
+ Get the value of a shader parameter as set on this instance.
+ </description>
+ </method>
  <method name="get_local_mouse_position" qualifiers="const">
  <return type="Vector2" />
  <description>
@@ -557,6 +564,17 @@
  Queues the [CanvasItem] to redraw. During idle time, if [CanvasItem] is visible, [constant NOTIFICATION_DRAW] is sent and [method _draw] is called. This only occurs [b]once[/b] per frame, even if this method has been called multiple times.
  </description>
  </method>
+ <method name="set_instance_shader_parameter">
+ <return type="void" />
+ <param index="0" name="name" type="StringName" />
+ <param index="1" name="value" type="Variant" />
+ <description>
+ Set the value of a shader uniform for this instance only ([url=$DOCS_URL/tutorials/shaders/shader_reference/shading_language.html#per-instance-uniforms]per-instance uniform[/url]). See also [method ShaderMaterial.set_shader_parameter] to assign a uniform on all instances using the same [ShaderMaterial].
+ [b]Note:[/b] For a shader uniform to be assignable on a per-instance basis, it [i]must[/i] be defined with [code]instance uniform ...[/code] rather than [code]uniform ...[/code] in the shader code.
+ [b]Note:[/b] [param name] is case-sensitive and must match the name of the uniform in the code exactly (not the capitalized name in the inspector).
+ [b]Note:[/b] Per-instance shader uniforms are currently only available in 3D, so there is no 2D equivalent of this method.
+ </description>
+ </method>
  <method name="set_notify_local_transform">
  <return type="void" />
  <param index="0" name="enable" type="bool" />

diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml
@@ -1865,6 +1865,34 @@
  Sets the visibility range values for the given geometry instance. Equivalent to [member GeometryInstance3D.visibility_range_begin] and related properties.
  </description>
  </method>
+ <method name="instance_item_get_shader_parameter" qualifiers="const">
+ <return type="Variant" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="parameter" type="StringName" />
+ <description>
+ </description>
+ </method>
+ <method name="instance_item_get_shader_parameter_default_value" qualifiers="const">
+ <return type="Variant" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="parameter" type="StringName" />
+ <description>
+ </description>
+ </method>
+ <method name="instance_item_get_shader_parameter_list" qualifiers="const">
+ <return type="Dictionary[]" />
+ <param index="0" name="instance" type="RID" />
+ <description>
+ </description>
+ </method>
+ <method name="instance_item_set_shader_parameter">
+ <return type="void" />
+ <param index="0" name="instance" type="RID" />
+ <param index="1" name="parameter" type="StringName" />
+ <param index="2" name="value" type="Variant" />
+ <description>
+ </description>
+ </method>
  <method name="instance_reset_physics_interpolation">
  <return type="void" />
  <param index="0" name="instance" type="RID" />