Class CubeResource

Resource for a CubeTexture which contains six resources.

memberof: PIXI

Hierarchy

AbstractMultiResource
- CubeResource

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CubeResource(source?: ArrayFixed<string | Resource, 6>, options?: ICubeResourceOptions): CubeResource

Overrides AbstractMultiResource.constructor
- Defined in source/node_modules/@pixi/core/index.d.ts:1273
Parameters
- Optional source: ArrayFixed<string | Resource, 6>
- Optional options: ICubeResourceOptions
Returns CubeResource

Properties

Protected _height

_height: number

Protected _width

_width: number

baseTexture

baseTexture: BaseTexture<Resource, IAutoDetectOptions>

destroyed

destroyed: boolean

internal

internal: boolean

itemDirtyIds

itemDirtyIds: number[]

items

items: ArrayFixed<BaseTexture<Resource, IAutoDetectOptions>, 6>

Readonly length

length: number

linkBaseTexture

linkBaseTexture: boolean

Protected onError

onError: Runner

Protected onResize

onResize: Runner

Protected onUpdate

onUpdate: Runner

Static SIDES

SIDES: number

Number of texture sides to store for CubeResources

name: PIXI.CubeResource.SIDES
static
member: {number}
default: 6

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

addBaseTextureAt

addBaseTextureAt(baseTexture: BaseTexture<Resource, IAutoDetectOptions>, index: number, linkBaseTexture?: boolean): CubeResource

Overrides AbstractMultiResource.addBaseTextureAt
- Defined in source/node_modules/@pixi/core/index.d.ts:1292
Set a baseTexture by ID

Parameters
- baseTexture: BaseTexture<Resource, IAutoDetectOptions>
- index: number
- Optional linkBaseTexture: boolean
Returns CubeResource

Instance for chaining

addResourceAt

addResourceAt(resource: Resource, index: number): CubeResource

Inherited from AbstractMultiResource.addResourceAt
- Defined in source/node_modules/@pixi/core/index.d.ts:277
Set a resource by ID

Parameters
- resource: Resource
- index: number
  
  Zero-based index of resource to set
Returns CubeResource

Instance for chaining

bind

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

Overrides AbstractMultiResource.bind
- Defined in source/node_modules/@pixi/core/index.d.ts:1291
Add binding

override

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

destroy

destroy(): void

Inherited from AbstractMultiResource.destroy
- 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

dispose

dispose(): void

Inherited from AbstractMultiResource.dispose
- Defined in source/node_modules/@pixi/core/index.d.ts:261
Destroy this BaseImageResource

override

Returns void

Protected initFromArray

initFromArray(resources: any[], options?: IAutoDetectOptions): void

Inherited from AbstractMultiResource.initFromArray
- Defined in source/node_modules/@pixi/core/index.d.ts:256
used from ArrayResource and CubeResource constructors

Parameters
- resources: any[]
  
  Can be resources, image elements, canvas, etc. , length should be same as constructor length
- Optional options: IAutoDetectOptions
Returns void

load

load(): Promise<CubeResource>

Inherited from AbstractMultiResource.load
- Defined in source/node_modules/@pixi/core/index.d.ts:295
Load all the resources simultaneously

override

Returns Promise<CubeResource>

When load is resolved

resize

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

Inherited from AbstractMultiResource.resize
- 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

Inherited from AbstractMultiResource.style
- 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

Inherited from AbstractMultiResource.unbind
- Defined in source/node_modules/@pixi/core/index.d.ts:289
Unset the parent base texture

member

{PIXI.BaseTexture}

override

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

update

update(): void

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

Returns void

upload

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

Overrides AbstractMultiResource.upload
- Defined in source/node_modules/@pixi/core/index.d.ts:1298
Upload the resource

Parameters
- renderer: Renderer
- _baseTexture: BaseTexture<Resource, IAutoDetectOptions>
- glTexture: GLTexture
Returns boolean

true is success

Static test

test(source: unknown): source is ArrayFixed<string | Resource, 6>

Overrides AbstractMultiResource.test
- Defined in source/node_modules/@pixi/core/index.d.ts:1315
Used to auto-detect the type of resource.

static

Parameters
- source: unknown
  
  The source object
Returns source is ArrayFixed<string | Resource, 6>

true if source is an array of 6 elements

Generated using TypeDoc