API Docs for: 2.2.1
Show:

BaseTexture Class

Uses
Defined in: pixi/textures/BaseTexture.hx:9

A texture stores the information that represents an image. All textures have a base texture

Constructor

BaseTexture

(
  • source
  • scaleMode
)

Defined in pixi/textures/BaseTexture.hx:9

Parameters:

  • source String

    the source object (image or canvas)

  • scaleMode Int

    Should be one of the PIXI.scaleMode consts

Methods

destroy

()

Defined in pixi/textures/BaseTexture.hx:67

Destroys this base texture

dirty

()

Defined in pixi/textures/BaseTexture.hx:74

Sets all glTextures to be dirty.

emit

(
  • eventName
  • data
)
Bool

Inherited from EventTarget: pixi/utils/EventTarget.hx:29

Emit an event to all registered event listeners.

Parameters:

  • eventName String

    The name of the event.

  • data Dynamic

Returns:

Bool:

Indication if we've emitted an event.

fromCanvas

(
  • canvas
  • scaleMode
)
static

Defined in pixi/textures/BaseTexture.hx:102

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

Parameters:

  • canvas Canvas

    The canvas element source of the texture

  • scaleMode Int

    Should be one of the PIXI.scaleMode consts

Returns:

BaseTexture

fromImage

(
  • imageUrl
  • crossorigin
  • scaleMode
)
static

Defined in pixi/textures/BaseTexture.hx:89

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

Parameters:

  • imageUrl String

    The image url of the texture

  • crossorigin Bool
  • scaleMode Int

    Should be one of the PIXI.scaleMode consts

Returns:

BaseTexture

listeners

(
  • eventName
)
Array

Inherited from EventTarget: pixi/utils/EventTarget.hx:20

Return a list of assigned event listeners.

Parameters:

  • eventName String

    The events that should be listed.

Returns:

Array:

An array of listener functions

off

(
  • eventName
  • callback
)

Inherited from EventTarget: pixi/utils/EventTarget.hx:61

Remove event listeners.

Parameters:

  • eventName String

    The event we want to remove.

  • callback Function

    The listener that we need to find.

on

(
  • eventName
  • callback
)

Inherited from EventTarget: pixi/utils/EventTarget.hx:41

Register a new EventListener for the given event.

Parameters:

  • eventName String

    Name of the event.

  • callback Functon

    Callback function.

once

(
  • eventName
  • callback
)

Inherited from EventTarget: pixi/utils/EventTarget.hx:52

Add an EventListener that's only called once.

Parameters:

  • eventName String

    Name of the event.

  • callback Function

    Callback function.

removeAllListeners

(
  • eventName
)

Inherited from EventTarget: pixi/utils/EventTarget.hx:72

Remove all listeners or only the listeners for the specified event.

Parameters:

  • eventName String

    The event you want to remove all listeners for.

updateSourceImage

(
  • newSrc
)

Defined in pixi/textures/BaseTexture.hx:81

Changes the source image of the texture

Parameters:

  • newSrc String

    the path of the image

Properties

hasLoaded

Bool

Defined in pixi/textures/BaseTexture.hx:49

[read-only] Describes if the base texture has loaded or not

height

Float

Defined in pixi/textures/BaseTexture.hx:35

[read-only] The height of the base texture set when the image has loaded

resolution

Float

Defined in pixi/textures/BaseTexture.hx:20

The Resolution of the texture.

scaleMode

Float

Defined in pixi/textures/BaseTexture.hx:42

The scale mode to apply when scaling this texture

source

Dynamic

Defined in pixi/textures/BaseTexture.hx:56

The source that is loaded to create the texture

width

Float

Defined in pixi/textures/BaseTexture.hx:28

[read-only] The width of the base texture set when the image has loaded