API Docs for: 1.5.0
Show:

Texture Class

Uses
Defined in: src/pixi/textures/Texture.js:10
Module: PIXI

A texture stores the information that represents an image or part of an image. It cannot be added to the display list directly. To do this use PIXI.Sprite. If no frame is provided then the whole image is used

Constructor

Texture

(
  • baseTexture
  • frame
)

Defined in src/pixi/textures/Texture.js:10

Parameters:

  • baseTexture BaseTexture

    The base texture source to create the texture from

  • frame Rectangle

    The rectangle frame of the texture to show

Methods

addEventListener

(
  • type
  • listener
)

Inherited from EventTarget: src/pixi/utils/EventTarget.js:32

Adds a listener for a specific event

Parameters:

  • type String

    A string representing the event type to listen for.

  • listener Function

    The callback function that will be fired when the event occurs

addTextureToCache

(
  • texture
  • id
)
static

Defined in src/pixi/textures/Texture.js:209

Adds a texture to the textureCache.

Parameters:

  • texture Texture
  • id String

    the id that the texture will be stored against.

destroy

(
  • destroyBase
)

Defined in src/pixi/textures/Texture.js:95

Destroys this texture

Parameters:

  • destroyBase Boolean

    Whether to destroy the base texture as well

dispatchEvent

(
  • event
)

Inherited from EventTarget: src/pixi/utils/EventTarget.js:55

Fires the event, ie pretends that the event has happened

Parameters:

  • event Event

    the event object

fromCanvas

(
  • canvas
)
static

Defined in src/pixi/textures/Texture.js:191

Helper function that returns a texture based on a canvas element If the canvas is not in the texture cache it will be created and loaded

Parameters:

  • canvas Canvas

    The canvas element source of the texture

Returns:

Texture

fromFrame

(
  • frameId
)
static

Defined in src/pixi/textures/Texture.js:175

Helper function that returns a texture based on a frame id If the frame id is not in the texture cache an error will be thrown

Parameters:

  • frameId String

    The frame id of the texture

Returns:

Texture

fromImage

(
  • imageUrl
  • crossorigin
)
static

Defined in src/pixi/textures/Texture.js:152

Helper function that returns a texture based on an image url If the image is not in the texture cache it will be created and loaded

Parameters:

  • imageUrl String

    The image url of the texture

  • crossorigin Boolean

    Whether requests should be treated as crossorigin

Returns:

Texture

onBaseTextureLoaded

(
  • event
)
private

Defined in src/pixi/textures/Texture.js:76

Called when the base texture is loaded

Parameters:

  • event Object

removeAllEventListeners

(
  • type
)

Inherited from EventTarget: src/pixi/utils/EventTarget.js:96

Removes all the listeners that were active for the specified event type

Parameters:

  • type String

    A string representing the event type which will have all its listeners removed

removeEventListener

(
  • type
  • listener
)

Inherited from EventTarget: src/pixi/utils/EventTarget.js:77

Removes the specified listener that was assigned to the specified event type

Parameters:

  • type String

    A string representing the event type which will have its listener removed

  • listener Function

    The callback function that was be fired when the event occured

removeTextureFromCache

(
  • id
)
Texture static

Defined in src/pixi/textures/Texture.js:222

Remove a texture from the textureCache.

Parameters:

  • id String

    the id of the texture to be removed

Returns:

Texture:

the texture that was removed

renderCanvas

(
  • displayObject
  • clear
)
private

Defined in src/pixi/textures/RenderTexture.js:178

This function will draw the display object to the texture.

Parameters:

  • displayObject DisplayObject

    The display object to render this texture on

  • clear Boolean

    If true the texture will be cleared before the displayObject is drawn

renderWebGL

(
  • displayObject
  • clear
)
private

Defined in src/pixi/textures/RenderTexture.js:126

This function will draw the display object to the texture.

Parameters:

  • displayObject DisplayObject

    The display object to render this texture on

  • clear Boolean

    If true the texture will be cleared before the displayObject is drawn

setFrame

(
  • frame
)

Defined in src/pixi/textures/Texture.js:106

Specifies the rectangle region of the baseTexture

Parameters:

  • frame Rectangle

    The frame of the texture to set it to

Properties

baseTexture

BaseTexture

Defined in src/pixi/textures/RenderTexture.js:60

The base texture object that this texture uses

baseTexture

BaseTexture

Defined in src/pixi/textures/Texture.js:33

The base texture of that this texture uses

frame

Rectangle

Defined in src/pixi/textures/RenderTexture.js:52

The framing rectangle of the render texture

frame

Rectangle

Defined in src/pixi/textures/Texture.js:41

The frame specifies the region of the base texture that this texture uses

height

Number

Defined in src/pixi/textures/RenderTexture.js:44

The height of the render texture

listeners

Object

Inherited from EventTarget: src/pixi/utils/EventTarget.js:24

Holds all the listeners

trim

Rectangle

Defined in src/pixi/textures/Texture.js:49

The trim point

width

Number

Defined in src/pixi/textures/RenderTexture.js:37

The with of the render texture