Update descriptions

rexrainbow · Jul 18, 2023 · 4a4c5b7 · 4a4c5b7
1 parent f2a5559
commit 4a4c5b7
Show file tree

Hide file tree

Showing 156 changed files with 4,168 additions and 102 deletions.
diff --git a/docs/docs/alphamaskimage.md b/docs/docs/alphamaskimage.md
@@ -208,4 +208,20 @@ image.setTexture(key, frame, {
     - `undefined` : Expand mask texture size to fit target texture.
     - A number : Scale mask texture size.
 - `backgroundColor` : Background color filled with masked area.
-    - `undefiined` : No background color.
+    - `undefiined` : No background color.
+
+### Other properties
+
+See [game object](gameobject.md)
+
+### Create mask
+
+```javascript
+var mask = image.createBitmapMask();
+```
+
+See [mask](mask.md)
+
+### Shader effects
+
+Support [preFX and postFX effects](shader-builtin.md)
diff --git a/docs/docs/bbcodetext.md b/docs/docs/bbcodetext.md
@@ -745,3 +745,19 @@ txt.setDelimiters(delimiterLeft, delimiterRight); // '<', '>'
     txt.setRTL(rtl).setText(newContent);
     ```
     - Invoke `setRTL` method before setting new content.
+
+### Other properties
+
+See [game object](gameobject.md)
+
+### Create mask
+
+```javascript
+var mask = txt.createBitmapMask();
+```
+
+See [mask](mask.md)
+
+### Shader effects
+
+Support [preFX and postFX effects](shader-builtin.md)
diff --git a/docs/docs/bitmaptext.md b/docs/docs/bitmaptext.md
@@ -360,10 +360,27 @@ var data = txt.getCharacterAt(x, y);
     - `r` : The right-most point of this character, including xAdvance.
     - `line` : The line number the character appears on.
 
+
 ### Other properties
 
 See [game object](gameobject.md)
 
+### Create mask
+
+```javascript
+var mask = txt.createBitmapMask();
+```
+
+See [mask](mask.md)
+
+### Shader effects
+
+Support [postFX effects](shader-builtin.md)
+
+!!! note
+    No preFX effect support
+
+
 ## Appendix
 
 ### Default characters set of retro font

diff --git a/docs/docs/blitter.md b/docs/docs/blitter.md
@@ -204,3 +204,22 @@ bob.destroy();
 ```javascript
 var data = bob.data;  // {}
 ```
+
+### Other properties
+
+See [game object](gameobject.md)
+
+### Create mask
+
+```javascript
+var mask = bob.createBitmapMask();
+```
+
+See [mask](mask.md)
+
+### Shader effects
+
+Support [postFX effects](shader-builtin.md)
+
+!!! note
+    No preFX effect support
diff --git a/docs/docs/canvas-circularprogress.md b/docs/docs/canvas-circularprogress.md
@@ -423,6 +423,22 @@ var circularProgress = scene.make.rexCircularProgressCanvas({
     }, scope);
     ```
 
+### Other properties
+
+See [game object](gameobject.md)
+
+### Create mask
+
+```javascript
+var mask = circularProgress.createBitmapMask();
+```
+
+See [mask](mask.md)
+
+### Shader effects
+
+Support [preFX and postFX effects](shader-builtin.md)
+
 ### Compare with Circular-progress shape
 
 - Circular-progress canvas creates a canvas then draw on that canvas, [circular progress shape](shape-circularprogress.md) draw on GRAPHICS pipeline like Shape or Graphics game object.

diff --git a/docs/docs/canvas-lineprogress.md b/docs/docs/canvas-lineprogress.md
@@ -364,6 +364,22 @@ var lineProgress = scene.make.rexLineProgressCanvas({
     // lineProgress.alpha = alpha;
     ```
 
+### Other properties
+
+See [game object](gameobject.md)
+
+### Create mask
+
+```javascript
+var mask = lineProgress.createBitmapMask();
+```
+
+See [mask](mask.md)
+
+### Shader effects
+
+Support [preFX and postFX effects](shader-builtin.md)
+
 ### Compare with Line-progress shape
 
 - Line-progress canvas creates a canvas then draw on that canvas, [line progress shape](shape-lineprogress.md) draw on GRAPHICS pipeline like Shape or Graphics game object.

diff --git a/docs/docs/canvas-roundrectangle.md b/docs/docs/canvas-roundrectangle.md
@@ -342,6 +342,18 @@ Number of interpolation points in each round corner. Default value is `4`.
 
 See [game object](gameobject.md)
 
+### Create mask
+
+```javascript
+var mask = rect.createBitmapMask();
+```
+
+See [mask](mask.md)
+
+### Shader effects
+
+Support [preFX and postFX effects](shader-builtin.md)
+
 ### Compare with [Shape-Roundrectangle](shape-roundrectangle.md)
 
 - Gradient

diff --git a/docs/docs/canvas.md b/docs/docs/canvas.md
@@ -267,7 +267,23 @@ or
 canvas.resize(width, height);
 ```
 
-## Compare with [Graphics object](graphics.md)
+### Other properties
+
+See [game object](gameobject.md)
+
+### Create mask
+
+```javascript
+var mask = canvas.createBitmapMask();
+```
+
+See [mask](mask.md)
+
+### Shader effects
+
+Support [preFX and postFX effects](shader-builtin.md)
+
+### Compare with [Graphics object](graphics.md)
 
  - Drawing method
     - This canvas object draws stuff on canvas in WEBGL or CANVAS render mode.  

diff --git a/docs/docs/canvasinput.md b/docs/docs/canvasinput.md
@@ -533,4 +533,16 @@ Set `enableCapture` to `false` to bypass key input to this input-text game objec
 
 ### Other properties
 
-See [DynamicText](dynamictext.md).
+See [Dynamic text game object](dynamictext.md) [game object](gameobject.md)
+
+### Create mask
+
+```javascript
+var mask = txt.createBitmapMask();
+```
+
+See [mask](mask.md)
+
+### Shader effects
+
+Support [preFX and postFX effects](shader-builtin.md)
diff --git a/docs/docs/circlemaskimage.md b/docs/docs/circlemaskimage.md
@@ -253,4 +253,20 @@ image.setTexture(key, frame, {
                 bl: {x : radiusX, y: radiusY},
                 br: {x : radiusX, y: radiusY},
             }
-            ```
+            ```
+
+### Other properties
+
+See [game object](gameobject.md)
+
+### Create mask
+
+```javascript
+var mask = image.createBitmapMask();
+```
+
+See [mask](mask.md)
+
+### Shader effects
+
+Support [preFX and postFX effects](shader-builtin.md)
diff --git a/docs/docs/container.md b/docs/docs/container.md
@@ -264,7 +264,26 @@ var scaleX = matrix.scaleX;
 var scaleY = matrix.scaleY;
 ```
 
-## Compare with [group object](group.md)
+### Other properties
+
+See [game object](gameobject.md)
+
+### Create mask
+
+```javascript
+var mask = container.createBitmapMask();
+```
+
+See [mask](mask.md)
+
+### Shader effects
+
+Support [postFX effects](shader-builtin.md)
+
+!!! note
+    No preFX effect support
+
+### Compare with [group object](group.md)
 
 - Container and group objects are all have a children list.
 - Container has position, angle, alpha, visible, ...etc, but group does not have.

diff --git a/docs/docs/containerlite.md b/docs/docs/containerlite.md
@@ -691,7 +691,12 @@ This method also will reset all local state of children.
 !!! note
     `container.add(containerLite)`, or `layer.add(containerLite)` won't add children of containerLite.
 
-## Compare with Official Container
+
+### Other properties
+
+See [game object](gameobject.md)
+
+### Compare with Official Container
 
 - Position/anlge/scale of a child object :
     - [Container](container.md) : Local position/anlge/scale, responding to parent container, not a world position/anlge/scale.

diff --git a/docs/docs/dynamicbitmaptext.md b/docs/docs/dynamicbitmaptext.md
@@ -116,4 +116,19 @@ txt.text = '...';
 
 ### Other properties
 
-This dynamic bitmap text class is extended from [bitmap text](bitmaptext.md)
+See  [bitmap text](bitmaptext.md), [game object](gameobject.md)
+
+### Create mask
+
+```javascript
+var mask = txt.createBitmapMask();
+```
+
+See [mask](mask.md)
+
+### Shader effects
+
+Support [postFX effects](shader-builtin.md)
+
+!!! note
+    No preFX effect support
diff --git a/docs/docs/dynamictext.md b/docs/docs/dynamictext.md
@@ -927,6 +927,22 @@ txt.setWrapConfig(config);
     ```
     - `child` : Any [Character](dynamictext.md#character) or [Image](dynamictext.md#image) child
 
+### Other properties
+
+See [game object](gameobject.md)
+
+### Create mask
+
+```javascript
+var mask = txt.createBitmapMask();
+```
+
+See [mask](mask.md)
+
+### Shader effects
+
+Support [preFX and postFX effects](shader-builtin.md)
+
 ### Compare with other kinds of text game object
 
 - [Built-in text](text.md): 

diff --git a/docs/docs/filechooser.md b/docs/docs/filechooser.md
@@ -298,7 +298,10 @@ scene.plugins.get('rexFileChooser').open({
             ```
     - Length `files` is 0 : User cancels file chooser dialog.
 
+### Other properties
+
+See [dom game object](domelement.md), [game object](gameobject.md)
 
 ### Interactive with other game objects
 
-See [dom-element's Interactive with other game objects](domelement.md#interactive-with-other-game-objects)
+See [dom-element's Interactive with other game objects](domelement.md#interactive-with-other-game-objects)
diff --git a/docs/docs/filedropzone.md b/docs/docs/filedropzone.md
@@ -276,6 +276,10 @@ fileDropZone.loadFilePromise(file, loaderType, key, cahceType)
     URL.revokeObjectURL(objectURL);
     ```
 
+### Other properties
+
+See [dom game object](domelement.md), [game object](gameobject.md)
+
 ### Interactive with other game objects
 
 See [dom-element's Interactive with other game objects](domelement.md#interactive-with-other-game-objects)
diff --git a/docs/docs/graphics.md b/docs/docs/graphics.md
@@ -237,10 +237,21 @@ graphics.rotateCanvas(radians);
 graphics.generateTexture(key, width, height);  // key: texture key
 ```
 
+### Other properties
+
+See [game object](gameobject.md)
+
 ### Create mask
 
 ```javascript
 var mask = graphics.createGeometryMask();
 ```
 
-See [mask](mask.md)
+See [mask](mask.md)
+
+### Shader effects
+
+Support [postFX effects](shader-builtin.md)
+
+!!! note
+    No preFX effect support
diff --git a/docs/docs/gridtable.md b/docs/docs/gridtable.md
@@ -564,4 +564,8 @@ var cell = table.getCell(cellIndex);
 
 ```javascript
 var cellIndex = cell.index;
-```
+```
+
+### Other properties
+
+See [game object](gameobject.md)
diff --git a/docs/docs/image.md b/docs/docs/image.md
@@ -99,4 +99,8 @@ See [game object](gameobject.md)
 var mask = image.createBitmapMask();
 ```
 
-See [mask](mask.md)
+See [mask](mask.md)
+
+### Shader effects
+
+Support [preFX and postFX effects](shader-builtin.md)