Skip to content

Commit 75958c9

Browse files
committed
Merge pull request #107976 from Calinou/doc-gradient-sample
Document `Gradient.sample()` clamping behavior
2 parents b3924e6 + 5c638b2 commit 75958c9

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

doc/classes/Gradient.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
<return type="Color" />
5757
<param index="0" name="offset" type="float" />
5858
<description>
59-
Returns the interpolated color specified by [param offset].
59+
Returns the interpolated color specified by [param offset]. [param offset] should be between [code]0.0[/code] and [code]1.0[/code] (inclusive). Using a value lower than [code]0.0[/code] will return the same color as [code]0.0[/code], and using a value higher than [code]1.0[/code] will return the same color as [code]1.0[/code]. If your input value is not within this range, consider using [method @GlobalScope.remap] on the input value with output values set to [code]0.0[/code] and [code]1.0[/code].
6060
</description>
6161
</method>
6262
<method name="set_color">

0 commit comments

Comments
 (0)