Class CubeResource

Resource for a CubeTexture which contains six resources.

Memberof

PIXI

Hierarchy (View Summary)

AbstractMultiResource
- CubeResource

Index

Constructors

constructor

new CubeResource(
source?: ArrayFixed<string | Resource, 6>,
options?: ICubeResourceOptions,
): CubeResource
Parameters
- Optionalsource: ArrayFixed<string | Resource, 6>
  Collection of URLs or resources to use as the sides of the cube.
- Optionaloptions: ICubeResourceOptions
  ImageResource options
  
  Constructor options for CubeResource.
  - OptionalautoLoad?: boolean
    Whether to auto-load resources
  - height: number
  - OptionallinkBaseTexture?: boolean
    In case BaseTextures are supplied, whether to copy them or use.
  - width: number
Returns CubeResource
Overrides AbstractMultiResource.constructor
- Defined in node_modules/@pixi/core/lib/textures/resources/CubeResource.d.ts:39

Properties

`Protected`_height

_height: number

Internal height of the resource.

`Protected`_width

_width: number

Internal width of the resource.

baseTexture

baseTexture: BaseTexture

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: ArrayFixed<BaseTexture<Resource, IAutoDetectOptions>, 6>

Collection of partial baseTextures that correspond to resources.

`Readonly`length

length: number

Number of elements in array.

`Protected`linkBaseTexture

linkBaseTexture: boolean

In case BaseTextures are supplied, whether to use same resource or bind baseTexture itself.

src

src: string

The url of the resource

`Static`SIDES

SIDES: number

Number of texture sides to store for CubeResources.

Accessors

height

get height(): number
The height of the resource.

Returns number
Inherited from AbstractMultiResource.height
- Defined in node_modules/@pixi/core/lib/textures/resources/Resource.d.ts:95

valid

get valid(): boolean
Has been validated

Returns boolean
Inherited from AbstractMultiResource.valid
- Defined in node_modules/@pixi/core/lib/textures/resources/Resource.d.ts:76

width

get width(): number
The width of the resource.

Returns number
Inherited from AbstractMultiResource.width
- Defined in node_modules/@pixi/core/lib/textures/resources/Resource.d.ts:90

Methods

addBaseTextureAt

addBaseTextureAt(
    baseTexture: BaseTexture,
    index: number,
    linkBaseTexture?: boolean,
): this
Set a baseTexture by ID
Parameters
- baseTexture: BaseTexture
- index: number
  Zero-based index of resource to set
- OptionallinkBaseTexture: boolean
Returns this
- Instance for chaining
Overrides AbstractMultiResource.addBaseTextureAt
- Defined in node_modules/@pixi/core/lib/textures/resources/CubeResource.d.ts:45

addResourceAt

addResourceAt(resource: Resource, index: number): this
Set a resource by ID
Parameters
- resource: Resource
- index: number
  Zero-based index of resource to set
Returns this
- Instance for chaining
Inherited from AbstractMultiResource.addResourceAt
- Defined in node_modules/@pixi/core/lib/textures/resources/AbstractMultiResource.d.ts:60

bind

bind(baseTexture: BaseTexture): void
Add binding.
Parameters
- baseTexture: BaseTexture
  parent base texture
Returns void
Overrides AbstractMultiResource.bind
- Defined in node_modules/@pixi/core/lib/textures/resources/CubeResource.d.ts:44

destroy

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

Returns void
Inherited from AbstractMultiResource.destroy
- Defined in node_modules/@pixi/core/lib/textures/resources/Resource.d.ts:119

dispose

dispose(): void
Destroy this BaseImageResource.

Returns void
Inherited from AbstractMultiResource.dispose
- Defined in node_modules/@pixi/core/lib/textures/resources/AbstractMultiResource.d.ts:46

`Protected`initFromArray

initFromArray(resources: any[], options?: IAutoDetectOptions): void
Used from ArrayResource and CubeResource constructors.
Parameters
- resources: any[]
  Can be resources, image elements, canvas, etc. , length should be same as constructor length
- Optionaloptions: IAutoDetectOptions
  Detect options for resources
Returns void
Inherited from AbstractMultiResource.initFromArray
- Defined in node_modules/@pixi/core/lib/textures/resources/AbstractMultiResource.d.ts:44

load

load(): Promise<CubeResource>
Load all the resources simultaneously

Returns Promise<CubeResource>
- When load is resolved
Inherited from AbstractMultiResource.load
- Defined in node_modules/@pixi/core/lib/textures/resources/AbstractMultiResource.d.ts:75

resize

resize(width: number, height: number): void
Trigger a resize event
Parameters
- width: number
  X dimension
- height: number
  Y dimension
Returns void
Inherited from AbstractMultiResource.resize
- Defined in node_modules/@pixi/core/lib/textures/resources/Resource.d.ts:71

style

style(
    _renderer: Renderer,
    _baseTexture: BaseTexture,
    _glTexture: GLTexture,
): boolean
Set the style, optional to override
Parameters
- _renderer: Renderer
  yeah, renderer!
- _baseTexture: BaseTexture
  the texture
- _glTexture: GLTexture
  texture instance for this webgl context
Returns boolean
- true is success
Inherited from AbstractMultiResource.style
- Defined in node_modules/@pixi/core/lib/textures/resources/Resource.d.ts:111

unbind

unbind(baseTexture: BaseTexture): void
Unset the parent base texture.
Parameters
- baseTexture: BaseTexture
Returns void
Inherited from AbstractMultiResource.unbind
- Defined in node_modules/@pixi/core/lib/textures/resources/AbstractMultiResource.d.ts:70

update

update(): void
Has been updated trigger event.

Returns void
Inherited from AbstractMultiResource.update
- Defined in node_modules/@pixi/core/lib/textures/resources/Resource.d.ts:78

upload

upload(
    renderer: Renderer,
    _baseTexture: BaseTexture,
    glTexture: GLTexture,
): boolean
Upload the resource
Parameters
- renderer: Renderer
- _baseTexture: BaseTexture
- glTexture: GLTexture
Returns boolean
true is success
Overrides AbstractMultiResource.upload
- Defined in node_modules/@pixi/core/lib/textures/resources/CubeResource.d.ts:53

`Static`test

test(source: unknown): source is ArrayFixed<string | Resource, 6>
Used to auto-detect the type of resource.
Parameters
- source: unknown
  The source object
Returns source is ArrayFixed<string | Resource, 6>
true if source is an array of 6 elements
Overrides AbstractMultiResource.test
- Defined in node_modules/@pixi/core/lib/textures/resources/CubeResource.d.ts:61

Class CubeResource

Memberof

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

OptionalautoLoad?: boolean

height: number

OptionallinkBaseTexture?: boolean

width: number

Returns CubeResource

Properties

Protected_height

Protected_width

baseTexture

Readonlydestroyed

Default

internal

ReadonlyitemDirtyIds

Readonlyitems

Readonlylength

ProtectedlinkBaseTexture

src

StaticSIDES

Accessors

height

Returns number

valid

Returns boolean

width

Returns number

Methods

addBaseTextureAt

Parameters

Returns this

addResourceAt

Parameters

Returns this

bind

Parameters

Returns void

destroy

Returns void

dispose

Returns void

ProtectedinitFromArray

Parameters

Returns void

load

Returns Promise<CubeResource>

resize

Parameters

Returns void

style

Parameters

Returns boolean

unbind

Parameters

Returns void

update

Returns void

upload

Parameters

Returns boolean

Statictest

Parameters

Returns source is ArrayFixed<string | Resource, 6>

Settings

On This Page

`Optional`autoLoad?: boolean

`Optional`linkBaseTexture?: boolean

`Protected`_height

`Protected`_width

`Readonly`destroyed

`Readonly`itemDirtyIds

`Readonly`items

`Readonly`length

`Protected`linkBaseTexture

`Static`SIDES

`Protected`initFromArray

`Static`test