Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
options |
object |
optional
Options to for Resource constructor
|
Extends
Members
-
_height number protected inherited
-
Internal height of the resource
-
_width number protected inherited
-
Internal width of the resource
-
baseTexture PIXI.BaseTexture
-
Bound baseTexture, there can only be one
-
destroyed boolean readonly inherited
-
If resource has been destroyed
- Default Value:
- false
-
height number readonly inherited
-
The height of the resource.
-
internal boolean protected inherited
-
true
if resource is created by BaseTexture useful for doing cleanup with BaseTexture destroy and not cleaning up resources that were created externally. -
Dirty IDs for each part
-
items Array.<PIXI.BaseTexture> readonly
-
Collection of partial baseTextures that correspond to resources
-
Number of elements in array
-
valid boolean readonly inherited
-
Has been validated
-
width number readonly inherited
-
The width of the resource.
Methods
-
addResourceAt (resource, index)PIXI.resources.ArrayResource
-
Set a resource by ID
Name Type Description resource
PIXI.resources.Resource index
number Zero-based index of resource to set
Returns:
Type Description PIXI.resources.ArrayResource Instance for chaining -
Bind to a parent BaseTexture
Name Type Description baseTexture
PIXI.BaseTexture Parent texture
-
destroy () inherited
-
Call when destroying resource, unbind any BaseTexture object before calling this method, as reference counts are maintained internally.
-
Clean up anything, this happens when destroying is ready.
-
used from ArrayResource and CubeResource constructors
Name Type Description resources
Array.<*> Can be resources, image elements, canvas, etc. , length should be same as constructor length
options
object optional detect options for resources
-
This can be overridden to start preloading a resource or do any other prepare step.
Returns:
Type Description Promise.<void> Handle the validate event -
resize (width, height) inherited
-
Trigger a resize event
Name Type Description width
number X dimension
height
number Y dimension
-
style (renderer, baseTexture, glTexture)boolean inherited
-
Set the style, optional to override
Name Type Description renderer
PIXI.Renderer yeah, renderer!
baseTexture
PIXI.BaseTexture the texture
glTexture
PIXI.GLTexture texture instance for this webgl context
Returns:
Type Description boolean true
is success -
Unbind to a parent BaseTexture
Name Type Description baseTexture
PIXI.BaseTexture Parent texture
-
update () inherited
-
Has been updated trigger event