UICanvas | 小游戏框架

Hierarchy

MeshRenderer
- UICanvas

Index

Constructors

constructor

Events

onDeserialized

Properties

Constructors

constructor

new UICanvas(entity: Entity & { transform: Transform3D } & { transform2D: Transform2D }): UICanvas

Overrides MeshRenderer.constructor
- Defined in src/engine/game/2D/UICanvas.ts:108
请使用entity.addComponent(engine.MeshRenderer)来创建

Parameters
- entity: Entity & { transform: Transform3D } & { transform2D: Transform2D }
Returns UICanvas

Events

onDeserialized

onDeserialized(data: any, context: any, builtContext: any): void

Inherited from MeshRenderer.onDeserialized
- Defined in src/engine/game/3D/meshRenderer.ts:596
Parameters
- data: any
- context: any
- builtContext: any
Returns void

Properties

Readonly entity

entity: Entity & { transform: Transform3D } & { transform2D: Transform2D }

Readonly forceTouchEndExceptEvent

forceTouchEndExceptEvent: Emitter<TouchEvent, TouchInputComponent> = ...

Readonly id

id: number = ...

Readonly interactiveDirtyEvent

interactiveDirtyEvent: Emitter<void, void> = ...

Readonly isDestroyed

isDestroyed: boolean = false

Readonly isDestroying

isDestroying: boolean = false

Readonly priority

priority: number = ...

Readonly treeChangeEvent

treeChangeEvent: Emitter<UILayerChangeType, Entity2D> = ...

Readonly treeDirtyEvent

treeDirtyEvent: Emitter<void, void> = ...

Static Readonly AdaptationType

AdaptationType: Readonly<typeof UIAdaptationType> = ...

Static Priority

Priority: { Align: number; Layout: number; Low: number; Physics: number; Render: number; Tool: number } = ...

Type declaration

Align: number
Layout: number
Low: number
Physics: number
Render: number
Tool: number

Static Optional Serialize

Serialize: (...args: any[]) => any

Type declaration

- (...args: any[]): any
- Parameters
  - Rest ...args: any[]
  Returns any

Accessors

UITreeRoot

get UITreeRoot(): Transform2D

- Defined in src/engine/game/2D/UICanvas.ts:90
deprecated

Returns Transform2D

active

get active(): boolean
set active(value: boolean): void

- Defined in src/engine/game/component.ts:57
Returns boolean
- Defined in src/engine/game/component.ts:60
Parameters
- value: boolean
Returns void

activeInHierarchy

get activeInHierarchy(): boolean

- Defined in src/engine/game/component.ts:79
在场景树中是否active

readonly

memberof

Component

Returns boolean

adaptationType

get adaptationType(): UIAdaptationType
set adaptationType(val: UIAdaptationType): void

- Defined in src/engine/game/2D/UICanvas.ts:43
正交模式，屏幕适配的模式

Returns UIAdaptationType
- Defined in src/engine/game/2D/UICanvas.ts:46
正交模式，屏幕适配的模式

Parameters
- val: UIAdaptationType
Returns void

castShadow

get castShadow(): boolean
set castShadow(s: boolean): void

- Defined in src/engine/game/3D/meshRenderer.ts:249
是否投射阴影

Returns boolean
- Defined in src/engine/game/3D/meshRenderer.ts:252
是否投射阴影

Parameters
- s: boolean
Returns void

cullingMask

get cullingMask(): number
set cullingMask(value: number): void

- Defined in src/engine/game/3D/meshRenderer.ts:278
剔除掩码，由entity的layer计算得出。
剔除时将使用该值与Camera的cullingMask做按位与，有值时才渲染。

Returns number
- Defined in src/engine/game/3D/meshRenderer.ts:285
剔除掩码，由entity的layer计算得出。
剔除时将使用该值与Camera的cullingMask做按位与，有值时才渲染。

deprecated

Parameters
- value: number
Returns void

designResolution

get designResolution(): Vector2
set designResolution(designSize: Vector2): void

- Defined in src/engine/game/2D/UICanvas.ts:57
Returns Vector2
- Defined in src/engine/game/2D/UICanvas.ts:60
Parameters
- designSize: Vector2
Returns void

deviceResolution

get deviceResolution(): Vector2
set deviceResolution(resolution: Vector2): void

- Defined in src/engine/game/2D/UICanvas.ts:68
Returns Vector2
- Defined in src/engine/game/2D/UICanvas.ts:71
Parameters
- resolution: Vector2
Returns void

dynamicBatch

get dynamicBatch(): boolean
set dynamicBatch(val: boolean): void

- Defined in src/engine/game/3D/meshRenderer.ts:317
是否开启3D Batch。

Returns boolean
- Defined in src/engine/game/3D/meshRenderer.ts:320
是否开启3D Batch。

Parameters
- val: boolean
Returns void

lastFrameVisible

get lastFrameVisible(): boolean

- Defined in src/engine/game/3D/meshRenderer.ts:138
上一帧是否被任意相机渲染。

Returns boolean

lightMapIndex

get lightMapIndex(): number
set lightMapIndex(s: number): void

- Defined in src/engine/game/3D/meshRenderer.ts:298
光照贴图索引。

Returns number
- Defined in src/engine/game/3D/meshRenderer.ts:301
光照贴图索引。

Parameters
- s: number
Returns void

lightMapScaleOffset

get lightMapScaleOffset(): Vector4
set lightMapScaleOffset(l: Vector4): void

- Defined in src/engine/game/3D/meshRenderer.ts:225
光照贴图的scaleOffset
暂时不支持 meshRenderer.lightMapScaleOffset.x = 1这种写法

Returns Vector4
- Defined in src/engine/game/3D/meshRenderer.ts:228
光照贴图的scaleOffset
暂时不支持 meshRenderer.lightMapScaleOffset.x = 1这种写法

Parameters
- l: Vector4
Returns void

lightsFA

get lightsFA(): default[]

- Defined in src/engine/game/3D/meshRenderer.ts:329
Returns default[]

material

get material(): Material
set material(material: Material): void

- Defined in src/engine/game/3D/meshRenderer.ts:469
主材质。

Returns Material
- Defined in src/engine/game/3D/meshRenderer.ts:473
主材质。

Parameters
- material: Material
Returns void

materialCount

get materialCount(): number

- Defined in src/engine/game/3D/meshRenderer.ts:455
获取当前材质数量。

Returns number

mesh

get mesh(): Mesh
set mesh(val: Mesh): void

- Defined in src/engine/game/3D/meshRenderer.ts:157
设置该MeshRenderer渲染的Mesh。

Returns Mesh
- Defined in src/engine/game/3D/meshRenderer.ts:160
设置该MeshRenderer渲染的Mesh。

Parameters
- val: Mesh
Returns void

receiveShadow

get receiveShadow(): boolean
set receiveShadow(s: boolean): void

- Defined in src/engine/game/3D/meshRenderer.ts:266
是否接收阴影

Returns boolean
- Defined in src/engine/game/3D/meshRenderer.ts:269
是否接收阴影

Parameters
- s: boolean
Returns void

resolution

get resolution(): DeepImmutableObject<Vector2>

- Defined in src/engine/game/2D/UICanvas.ts:82
duplicate

Returns DeepImmutableObject<Vector2>

sharedMaterial

get sharedMaterial(): Material

- Defined in src/engine/game/3D/meshRenderer.ts:462
获取共享主材质。

Returns Material

worldBoundBall

get worldBoundBall(): BoundBall

- Defined in src/engine/game/3D/meshRenderer.ts:174
世界坐标系下的包围球。

Returns BoundBall

Methods

addAffectLight

addAffectLight(light: default): void

Inherited from MeshRenderer.addAffectLight
- Defined in src/engine/game/3D/meshRenderer.ts:337
Parameters
- light: default
Returns void

addMaterial

addMaterial(material: Material): void

Inherited from MeshRenderer.addMaterial
- Defined in src/engine/game/3D/meshRenderer.ts:554
增加材质。

Parameters
- material: Material
Returns void

addToRenderList

addToRenderList(list: Uint32Array, index: number): void

Inherited from MeshRenderer.addToRenderList
- Defined in src/engine/game/3D/meshRenderer.ts:591
Parameters
- list: Uint32Array
- index: number
Returns void

addUILayerRoot

addUILayerRoot(rootEntity: Entity2D): void

- Defined in src/engine/game/2D/UICanvas.ts:155
Parameters
- rootEntity: Entity2D
Returns void

destroy

destroy(): void

Inherited from MeshRenderer.destroy
- Defined in src/engine/game/component.ts:133
Returns void

getMaterialAtIndex

getMaterialAtIndex(index: number): Material

Inherited from MeshRenderer.getMaterialAtIndex
- Defined in src/engine/game/3D/meshRenderer.ts:534
获取第index位材质，当第一次获取成功时，该材质会被拷贝，并将替换材质。

Parameters
- index: number
Returns Material

getShaderDef

getShaderDef(marcos: {}): string | number

- Defined in src/engine/game/2D/UICanvas.ts:174
Parameters
- marcos: {}
  - [name: string]: string | number | boolean
Returns string | number

getSharedMaterialAtIndex

getSharedMaterialAtIndex(index: number): Material

Inherited from MeshRenderer.getSharedMaterialAtIndex
- Defined in src/engine/game/3D/meshRenderer.ts:547
获取第index位材质的sharedMaterial，此操作不会进行材质拷贝。

Parameters
- index: number
Returns Material

getTypeName

getTypeName(): string

Inherited from MeshRenderer.getTypeName
- Defined in src/engine/game/component.ts:129
Returns string

isDetached

isDetached(): boolean

Inherited from MeshRenderer.isDetached
- Defined in src/engine/game/component.ts:145
Returns boolean

markInteractiveDirty

markInteractiveDirty(): void

- Defined in src/engine/game/2D/UICanvas.ts:170
Returns void

markLayerRootDirtyByTransform2D

markLayerRootDirtyByTransform2D(transform2D: Transform2D): void

- Defined in src/engine/game/2D/UICanvas.ts:144
Parameters
- transform2D: Transform2D
Returns void

markTreeDirty

markTreeDirty(): void

- Defined in src/engine/game/2D/UICanvas.ts:140
Returns void

markUILayerRootDirty

markUILayerRootDirty(rootEntity: Entity2D): void

- Defined in src/engine/game/2D/UICanvas.ts:164
Parameters
- rootEntity: Entity2D
Returns void

markUILayerRootVisbleDirty

markUILayerRootVisbleDirty(rootEntity: Entity2D): void

- Defined in src/engine/game/2D/UICanvas.ts:167
Parameters
- rootEntity: Entity2D
Returns void

minimizeMaterialsToShortest

minimizeMaterialsToShortest(): void

Inherited from MeshRenderer.minimizeMaterialsToShortest
- Defined in src/engine/game/3D/meshRenderer.ts:579
Returns void

refreshAffectLight

refreshAffectLight(): void

Inherited from MeshRenderer.refreshAffectLight
- Defined in src/engine/game/3D/meshRenderer.ts:371
Returns void

refreshLightsUniformFA

refreshLightsUniformFA(): void

Inherited from MeshRenderer.refreshLightsUniformFA
- Defined in src/engine/game/3D/meshRenderer.ts:388
Returns void

refreshUILayerRoot

refreshUILayerRoot(rootEntity: Entity2D): void

- Defined in src/engine/game/2D/UICanvas.ts:161
Parameters
- rootEntity: Entity2D
Returns void

removeAffectLight

removeAffectLight(light: default): void

Inherited from MeshRenderer.removeAffectLight
- Defined in src/engine/game/3D/meshRenderer.ts:352
Parameters
- light: default
Returns void

removeUILayerRoot

removeUILayerRoot(rootEntity: Entity2D): void

- Defined in src/engine/game/2D/UICanvas.ts:158
Parameters
- rootEntity: Entity2D
Returns void

resetProperties

resetProperties(): void

Inherited from MeshRenderer.resetProperties
- Defined in src/engine/game/component.ts:169
Returns void

setLightsUniformDirty

setLightsUniformDirty(): void

Inherited from MeshRenderer.setLightsUniformDirty
- Defined in src/engine/game/3D/meshRenderer.ts:363
Returns void

setMaterialAtIndex

setMaterialAtIndex(material: Material, index: number): void

Inherited from MeshRenderer.setMaterialAtIndex
- Defined in src/engine/game/3D/meshRenderer.ts:561
设置第n个位置的材质。

Parameters
- material: Material
- index: number
Returns void

Hierarchy

Index

Constructors

Events

Properties

Accessors

Methods

Constructors

constructor

Parameters

entity: Entity & { transform: Transform3D } & { transform2D: Transform2D }

Returns UICanvas

Events

onDeserialized

Parameters

data: any

context: any

builtContext: any

Returns void

Properties

Readonly entity

Readonly forceTouchEndExceptEvent

Readonly id

Readonly interactiveDirtyEvent

Readonly isDestroyed

Readonly isDestroying

Readonly priority

Readonly treeChangeEvent

Readonly treeDirtyEvent

Static Readonly AdaptationType

Static Priority

Type declaration

Align: number

Layout: number

Low: number

Physics: number

Render: number

Tool: number

Static Optional Serialize

Type declaration

Parameters

Rest ...args: any[]

Returns any

Accessors

UITreeRoot

Returns Transform2D

active

Returns boolean

Parameters

value: boolean

Returns void

activeInHierarchy

Returns boolean

adaptationType

Returns UIAdaptationType

Parameters

val: UIAdaptationType

Returns void

castShadow

Returns boolean

Parameters

s: boolean

Returns void

cullingMask

Returns number

Parameters

value: number

Returns void

designResolution

Returns Vector2

Parameters

designSize: Vector2

Returns void

deviceResolution

Returns Vector2

Parameters

resolution: Vector2

Returns void

dynamicBatch

Returns boolean