Class: BlobResource

PIXI.BlobResource

Resource that fetches texture data over the network and stores it in a buffer.

new PIXI.BlobResource (source, options) overrides

Name Type Attributes Default Description
source string | BufferType

The buffer/URL of the texture file.

options PIXI.IBlobResourceOptions <optional>
options.autoLoad boolean <optional>
false

Whether to fetch the data immediately; you can fetch it later via PIXI.BlobResource#load.

options.width number <optional>
1

The width in pixels.

options.height number <optional>
1

The height in pixels.

options.unpackAlignment 1 | 2 | 4 | 8 <optional>
4

The alignment of the pixel rows.

Extends

Members

buffer PIXI.ViewableBuffer | null protected

The viewable buffer on the data.

origin string | null protected

The URL of the texture file.

Methods

load () Promise<this> overrides

Loads the blob

Returns:
Type Description
Promise<this>

Inherited Properties

From class PIXI.Resource

destroyed boolean readonly inherited

If resource has been destroyed.

Default Value:
  • false

height number readonly inherited

The height of the resource.

internal boolean inherited

true if resource is created by BaseTexture useful for doing cleanup with BaseTexture destroy and not cleaning up resources that were created externally.

src string inherited

The url of the resource

valid boolean readonly inherited

Has been validated

width number readonly inherited

The width of the resource.

_height number protected inherited

Internal height of the resource.

_width number protected inherited

Internal width of the resource.

Inherited Methods

From class PIXI.Resource

bind (baseTexture) void inherited

Bind to a parent BaseTexture

Name Type Description
baseTexture PIXI.BaseTexture

Parent texture

destroy () void inherited

Call when destroying resource, unbind any BaseTexture object before calling this method, as reference counts are maintained internally.

dispose () void inherited

Clean up anything, this happens when destroying is ready.

resize (width, height) void inherited

Trigger a resize event

Name Type Description
width number

X dimension

height number

Y dimension

style (_renderer, _baseTexture, _glTexture) boolean inherited

Set the style, optional to override

Name Type Description
_renderer PIXI.Renderer

yeah, renderer!

_baseTexture PIXI.BaseTexture

the texture

_glTexture PIXI.GLTexture

texture instance for this webgl context

Returns:
Type Description
boolean
  • true is success

unbind (baseTexture) void inherited

Unbind to a parent BaseTexture

Name Type Description
baseTexture PIXI.BaseTexture

Parent texture

update () void inherited

Has been updated trigger event.

upload (renderer, baseTexture, glTexture) boolean abstract inherited

Uploads the texture or returns false if it cant for some reason. Override this.

Name Type Description
renderer PIXI.Renderer

yeah, renderer!

baseTexture PIXI.BaseTexture

the texture

glTexture PIXI.GLTexture

texture instance for this webgl context

Returns:
Type Description
boolean
  • true is success