PixiJS

Class: BaseTexture

PIXI.BaseTexture

A Texture stores the information that represents an image. All textures have a base texture, which contains information about the source. Therefore you can have many textures all using a single BaseTexture

new PIXI.BaseTexture (resource, options)

BaseTexture.js:40
Name Type Default Description
resource PIXI.resources.Resource | string | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement null optional

The current resource to use, for things that aren't Resource objects, will be converted into a Resource.
options Object optional

Collection of options

Name Type Default Description
mipmap PIXI.MIPMAP_MODES PIXI.settings.MIPMAP_TEXTURES optional

If mipmapping is enabled for texture
anisotropicLevel number PIXI.settings.ANISOTROPIC_LEVEL optional

Anisotropic filtering level of texture
wrapMode PIXI.WRAP_MODES PIXI.settings.WRAP_MODE optional

Wrap mode for textures
scaleMode PIXI.SCALE_MODES PIXI.settings.SCALE_MODE optional

Default scale mode, linear, nearest
format PIXI.FORMATS PIXI.FORMATS.RGBA optional

GL format type
type PIXI.TYPES PIXI.TYPES.UNSIGNED_BYTE optional

GL data type
target PIXI.TARGETS PIXI.TARGETS.TEXTURE_2D optional

GL texture target
alphaMode PIXI.ALPHA_MODES PIXI.ALPHA_MODES.UNPACK optional

Pre multiply the image alpha
width number 0 optional

Width of the texture
height number 0 optional

Height of the texture
resolution number optional

Resolution of the base texture
resourceOptions object optional

Optional resource options, see autoDetectResource

Extends

Members

PIXI.BaseTexture._globalBatch number static

Global number of the texture batch, used by multi-texture renderers

_batchEnabled number

Number of the texture batch, used by multi-texture renderers

_batchLocation number

Location inside texture batch, used by multi-texture renderers

_id number Deprecated : since 5.2.0

Batch local field, stores current texture location

See:

alphaMode PIXI.ALPHA_MODES

How to treat premultiplied alpha, see PIXI.ALPHA_MODES.

Default Value:
  • PIXI.ALPHA_MODES.UNPACK

anisotropicLevel number

Anisotropic filtering level of texture

Default Value:
  • PIXI.settings.ANISOTROPIC_LEVEL

cacheId string

Currently default cache ID.

destroyed boolean readonly

Flag if BaseTexture has been destroyed.

dirtyId number readonly

Used by TextureSystem to only update texture to the GPU when needed. Please call update() to increment it.

dirtyStyleId number protected

Used by TextureSystem to only update texture style when needed.

format PIXI.FORMATS

The pixel format of the texture

Default Value:
  • PIXI.FORMATS.RGBA

hasLoaded boolean Deprecated : since 5.0.0 readonly

See:

height number readonly

The height of the base texture set when the image has loaded

imageUrl string Deprecated : since 5.0.0

See:

isPowerOfTwo boolean readonly

Whether or not the texture is a power of two, try to use power of two textures as much as you can

Default Value:
  • false

mipmap PIXI.MIPMAP_MODES

Mipmap mode of the texture, affects downscaled images

Default Value:
  • PIXI.settings.MIPMAP_TEXTURES

parentTextureArray PIXI.BaseTexture

Whether its a part of another texture, handled by ArrayResource or CubeResource

premultiplyAlpha boolean Deprecated : since 5.2.0 readonly

See:

realHeight number readonly

Pixel height of the source of this texture

realWidth number readonly

Pixel width of the source of this texture

resolution number

The resolution / device pixel ratio of the texture

Default Value:
  • PIXI.settings.RESOLUTION

resource PIXI.resources.Resource readonly

The resource used by this BaseTexture, there can only be one resource per BaseTexture, but textures can share resources.

scaleMode PIXI.SCALE_MODES

The scale mode to apply when scaling this texture

Default Value:
  • PIXI.settings.SCALE_MODE

source HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | SVGElement Deprecated : since 5.0.0 readonly

See:

target PIXI.TARGETS

The target type

Default Value:
  • PIXI.TARGETS.TEXTURE_2D

textureCacheIds Array.<string> readonly

The collection of alternative cache ids, since some BaseTextures can have more than one ID, short name and longer full URL

touched number protected

Used by automatic texture Garbage Collection, stores last GC tick when it was bound

type PIXI.TYPES

The type of resource data

Default Value:
  • PIXI.TYPES.UNSIGNED_BYTE

uid number protected

Global unique identifier for this BaseTexture

valid boolean readonly

Generally speaking means when resource is loaded.

width number readonly

The width of the base texture set when the image has loaded

wrapMode number

How the texture wraps

Methods

PIXI.BaseTexture.addToCache (baseTexture, id) static

BaseTexture.js:513

Adds a BaseTexture to the global BaseTextureCache. This cache is shared across the whole PIXI object.

Name Type Description
baseTexture PIXI.BaseTexture

The BaseTexture to add to the cache.
id string

The id that the BaseTexture will be stored against.

PIXI.BaseTexture.from (source, options, strict)PIXI.BaseTexture static

BaseTexture.js:465

Helper function that creates a base texture based on the source you provide. The source can be - image url, image element, canvas element. If the source is an image url or an image element and not in the base texture cache, it will be created and loaded.

Name Type Description
source string | HTMLImageElement | HTMLCanvasElement | SVGElement | HTMLVideoElement

The source to create base texture from.
options object optional

See PIXI.BaseTexture's constructor for options.
strict boolean optional

Enforce strict-mode, see PIXI.settings.STRICT_TEXTURE_CACHE.
Returns:
Type Description
PIXI.BaseTexture The new base texture.

PIXI.BaseTexture.fromBuffer (buffer, width, height, options)PIXI.BaseTexture static

BaseTexture.js:500

Create a new BaseTexture with a BufferResource from a Float32Array. RGBA values are floats from 0 to 1.

Name Type Description
buffer Float32Array | Uint8Array

The optional array to use, if no data is provided, a new Float32Array is created.
width number

Width of the resource
height number

Height of the resource
options object optional

See PIXI.BaseTexture's constructor for options.
Returns:
Type Description
PIXI.BaseTexture The resulting new BaseTexture

PIXI.BaseTexture.fromCanvas () Deprecated : since 5.0.0 static

useDeprecated.js:833
See:

PIXI.BaseTexture.fromImage () Deprecated : since 5.0.0 static

useDeprecated.js:821
See:

PIXI.BaseTexture.fromSVG () Deprecated : since 5.0.0 static

useDeprecated.js:844
See:

PIXI.BaseTexture.removeFromCache (baseTexture)PIXI.BaseTexture | null static

BaseTexture.js:532

Remove a BaseTexture from the global BaseTextureCache.

Name Type Description
baseTexture string | PIXI.BaseTexture

id of a BaseTexture to be removed, or a BaseTexture instance itself.
Returns:
Type Description
PIXI.BaseTexture | null The BaseTexture that was removed.

castToBaseTexture ()

BaseTexture.js:449

Utility function for BaseTexture|Texture cast

destroy ()

BaseTexture.js:415

Destroys this base texture. The method stops if resource doesn't want this texture to be destroyed. Removes texture from all caches.

dispose ()

BaseTexture.js:443

Frees the texture from WebGL memory without destroying this texture object. This means you can still use the texture later which will upload it to GPU memory again.

Fires:

getDrawableSource ()PIXI.ICanvasImageSource

BaseTexture.js:2

Get the drawable source, such as HTMLCanvasElement or HTMLImageElement suitable for rendering with CanvasRenderer. Provided by @pixi/canvas-renderer package.

Returns:
Type Description
PIXI.ICanvasImageSource Source to render with CanvasRenderer

loadSource () Deprecated : since 5.0.0

useDeprecated.js:714

setRealSize (realWidth, realHeight, resolution)PIXI.BaseTexture

BaseTexture.js:332

Sets real size of baseTexture, preserves current resolution.

Name Type Description
realWidth number

Full rendered width
realHeight number

Full rendered height
resolution number optional

Optionally set resolution
Returns:
Type Description
PIXI.BaseTexture this

setResolution (resolution)PIXI.BaseTexture

BaseTexture.js:354

Changes resolution

Name Type Description
resolution number

res
Returns:
Type Description
PIXI.BaseTexture this

setResource (resource)PIXI.BaseTexture

BaseTexture.js:374

Sets the resource if it wasn't set. Throws error if resource already present

Name Type Description
resource PIXI.resources.Resource

that is managing this BaseTexture
Returns:
Type Description
PIXI.BaseTexture this

setSize (width, height, resolution)PIXI.BaseTexture

BaseTexture.js:316

Changes w/h/resolution. Texture becomes valid if width and height are greater than zero.

Name Type Description
width number

Visual width
height number

Visual height
resolution number optional

Optionally set resolution
Returns:
Type Description
PIXI.BaseTexture this

setStyle (scaleMode, mipmap)PIXI.BaseTexture

BaseTexture.js:293

Changes style options of BaseTexture

Name Type Description
scaleMode PIXI.SCALE_MODES optional

Pixi scalemode
mipmap PIXI.MIPMAP_MODES optional

enable mipmaps
Returns:
Type Description
PIXI.BaseTexture this

update ()

BaseTexture.js:388

Invalidates the object. Texture becomes valid if width and height are greater than zero.

Events

dispose

BaseTexture.js:258

Fired when BaseTexture is destroyed.

Name Type Description
baseTexture PIXI.BaseTexture

Instance of texture being destroyed.

error

BaseTexture.js:236

Fired when a not-immediately-available source fails to load.

Name Type Description
baseTexture PIXI.BaseTexture

Resource errored.
event ErrorEvent

Load error event.

loaded

BaseTexture.js:244

Fired when BaseTexture is updated.

Name Type Description
baseTexture PIXI.BaseTexture

Resource loaded.

loaded

BaseTexture.js:229

Fired when a not-immediately-available source finishes loading.

Name Type Description
baseTexture PIXI.BaseTexture

Resource loaded.

update

BaseTexture.js:251

Fired when BaseTexture is updated.

Name Type Description
baseTexture PIXI.BaseTexture

Instance of texture being updated.