Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RenderTexture

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected _frame

_frame: Rectangle

Protected _rotate

_rotate: boolean | 0

Protected _updateID

_updateID: number

Protected _uvs

_uvs: TextureUvs

baseTexture

baseTexture: BaseTexture

frame

frame: Rectangle

height

height: number

Protected legacyRenderer

legacyRenderer: any

noFrame

noFrame: boolean

orig

orig: Rectangle

requiresUpdate

requiresUpdate: boolean

rotate

rotate: number

textureCacheIds

textureCacheIds: string[]

transform

transform: any

Optional trim

trim: Rectangle

valid

valid: boolean

width

width: number

Static EMPTY

EMPTY: Texture

Static EventEmitter

EventEmitter: object

Type declaration

  • constructor: function

    • Returns EventEmitter

  • prefixed: string | boolean

Static WHITE

WHITE: Texture

Static prefixed

prefixed: string | boolean

Methods

Protected _updateUvs

  • _updateUvs(): void

  • Returns void

addListener

  • addListener(event: "update", fn: function, context?: any): this

clone

  • Returns Texture

destroy

  • destroy(destroyBase?: boolean): void

  • Parameters

    • Optional destroyBase: boolean

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Calls each of the listeners registered for a given event.

    Parameters

    • event: string | symbol

      The event name.

    • Rest ...args: any[]

      Arguments that are passed to registered listeners

    Returns boolean

    true if the event had listeners, else false.

eventNames

  • eventNames(): Array<string | symbol>

  • Return an array listing the events for which the emitter has registered listeners.

    Returns Array<string | symbol>

listeners

  • listeners(event: string | symbol): Function[]
  • listeners(event: string | symbol, exists: boolean): boolean

  • Return the listeners registered for a given event.

    Parameters

    • event: string | symbol

      The event name.

    Returns Function[]

  • Check if there listeners for a given event. If exists argument is not true lists listeners.

    Parameters

    • event: string | symbol

      The event name.

    • exists: boolean

      Only check if there are listeners.

    Returns boolean

off

  • off(event: "update", fn?: function, context?: any): this

  • Parameters

    • event: "update"
    • Optional fn: function
    • Optional context: any

    Returns this

on

  • on(event: "update", fn: function, context?: any): this

  • Parameters

    • event: "update"
    • fn: function
    • Optional context: any

    Returns this

Protected onBaseTextureLoaded

Protected onBaseTextureUpdated

once

  • once(event: "update", fn: function, context?: any): this

  • Parameters

    • event: "update"
    • fn: function
    • Optional context: any

    Returns this

removeAllListeners

  • removeAllListeners(event: "update"): this

removeListener

  • removeListener(event: "update", fn?: function, context?: any): this

resize

  • resize(width: number, height: number, doNotResizeBaseTexture?: boolean): void

  • Parameters

    • width: number
    • height: number
    • Optional doNotResizeBaseTexture: boolean

    Returns void

setMaxListeners

  • setMaxListeners(): this

  • This function doesn't apply anymore.

    deprecated

    Returns this

update

  • update(): void

  • Returns void

Static addTextureToCache

  • addTextureToCache(texture: Texture, id: string): void

Static addToCache

  • addToCache(texture: Texture, id: string): void

  • Parameters

    Returns void

Static create

  • create(width?: number, height?: number, scaleMode?: number, resolution?: number): RenderTexture

  • Parameters

    • Optional width: number
    • Optional height: number
    • Optional scaleMode: number
    • Optional resolution: number

    Returns RenderTexture

Static from

  • from(source: number | string | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | BaseTexture): Texture

  • Parameters

    • source: number | string | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement | BaseTexture

    Returns Texture

Static fromCanvas

  • fromCanvas(canvas: HTMLCanvasElement, scaleMode?: number, origin?: string): Texture

  • Parameters

    • canvas: HTMLCanvasElement
    • Optional scaleMode: number
    • Optional origin: string

    Returns Texture

Static fromFrame

  • fromFrame(frameId: string): Texture

  • Parameters

    • frameId: string

    Returns Texture

Static fromImage

  • fromImage(imageUrl: string, crossOrigin?: boolean, scaleMode?: number, sourceScale?: number): Texture

  • Parameters

    • imageUrl: string
    • Optional crossOrigin: boolean
    • Optional scaleMode: number
    • Optional sourceScale: number

    Returns Texture

Static fromLoader

  • fromLoader(source: HTMLImageElement | HTMLCanvasElement, imageUrl: string, name?: string): Texture

  • Parameters

    • source: HTMLImageElement | HTMLCanvasElement
    • imageUrl: string
    • Optional name: string

    Returns Texture

Static fromVideo

  • fromVideo(video: HTMLVideoElement | string, scaleMode?: number): Texture

  • Parameters

    • video: HTMLVideoElement | string
    • Optional scaleMode: number

    Returns Texture

Static fromVideoUrl

  • fromVideoUrl(videoUrl: string, scaleMode?: number): Texture

  • Parameters

    • videoUrl: string
    • Optional scaleMode: number

    Returns Texture

Static removeFromCache

Static removeTextureFromCache

  • removeTextureFromCache(id: string): Texture

Generated using TypeDoc