Browse Source

Merge pull request #45934 from angad-k/fix-smoothstep-function-documentation

fix minor issue in smooth step function's documentation
Rémi Verschelde 4 năm trước cách đây
mục cha
commit
8107cbd66e
1 tập tin đã thay đổi với 1 bổ sung1 xóa
  1. 1 1
      doc/classes/@GlobalScope.xml

+ 1 - 1
doc/classes/@GlobalScope.xml

@@ -935,7 +935,7 @@
 			<description>
 				Returns the result of smoothly interpolating the value of [code]x[/code] between [code]0[/code] and [code]1[/code], based on the where [code]x[/code] lies with respect to the edges [code]from[/code] and [code]to[/code].
 				The return value is [code]0[/code] if [code]x &lt;= from[/code], and [code]1[/code] if [code]x &gt;= to[/code]. If [code]x[/code] lies between [code]from[/code] and [code]to[/code], the returned value follows an S-shaped curve that maps [code]x[/code] between [code]0[/code] and [code]1[/code].
-				This S-shaped curve is the cubic Hermite interpolator, given by [code]f(x) = 3*x^2 - 2*x^3[/code].
+				This S-shaped curve is the cubic Hermite interpolator, given by [code]f(y) = 3*y^2 - 2*y^3[/code] where [code]y = (x-from) / (to-from)[/code].
 				[codeblock]
 				smoothstep(0, 2, -5.0) # Returns 0.0
 				smoothstep(0, 2, 0.5) # Returns 0.15625