PIXI. BaseTexture

new BaseTexture(source, scaleMode)

A texture stores the information that represents an image. All textures have a base texture.

Parameters:
Name Type Description
source String

the source object (image or canvas)

scaleMode Number

See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values

Source - pixi/textures/BaseTexture.js, line 9

Members

<readonly> hasLoaded :Boolean

[read-only] Set to true once the base texture has loaded

Source - pixi/textures/BaseTexture.js, line 55

<readonly> height :Number

[read-only] The height of the base texture set when the image has loaded

Source - pixi/textures/BaseTexture.js, line 37

imageUrl :String

Source - pixi/textures/BaseTexture.js, line 132

mipmap :Boolean

Set this to true if a mipmap of this texture needs to be generated. This value needs to be set before the texture is used Also the texture must be a power of two size to work

Source - pixi/textures/BaseTexture.js, line 92

premultipliedAlpha :Boolean

Controls if RGB channels should be pre-multiplied by Alpha (WebGL only)

Default Value:
  • true
Source - pixi/textures/BaseTexture.js, line 74

resolution :Number

The Resolution of the texture.

Source - pixi/textures/BaseTexture.js, line 20

scaleMode :Number

The scale mode to apply when scaling this texture

Default Value:
  • PIXI.scaleModes.LINEAR
Source - pixi/textures/BaseTexture.js, line 46

skipRender :Boolean

A BaseTexture can be set to skip the rendering phase in the WebGL Sprite Batch.

You may want to do this if you have a parent Sprite with no visible texture (i.e. uses the internal __default texture) that has children that you do want to render, without causing a batch flush in the process.

Source - pixi/textures/BaseTexture.js, line 121

source :Image

The image source that is used to create the texture.

Source - pixi/textures/BaseTexture.js, line 64

<readonly> width :Number

[read-only] The width of the base texture set when the image has loaded

Source - pixi/textures/BaseTexture.js, line 28

Methods

<static> fromCanvas(canvas, scaleMode) → {PIXI.BaseTexture}

Helper function that creates a base texture from the given canvas element.

Parameters:
Name Type Description
canvas Canvas

The canvas element source of the texture

scaleMode Number

See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values

Returns:
Source - pixi/textures/BaseTexture.js, line 295

<static> fromImage(imageUrl, crossorigin, scaleMode) → {PIXI.BaseTexture}

Helper function that creates a base texture from the given image url. If the image is not in the base texture cache it will be created and loaded.

Parameters:
Name Type Description
imageUrl String

The image url of the texture

crossorigin Boolean

-

scaleMode Number

See {{#crossLink "PIXI/scaleModes:property"}}PIXI.scaleModes{{/crossLink}} for possible values

Returns:
Source - pixi/textures/BaseTexture.js, line 252

destroy()

Destroys this base texture

Source - pixi/textures/BaseTexture.js, line 167

dirty()

Sets all glTextures to be dirty.

Source - pixi/textures/BaseTexture.js, line 211

forceLoaded(width, height)

Forces this BaseTexture to be set as loaded, with the given width and height. Then calls BaseTexture.dirty. Important for when you don't want to modify the source object by forcing in complete or dimension properties it may not have.

Parameters:
Name Type Description
width Number
  • The new width to force the BaseTexture to be.
height Number
  • The new height to force the BaseTexture to be.
Source - pixi/textures/BaseTexture.js, line 149

unloadFromGPU()

Removes the base texture from the GPU, useful for managing resources on the GPU. Atexture is still 100% usable and will simply be reuploaded if there is a sprite on screen that is using it.

Source - pixi/textures/BaseTexture.js, line 224

updateSourceImage(newSrc)

Changes the source image of the texture

Parameters:
Name Type Description
newSrc String

the path of the image

Source - pixi/textures/BaseTexture.js, line 198
Phaser Copyright © 2012-2016 Photon Storm Ltd.
Documentation generated by JSDoc 3.3.2 on Thu May 19 2016 12:35:47 GMT+0100 (GMT Daylight Time) using the DocStrap template.