publish 1.15.6

CHANGELOG.md

@@ -1,3 +1,7 @@
+## [1.15.6](https://github.com/hiloteam/Hilo3d/compare/1.15.5...1.15.6) (2020-08-26)
+* update doc & .d.ts 
+
+
 ## [1.15.5](https://github.com/hiloteam/Hilo3d/compare/1.15.4...1.15.5) (2020-07-31)
 
 

README.md

@@ -23,7 +23,7 @@ English | [简体中文](./README_ZH.md)
 * use script tag from a [cdn][cdn-url]
 
 	```
-	<script src='//g.alicdn.com/hilo/Hilo3d/1.15.5/Hilo3d.js'></script>
+	<script src='//g.alicdn.com/hilo/Hilo3d/1.15.6/Hilo3d.js'></script>
 	```
 
 ### Documentation
@@ -119,4 +119,4 @@ English | [简体中文](./README_ZH.md)
 [size-image]:https://img.badgesize.io/hiloteam/hilo3d/master/build/Hilo3d.js.svg?compression=gzip&style=flat-square
 [ci-url]:https://github.com/hiloteam/Hilo3d/actions?query=workflow%3A%22npm+test%22+branch%3Adev
 [ci-image]:https://img.shields.io/github/workflow/status/hiloteam/Hilo3d/npm%20test?style=flat-square
-[cdn-url]: https://g.alicdn.com/hilo/Hilo3d/1.15.5/Hilo3d.js
+[cdn-url]: https://g.alicdn.com/hilo/Hilo3d/1.15.6/Hilo3d.js

README_ZH.md

@@ -23,7 +23,7 @@
 * 使用 script 标签加载 [cdn][cdn-url]
 
     ```
-    <script src='//g.alicdn.com/hilo/Hilo3d/1.15.5/Hilo3d.js'></script>
+    <script src='//g.alicdn.com/hilo/Hilo3d/1.15.6/Hilo3d.js'></script>
     ```
 
 ### 文档
@@ -120,4 +120,4 @@
 [size-image]:https://img.badgesize.io/hiloteam/hilo3d/master/build/Hilo3d.js.svg?compression=gzip&style=flat-square
 [ci-url]:https://github.com/hiloteam/Hilo3d/actions?query=workflow%3A%22npm+test%22+branch%3Adev
 [ci-image]:https://img.shields.io/github/workflow/status/hiloteam/Hilo3d/npm%20test?style=flat-square
-[cdn-url]: https://g.alicdn.com/hilo/Hilo3d/1.15.5/Hilo3d.js
+[cdn-url]: https://g.alicdn.com/hilo/Hilo3d/1.15.6/Hilo3d.js

docs/Stage.html

@@ -7856,7 +7856,41 @@ <h4 class="name" id="Stage">
 
 
 
-                <p>stage的容器</p></td>
+                <p>stage的容器, 如果有，会把canvas加进container里。</p></td>
+        </tr>
+
+
+
+        <tr>
+
+                <td class="name"><code>canvas</code></td>
+
+
+            <td class="type">
+
+
+<span class="param-type">HTMLCanvasElement</span>
+
+
+
+            </td>
+
+
+                <td class="default">
+
+                </td>
+
+
+            <td class="description last">
+
+
+                        <span class="optional">optional</span>
+
+
+
+
+
+                <p>stage的canvas，不传会自动创建。</p></td>
         </tr>
 
 
@@ -10038,7 +10072,7 @@ <h4 class="name" id="resize">
 
 
             <div class="tag-source">
-                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line149">line 149</a>
+                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line150">line 150</a>
             </div>
 
         </div>
@@ -10297,7 +10331,7 @@ <h4 class="name" id="setOffset">
 
 
             <div class="tag-source">
-                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line177">line 177</a>
+                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line178">line 178</a>
             </div>
 
         </div>
@@ -10464,7 +10498,7 @@ <h4 class="name" id="viewport">
 
 
             <div class="tag-source">
-                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line195">line 195</a>
+                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line196">line 196</a>
             </div>
 
         </div>
@@ -10677,7 +10711,7 @@ <h4 class="name" id="tick">
 
 
             <div class="tag-source">
-                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line205">line 205</a>
+                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line206">line 206</a>
             </div>
 
         </div>
@@ -10821,7 +10855,7 @@ <h4 class="name" id="enableDOMEvent">
 
 
             <div class="tag-source">
-                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line218">line 218</a>
+                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line219">line 219</a>
             </div>
 
         </div>
@@ -10991,7 +11025,7 @@ <h4 class="name" id="updateDomViewport">
 
 
             <div class="tag-source">
-                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line314">line 314</a>
+                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line315">line 315</a>
             </div>
 
         </div>
@@ -11090,7 +11124,7 @@ <h4 class="name" id="getMeshResultAtPoint">
 
 
             <div class="tag-source">
-                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line329">line 329</a>
+                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line330">line 330</a>
             </div>
 
         </div>
@@ -11316,7 +11350,7 @@ <h4 class="name" id="releaseGLResource">
 
 
             <div class="tag-source">
-                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line356">line 356</a>
+                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line357">line 357</a>
             </div>
 
         </div>
@@ -16275,7 +16309,7 @@ <h4 class="name" id="destroy">
 
 
             <div class="tag-source">
-                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line365">line 365</a>
+                <a href="core_Stage.js.html">core/Stage.js</a>, <a href="core_Stage.js.html#line366">line 366</a>
             </div>
 
         </div>

docs/core_Stage.js.html

@@ -7791,7 +7791,8 @@ <h1 class="page-title" data-filename="core_Stage.js.html">Source: core/Stage.js<
     /**
      * @constructs
      * @param {Object} [params] 创建对象的属性参数。可包含此类的所有属性，所有属性会透传给 Renderer。
-     * @param {HTMLElement} [params.container] stage的容器
+     * @param {HTMLElement} [params.container] stage的容器, 如果有，会把canvas加进container里。
+     * @param {HTMLCanvasElement} [params.canvas] stage的canvas，不传会自动创建。
      * @param {Number} [params.pixelRatio=根据设备自动判断] 像素密度。
      * @param {Color} [params.clearColor=new Color(1, 1, 1, 1)] 背景色。
      * @param {Boolean} [params.useFramebuffer=false] 是否使用Framebuffer，有后处理需求时需要。

docs/index.html

@@ -7739,7 +7739,7 @@ <h3> </h3>
 <h3 align="center">A 3D WebGL Rendering Engine</h3>
 <hr>
 <p><a href="#Installation">Installation</a> • <a href="#Documentation">Documentation</a> • <a href="#Development">Development</a> • <a href="#Showcase">Showcase</a> • <a href="#Examples">Examples</a> • <a href="#Authors">Authors</a> • <a href="#License">License</a></p>
-<p><a target="_blank" href="https://www.npmjs.com/package/hilo3d"><img src="https://img.shields.io/npm/v/hilo3d.svg?style=flat-square" alt="npm"></a> <a target="_blank" href="https://github.com/hiloteam/Hilo3d/actions?query=workflow%3A%22npm+test%22+branch%3Adev"><img src="https://img.shields.io/github/workflow/status/hiloteam/Hilo3d/npm%20test?style=flat-square" alt="ci"></a> <a target="_blank" href="https://g.alicdn.com/hilo/Hilo3d/1.15.5/Hilo3d.js"><img src="https://img.badgesize.io/hiloteam/hilo3d/master/build/Hilo3d.js.svg?compression=gzip&amp;style=flat-square" alt="size"></a> <a target="_blank" href="https://gitter.im/hiloteam/Hilo3d?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge&amp;utm_content=badge"><img src="https://img.shields.io/badge/GITTER-join%20chat-green.svg?style=flat-square" alt="gitter.im"></a></p>
+<p><a target="_blank" href="https://www.npmjs.com/package/hilo3d"><img src="https://img.shields.io/npm/v/hilo3d.svg?style=flat-square" alt="npm"></a> <a target="_blank" href="https://github.com/hiloteam/Hilo3d/actions?query=workflow%3A%22npm+test%22+branch%3Adev"><img src="https://img.shields.io/github/workflow/status/hiloteam/Hilo3d/npm%20test?style=flat-square" alt="ci"></a> <a target="_blank" href="https://g.alicdn.com/hilo/Hilo3d/1.15.6/Hilo3d.js"><img src="https://img.badgesize.io/hiloteam/hilo3d/master/build/Hilo3d.js.svg?compression=gzip&amp;style=flat-square" alt="size"></a> <a target="_blank" href="https://gitter.im/hiloteam/Hilo3d?utm_source=badge&amp;utm_medium=badge&amp;utm_campaign=pr-badge&amp;utm_content=badge"><img src="https://img.shields.io/badge/GITTER-join%20chat-green.svg?style=flat-square" alt="gitter.im"></a></p>
 <h3>Features</h3>
 <ul>
 <li>Compatible for multiple mobile and desktop browsers.</li>
@@ -7755,8 +7755,8 @@ <h3 id="Installation">Installation</h3>
 </code></pre>
 </li>
 <li>
-<p>use script tag from a <a target="_blank" href="https://g.alicdn.com/hilo/Hilo3d/1.15.5/Hilo3d.js">cdn</a></p>
-<pre class="prettyprint source"><code>&lt;script src='//g.alicdn.com/hilo/Hilo3d/1.15.5/Hilo3d.js'>&lt;/script>
+<p>use script tag from a <a target="_blank" href="https://g.alicdn.com/hilo/Hilo3d/1.15.6/Hilo3d.js">cdn</a></p>
+<pre class="prettyprint source"><code>&lt;script src='//g.alicdn.com/hilo/Hilo3d/1.15.6/Hilo3d.js'>&lt;/script>
 </code></pre>
 </li>
 </ul>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "hilo3d",
-  "version": "1.15.5",
+  "version": "1.15.6",
   "description": "Hilo3d, a WebGL 3d engine.",
   "main": "build/Hilo3d.js",
   "types": "types/index.d.ts",

types/index.d.ts

@@ -6328,7 +6328,8 @@ declare class Tween {
  *     height:innerHeight
  * });
  * @param [params] - 创建对象的属性参数。可包含此类的所有属性，所有属性会透传给 Renderer。
- * @param [params.container] - stage的容器
+ * @param [params.container] - stage的容器, 如果有，会把canvas加进container里。
+ * @param [params.canvas] - stage的canvas，不传会自动创建。
  * @param [params.pixelRatio = 根据设备自动判断] - 像素密度。
  * @param [params.clearColor = new Color(1, 1, 1, 1)] - 背景色。
  * @param [params.useFramebuffer = false] - 是否使用Framebuffer，有后处理需求时需要。
@@ -6346,6 +6347,7 @@ declare class Tween {
 declare class Stage extends Node {
     constructor(params?: {
         container?: HTMLElement;
+        canvas?: HTMLCanvasElement;
         pixelRatio?: number;
         clearColor?: Color;
         useFramebuffer?: boolean;