diff options
Diffstat (limited to 'doc/classes/Gradient.xml')
| -rw-r--r-- | doc/classes/Gradient.xml | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/doc/classes/Gradient.xml b/doc/classes/Gradient.xml index d80fed204e..247a7afe85 100644 --- a/doc/classes/Gradient.xml +++ b/doc/classes/Gradient.xml @@ -1,10 +1,10 @@ <?xml version="1.0" encoding="UTF-8" ?> <class name="Gradient" inherits="Resource" category="Core" version="3.2"> <brief_description> - Color interpolator node. + A color interpolator resource which can be used to generate colors between user-defined color points. </brief_description> <description> - Given a set of colors, this node will interpolate them in order, meaning, that if you have color 1, color 2 and color 3, the ramp will interpolate (generate the colors between two colors) from color 1 to color 2 and from color 2 to color 3. Initially the ramp will have 2 colors (black and white), one (black) at ramp lower offset 0 and the other (white) at the ramp higher offset 1. + Given a set of colors, this resource will interpolate them in order. This means that if you have color 1, color 2 and color 3, the ramp will interpolate from color 1 to color 2 and from color 2 to color 3. The ramp will initially have 2 colors (black and white), one (black) at ramp lower offset 0 and the other (white) at the ramp higher offset 1. </description> <tutorials> </tutorials> @@ -17,7 +17,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> - Adds the specified color to the end of the ramp, with the specified offset + Adds the specified color to the end of the ramp, with the specified offset. </description> </method> <method name="get_color" qualifiers="const"> @@ -26,7 +26,7 @@ <argument index="0" name="point" type="int"> </argument> <description> - Returns the color of the ramp color at index [i]point[/i] + Returns the color of the ramp color at index [code]point[/code]. </description> </method> <method name="get_offset" qualifiers="const"> @@ -35,14 +35,14 @@ <argument index="0" name="point" type="int"> </argument> <description> - Returns the offset of the ramp color at index [i]point[/i] + Returns the offset of the ramp color at index [code]point[/code]. </description> </method> <method name="get_point_count" qualifiers="const"> <return type="int"> </return> <description> - Returns the number of colors in the ramp + Returns the number of colors in the ramp. </description> </method> <method name="interpolate"> @@ -51,7 +51,7 @@ <argument index="0" name="offset" type="float"> </argument> <description> - Returns the interpolated color specified by [i]offset[/i] + Returns the interpolated color specified by [code]offset[/code]. </description> </method> <method name="remove_point"> @@ -60,7 +60,7 @@ <argument index="0" name="offset" type="int"> </argument> <description> - Removes the color at the index [i]offset[/i] + Removes the color at the index [code]offset[/code]. </description> </method> <method name="set_color"> @@ -71,7 +71,7 @@ <argument index="1" name="color" type="Color"> </argument> <description> - Sets the color of the ramp color at index [i]point[/i] + Sets the color of the ramp color at index [code]point[/code]. </description> </method> <method name="set_offset"> @@ -82,15 +82,15 @@ <argument index="1" name="offset" type="float"> </argument> <description> - Sets the offset for the ramp color at index [i]point[/i] + Sets the offset for the ramp color at index [code]point[/code]. </description> </method> </methods> <members> - <member name="colors" type="PoolColorArray" setter="set_colors" getter="get_colors"> + <member name="colors" type="PoolColorArray" setter="set_colors" getter="get_colors" default="PoolColorArray( 0, 0, 0, 1, 1, 1, 1, 1 )"> Gradient's colors returned as a [PoolColorArray]. </member> - <member name="offsets" type="PoolRealArray" setter="set_offsets" getter="get_offsets"> + <member name="offsets" type="PoolRealArray" setter="set_offsets" getter="get_offsets" default="PoolRealArray( 0, 1 )"> Gradient's offsets returned as a [PoolRealArray]. </member> </members> |