Material 类型

继承于 Asset

模块: cc 父模块: cc

材质资源类。

索引

属性（properties）

• url String cc.Asset.url is deprecated, please use nativeUrl instead
• _uuid String
• loaded Boolean 该资源是否已经成功加载。
• nativeUrl String 返回该资源对应的目标平台资源的 URL，如果没有将返回一个空字符串。
• refCount Number 引用的数量
• _native String 保存原生资源的 URL。
• _nativeAsset Object 此资源依赖的底层原生资源（如果有的话）。
• _name String
• _objFlags Number
• name String 该对象的名称。
• isValid Boolean 表示该对象是否可用（被 destroy 后将不可用）。

方法

• getBuiltinMaterial 获取内置材质
• createWithBuiltin 使用内建 Effect 创建一个材质。
• create 创建一个材质。
• setProperty 设置材质的属性
• getProperty 获取材质的属性。
• define 设置材质的宏定义。
• getDefine 获取材质的宏定义。
• setCullMode 设置材质的裁减模式。
• setDepth 设置材质的深度渲染状态。
• setBlend 设置材质的混合渲染状态。
• setStencilEnabled 设置是否开启模板测试。
• setStencil 设置材质的模板测试渲染参数。
• toString 返回资源的 URL。
• serialize 应 AssetDB 要求提供这个方法。
• createNode 使用该资源在场景中创建一个新节点。
• _setRawAsset 为此资源设置原生文件名。
• addRef 增加资源的引用
• decRef 减少资源的引用并尝试进行自动释放。
• destroy 销毁该对象，并释放所有它对其它对象的引用。
• _destruct 清除实例中的所有引用。
• _onPreDestroy 在对象被销毁之前调用。
• _serialize 为此对象定制序列化。
• _deserialize 从自定义序列化数据初始化此对象。

Details

属性（properties）

url

cc.Asset.url is deprecated, please use nativeUrl instead

_uuid

loaded

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

nativeUrl

返回该资源对应的目标平台资源的 URL，如果没有将返回一个空字符串。

refCount

引用的数量

_native

保存原生资源的 URL。

_nativeAsset

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

_name

_objFlags

name

该对象的名称。

示例

obj.name = "New Obj";

isValid

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

示例

var node = new cc.Node();
cc.log(node.isValid);    // true
node.destroy();
cc.log(node.isValid);    // true, still valid in this frame
// after a frame...
cc.log(node.isValid);    // false, destroyed in the end of last frame

方法

getBuiltinMaterial

获取内置材质

参数列表

• name string

createWithBuiltin

使用内建 Effect 创建一个材质。

参数列表

• effectName string
• techniqueIndex number

create

创建一个材质。

参数列表

• effectAsset EffectAsset
• techniqueIndex number

setProperty

设置材质的属性

参数列表

• name string
• val Object
• passIdx number
• directly boolean

getProperty

获取材质的属性。

参数列表

• name string
• passIdx number

define

设置材质的宏定义。

参数列表

• name string
• val boolean | number
• passIdx number
• force boolean

getDefine

获取材质的宏定义。

参数列表

• name string
• passIdx number

setCullMode

设置材质的裁减模式。

参数列表

• cullMode number
• passIdx number

setDepth

设置材质的深度渲染状态。

参数列表

• depthTest boolean
• depthWrite boolean
• depthFunc number
• passIdx number

setBlend

设置材质的混合渲染状态。

参数列表

• enabled boolean
• blendEq number
• blendSrc number
• blendDst number
• blendAlphaEq number
• blendSrcAlpha number
• blendDstAlpha number
• blendColor number
• passIdx number

setStencilEnabled

设置是否开启模板测试。

参数列表

• stencilTest number
• passIdx number

setStencil

设置材质的模板测试渲染参数。

参数列表

• stencilTest number
• stencilFunc number
• stencilRef number
• stencilMask number
• stencilFailOp number
• stencilZFailOp number
• stencilZPassOp number
• stencilWriteMask number
• passIdx number

toString

返回资源的 URL。

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

serialize

应 AssetDB 要求提供这个方法。

createNode

使用该资源在场景中创建一个新节点。
如果这类资源没有相应的节点类型，该方法应该是空的。

参数列表

• callback Function
  • error String null or the error info
  • node Object the created node or null

_setRawAsset

为此资源设置原生文件名。

参数列表

• filename String
• inLibrary Boolean

addRef

增加资源的引用

decRef

减少资源的引用并尝试进行自动释放。

destroy

销毁该对象，并释放所有它对其它对象的引用。
实际销毁操作会延迟到当前帧渲染前执行。从下一帧开始，该对象将不再可用。 您可以在访问对象之前使用 cc.isValid(obj) 来检查对象是否已被销毁。

示例

obj.destroy();

_destruct

清除实例中的所有引用。

注意：此方法不会清除在 CCObject 实例中定义的 getter 或 setter。如果需要，你可以重写 _destruct 方法。例如：

_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;
        }
    }
}

_onPreDestroy

在对象被销毁之前调用。

_serialize

为此对象定制序列化。

参数列表

• exporting Boolean

_deserialize

从自定义序列化数据初始化此对象。

参数列表

• data Object the serialized json data
• ctx _Deserializer