Material Class

Extends Asset

Module: cc Parent Module: cc

Material Asset.

Index

Properties

• url String cc.Asset.url is deprecated, please use nativeUrl instead
• _uuid String
• loaded Boolean Whether the asset is loaded or not.
• nativeUrl String Returns the url of this asset's native object, if none it will returns an empty string.
• refCount Number The number of reference
• _native String Serializable url for native asset.
• _nativeAsset Object The underlying native asset of this asset if one is available.
• _name String
• _objFlags Number
• name String The name of the object.
• isValid Boolean Indicates whether the object is not yet destroyed.

Methods

• getBuiltinMaterial Get built-in materials
• createWithBuiltin Creates a Material with builtin Effect.
• create Creates a Material.
• setProperty Sets the Material property
• getProperty Gets the Material property.
• define Sets the Material define.
• getDefine Gets the Material define.
• setCullMode Sets the Material cull mode.
• setDepth Sets the Material depth states.
• setBlend Sets the Material blend states.
• setStencilEnabled Sets whether enable the stencil test.
• setStencil Sets the Material stencil render states.
• toString Returns the asset's url.
• serialize Provide this method at the request of AssetDB.
• createNode Create a new node using this asset in the scene....
• _setRawAsset Set native file name for this asset.
• addRef Add references of asset
• decRef Reduce references of asset and it will be auto released when refCount equals 0.
• destroy Actual object destruction will delayed until before rendering.
• _destruct Clear all references in the instance.
• _onPreDestroy Called before the object being destroyed.
• _serialize The customized serialization for this object.
• _deserialize Init this object from the custom serialized data.

Details

Properties

url

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

_uuid

loaded

Whether the asset is loaded or not.

nativeUrl

Returns the url of this asset's native object, if none it will returns an empty string.

refCount

The number of reference

_native

Serializable url for native asset.

_nativeAsset

The underlying native asset of this asset if one is available. This property can be used to access additional details or functionality releated to the asset. This property will be initialized by the loader if _native is available.

_name

_objFlags

name

The name of the object.

Examples

obj.name = "New Obj";

isValid

Indicates whether the object is not yet destroyed. (It will not be available after being destroyed)
When an object's destroy is called, it is actually destroyed after the end of this frame. So isValid will return false from the next frame, while isValid in the current frame will still be true. If you want to determine whether the current frame has called destroy, use cc.isValid(obj, true), but this is often caused by a particular logical requirements, which is not normally required.

Examples

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

Methods

getBuiltinMaterial

Get built-in materials

Parameters

• name string

createWithBuiltin

Creates a Material with builtin Effect.

Parameters

• effectName string
• techniqueIndex number

create

Creates a Material.

Parameters

• effectAsset EffectAsset
• techniqueIndex number

setProperty

Sets the Material property

Parameters

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

getProperty

Gets the Material property.

Parameters

• name string
• passIdx number

define

Sets the Material define.

Parameters

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

getDefine

Gets the Material define.

Parameters

• name string
• passIdx number

setCullMode

Sets the Material cull mode.

Parameters

• cullMode number
• passIdx number

setDepth

Sets the Material depth states.

Parameters

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

setBlend

Sets the Material blend states.

Parameters

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

setStencilEnabled

Sets whether enable the stencil test.

Parameters

• stencilTest number
• passIdx number

setStencil

Sets the Material stencil render states.

Parameters

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

toString

Returns the asset's url.

The Asset object overrides the toString() method of the Object object. For Asset objects, the toString() method returns a string representation of the object. JavaScript calls the toString() method automatically when an asset is to be represented as a text value or when a texture is referred to in a string concatenation.

serialize

Provide this method at the request of AssetDB.

createNode

Create a new node using this asset in the scene.
If this type of asset dont have its corresponding node type, this method should be null.

Parameters

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

_setRawAsset

Set native file name for this asset.

Parameters

• filename String
• inLibrary Boolean

addRef

Add references of asset

decRef

Reduce references of asset and it will be auto released when refCount equals 0.

destroy

Destroy this Object, and release all its own references to other objects.
Actual object destruction will delayed until before rendering. From the next frame, this object is not usable anymore. You can use cc.isValid(obj) to check whether the object is destroyed before accessing it.

Examples

obj.destroy();

_destruct

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

_onPreDestroy

Called before the object being destroyed.

_serialize

The customized serialization for this object. (Editor Only)

Parameters

• exporting Boolean

_deserialize

Init this object from the custom serialized data.

Parameters

• data Object the serialized json data
• ctx _Deserializer