Class AbstractMultiResourceAbstract

Resource that can manage several resource (items) inside. All resources need to have the same pixel size. Parent class for CubeResource and ArrayResource

Memberof

PIXI

Hierarchy (view full)

Constructors

constructor

Properties

baseTexture destroyed internal itemDirtyIds items length src

Accessors

height valid width

Methods

addBaseTextureAt addResourceAt bind destroy dispose load resize style unbind update upload test

Constructors

constructor

Properties

baseTexture

baseTexture: BaseTexture<Resource, IAutoDetectOptions>

Bound baseTexture, there can only be one.

Readonly destroyed

destroyed: boolean

If resource has been destroyed.

Default

false

internal

internal: boolean

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

Readonly itemDirtyIds

itemDirtyIds: number[]

Dirty IDs for each part.

Readonly items

items: BaseTexture<Resource, IAutoDetectOptions>[]

Collection of partial baseTextures that correspond to resources.

Readonly length

length: number

Number of elements in array.

src

src: string

The url of the resource

Accessors

height

  • get height(): number

  • The height of the resource.

    Returns number

valid

  • get valid(): boolean

  • Has been validated

    Returns boolean

width

  • get width(): number

  • The width of the resource.

    Returns number

Methods

Abstract addBaseTextureAt

  • addBaseTextureAt(baseTexture, index): this

  • Set a baseTexture by ID

    Parameters

    Returns this

    • Instance for chaining

addResourceAt

  • addResourceAt(resource, index): this

  • Set a resource by ID

    Parameters

    • resource: Resource
    • index: number

      Zero-based index of resource to set

    Returns this

    • Instance for chaining

bind

destroy

  • destroy(): void

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

    Returns void

dispose

  • dispose(): void

  • Destroy this BaseImageResource.

    Returns void

load

  • load(): Promise<AbstractMultiResource>

  • Load all the resources simultaneously

    Returns Promise<AbstractMultiResource>

    • When load is resolved

resize

  • resize(width, height): void

  • Trigger a resize event

    Parameters

    • width: number

      X dimension

    • height: number

      Y dimension

    Returns void

style

  • style(_renderer, _baseTexture, _glTexture): boolean

  • Set the style, optional to override

    Parameters

    Returns boolean

    • true is success

unbind

update

  • update(): void

  • Has been updated trigger event.

    Returns void

Abstract upload

  • upload(renderer, baseTexture, glTexture): boolean

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

    Parameters

    Returns boolean

    • true is success

Static test

  • test(_source, _extension?): boolean

  • Abstract, used to auto-detect resource type.

    Parameters

    • _source: unknown

      The source object

    • Optional _extension: string

      The extension of source, if set

    Returns boolean

Settings

Member Visibility

Theme

On This Page

constructorbaseTexturedestroyedinternalitemDirtyIdsitemslengthsrcheightvalidwidthaddBaseTextureAtaddResourceAtbinddestroydisposeloadresizestyleunbindupdateuploadtest

Generated using TypeDoc