Skip to content

Commit

Permalink
UMD build explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
ivanpopelyshev committed Jun 3, 2021
1 parent 21927be commit a9082d7
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# pixi-picture
# @pixi/picture

Compatible with PixiJS `6.0.4` and up. No guarantee for earlier versions!

Expand Down Expand Up @@ -57,6 +57,20 @@ If specified `useContextAlpha: false` in renderer creation parameters, main fram
When using `MaskFilter` with `maskBefore=true`, input is automatically flipped by Y. This operation is not needed if your base filter does not care about flipping Y, for example `BlurFilter` or `ColorMatrixFilter`.
In this case, you can specify `maskFilter.safeFlipY=true`, that will turn off extra flipping.

## Vanilla JS, UMD build

All pixiJS v6 plugins has special `umd` build suited for vanilla.
Navigate `pixi-picture` npm package, take `dist/pixi-picture.umd.js` file.

```html
<script src='lib/pixi.js'></script>
<script src='lib/pixi-picture.umd.js'></script>
```

```js
let sprite = new PIXI.picture.Sprite();
```

## Previous versions

For PixiJS `v5` and prior see README `pixi-v5` branch, or just use npm package `pixi-picture`
Expand Down

0 comments on commit a9082d7

Please sign in to comment.