PIXI

Class: BitmapText

PIXI.extras. BitmapText

new PIXI.extras.BitmapText(text, style)

extras/BitmapText.js, line 31

A BitmapText object will create a line or multiple lines of text using bitmap font. To
split a line you can use '\n', '\r' or '\r\n' in your string. You can generate the fnt files using:

A BitmapText can only be created when the font is loaded

// in this case the font is in a file called 'desyrel.fnt'
var bitmapText = new PIXI.extras.BitmapText("text using a fancy font!", {font: "35px Desyrel", align: "right"});

http://www.angelcode.com/products/bmfont/ for windows or
http://www.bmglyph.com/ for mac.

Name Type Description
text string

The copy that you would like the text to display
style object

The style parameters

Name Type Default Description
font string | object

The font descriptor for the object, can be passed as a string of form
"24px FontName" or "FontName" or as an object with explicit name/size properties.

Name Type Description
name string optional

The bitmap font id
size number optional

The size of the font in pixels, e.g. 24
align string 'left' optional

Alignment for multiline text ('left', 'center' or 'right'), does not affect
single line text
tint number 0xFFFFFF optional

The tint color

Extends

Members

alignstring

The alignment of the BitmapText object

Default Value:
  • 'left'

alphanumber

The opacity of the object.

cacheAsBitmapboolean

Set this to true if you want this display object to be cached as a bitmap.
This basically takes a snap shot of the display object as it is at that moment. It can provide a performance benefit for complex static displayObjects.
To remove simply set this property to 'false'

readonlychildrenArray.<PIXI.DisplayObject>

The array of children of this container.

dirtyboolean

The dirty state of this object.

filterAreaPIXI.Rectangle

The area the filter is applied to. This is used as more of an optimisation
rather than figuring out the dimensions of the displayObject each frame you can set this rectangle

filtersArray.<PIXI.AbstractFilter>

Sets the filters for the displayObject.

  • IMPORTANT: This is a webGL only feature and will be ignored by the canvas renderer.
    To remove filters simply set this property to 'null'

fontFont

The font descriptor of the BitmapText object

heightnumber

The height of the Container, setting this will actually modify the scale to achieve the value set

maskPIXI.Graphics PIXI.Sprite

Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it.
In PIXI a regular mask must be a PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it utilises shape clipping.
To remove a mask, set this property to null.

TODO
  • For the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.

maxLineHeightnumber

The max line height. This is useful when trying to use the total height of the Text, ie: when trying to vertically align.

maxWidthnumber

The max width of this bitmap text in pixels. If the text provided is longer than the value provided, line breaks will be automatically inserted in the last whitespace.
Disable by setting value to 0

readonlyparentPIXI.Container

The display object container that contains this display object.

pivotPIXI.Point

The pivot point of the displayObject that it rotates around

positionPIXI.Point

The coordinate of the object relative to the local coordinates of the parent.

renderableboolean

Can this object be rendered, if false the object will not be drawn but the updateTransform
methods will still be called.

rotationnumber

The rotation of the object in radians.

scalePIXI.Point

The scale factor of the object.

skewPIXI.Point

The skew factor for the object in radians.

textstring

The text of the BitmapText object

readonlytextHeightnumber

The height of the overall text, different from fontSize,
which is defined in the style object

readonlytextWidthnumber

The width of the overall text, different from fontSize,
which is defined in the style object

tintnumber

The tint of the BitmapText object

visibleboolean

The visibility of the object. If false the object will not be drawn, and
the updateTransform function will not be called.

widthnumber

The width of the Container, setting this will actually modify the scale to achieve the value set

readonlyworldAlphanumber

The multiplied alpha of the displayObject

readonlyworldTransformPIXI.Matrix

Current transform of the object based on world (parent) factors

readonlyworldVisibleboolean

Indicates if the sprite is globally visible.

xnumber

The position of the displayObject on the x axis relative to the local coordinates of the parent.

ynumber

The position of the displayObject on the y axis relative to the local coordinates of the parent.

Methods

inherited addChild(child){PIXI.DisplayObject}

core/display/Container.js, line 112

Adds a child to the container.

You can also add multple items like so: myContainer.addChild(thinkOne, thingTwo, thingThree)

Name Type Description
child PIXI.DisplayObject

The DisplayObject to add to the container
Returns:
Type Description
PIXI.DisplayObject The child that was added.

inherited addChildAt(child, index){PIXI.DisplayObject}

core/display/Container.js, line 153

Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

Name Type Description
child PIXI.DisplayObject

The child to add
index number

The index to place the child in
Returns:
Type Description
PIXI.DisplayObject The child that was added.

inherited destroy(destroyChildren)

core/display/Container.js, line 630

Destroys the container

Name Type Default Description
destroyChildren boolean false optional

if set to true, all the children will have their destroy method called as well

inherited generateTexture(renderer, resolution, scaleMode){PIXI.Texture}

core/display/Container.js, line 368

Useful function that returns a texture of the display object that can then be used to create sprites
This can be quite useful if your displayObject is static / complicated and needs to be reused multiple times.

Name Type Description
renderer PIXI.CanvasRenderer | PIXI.WebGLRenderer

The renderer used to generate the texture.
resolution number

The resolution of the texture being generated
scaleMode number

See PIXI.SCALE_MODES for possible values
Returns:
Type Description
PIXI.Texture a texture of the display object

inherited getBounds(){PIXI.Rectangle}

core/display/Container.js, line 410

Retrieves the bounds of the Container as a rectangle. The bounds calculation takes all visible children into consideration.

Returns:
Type Description
PIXI.Rectangle The rectangular bounding area

inherited getChildAt(index){PIXI.DisplayObject}

core/display/Container.js, line 248

Returns the child at the specified index

Name Type Description
index number

The index to get the child at
Returns:
Type Description
PIXI.DisplayObject The child at the given index, if any.

inherited getChildIndex(child){number}

core/display/Container.js, line 210

Returns the index position of a child DisplayObject instance

Name Type Description
child PIXI.DisplayObject

The DisplayObject instance to identify
Returns:
Type Description
number The index position of the child display object to identify

getLocalBounds(){PIXI.Rectangle}

extras/BitmapText.js, line 366

Validates text before calling parent's getLocalBounds

Returns:
Type Description
PIXI.Rectangle The rectangular bounding area

inherited removeChild(child){PIXI.DisplayObject}

core/display/Container.js, line 264

Removes a child from the container.

Name Type Description
child PIXI.DisplayObject

The DisplayObject to remove
Returns:
Type Description
PIXI.DisplayObject The child that was removed.

inherited removeChildAt(index){PIXI.DisplayObject}

core/display/Container.js, line 304

Removes a child from the specified index position.

Name Type Description
index number

The index to get the child from
Returns:
Type Description
PIXI.DisplayObject The child that was removed.

inherited removeChildren(beginIndex, endIndex)

core/display/Container.js, line 324

Removes all children from this container that are within the begin and end indexes.

Name Type Description
beginIndex number

The beginning position. Default value is 0.
endIndex number

The ending position. Default value is size of the container.

inherited renderCanvas(renderer)

core/display/Container.js, line 601

Renders the object using the Canvas renderer

Name Type Description
renderer PIXI.CanvasRenderer

The renderer

inherited renderWebGL(renderer)

core/display/Container.js, line 509

Renders the object using the WebGL renderer

Name Type Description
renderer PIXI.WebGLRenderer

The renderer

inherited setChildIndex(child, index)

core/display/Container.js, line 228

Changes the position of an existing child in the display object container

Name Type Description
child PIXI.DisplayObject

The child DisplayObject instance for which you want to change the index number
index number

The resulting index number for the child display object

inherited setParent(container){Container}

core/display/DisplayObject.js, line 505

Set the parent Container of this DisplayObject

Name Type Description
container Container

The Container to add this DisplayObject to
Returns:
Type Description
Container The Container that this DisplayObject was added to

setText()

deprecation.js, line 243
Deprecated
  • since version 3.0.0
    See:

    inherited setTransform(x, y, scaleX, scaleY, rotation, skewX, skewY, pivotX, pivotY){PIXI.DisplayObject}

    core/display/DisplayObject.js, line 530

    Convenience function to set the postion, scale, skew and pivot at once.

    Name Type Default Description
    x number 0 optional

    The X position
    y number 0 optional

    The Y position
    scaleX number 1 optional

    The X scale value
    scaleY number 1 optional

    The Y scale value
    rotation number 0 optional

    The rotation
    skewX number 0 optional

    The X skew value
    skewY number 0 optional

    The Y skew value
    pivotX number 0 optional

    The X pivot value
    pivotY number 0 optional

    The Y pivot value
    Returns:
    Type Description
    PIXI.DisplayObject

    inherited swapChildren(child, child2)

    core/display/Container.js, line 184

    Swaps the position of 2 Display Objects within this container.

    Name Type Description
    child PIXI.DisplayObject
    child2 PIXI.DisplayObject

    inherited toGlobal(position){PIXI.Point}

    core/display/DisplayObject.js, line 402

    Calculates the global position of the display object

    Name Type Description
    position PIXI.Point

    The world origin to calculate from
    Returns:
    Type Description
    PIXI.Point A point object representing the position of this object

    inherited toLocal(position, from, point){PIXI.Point}

    core/display/DisplayObject.js, line 430

    Calculates the local position of the display object relative to another point

    Name Type Description
    position PIXI.Point

    The world origin to calculate from
    from PIXI.DisplayObject optional

    The DisplayObject to calculate the global position from
    point PIXI.Point optional

    A Point object in which to store the value, optional (otherwise will create a new Point)
    Returns:
    Type Description
    PIXI.Point A point object representing the position of this object