未验证 提交 484964ef 编写于 作者: M Michael Herzog 提交者: GitHub

Docs: Add some missing API. (#23510)

上级 fb9d575c
......@@ -47,6 +47,11 @@
Default is *0*.
</p>
<h3>[property:Number cumulativeWeightAdditive]</h3>
<p>
Default is *0*.
</p>
<h3>[property:Number valueSize]</h3>
<p>
......@@ -73,6 +78,14 @@
If weight is *0* this does nothing.
</p>
<h3>[method:undefined accumulateAdditive]( [param:Number weight] )</h3>
<p>
Accumulate data in the 'incoming' region into 'add'.<br />
If weight is *0* this does nothing.
</p>
<h3>[method:undefined apply]( [param:Number accuIndex] )</h3>
<p>
Apply the state of [page:PropertyMixer.buffer buffer] 'accu[i]' to the binding when accus differ.
......
......@@ -116,6 +116,11 @@
setting / removing filters.
</p>
<h3>[method:Float getDetune]()</h3>
<p>
Returns the detuning of oscillation in cents.
</p>
<h3>[method:BiquadFilterNode getFilter]()</h3>
<p>
Returns the first element of the [page:Audio.filters filters] array.
......@@ -168,6 +173,11 @@
If [page:Audio.autoplay autoplay], also starts playback.
</p>
<h3>[method:this setDetune]( [param:Float value] )</h3>
<p>
Defines the detuning of oscillation in cents.
</p>
<h3>[method:this setFilter]( filter )</h3>
<p>
Applies a single filter node to the audio.
......
......@@ -22,6 +22,13 @@
Returns a data URI containing a representation of the given image.
</p>
<h3>[method:Object sRGBToLinear]( [param:HTMLCanvasElement image] | [param:HTMLImageElement image] | [param:ImageBitmap image] )</h3>
<p>
image -- The image object.<br /><br />
Converts the given sRGB image data to linear color space.
</p>
<h2>Source</h2>
<p>
......
......@@ -62,6 +62,11 @@ rectLight.add( rectLightHelper );
See the base [page:Light Light] class for common properties.
</p>
<h3>[property:Float height]</h3>
<p>
The height of the light.
</p>
<h3>[property:Float intensity]</h3>
<p>
The light's intensity. Default is *1*. <br />
......@@ -81,6 +86,11 @@ rectLight.add( rectLightHelper );
Changing the power will also change the light's intensity.
</p>
<h3>[property:Float width]</h3>
<p>
The width of the light.
</p>
<h2>Methods</h2>
<p>
See the base [page:Light Light] class for common methods.
......
......@@ -141,6 +141,12 @@ zAxis = (c, f, i)
<h3>[method:this multiplyScalar]( [param:Float s] )</h3>
<p>Multiplies every component of the matrix by the scalar value *s*.</p>
<h3>[method:this rotate]( [param:Float theta] )</h3>
<p>Rotates this matrix by the given angle (in radians).</p>
<h3>[method:this scale]( [param:Float sx], [param:Float sy] )</h3>
<p>Scales this matrix with the given scalar values.</p>
<h3>[method:this set]( [param:Float n11], [param:Float n12], [param:Float n13], [param:Float n21], [param:Float n22], [param:Float n23], [param:Float n31], [param:Float n32], [param:Float n33] )</h3>
<p>
[page:Float n11] - value to put in row 1, col 1.<br />
......@@ -183,6 +189,9 @@ zAxis = (c, f, i)
[link:https://en.wikipedia.org/wiki/Row-_and_column-major_order#Column-major_order column-major] format.
</p>
<h3>[method:this translate]( [param:Float tx], [param:Float ty] )</h3>
<p>Translates this matrix by the given scalar values.</p>
<h3>[method:this transpose]()</h3>
<p>[link:https://en.wikipedia.org/wiki/Transpose Transposes] this matrix in place.</p>
......
......@@ -113,6 +113,17 @@
Calculate a [page:Plane plane] based on the triangle. .
</p>
<h3>[method:Vector2 getUV]( [param:Vector3 point], [param:Vector2 uv1], [param:Vector2 uv2], [param:Vector2 uv3], [param:Vector2 target] )</h3>
<p>
[page:Vector3 point] - The point on the triangle.<br />
[page:Vector2 uv1] - The uv coordinate of the triangle's first vertex.<br />
[page:Vector2 uv2] - The uv coordinate of the triangle's second vertex.<br />
[page:Vector2 uv2] - The uv coordinate of the triangle's third vertex.<br />
[page:Vector2 target] — the result will be copied into this Vector2.<br /><br />
Returns the uv coordinates for the given point on the triangle.
</p>
<h3>[method:Boolean intersectsBox]( [param:Box3 box] )</h3>
<p>
[page:Box3 box] - Box to check for intersection against.<br /><br />
......@@ -120,6 +131,13 @@
Determines whether or not this triangle intersects [page:Box3 box].
</p>
<h3>[method:Boolean isFrontFacing]( [param:Vector3 direction] )</h3>
<p>
[page:Vector3 direction] - The direction to test.<br /><br />
Whether the triangle is oriented towards the given direction or not.
</p>
<h3>[method:this set]( [param:Vector3 a], [param:Vector3 b], [param:Vector3 c] ) [param:Triangle this]</h3>
<p>
Sets the triangle's [page:.a a], [page:.b b] and [page:.c c] properties to the passed [page:Vector3 vector3s].<br>
......
......@@ -69,6 +69,11 @@
in two different coordinate spaces for the same WebXR controller.
</p>
<h3>[method:Float getFoveation]()</h3>
<p>
Returns the amount of foveation used by the XR compositor for the projection layer.
</p>
<h3>[method:Group getHand]( [param:Integer index] )</h3>
<p>
[page:Integer index] — The index of the controller. <br /><br />
......@@ -87,6 +92,13 @@
Returns the *XRSession* object which allows a more fine-grained management of active WebXR sessions on application level.
</p>
<h3>[method:undefined setFoveation]( [param:Float foveation] )</h3>
<p>
[page:Float foveation] — The foveation to set.<br /><br />
Specifies the amount of foveation used by the XR compositor for the layer. Must be a value between *0* and *1*.
</p>
<h3>[method:undefined setFramebufferScaleFactor]( [param:Float framebufferScaleFactor] )</h3>
<p>
[page:Float framebufferScaleFactor] — The framebuffer scale factor to set.<br /><br />
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册