Chore: Update document (#8832)

pixijs · Nov 7, 2022 · a7479ad · a7479ad
1 parent d4fa582
commit a7479ad
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 9 deletions.
diff --git a/packages/core/src/textures/Texture.ts b/packages/core/src/textures/Texture.ts
@@ -60,7 +60,8 @@ function removeAllHandlers(tex: any): void
  * // sprite1._textureID should not be undefined if the texture has finished processing the SVG file
  * ```
  *
- * You can use a ticker or rAF to ensure your sprites load the finished textures after processing. See issue #3068.
+ * You can use a ticker or rAF to ensure your sprites load the finished textures after processing.
+ * See issue [#3085]{@link https://github.com/pixijs/pixijs/issues/3085}.
  * @memberof PIXI
  * @typeParam R - The BaseTexture's Resource type.
  */

diff --git a/packages/display/src/Container.ts b/packages/display/src/Container.ts
@@ -97,10 +97,10 @@ export class Container<T extends DisplayObject = DisplayObject> extends DisplayO
 
         /**
          * Fired when a DisplayObject is removed from this Container.
-         * @event PIXI.DisplayObject#childRemoved
+         * @event PIXI.Container#childRemoved
          * @param {PIXI.DisplayObject} child - The child removed from the Container.
          * @param {PIXI.Container} container - The container that removed the child.
-         * @param {number} index - The former children's index of the removed child
+         * @param {number} index - The former children's index of the removed child.
          */
     }
 

diff --git a/packages/graphics/src/Graphics.ts b/packages/graphics/src/Graphics.ts
@@ -1019,7 +1019,10 @@ export class Graphics extends Container
         return shader;
     }
 
-    /** Retrieves the bounds of the graphic shape as a rectangle object. */
+    /**
+     * Retrieves the bounds of the graphic shape as a rectangle object.
+     * @see PIXI.GraphicsGeometry#bounds
+     */
     protected _calculateBounds(): void
     {
         this.finishPoly();

diff --git a/packages/graphics/src/GraphicsGeometry.ts b/packages/graphics/src/GraphicsGeometry.ts
@@ -43,11 +43,7 @@ const tmpPoint = new Point();
  */
 export class GraphicsGeometry extends BatchGeometry
 {
-    /**
-     * The maximum number of points to consider an object "batchable",
-     * able to be batched by the renderer's batch system.
-\
-     */
+    /** The maximum number of points to consider an object "batchable", able to be batched by the renderer's batch system. */
     public static BATCHABLE_SIZE = 100;
 
     /** Minimal distance between points that are considered different. Affects line tesselation. */
@@ -123,6 +119,11 @@ export class GraphicsGeometry extends BatchGeometry
 
     /**
      * Get the current bounds of the graphic geometry.
+     *
+     * Since 6.5.0, bounds of the graphics geometry are calculated based on the vertices of generated geometry.
+     * Since shapes or strokes with full transparency (`alpha: 0`) will not generate geometry, they are not considered
+     * when calculating bounds for the graphics geometry. See PR [#8343]{@link https://github.com/pixijs/pixijs/pull/8343}
+     * and issue [#8623]{@link https://github.com/pixijs/pixijs/pull/8623}.
      * @readonly
      */
     public get bounds(): Bounds