Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Material

材质资源类，包含模型绘制方式的全部细节描述。

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _defines

_defines: MacroRecord[] = []

Protected _effectAsset

_effectAsset: EffectAsset | null = null

Protected _hash

_hash: number = 0

Protected _name

_name: string

_native

_native: string = ""

用于本机资产的可序列化URL。供内部使用。

default

""

_objFlags

_objFlags: number

Protected _passes

_passes: Pass[] = []

Protected _props

_props: Record<string, MaterialPropertyFull | MaterialPropertyFull[]>[] = []

Protected _states

_states: PassOverrides[] = []

Protected _techIdx

_techIdx: number = 0

_uuid

_uuid: string

内部使用。

loaded

loaded: boolean = true

该资源是否已经成功加载。

Static preventDeferredLoadDependents

preventDeferredLoadDependents: boolean = false

当场景或 Prefab 被标记为 asyncLoadAssets，禁止延迟加载该资源所依赖的其它 RawAsset。

default

false

Static preventPreloadNativeObject

preventPreloadNativeObject: boolean = false

禁止预加载原生对象。

default

false

Accessors

Private nativeAsset

  • get nativeAsset(): any
  • set nativeAsset(obj: any): void

  • 此资源的基础资源（如果有）。 此属性可用于访问与资源相关的其他详细信息或功能。
    如果_native可用，则此属性将由加载器初始化。

    default

    null

    Returns any

  • 此资源的基础资源（如果有）。 此属性可用于访问与资源相关的其他详细信息或功能。
    如果_native可用，则此属性将由加载器初始化。

    default

    null

    Parameters

    • obj: any

    Returns void

effectAsset

effectName

  • get effectName(): string

hash

  • get hash(): number

isValid

  • get isValid(): boolean

  • 表示该对象是否可用（被 destroy 后将不可用）。
    当一个对象的 destroy 调用以后，会在这一帧结束后才真正销毁。
    因此从下一帧开始 isValid 就会返回 false，而当前帧内 isValid 仍然会是 true。
    如果希望判断当前帧是否调用过 destroy，请使用 isValid(obj, true)，不过这往往是特殊的业务需求引起的，通常情况下不需要这样。

    default

    true

    readonly
    example
    import { Node, log } from 'cc';
const node = new Node();
log(node.isValid);    // true
node.destroy();
log(node.isValid);    // true, still valid in this frame
// after a frame...
log(node.isValid);    // false, destroyed in the end of last frame

    Returns boolean

name

  • get name(): string
  • set name(value: string): void

nativeUrl

  • get nativeUrl(): string

owner

parent

passes

  • get passes(): Pass[]

technique

  • get technique(): number

Methods

Protected bindTexture

Protected createPasses

  • _createPasses(): Pass[]

destroyImmediate

  • _destroyImmediate(): void

destruct

  • _destruct(): void

  • Clear all references in the instance.

    NOTE: this method will not clear the getter or setter functions which defined in the instance of CCObject. You can override the _destruct method if you need, for example: _destruct: function () { for (var key in this) { if (this.hasOwnProperty(key)) { switch (typeof this[key]) { case 'string': this[key] = ''; break; case 'object': case 'function': this[key] = null; break; } } }

    Returns void

Protected doDestroy

  • _doDestroy(): void

Protected prepareInfo

  • prepareInfo(patch: object | object[], cur: object[]): void

Private setRawAsset

  • setRawAsset(filename: string, inLibrary?: boolean): void

Protected update

  • update(keepProps?: boolean): void

Protected uploadProperty

copy

Optional createNode

destroy

  • destroy(): boolean

emit

  • emit(type: EventType, arg0?: any, arg1?: any, arg2?: any, arg3?: any, arg4?: any): void

getProperty

hasEventListener

  • hasEventListener(type: string, callback?: Function, target?: undefined | object): boolean

  • 检查指定事件是否已注册回调。

    Parameters

    • type: string

      Event type.

    • Optional callback: Function

      Callback function when event triggered.

    • Optional target: undefined | object

      Callback callee.

    Returns boolean

initialize

off

  • 删除之前用同类型，回调，目标或 useCapture 注册的事件监听器，如果只传递 type，将会删除 type 类型的所有事件监听器。

    example

    import { log } from 'cc'; // register fire eventListener var callback = eventTarget.on('fire', function () { log("fire in the hole"); }, target); // remove fire event listener eventTarget.off('fire', callback, target); // remove all fire event listeners eventTarget.off('fire');

    Type parameters

    • TFunction: Function

    Parameters

    • type: EventType

      A string representing the event type being removed.

    • Optional callback: TFunction

      The callback to remove.

    • Optional thisArg: any

    Returns void

on

  • on<TFunction>(type: EventType, callback: TFunction, thisArg?: any, once?: undefined | false | true): typeof callback

  • 注册事件目标的特定事件类型回调。这种类型的事件应该被 emit 触发。

    example

    import { log } from 'cc'; eventTarget.on('fire', function () { log("fire in the hole"); }, node);

    Type parameters

    • TFunction: Function

    Parameters

    • type: EventType

      A string representing the event type to listen for.

    • callback: TFunction

      The callback that will be invoked when the event is dispatched. The callback is ignored if it is a duplicate (the callbacks are unique).

    • Optional thisArg: any

      The target (this object) to invoke the callback, can be null

    • Optional once: undefined | false | true

    Returns typeof callback

    • Just returns the incoming callback so you can save the anonymous function easier.

onLoaded

  • onLoaded(): void

once

  • once<TFunction>(type: EventType, callback: TFunction, thisArg?: any): typeof callback

  • 注册事件目标的特定事件类型回调，回调会在第一时间被触发后删除自身。

    example

    import { log } from 'cc'; eventTarget.once('fire', function () { log("this is the callback and will be invoked only once"); }, node);

    Type parameters

    • TFunction: Function

    Parameters

    • type: EventType

      A string representing the event type to listen for.

    • callback: TFunction

      The callback that will be invoked when the event is dispatched. The callback is ignored if it is a duplicate (the callbacks are unique).

    • Optional thisArg: any

    Returns typeof callback

overridePipelineStates

  • overridePipelineStates(overrides: PassOverrides, passIdx?: undefined | number): void

  • 使用指定管线状态重载当前的 pass（数组）。只允许对材质实例执行。

    Parameters

    • overrides: PassOverrides

      The pipeline state override values.

    • Optional passIdx: undefined | number

      The pass to apply to. Will apply to all passes if not specified.

    Returns void

recompileShaders

  • recompileShaders(overrides: MacroRecord, passIdx?: undefined | number): void

  • 使用指定预处理宏重新编译当前 pass（数组）中的 shader。只允许对材质实例执行。

    Parameters

    • overrides: MacroRecord

      The shader macro override values.

    • Optional passIdx: undefined | number

      The pass to apply to. Will apply to all passes if not specified.

    Returns void

removeAll

  • removeAll(typeOrTarget: string | object): void

  • 移除在特定事件类型中注册的所有回调或在某个目标中注册的所有回调。

    Parameters

    • typeOrTarget: string | object

      The event type or target with which the listeners will be removed

    Returns void

reset

resetUniforms

  • resetUniforms(clearPasses?: boolean): void

  • 重置材质的所有 uniform 参数数据为 EffectAsset 中的默认初始值。

    Parameters

    • Default value clearPasses: boolean = true

      Will the rendering data be cleared too?

    Returns void

Private serialize

  • serialize(): void

setProperty

targetOff

  • targetOff(typeOrTarget: string | object): void

  • 在当前 EventTarget 上删除指定目标（target 参数）注册的所有事件监听器。 这个函数无法删除当前 EventTarget 的所有事件监听器，也无法删除 target 参数所注册的所有事件监听器。 这个函数只能删除 target 参数在当前 EventTarget 上注册的所有事件监听器。

    Parameters

    • typeOrTarget: string | object

      The target to be searched for all related listeners

    Returns void

toString

  • toString(): string

  • 返回对象的字符串表示形式。
    Asset 对象将会重写 Object 对象的 toString() 方法。
    当资源要表示为文本值时或在字符串连接时引用时，
    JavaScript 会自动调用 toString() 方法。

    对于原始类型的资源，它将返回this.nativeUrl。
    否则，返回空字符串。
    子类可能会覆盖此方法。

    method

    toString

    Returns string

Static deferredDestroy

  • _deferredDestroy(): void

Static deserialize

  • deserialize(data: any): any

Static getHash

Static isRawAssetType

  • isRawAssetType(ctor: Function): boolean

Generated using TypeDoc