AtlasResource

class AtlasResource extends PIXI.Resource

An AtlasResource is used by AtlasAllocator to manage texture sources

Constructor


new AtlasResource(width: number, height: number) → {}

Creates an atlas resource.

Parameters:
Name Type Description
width number
height number

Summary


Properties from AtlasResource

AtlasResourceItem[]
managedItems

The list of managed resources in the atlas.

Methods from AtlasResource

boolean
upload(renderer: PIXI.Renderer, baseTexture: PIXI.BaseTexture, glTexture: PIXI.GLTexture)

Uploads the atlas.

void
protected uploadItem(renderer: PIXI.Renderer, target: number, format: number, type: number, item: AtlasResourceItem)

Uploads the atlas item to the GPU.

Properties inherited from Resource

boolean
destroyed = false
number
height
boolean
internal
string
src

The url of the resource

boolean
valid
number
width
number
protected _height

Internal height of the resource.

number
protected _width

Internal width of the resource.

Methods inherited from Resource

void
bind(baseTexture: PIXI.BaseTexture)
void
destroy()
void
dispose()

Clean up anything, this happens when destroying is ready.

void
resize(width: number, height: number)
boolean
style(_renderer: PIXI.Renderer, _baseTexture: PIXI.BaseTexture, _glTexture: PIXI.GLTexture)
void
unbind(baseTexture: PIXI.BaseTexture)
void
update()

Has been updated trigger event.

Promise<PIXI.Resource>
protected load()

Public Properties


managedItems AtlasResource.ts:54
managedItems: AtlasResourceItem[]

The list of managed resources in the atlas.

Public Methods


upload AtlasResource.ts:72
upload(renderer: PIXI.Renderer, baseTexture: PIXI.BaseTexture, glTexture: PIXI.GLTexture) → {boolean}

Uploads the atlas.

Parameters:
Name Type Description
renderer PIXI.Renderer
baseTexture PIXI.BaseTexture
glTexture PIXI.GLTexture
Returns:
Type Description
boolean

Protected Methods


uploadItem AtlasResource.ts:124
protected uploadItem(renderer: PIXI.Renderer, target: number, format: number, type: number, item: AtlasResourceItem) → {void}

Uploads the atlas item to the GPU.

Parameters:
Name Type Description
renderer PIXI.Renderer

The renderer holding the WebGL context.

target number

The binding point of the base-texture.

format number

The format of the base-texture.

type number

The type of the base-texture data.

item AtlasResourceItem

The item to upload.

Returns:
Type Description
void

Powered by webdoc!