Class Resource

Base resource class for textures that manages validation and uploading, depending on its type.

Uploading of a base texture to the GPU is required.

memberof: PIXI

Hierarchy

Resource

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Resource(width?: number, height?: number): Resource

- Defined in source/node_modules/@pixi/core/index.d.ts:3349
Parameters
- Optional width: number
- Optional height: number
Returns Resource

Properties

Protected _height

_height: number

Protected _width

_width: number

destroyed

destroyed: boolean

internal

internal: boolean

Protected onError

onError: Runner

Protected onResize

onResize: Runner

Protected onUpdate

onUpdate: Runner

Accessors

height

get height(): number

- Defined in source/node_modules/@pixi/core/index.d.ts:3403
The height of the resource.

member

{number}

readonly

Returns number

valid

get valid(): boolean

- Defined in source/node_modules/@pixi/core/index.d.ts:3378
Has been validated

readonly

member

{boolean}

Returns boolean

width

get width(): number

- Defined in source/node_modules/@pixi/core/index.d.ts:3396
The width of the resource.

member

{number}

readonly

Returns number

Methods

bind

bind(baseTexture: BaseTexture<Resource, IAutoDetectOptions>): void

- Defined in source/node_modules/@pixi/core/index.d.ts:3360
Bind to a parent BaseTexture

Parameters
- baseTexture: BaseTexture<Resource, IAutoDetectOptions>
  
  Parent texture
Returns void

destroy

destroy(): void

- Defined in source/node_modules/@pixi/core/index.d.ts:3433
Call when destroying resource, unbind any BaseTexture object before calling this method, as reference counts are maintained internally.

Returns void

Protected dispose

dispose(): void

- Defined in source/node_modules/@pixi/core/index.d.ts:3427
Clean up anything, this happens when destroying is ready.

Returns void

Protected load

load(): Promise<Resource>

- Defined in source/node_modules/@pixi/core/index.d.ts:3389
This can be overridden to start preloading a resource or do any other prepare step.

Returns Promise<Resource>

Handle the validate event

resize

resize(width: number, height: number): void

- Defined in source/node_modules/@pixi/core/index.d.ts:3372
Trigger a resize event

Parameters
- width: number
  
  X dimension
- height: number
  
  Y dimension
Returns void

style

style(_renderer: Renderer, _baseTexture: BaseTexture<Resource, IAutoDetectOptions>, _glTexture: GLTexture): boolean

- Defined in source/node_modules/@pixi/core/index.d.ts:3421
Set the style, optional to override

Parameters
- _renderer: Renderer
- _baseTexture: BaseTexture<Resource, IAutoDetectOptions>
- _glTexture: GLTexture
Returns boolean

true is success

unbind

unbind(baseTexture: BaseTexture<Resource, IAutoDetectOptions>): void

- Defined in source/node_modules/@pixi/core/index.d.ts:3366
Unbind to a parent BaseTexture

Parameters
- baseTexture: BaseTexture<Resource, IAutoDetectOptions>
  
  Parent texture
Returns void

update

update(): void

- Defined in source/node_modules/@pixi/core/index.d.ts:3382
Has been updated trigger event

Returns void

Abstract upload

upload(renderer: Renderer, baseTexture: BaseTexture<Resource, IAutoDetectOptions>, glTexture: GLTexture): boolean

- Defined in source/node_modules/@pixi/core/index.d.ts:3412
Uploads the texture or returns false if it cant for some reason. Override this.

Parameters
- renderer: Renderer
  
  yeah, renderer!
- baseTexture: BaseTexture<Resource, IAutoDetectOptions>
  
  the texture
- glTexture: GLTexture
  
  texture instance for this webgl context
Returns boolean

true is success

Static test

test(_source: unknown, _extension?: string): boolean

- Defined in source/node_modules/@pixi/core/index.d.ts:3441
Abstract, used to auto-detect resource type

static

Parameters
- _source: unknown
- Optional _extension: string
Returns boolean

Generated using TypeDoc