Class: BaseTexture

PIXI. BaseTexture

new BaseTexture(source, scaleMode [, resolution])

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

Parameters:
Name Type Argument Description
source String | Canvas

the source object (image or canvas)

scaleMode Number

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

resolution Number <optional>

the resolution of the texture (for HiDPI displays)

Source:
src/pixi/textures/BaseTexture.js line 14

Members

<readonly> hasLoaded : Boolean

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

Type:
  • Boolean
Source:
src/pixi/textures/BaseTexture.js line 58

<readonly> height : Number

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

Type:
  • Number
Source:
src/pixi/textures/BaseTexture.js line 40

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

Type:
  • Boolean
Source:
src/pixi/textures/BaseTexture.js line 93

premultipliedAlpha : Boolean

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

Type:
  • Boolean
Default Value:
  • true
Source:
src/pixi/textures/BaseTexture.js line 75

resolution : Number

The Resolution of the texture.

Type:
  • Number
Source:
src/pixi/textures/BaseTexture.js line 22

scaleMode : Number

The scale mode to apply when scaling this texture

Type:
  • Number
Default Value:
  • PIXI.scaleModes.LINEAR
Source:
src/pixi/textures/BaseTexture.js line 49

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.

Type:
  • Boolean
Source:
src/pixi/textures/BaseTexture.js line 131

source : Image

The image source that is used to create the texture.

Type:
  • Image
Source:
src/pixi/textures/BaseTexture.js line 66

textureIndex : Number

The multi texture batching index number.

Type:
  • Number
Source:
src/pixi/textures/BaseTexture.js line 100

<readonly> width : Number

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

Type:
  • Number
Source:
src/pixi/textures/BaseTexture.js line 31

Methods

destroy()

Destroys this base texture

Source:
src/pixi/textures/BaseTexture.js line 161

dirty()

Sets all glTextures to be dirty.

Source:
src/pixi/textures/BaseTexture.js line 190

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:
src/pixi/textures/BaseTexture.js line 144

fromCanvas(canvas, scaleMode [, resolution])

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

Parameters:
Name Type Argument Description
canvas Canvas

The canvas element source of the texture

scaleMode Number

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

resolution Number <optional>

the resolution of the texture (for HiDPI displays)

Source:
src/pixi/textures/BaseTexture.js line 231
Returns:
Type
BaseTexture

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:
src/pixi/textures/BaseTexture.js line 203

updateSourceImage(newSrc) deprecated

Changes the source image of the texture

Parameters:
Name Type Description
newSrc String

the path of the image

Deprecated:
  • This method is deprecated. Please use Phaser.Sprite.loadTexture instead.
Source:
src/pixi/textures/BaseTexture.js line 178

phaser-ce@2.9.2 is on GitHub and NPM

Documentation generated by JSDoc 3.5.4 on 2017-11-09 using Tomorrow.