Class CanvasTexture2D

2D纹理

Hierarchy

Texture2D
- CanvasTexture2D

Constructors

constructor

new CanvasTexture2D(): CanvasTexture2D
Returns CanvasTexture2D
Overrides Texture2D.constructor
- Defined in src/textures/CanvasTexture2D.ts:8

Properties

OFFSCREEN_HEIGHT

OFFSCREEN_HEIGHT: number = 1024

OFFSCREEN_WIDTH

OFFSCREEN_WIDTH: number = 1024

class

__class__: "Texture2D"

`Protected` _activePixels

_activePixels: TexImageSource | TexImageSource[]

`Protected` _dataURL

_dataURL: string

`Protected` _pixels

_pixels: TexImageSource | TexImageSource[]

需要使用的贴图数据

anisotropy

anisotropy: number = 1

各向异性过滤。使用各向异性过滤能够使纹理的效果更好，但是会消耗更多的内存、CPU、GPU时间。默认为1。

assetType

assetType: AssetType = AssetType.texture

canvas

canvas: HTMLCanvasElement

flipY

flipY: boolean = false

对图像进行Y轴反转。默认值为false

format

format: TextureFormat = 'RGBA'

格式

generateMipmap

generateMipmap: boolean = true

是否生成mipmap

hideFlags

hideFlags: HideFlags = HideFlags.None

隐藏标记，用于控制是否在层级界面、检查器显示，是否保存

invalid

invalid: boolean = true

是否失效，值为true时重新创建 WebGLTexture

isRenderTarget

isRenderTarget: boolean = false

是否为渲染目标纹理

magFilter

magFilter: TextureMagFilter = 'LINEAR'

minFilter

minFilter: TextureMinFilter = 'LINEAR_MIPMAP_LINEAR'

name

name: string

noPixels

noPixels: ImageDatas = ImageDatas.white

当贴图数据未加载好等情况时代替使用

premulAlpha

premulAlpha: boolean = false

将图像RGB颜色值得每一个分量乘以A。默认为false

textureType

textureType: TextureType = 'TEXTURE_2D'

纹理类型

type

type: TextureDataType = 'UNSIGNED_BYTE'

数据类型

`Static` default

default: Texture2D<Texture2DEventMap>

默认贴图

`Static` defaultNormal

defaultNormal: Texture2D<Texture2DEventMap>

默认法线贴图

`Static` defaultParticle

defaultParticle: Texture2D<Texture2DEventMap>

默认粒子贴图

`Static` white

white: Texture2D<Texture2DEventMap>

默认贴图

Accessors

activePixels

get activePixels(): TexImageSource | TexImageSource[]
当前使用的贴图数据

Returns TexImageSource | TexImageSource[]
Inherited from Texture2D.activePixels
- Defined in src/renderer/data/Texture.ts:174

dataURL

get dataURL(): string
Returns string
Inherited from Texture2D.dataURL
- Defined in src/textures/TextureInfo.ts:50

image

get image(): HTMLImageElement
Returns HTMLImageElement
Inherited from Texture2D.image
- Defined in src/textures/Texture2D.ts:87

isLoaded

get isLoaded(): boolean
是否已加载

Returns boolean
Inherited from Texture2D.isLoaded
- Defined in src/textures/Texture2D.ts:84

isPowerOfTwo

get isPowerOfTwo(): boolean
是否为2的幂贴图

Returns boolean
Inherited from Texture2D.isPowerOfTwo
- Defined in src/renderer/data/Texture.ts:224

source

get source(): {
url: string;
}
用于表示初始化纹理的数据来源

Returns {
url: string;
}
- url: string
Inherited from Texture2D.source
- Defined in src/textures/Texture2D.ts:95
set source(v: {
url: string;
}): void
Parameters
- v: {
  url: string;
  }
  - url: string
Returns void
Inherited from Texture2D.source
- Defined in src/textures/Texture2D.ts:100

wrapS

get wrapS(): TextureWrap
表示x轴的纹理的回环方式，就是当纹理的宽度小于需要贴图的平面的宽度的时候，平面剩下的部分应该p以何种方式贴图的问题。

Returns TextureWrap
Inherited from Texture2D.wrapS
- Defined in src/renderer/data/Texture.ts:122
set wrapS(v: TextureWrap): void
Parameters
- v: TextureWrap
Returns void
Inherited from Texture2D.wrapS
- Defined in src/renderer/data/Texture.ts:133

wrapT

get wrapT(): TextureWrap
表示y轴的纹理回环方式。 magFilter和minFilter表示过滤的方式。

Returns TextureWrap
Inherited from Texture2D.wrapT
- Defined in src/renderer/data/Texture.ts:142
set wrapT(v: TextureWrap): void
Parameters
- v: TextureWrap
Returns void
Inherited from Texture2D.wrapT
- Defined in src/renderer/data/Texture.ts:153

Methods

`Private` _canvasChanged

_canvasChanged(): void
Returns void
- Defined in src/textures/CanvasTexture2D.ts:14

broadcast

broadcast<K>(type: K, data?: Texture2DEventMap[K]): IEvent<Texture2DEventMap[K]>
将事件广播到下级对象中。

Returns
返回广播后的事件。
Type Parameters
- K extends "loadCompleted"
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: Texture2DEventMap[K]
  
  事件携带的自定义数据。
Returns IEvent<Texture2DEventMap[K]>
Inherited from Texture2D.broadcast
- Defined in src/event/EventEmitter.ts:176

bubbles

bubbles<K>(type: K, data?: Texture2DEventMap[K]): IEvent<Texture2DEventMap[K]>
将事件冒泡到上级对象中。

Returns
返回冒泡后的事件。
Type Parameters
- K extends "loadCompleted"
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: Texture2DEventMap[K]
  
  事件携带的自定义数据。
Returns IEvent<Texture2DEventMap[K]>
Inherited from Texture2D.bubbles
- Defined in src/event/EventEmitter.ts:189

dispose

dispose(): void
销毁

Returns void
Inherited from Texture2D.dispose
- Defined in src/event/EventEmitter.ts:535

emit

emit<K>(type: K, data?: Texture2DEventMap[K], bubbles?: boolean, broadcast?: boolean, share?: boolean): IEvent<Texture2DEventMap[K]>
发射事件。

Returns
返回发射后的事件。
Type Parameters
- K extends "loadCompleted"
Parameters
- type: K
  
  事件的类型。类型区分大小写。
- Optional data: Texture2DEventMap[K]
  
  事件携带的自定义数据。
- bubbles: boolean = false
  
  是否向上级报告事件。默认为false。
- broadcast: boolean = false
  
  是否向下级广播事件。默认为false。
- share: boolean = true
  
  是否向平级分享事件。默认为true。
Returns IEvent<Texture2DEventMap[K]>
Inherited from Texture2D.emit
- Defined in src/event/EventEmitter.ts:145

emitEvent

emitEvent<K>(event: IEvent<Texture2DEventMap[K]>): IEvent<Texture2DEventMap[K]>
发射事件。

当事件重复流向一个对象时将不会被处理。

Returns
返回事件是否被处理
Type Parameters
- K extends "loadCompleted"
Parameters
- event: IEvent<Texture2DEventMap[K]>
  
  事件对象
Returns IEvent<Texture2DEventMap[K]>
Inherited from Texture2D.emitEvent
- Defined in src/event/EventEmitter.ts:110

eventNames

eventNames<K>(): K[]
返回监听的事件类型列表。
Type Parameters
- K extends "loadCompleted"
Returns K[]
Inherited from Texture2D.eventNames
- Defined in src/event/EventEmitter.ts:70

getSize

getSize(): {
x: number;
y: number;
}
纹理尺寸

Returns {
x: number;
y: number;
}
- x: number
- y: number
Inherited from Texture2D.getSize
- Defined in src/textures/TextureInfo.ts:23

`Protected` handelEventBroadcast

handelEventBroadcast<K>(event: IEvent<Texture2DEventMap[K]>): void
向下级广播事件
Type Parameters
- K extends "loadCompleted"
Parameters
- event: IEvent<Texture2DEventMap[K]>
  
  事件
Returns void
Inherited from Texture2D.handelEventBroadcast
- Defined in src/event/EventEmitter.ts:506

`Protected` handelEventBubbles

handelEventBubbles<K>(event: IEvent<Texture2DEventMap[K]>): void
向上级报告事件
Type Parameters
- K extends "loadCompleted"
Parameters
- event: IEvent<Texture2DEventMap[K]>
  
  事件
Returns void
Inherited from Texture2D.handelEventBubbles
- Defined in src/event/EventEmitter.ts:475

`Protected` handelEventShare

handelEventShare<K>(event: IEvent<Texture2DEventMap[K]>): void
向平级分享事件
Type Parameters
- K extends "loadCompleted"
Parameters
- event: IEvent<Texture2DEventMap[K]>
  
  事件
Returns void
Inherited from Texture2D.handelEventShare
- Defined in src/event/EventEmitter.ts:451

`Protected` handleEvent

handleEvent<K>(e: IEvent<Texture2DEventMap[K]>): void
处理事件
Type Parameters
- K extends "loadCompleted"
Parameters
- e: IEvent<Texture2DEventMap[K]>
  
  事件
Returns void
Inherited from Texture2D.handleEvent
- Defined in src/event/EventEmitter.ts:389

has

has<K>(type: K): boolean
检查 Event 对象是否为特定事件类型注册了任何侦听器.

Returns
如果指定类型的侦听器已注册，则值为 true；否则，值为 false。
Type Parameters
- K extends "loadCompleted"
Parameters
- type: K
  
  事件的类型。
Returns boolean
Inherited from Texture2D.has
- Defined in src/event/EventEmitter.ts:200

invalidate

invalidate(): void
使纹理失效

Returns void
Inherited from Texture2D.invalidate
- Defined in src/renderer/data/Texture.ts:216

listenerCount

listenerCount<K>(type: K): number
返回指定事件类型的监听数量。
Type Parameters
- K extends "loadCompleted"
Parameters
- type: K
  
  事件的类型。
Returns number
Inherited from Texture2D.listenerCount
- Defined in src/event/EventEmitter.ts:82

off

off<K>(type?: K, listener?: ((event: IEvent<Texture2DEventMap[K]>) => void), thisObject?: any): CanvasTexture2D
移除监听
Type Parameters
- K extends "loadCompleted"
Parameters
- Optional type: K
  
  事件的类型。可选。该值为空时所有被监听对象上的监听均将被移除。
- Optional listener: ((event: IEvent<Texture2DEventMap[K]>) => void)
  
  要删除的监听器对象。可选。该值为空时所有指定类型的监听均将被移除。
  - - (event: IEvent<Texture2DEventMap[K]>): void
    - Parameters
      
      event: IEvent<Texture2DEventMap[K]>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
Returns CanvasTexture2D
Inherited from Texture2D.off
- Defined in src/event/EventEmitter.ts:253

offAll

offAll<K>(type?: K): CanvasTexture2D
移除所有监听
Type Parameters
- K extends "loadCompleted"
Parameters
- Optional type: K
  
  事件的类型。可选。该值为空时所有被监听对象上的监听均将被移除。
Returns CanvasTexture2D
Inherited from Texture2D.offAll
- Defined in src/event/EventEmitter.ts:303

offAny

offAny<K>(listener?: ((event: IEvent<Texture2DEventMap[K]>) => void), thisObject?: any): CanvasTexture2D
移除监听对象的任意事件。
Type Parameters
- K extends "loadCompleted"
Parameters
- Optional listener: ((event: IEvent<Texture2DEventMap[K]>) => void)
  
  处理事件的监听器函数。
  - - (event: IEvent<Texture2DEventMap[K]>): void
    - Parameters
      
      event: IEvent<Texture2DEventMap[K]>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
Returns CanvasTexture2D
Inherited from Texture2D.offAny
- Defined in src/event/EventEmitter.ts:353

on

on<K>(type: K, listener: ((event: IEvent<Texture2DEventMap[K]>) => void), thisObject?: any, priority?: number, once?: boolean): CanvasTexture2D
为监听对象新增指定类型的事件监听。
Type Parameters
- K extends "loadCompleted"
Parameters
- type: K
  
  事件的类型。
- listener: ((event: IEvent<Texture2DEventMap[K]>) => void)
  
  处理事件的监听器函数。
  - - (event: IEvent<Texture2DEventMap[K]>): void
    - Parameters
      
      event: IEvent<Texture2DEventMap[K]>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
- priority: number = 0
  
  事件监听器的优先级。数字越大，优先级越高。默认为0。
- once: boolean = false
  
  值为true时在监听一次事件后该监听器将被移除。默认为false。
Returns CanvasTexture2D
Inherited from Texture2D.on
- Defined in src/event/EventEmitter.ts:214

onAny

onAny<K>(listener: ((event: IEvent<Texture2DEventMap[K]>) => void), thisObject?: any, priority?: number, once?: boolean): CanvasTexture2D
监听对象的任意事件，该对象的任意事件都将触发该监听器的调用。
Type Parameters
- K extends "loadCompleted"
Parameters
- listener: ((event: IEvent<Texture2DEventMap[K]>) => void)
  
  处理事件的监听器函数。
  - - (event: IEvent<Texture2DEventMap[K]>): void
    - Parameters
      
      event: IEvent<Texture2DEventMap[K]>
      
      Returns void
- Optional thisObject: any
  
  监听器的上下文。可选。
- priority: number = 0
  
  事件监听器的优先级。数字越大，优先级越高。默认为0。
- once: boolean = false
  
  值为true时在监听一次事件后该监听器将被移除。默认为false。
Returns CanvasTexture2D
Inherited from Texture2D.onAny
- Defined in src/event/EventEmitter.ts:318

onLoadCompleted

onLoadCompleted(): Promise<void>
已加载完成或者加载完成时立即调用

Returns Promise<void>
Inherited from Texture2D.onLoadCompleted
- Defined in src/textures/Texture2D.ts:142

once

once<K>(type: K, listener: ((event: IEvent<Texture2DEventMap[K]>) => void), thisObject?: any, priority?: number): CanvasTexture2D
监听一次事件后将会被移除
Type Parameters
- K extends "loadCompleted"
Parameters
- type: K
  
  事件的类型。
- listener: ((event: IEvent<Texture2DEventMap[K]>) => void)
  
  处理事件的侦听器函数。
  - - (event: IEvent<Texture2DEventMap[K]>): void
    - Parameters
      
      event: IEvent<Texture2DEventMap[K]>
      
      Returns void
- Optional thisObject: any
  
  listener函数作用域
- priority: number = 0
  
  事件侦听器的优先级。数字越大，优先级越高。默认优先级为 0。
Returns CanvasTexture2D
Inherited from Texture2D.once
- Defined in src/event/EventEmitter.ts:95

`Protected` updateActivePixels

updateActivePixels(): void
Returns void
Inherited from Texture2D.updateActivePixels
- Defined in src/textures/TextureInfo.ts:73

`Static` create

create<K>(geometry: K, params?: gPartial<TextureMap[K]>): TextureMap[K]
构造纹理。

Returns
纹理实例。
Type Parameters
- K extends keyof TextureMap
Parameters
- geometry: K
  
  纹理类名称。
- Optional params: gPartial<TextureMap[K]>
  
  纹理参数。
Returns TextureMap[K]
Inherited from Texture2D.create
- Defined in src/renderer/data/Texture.ts:50

`Static` fromUrl

fromUrl(url: string): Texture2D<Texture2DEventMap>
从url初始化纹理
Parameters
- url: string
  
  路径
Returns Texture2D<Texture2DEventMap>
Inherited from Texture2D.fromUrl
- Defined in src/textures/Texture2D.ts:181

`Static` getEventEmitter

getEventEmitter(target: any): EventEmitter<any>
获取事件发射器
Parameters
- target: any
Returns EventEmitter<any>
Inherited from Texture2D.getEventEmitter
- Defined in src/event/EventEmitter.ts:29

`Static` getOrCreateEventEmitter

getOrCreateEventEmitter(target: any): EventEmitter<any>
获取事件发射器，当没有找到对应发射器时，返回新建的事件发射器。
Parameters
- target: any
Returns EventEmitter<any>
Inherited from Texture2D.getOrCreateEventEmitter
- Defined in src/event/EventEmitter.ts:44

Class CanvasTexture2D

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns CanvasTexture2D

Properties

OFFSCREEN_HEIGHT

OFFSCREEN_WIDTH

__class__

Protected _activePixels

Protected _dataURL

Protected _pixels

anisotropy

assetType

canvas

flipY

format

generateMipmap

hideFlags

invalid

isRenderTarget

magFilter

minFilter

name

noPixels

premulAlpha

textureType

type

Static default

Static defaultNormal

Static defaultParticle

Static white

Accessors

activePixels

Returns TexImageSource | TexImageSource[]

dataURL

Returns string

image

Returns HTMLImageElement

isLoaded

Returns boolean

isPowerOfTwo

Returns boolean

source

Returns { url: string; }

url: string

Parameters

v: { url: string; }

url: string

Returns void

wrapS

Returns TextureWrap

Parameters

v: TextureWrap

Returns void

wrapT

Returns TextureWrap

Parameters

v: TextureWrap

Returns void

Methods

Private _canvasChanged

Returns void

broadcast

Returns

Type Parameters

K extends "loadCompleted"

Parameters

type: K

Optional data: Texture2DEventMap[K]

Returns IEvent<Texture2DEventMap[K]>

bubbles

Returns

Type Parameters

K extends "loadCompleted"

class

`Protected` _activePixels

`Protected` _dataURL

`Protected` _pixels

`Static` default

`Static` defaultNormal

`Static` defaultParticle

`Static` white

Returns {
url: string;
}

v: {
url: string;
}

`Private` _canvasChanged

`Optional` data: Texture2DEventMap[K]

`Optional` data: Texture2DEventMap[K]

`Optional` data: Texture2DEventMap[K]

Returns {
x: number;
y: number;
}

`Protected` handelEventBroadcast

`Protected` handelEventBubbles

`Protected` handelEventShare

`Protected` handleEvent