expo-pixi
Tools to use Pixi.js in Expo!
To get started: yarn add expo-pixi
in your Expo project and import it with
import ExpoPixi from 'expo-pixi';
.
Functions
ExpoPixi.application(props): PIXI.Application
A helper function to create a PIXI.Application
from a WebGL context.
EXGL knows to end a frame when the function: endFrameEXP
is called on the GL context.
context
is the only required prop.
Learn more about PIXI.Application props
ExpoPixi.textureAsync(resource: any): Promise
ExpoPixi.spriteAsync(resource: any): Promise
a helper function to resolve the asset passed in.
textureAsync
accepts:
- localUri: string | ex: "file://some/path/image.png"
- static resource: number | ex: require('./image.png')
- remote url: string | ex: "https://www.something.com/image.png"
- asset-library: string (iOS
CameraRoll
) | ex: "asset-library://some/path/image.png" - Expo Asset: Expo.Asset | learn more: https://docs.expo.io/versions/latest/guides/assets.html
You cannot send in relative string paths as Metro Bundler looks for static resources.
ExpoPixi.sprite({ localUri: string, width: number, height: number }): PIXI.Sprite
ExpoPixi.texture({ localUri: string, width: number, height: number }): PIXI.Texture
Pixi.js does a type check so we wrap our asset in a HTMLImageElement
shim.
ExpoPixi.Sketch
A component used for drawing smooth signatures and sketches.
See the sketch example on how to save the images!
Notice: the edges and ends are not rounded as this is not supported in PIXI yet: Issue
Props
Property | Type | Default | Description |
---|---|---|---|
strokeColor | number | 0x000000 | Color of the lines |
strokeWidth | number | 10 | Weight of the lines |
strokeAlpha | number | 1 | Opacity of the lines |
onChange | () => PIXI.Renderer | null | Invoked whenever a user is done drawing a line |
onReady | () => WebGLRenderingContext | null | Invoked when the GL context is ready to be used |
ExpoPixi.FilterImage
A Image component that uses PIXI.Filter
Props
Property | Type | Default | Description |
---|---|---|---|
resizeMode | string | null | Currently only supports cover , and contain |
filters | Array<PIXI.Filter> | null | Array of filters to apply to the image |
source | number, string, Expo.Asset | null | Source can be a static resource, image url (not {uri} ), or an Expo.Asset |
Example
;;; <ExpoGLView style= flex: 1 onContextCreate=async { const app = ExpoPixi; const sprite = await ExpoPixi; appstage; } />;