new PIXI.BaseTexture(source, scaleMode, resolution)
Name | Type | Default | Description |
---|---|---|---|
source |
HTMLImageElement | HTMLCanvasElement |
optional
the source object of the texture. |
|
scaleMode |
number | PIXI.settings.SCALE_MODE |
optional
See PIXI.SCALE_MODES for possible values |
resolution |
number | 1 |
optional
The resolution / device pixel ratio of the texture |
Extends
- EventEmitter
Members
-
readonlyhasLoadedboolean
-
Set to true once the base texture has successfully loaded.
This is never true if the underlying source fails to load or has no texture data.
-
readonlyheightnumber
-
The height of the base texture set when the image has loaded
-
readonlyimageTypestring
-
Type of image defined in source, eg.
png
orsvg
-
imageUrlstring
-
The image url of the texture
-
readonlyisLoadingboolean
-
Set to true if the source is currently loading.
If an Image source is loading the 'loaded' or 'error' event will be
dispatched when the operation ends. An underyling source that is
immediately-available bypasses loading entirely. -
mipmapboolean
-
Set this to true if a mipmap of this texture needs to be generated. This value needs
to be set before the texture is used
Also the texture must be a power of two size to work- See:
-
readonlyorigSourceImage
-
The image source that is used to create the texture. This is used to
store the original Svg source when it is replaced with a canvas element.TODO: Currently not in use but could be used when re-scaling svg.
-
premultipliedAlphaboolean
-
Controls if RGB channels should be pre-multiplied by Alpha (WebGL only)
All blend modes, and shaders written for default value. Change it on your own risk.- Default Value:
- true
-
readonlyrealHeightnumber
-
Used to store the actual height of the source of this texture
-
readonlyrealWidthnumber
-
Used to store the actual width of the source of this texture
-
resolutionnumber
-
The resolution / device pixel ratio of the texture
- Default Value:
- 1
-
scaleModenumber
-
The scale mode to apply when scaling this texture
- Default Value:
- PIXI.settings.SCALE_MODE
- See:
-
readonlysourceHTMLImageElement HTMLCanvasElement
-
The image source that is used to create the texture.
TODO: Make this a setter that calls loadSource();
-
readonlysourceScalenumber
-
Scale for source image. Used with Svg images to scale them before rasterization.
-
readonlywidthnumber
-
The width of the base texture set when the image has loaded
-
wrapModenumber
-
WebGL Texture wrap mode
- See:
Methods
-
staticPIXI.BaseTexture.fromCanvas(canvas, scaleMode){PIXI.BaseTexture}
-
Helper function that creates a base texture from the given canvas element.
Name Type Description canvas
HTMLCanvasElement The canvas element source of the texture
scaleMode
number See PIXI.SCALE_MODES for possible values
Returns:
Type Description PIXI.BaseTexture The new base texture. -
staticPIXI.BaseTexture.fromImage(imageUrl, crossorigin, scaleMode, sourceScale){PIXI.BaseTexture}
-
Helper function that creates a base texture from the given image url.
If the image is not in the base texture cache it will be created and loaded.Name Type Default Description imageUrl
string The image url of the texture
crossorigin
boolean (auto) optional Should use anonymous CORS? Defaults to true if the URL is not a data-URI.
scaleMode
number PIXI.settings.SCALE_MODE optional See PIXI.SCALE_MODES for possible values
sourceScale
number (auto) optional Scale for the original image, used with Svg images.
Returns:
Type Description PIXI.BaseTexture The new base texture. -
_loadSvgSource()
-
Checks if
source
is an SVG image and whether it's loaded via a URL or a data URI. Then calls_loadSvgSourceUsingDataUri
or_loadSvgSourceUsingXhr
. -
_loadSvgSourceUsingDataUri(dataUri)
-
Reads an SVG string from data URI and then calls
_loadSvgSourceUsingString
.Name Type Description dataUri
string The data uri to load from.
-
_loadSvgSourceUsingString(svgString)
-
Loads texture using an SVG string. The original SVG Image is stored as
origSource
and the
created canvas is the newsource
. The SVG is scaled usingsourceScale
. Called by_loadSvgSourceUsingXhr
or_loadSvgSourceUsingDataUri
.Name Type Description svgString
string SVG source as string
Fires:
- event:loaded
-
_loadSvgSourceUsingXhr()
-
Loads an SVG string from
imageUrl
using XHR and then calls_loadSvgSourceUsingString
. -
_updateImageType()
-
Updates type of the source image.
-
destroy()
-
Destroys this base texture
-
dispose()
-
Frees the texture from WebGL memory without destroying this texture object.
This means you can still use the texture later which will upload it to GPU
memory again. -
protectedloadSource(source)
-
Load a source.
If the source is not-immediately-available, such as an image that needs to be
downloaded, then the 'loaded' or 'error' event will be dispatched in the future
andhasLoaded
will remain false after this call.The logic state after calling
loadSource
directly or indirectly (eg.fromImage
,new BaseTexture
) is:if (texture.hasLoaded) { // texture ready for use } else if (texture.isLoading) { // listen to 'loaded' and/or 'error' events on texture } else { // not loading, not going to load UNLESS the source is reloaded // (it may still make sense to listen to the events) }
Name Type Description source
HTMLImageElement | HTMLCanvasElement the source object of the texture.
-
update()
-
Updates the texture on all the webgl renderers, this also assumes the src has changed.
Fires:
- event:update
-
updateSourceImage(newSrc)
-
Changes the source image of the texture.
The original source must be an Image element.Name Type Description newSrc
string the path of the image
Events
-
Fired when a not-immediately-available source fails to load.
-
loaded
-
Fired when a not-immediately-available source finishes loading.