Module `Text-PIXI`

class type _t = { ... }

type t = Js.t(_t);

A Text Object will create a line or multiple lines of text. The text is created using the Canvas API. The primary advantage of this class over BitmapText is that you have great control over the style of the next, which you can change at runtime.

The primary disadvantages is that each piece of text has it's own texture, which can use more memory. When text changes, this texture has to be re-generated and re-uploaded to the GPU, taking up time.

To split a line you can use '\n' in your text string, or, on the style object, change its wordWrap property to true and and give the wordWrapWidth property a value.

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 PIXI.Sprite.Impl;

let create: PIXI.Texture.t => PIXI.Sprite.t;
let getAnchor: Js.t(PIXI.Sprite._t) => PIXI.ObservablePoint.t;
let setAnchor: Js.t(PIXI.Sprite._t) => PIXI.ObservablePoint.t => unit;
let _getBlendMode: Js.t(PIXI.Sprite._t) => int;

let getBlendMode: Js.t(PIXI.Sprite._t) => PIXI.BLEND_MODES.t;

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

let setBlendMode: Js.t(PIXI.Sprite._t) => PIXI.BLEND_MODES.t => unit;

let getPluginName: Js.t(PIXI.Sprite._t) => string;
let setPluginName: Js.t(PIXI.Sprite._t) => string => unit;
let getRoundPixels: Js.t(PIXI.Sprite._t) => bool;
let setRoundPixels: Js.t(PIXI.Sprite._t) => bool => unit;
let getShader: Js.t(PIXI.Sprite._t) => Js.t(PIXI.Shader._t);
let setShader: Js.t(PIXI.Sprite._t) => Js.t(PIXI.Shader._t) => unit;
let getTexture: Js.t(PIXI.Sprite._t) => Js.t(PIXI.Texture._t);
let setTexture: Js.t(PIXI.Sprite._t) => Js.t(PIXI.Texture._t) => unit;
let getTint: Js.t(PIXI.Sprite._t) => int;
let setTint: Js.t(PIXI.Sprite._t) => int => unit;
let calculateTrimmedVertices: Js.t(PIXI.Sprite._t) => unit;
let calculateVertices: Js.t(PIXI.Sprite._t) => unit;
let containsPoint: Js.t(PIXI.Sprite._t) => PIXI.Point.t => bool;

include Impl;

let create: text:string => ?⁠style:PIXI.TextStyle.t => ?⁠canvas:Webapi.Dom.HtmlElement.t => unit => t;
let getCanvas: Js.t(_t) => Webapi.Dom.HtmlElement.t;: The canvas element that everything is drawn to

let setCanvas: Js.t(_t) => Webapi.Dom.HtmlElement.t => unit;: The canvas element that everything is drawn to

let getContext: Js.t(_t) => Webapi.Canvas.Canvas2d.t;: The canvas 2d context that everything is drawn with

let setContext: Js.t(_t) => Webapi.Canvas.Canvas2d.t => unit;: The canvas 2d context that everything is drawn with

let getResolution: Js.t(_t) => float;: The resolution / device pixel ratio of the canvas. This is set to automatically match the renderer resolution by default, but can be overridden by setting manually.

let setResolution: Js.t(_t) => float => unit;: The resolution / device pixel ratio of the canvas. This is set to automatically match the renderer resolution by default, but can be overridden by setting manually.

let getStyle: Js.t(_t) => PIXI.TextStyle.t;: Set the style of the text. Set up an event listener to listen for changes on the style object and mark the text as dirty.

let setStyle: Js.t(_t) => PIXI.TextStyle.t => unit;: Set the style of the text. Set up an event listener to listen for changes on the style object and mark the text as dirty.

let getText: Js.t(_t) => string;: Set the copy for the text object. To split a line you can use '\n'.

let setText: Js.t(_t) => string => unit;: Set the copy for the text object. To split a line you can use '\n'.