Module `Sprite-PIXI`

class type _t = { ... }

type t = Js.t(_t);: The Sprite object is the base for all textured objects that are rendered to the screen

let _from: source:[ `String(string) | `HTMLCanvasElement(Webapi.Dom.HtmlElement.t) | `HTMLVideoElement(Webapi.Dom.HtmlElement.t) ] => options:'a => unit => t;

let from: source:[ `HTMLCanvasElement(Webapi.Dom.HtmlElement.t) | `HTMLVideoElement(Webapi.Dom.HtmlElement.t) | `String(string) ] => ?⁠options:Js.t({. _type: Js.undefined(int), alphaMode: Js.undefined(int), anisotropicLevel: Js.undefined(int), format: Js.undefined(int), height: Js.undefined(float), mipmap: Js.undefined(int), resolution: Js.undefined(float), resourceOptions: Js.undefined(Js.t({. })), scaleMode: Js.undefined(int), target: Js.undefined(int), width: Js.undefined(float), wrapMode: Js.undefined(int), }) => unit => t;: Helper function that creates a new sprite based on the source you provide. The source can be - frame id, image url, video url, canvas element, video element, base texture

module Impl: { ... };

include PIXI.EventEmitter.Impl;

let create: unit => PIXI.EventEmitter.t;
let eventNames: Js.t(PIXI.EventEmitter._t) => array(string);
let listeners: Js.t(PIXI.EventEmitter._t) => event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => array((Js.t({.. }) => unit));
let listenerCount: Js.t(PIXI.EventEmitter._t) => event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => int;
let emit: Js.t(PIXI.EventEmitter._t) => event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => bool;
let on: Js.t(PIXI.EventEmitter._t as 'd) => event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => fn:('b => unit) => ?⁠context:'c => unit => Js.t('d);
let addListener: Js.t(PIXI.EventEmitter._t as 'd) => event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => fn:('b => unit) => ?⁠context:'c => unit => Js.t('d);
let once: Js.t(PIXI.EventEmitter._t as 'd) => event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => fn:('b => unit) => ?⁠context:'c => unit => Js.t('d);
let removeListener: Js.t(PIXI.EventEmitter._t as 'b) => event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => ?⁠fn:(Js.t({.. }) => unit) => ?⁠context:Js.t({.. }) => ?⁠once:bool => unit => Js.t('b);
let off: Js.t(PIXI.EventEmitter._t as 'b) => event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => ?⁠fn:(Js.t({.. }) => unit) => ?⁠context:Js.t({.. }) => ?⁠once:bool => unit => Js.t('b);
let removeAllListeners: Js.t(PIXI.EventEmitter._t as 'b) => ?⁠event:[ `String(string) | `Symbol(PIXI.Symbol.t) ] => unit => Js.t('b);

include PIXI.DisplayObject.Impl;

let create: unit => PIXI.DisplayObject.t;
let getAccessible: Js.t(PIXI.C.displayObject) => bool;
let setAccessible: Js.t(PIXI.C.displayObject) => bool => unit;
let getAccessibleChildren: Js.t(PIXI.C.displayObject) => bool;
let setAccessibleChildren: Js.t(PIXI.C.displayObject) => bool => unit;
let getAccessibleHint: Js.t(PIXI.C.displayObject) => string;
let setAccessibleHint: Js.t(PIXI.C.displayObject) => string => unit;
let getAccessibleTitle: Js.t(PIXI.C.displayObject) => Js.Nullable.t(string);
let setAccessibleTitle: Js.t(PIXI.C.displayObject) => Js.Nullable.t(string) => unit;
let getAccessibleType: Js.t(PIXI.C.displayObject) => string;
let setAccessibleType: Js.t(PIXI.C.displayObject) => string => unit;
let getAlpha: Js.t(PIXI.C.displayObject) => float;
let setAlpha: Js.t(PIXI.C.displayObject) => float => unit;
let getAngle: Js.t(PIXI.C.displayObject) => float;
let setAngle: Js.t(PIXI.C.displayObject) => float => unit;
let getButtonMode: Js.t(PIXI.C.displayObject) => bool;
let setButtonMode: Js.t(PIXI.C.displayObject) => bool => unit;
let getCacheAsBitmap: Js.t(PIXI.C.displayObject) => bool;
let setCacheAsBitmap: Js.t(PIXI.C.displayObject) => bool => unit;
let getCursor: Js.t(PIXI.C.displayObject) => string;
let setCursor: Js.t(PIXI.C.displayObject) => string => unit;
let getFilterArea: Js.t(PIXI.C.displayObject) => Js.Nullable.t(Js.t(PIXI.Rectangle._t));
let setFilterArea: Js.t(PIXI.C.displayObject) => Js.Nullable.t(Js.t(PIXI.Rectangle._t)) => unit;
let getFilters: Js.t(PIXI.C.displayObject) => Js.Nullable.t(array(PIXI.Filter.t));
let setFilters: Js.t(PIXI.C.displayObject) => Js.Nullable.t(array(PIXI.Filter.t)) => unit;
let getHitArea: Js.t(PIXI.C.displayObject) => 'hitArea;
let setHitArea: Js.t(PIXI.C.displayObject) => 'hitArea => unit;
let getInteractive: Js.t(PIXI.C.displayObject) => bool;
let setInteractive: Js.t(PIXI.C.displayObject) => bool => unit;
let getIsMask: Js.t(PIXI.C.displayObject) => bool;
let getIsSprite: Js.t(PIXI.C.displayObject) => bool;
let getLocalTransform: Js.t(PIXI.C.displayObject) => Js.t(PIXI.Matrix._t);
let getMask: Js.t(PIXI.C.displayObject) => 'mask;
let setMask: Js.t(PIXI.C.displayObject) => 'mask => unit;
let getName: Js.t(PIXI.C.displayObject) => Js.Nullable.t(string);
let setName: Js.t(PIXI.C.displayObject) => Js.Nullable.t(string) => unit;
let getParent: Js.t(PIXI.C.displayObject) => Js.Nullable.t(PIXI.C.container);
let getPivot: Js.t(PIXI.C.displayObject) => Js.t(PIXI.ObservablePoint._t);
let setPivot: Js.t(PIXI.C.displayObject) => Js.t(PIXI.ObservablePoint._t) => unit;
let getPosition: Js.t(PIXI.C.displayObject) => Js.t(PIXI.ObservablePoint._t);
let setPosition: Js.t(PIXI.C.displayObject) => Js.t(PIXI.ObservablePoint._t) => unit;
let getRenderable: Js.t(PIXI.C.displayObject) => bool;
let setRenderable: Js.t(PIXI.C.displayObject) => bool => unit;
let getRotation: Js.t(PIXI.C.displayObject) => float;
let setRotation: Js.t(PIXI.C.displayObject) => float => unit;
let getScale: Js.t(PIXI.C.displayObject) => Js.t(PIXI.ObservablePoint._t);
let setScale: Js.t(PIXI.C.displayObject) => Js.t(PIXI.ObservablePoint._t) => unit;
let getSkew: Js.t(PIXI.C.displayObject) => Js.t(PIXI.ObservablePoint._t);
let setSkew: Js.t(PIXI.C.displayObject) => Js.t(PIXI.ObservablePoint._t) => unit;
let getTransform: Js.t(PIXI.C.displayObject) => Js.t(PIXI.Transform._t);
let getVisible: Js.t(PIXI.C.displayObject) => bool;
let setVisible: Js.t(PIXI.C.displayObject) => bool => unit;
let getWorldAlpha: Js.t(PIXI.C.displayObject) => float;
let getWorldTransform: Js.t(PIXI.C.displayObject) => Js.t(PIXI.Matrix._t);
let getWorldVisible: Js.t(PIXI.C.displayObject) => bool;
let getX: Js.t(PIXI.C.displayObject) => float;
let setX: Js.t(PIXI.C.displayObject) => float => unit;
let getY: Js.t(PIXI.C.displayObject) => float;
let setY: Js.t(PIXI.C.displayObject) => float => unit;
let getZIndex: Js.t(PIXI.C.displayObject) => float;
let setZIndex: Js.t(PIXI.C.displayObject) => float => unit;
let _recursivePostUpdateTransform: Js.t(PIXI.C.displayObject) => unit;
let destroy: Js.t(PIXI.C.displayObject) => unit;
let getBounds: Js.t(PIXI.C.displayObject) => ?⁠skipUpdate:bool => ?⁠rect:Js.t(PIXI.Rectangle._t) => unit => Js.t(PIXI.Rectangle._t);
let getGlobalPosition: Js.t(PIXI.C.displayObject) => ?⁠point:Js.t(PIXI.Point._t) => ?⁠skipUpdate:bool => unit => Js.t(PIXI.Point._t);
let getLocalBounds: Js.t(PIXI.C.displayObject) => ?⁠rectangle:Js.t(PIXI.Rectangle._t) => unit => Js.t(PIXI.Rectangle._t);
let setContainer: Js.t(PIXI.C.displayObject) => Js.t(PIXI.C.container as 'b) => Js.t('b);
let setTransform: Js.t(PIXI.C.displayObject) => ?⁠x:float => ?⁠y:float => ?⁠scaleX:float => ?⁠scaleY:float => ?⁠rotation:float => ?⁠skewX:float => ?⁠skewY:float => ?⁠pivotX:float => ?⁠pivotY:float => unit => PIXI.DisplayObject.t;
let toGlobal: Js.t(PIXI.C.displayObject) => position:[ `ObservablePoint(PIXI.ObservablePoint.t) | `Point(PIXI.Point.t) ] => ?⁠point:PIXI.Point.t => ?⁠skipUpdate:bool => unit => PIXI.Point.t;
let toLocal: Js.t(PIXI.C.displayObject) => position:[ `ObservablePoint(PIXI.ObservablePoint.t) | `Point(PIXI.Point.t) ] => ?⁠from:PIXI.DisplayObject.t => ?⁠point:PIXI.Point.t => ?⁠skipUpdate:bool => unit => PIXI.Point.t;
let updateTransform: Js.t(PIXI.C.displayObject) => unit;

include PIXI.Container.Impl;

let create: unit => PIXI.Container.t;
let createDestroyOptions: ?⁠children:bool => ?⁠texture:bool => ?⁠baseTexture:bool => unit => Js.t({. baseTexture: Js.undefined(bool), children: Js.undefined(bool), texture: Js.undefined(bool), });
let getChildren: Js.t(PIXI.C.container) => array(Js.t(PIXI.C.displayObject));
let getHeight: Js.t(PIXI.C.container) => float;
let setHeight: Js.t(PIXI.C.container) => float => unit;
let getInteractiveChildren: Js.t(PIXI.C.container) => bool;
let setInteractiveChildren: Js.t(PIXI.C.container) => bool => unit;
let getSortableChildren: Js.t(PIXI.C.container) => bool;
let setSortableChildren: Js.t(PIXI.C.container) => bool => unit;
let getSortDirty: Js.t(PIXI.C.container) => bool;
let setSortDirty: Js.t(PIXI.C.container) => bool => unit;
let getWidth: Js.t(PIXI.C.container) => float;
let setWidth: Js.t(PIXI.C.container) => float => unit;
let addChild: Js.t(PIXI.C.container) => Js.t(PIXI.C.displayObject as 'b) => Js.t('b);
let addChildAt: Js.t(PIXI.C.container) => Js.t(PIXI.C.displayObject as 'b) => index:int => Js.t('b);
let calculateBounds: Js.t(PIXI.C.container) => unit;
let _destroy: Js.t(PIXI.C.container) => ?⁠options:'a => unit => unit;

let destroy: Js.t(PIXI.C.container) => ?⁠options:Js.t({. baseTexture: Js.undefined(bool), children: Js.undefined(bool), texture: Js.undefined(bool), }) => unit => unit;

let getChildAt: Js.t(PIXI.C.container) => int => Js.t(PIXI.C.displayObject);
let getChildByName: Js.t(PIXI.C.container) => string => Js.t(PIXI.C.displayObject);
let getChildIndex: Js.t(PIXI.C.container) => Js.t(PIXI.C.displayObject) => int;
let removeChild: Js.t(PIXI.C.container) => Js.t(PIXI.C.displayObject as 'b) => Js.t('b);
let removeChildAt: Js.t(PIXI.C.container) => int => Js.t(PIXI.C.displayObject);
let removeChildren: Js.t(PIXI.C.container) => ?⁠beginIndex:int => ?⁠endIndex:int => unit => array(Js.t(PIXI.C.displayObject));
let renderCanvas: Js.t(PIXI.C.container) => Js.t(PIXI.AbstractRenderer._t) => unit;
let setChildIndex: Js.t(PIXI.C.container) => int => unit;
let sortChildren: Js.t(PIXI.C.container) => unit;
let swapChildren: Js.t(PIXI.C.container) => Js.t(PIXI.C.displayObject) => Js.t(PIXI.C.displayObject) => unit;

include Impl;

let create: PIXI.Texture.t => t;
let getAnchor: Js.t(_t) => PIXI.ObservablePoint.t;: The anchor sets the origin point of the text. The default value is taken from the Texture and passed to the constructor. The default is (0,0), this means the text's origin is the top left. Setting the anchor to (0.5,0.5) means the text's origin is centered. Setting the anchor to (1,1) would mean the text's origin point will be the bottom right corner.

let setAnchor: Js.t(_t) => PIXI.ObservablePoint.t => unit;: The anchor sets the origin point of the text. The default value is taken from the Texture and passed to the constructor. The default is (0,0), this means the text's origin is the top left. Setting the anchor to (0.5,0.5) means the text's origin is centered. Setting the anchor to (1,1) would mean the text's origin point will be the bottom right corner.

let _getBlendMode: Js.t(_t) => int;

let getBlendMode: Js.t(_t) => PIXI.BLEND_MODES.t;: The blend mode to be applied to the sprite. Apply a value of PIXI.BLEND_MODES.NORMAL to reset the blend mode.

let _setBlendMode: Js.t(_t) => int => unit;

let setBlendMode: Js.t(_t) => PIXI.BLEND_MODES.t => unit;: The blend mode to be applied to the sprite. Apply a value of PIXI.BLEND_MODES.NORMAL to reset the blend mode.

let getPluginName: Js.t(_t) => string;: Plugin that is responsible for rendering this element. Allows to customize the rendering process without overriding '_render' & '_renderCanvas' methods.

let setPluginName: Js.t(_t) => string => unit;: Plugin that is responsible for rendering this element. Allows to customize the rendering process without overriding '_render' & '_renderCanvas' methods.

let getRoundPixels: Js.t(_t) => bool;: If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation. Advantages can include sharper image quality (like text) and faster rendering on canvas. The main disadvantage is movement of objects may appear less smooth. To set the global default, change PIXI.settings.ROUND_PIXELS

let setRoundPixels: Js.t(_t) => bool => unit;: If true PixiJS will Math.floor() x/y values when rendering, stopping pixel interpolation. Advantages can include sharper image quality (like text) and faster rendering on canvas. The main disadvantage is movement of objects may appear less smooth. To set the global default, change PIXI.settings.ROUND_PIXELS

let getShader: Js.t(_t) => Js.t(PIXI.Shader.#_t);: The shader that will be used to render the sprite. Set to null to remove a current shader.

let setShader: Js.t(_t) => Js.t(PIXI.Shader.#_t) => unit;: The shader that will be used to render the sprite. Set to null to remove a current shader.

let getTexture: Js.t(_t) => Js.t(PIXI.Texture.#_t);: The texture that the sprite is using

let setTexture: Js.t(_t) => Js.t(PIXI.Texture.#_t) => unit;: The texture that the sprite is using

let getTint: Js.t(_t) => int;: The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.

let setTint: Js.t(_t) => int => unit;: The tint applied to the sprite. This is a hex value. A value of 0xFFFFFF will remove any tint effect.

let calculateTrimmedVertices: Js.t(_t) => unit;: calculates worldTransform * vertices for a non texture with a trim. store it in vertexTrimmedData This is used to ensure that the true width and height of a trimmed texture is respected

let calculateVertices: Js.t(_t) => unit;: calculates worldTransform * vertices, store it in vertexData

let containsPoint: Js.t(_t) => PIXI.Point.t => bool;: Tests if a point is inside this sprite