Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Chore: Update document #8832

Merged
merged 1 commit into from Nov 7, 2022
Merged

Chore: Update document #8832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/core/src/textures/Texture.ts
View file
Open in desktop
Expand Up @@ -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.
*/
Expand Down
4 changes: 2 additions & 2 deletions packages/display/src/Container.ts
View file
Open in desktop
Expand Up @@ -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.
*/
}

Expand Down
5 changes: 4 additions & 1 deletion packages/graphics/src/Graphics.ts
View file
Open in desktop
Expand Up @@ -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();
Expand Down
11 changes: 6 additions & 5 deletions packages/graphics/src/GraphicsGeometry.ts
View file
Open in desktop
Expand Up @@ -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. */
Expand Down Expand Up @@ -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
Expand Down