Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Canvas2D

Hierarchy

Index

Constructors

Events

Properties

Accessors

Methods

Constructors

constructor

Events

onDeserialized

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

  • Parameters

    • data: any
    • context: any
    • builtContext: any

    Returns void

Properties

Readonly entity

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

Readonly id

id: number = ...

Readonly isDestroyed

isDestroyed: boolean = false

Readonly isDestroying

isDestroying: boolean = false

Readonly priority

priority: number = ...

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 RenderMode

RenderMode: Readonly<typeof EnumRendererMode> = ...

图片填充方式枚举值。

static
memberof

UISprite

Static Optional Serialize

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

Type declaration

    • (...args: any[]): any

    • Parameters

      • Rest ...args: any[]

      Returns any

Accessors

active

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

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

activeInHierarchy

  • get activeInHierarchy(): boolean

  • 在场景树中是否active

    readonly
    memberof

    Component

    Returns boolean

castShadow

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

  • 是否投射阴影

    Returns boolean

  • 是否投射阴影

    Parameters

    • s: boolean

    Returns void

cullingMask

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

  • 剔除掩码，由entity的layer计算得出。
    剔除时将使用该值与Camera的cullingMask做按位与，有值时才渲染。

    Returns number

  • 剔除掩码，由entity的layer计算得出。
    剔除时将使用该值与Camera的cullingMask做按位与，有值时才渲染。

    deprecated

    Parameters

    • value: number

    Returns void

dynamicBatch

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

  • 是否开启3D Batch。

    Returns boolean

  • 是否开启3D Batch。

    Parameters

    • val: boolean

    Returns void

lastFrameVisible

  • get lastFrameVisible(): boolean

  • 上一帧是否被任意相机渲染。

    Returns boolean

lightMapIndex

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

  • 光照贴图索引。

    Returns number

  • 光照贴图索引。

    Parameters

    • s: number

    Returns void

lightMapScaleOffset

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

  • 光照贴图的scaleOffset
    暂时不支持 meshRenderer.lightMapScaleOffset.x = 1这种写法

    Returns Vector4

  • 光照贴图的scaleOffset
    暂时不支持 meshRenderer.lightMapScaleOffset.x = 1这种写法

    Parameters

    Returns void

lightsFA

  • get lightsFA(): default[]

  • Returns default[]

material

  • 主材质。

    Returns Material

  • 主材质。

    Parameters

    Returns void

materialCount

  • get materialCount(): number

  • 获取当前材质数量。

    Returns number

mesh

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

  • 设置该MeshRenderer渲染的Mesh。

    Returns Mesh

  • 设置该MeshRenderer渲染的Mesh。

    Parameters

    Returns void

proportionalScale

  • get proportionalScale(): number
  • set proportionalScale(proportionalScale: number): void

  • Canvas的是否使用subMesh渲染

    memberof

    Canvas2D

    Returns number

  • Canvas的是否使用subMesh渲染

    Parameters

    • proportionalScale: number

    Returns void

receiveShadow

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

  • 是否接收阴影

    Returns boolean

  • 是否接收阴影

    Parameters

    • s: boolean

    Returns void

renderMode

  • get renderMode(): EnumRendererMode
  • set renderMode(renderMode: EnumRendererMode): void

  • billBoard类型

    memberof

    Canvas2D

    Returns EnumRendererMode

  • billBoard类型

    Parameters

    • renderMode: EnumRendererMode

    Returns void

sharedMaterial

  • 获取共享主材质。

    Returns Material

useSubMesh

  • get useSubMesh(): boolean
  • set useSubMesh(useSubMesh: boolean): void

  • Canvas的是否使用subMesh渲染

    memberof

    Canvas2D

    Returns boolean

  • Canvas的是否使用subMesh渲染

    Parameters

    • useSubMesh: boolean

    Returns void

worldBoundBall

  • 世界坐标系下的包围球。

    Returns BoundBall

Methods

addAffectLight

  • addAffectLight(light: default): void

  • Parameters

    • light: default

    Returns void

addMaterial

addToRenderList

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

  • Parameters

    • list: Uint32Array
    • index: number

    Returns void

destroy

  • destroy(): void

getMaterialAtIndex

  • getMaterialAtIndex(index: number): Material

  • 获取第index位材质，当第一次获取成功时，该材质会被拷贝，并将替换材质。

    Parameters

    • index: number

    Returns Material

getSharedMaterialAtIndex

  • getSharedMaterialAtIndex(index: number): Material

  • 获取第index位材质的sharedMaterial，此操作不会进行材质拷贝。

    Parameters

    • index: number

    Returns Material

getTypeName

  • getTypeName(): string

isDetached

  • isDetached(): boolean

markSubMatrixDirty

  • markSubMatrixDirty(): void

  • Returns void

markTreeDirty

  • markTreeDirty(): void

  • Returns void

minimizeMaterialsToShortest

  • minimizeMaterialsToShortest(): void

refreshAffectLight

  • refreshAffectLight(): void

refreshLightsUniformFA

  • refreshLightsUniformFA(): void

removeAffectLight

  • removeAffectLight(light: default): void

resetProperties

  • resetProperties(): void

setLightsUniformDirty

  • setLightsUniformDirty(): void

setMaterialAtIndex

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

Generated using TypeDoc