Texture2D 类型

继承于 RawAsset

模块: cc 父模块: cc

This class allows to easily create OpenGL or Canvas 2D textures from images, text or raw data.
The created cc.Texture2D object will always have power-of-two dimensions.
Depending on how you create the cc.Texture2D object, the actual image area of the texture might be smaller than the texture dimensions
i.e. "contentSize" != (pixelsWide, pixelsHigh) and (maxS, maxT) != (1.0, 1.0).
Be aware that the content of the generated textures will be upside-down!

索引

属性（properties）

• url String 贴图文件的 url，当贴图不是由文件创建时值可能为空
• loaded Boolean 贴图是否已经成功加载
• width Number 贴图像素宽度
• height Number 贴图像素高度
• pixelFormat Number Pixel format of the texture.
• pixelWidth Number Width in pixels.
• pixelHeight Number Height in pixels.
• _uuid String
• _name String
• _objFlags Number
• name String 该对象的名称。
• isValid Boolean 表示该对象是否可用（被销毁后将不可用）。

方法

• update Update texture options, not available in Canvas render mode. image, format, premultiplyAlpha can not be updated in native.
• getPixelWidth Get width in pixels.
• getPixelHeight Get height of in pixels.
• getContentSize Get content size.
• getContentSizeInPixels Get content size in pixels.
• initWithElement Init with HTML element.
• initWithData Intializes with a texture2d with data.
• initWithImage Initializes a texture from a UIImage object. Extensions to make it easy to create a CCTexture2D object from an image file. Note that RGBA type textures will have their alpha premultiplied - use the blending mode (gl.ONE, gl.ONE_MINUS_SRC_ALPHA).
• getHtmlElementObj HTMLElement Object getter, available only on web. In most case, it will return null, because we are recycling the dom image element for better loading performance and lower image cache memory usage.
• isLoaded Check whether texture is loaded.
• handleLoadedTexture Handler of texture loaded event.
• description Description of cc.Texture2D.
• releaseTexture Release texture.
• getPixelFormat Pixel format of the texture.
• hasPremultipliedAlpha Whether or not the texture has their Alpha premultiplied, support only in WebGl rendering mode.
• hasMipmaps Whether or not use mipmap, support only in WebGl rendering mode.
• setTexParameters Sets the min filter, mag filter, wrap s and wrap t texture parameters.
  If the texture size is NPOT (non power of 2), then in can only use gl.CLAMPTO_EDGE in gl.TEXTURE_WRAP{S,T}.
• setAntiAliasTexParameters sets antialias texture parameters:
  
  • GL_TEXTURE_MIN_FILTER = GL_NEAREST
    
  • GL_TEXTURE_MAG_FILTER = GL_NEAREST
    supported only in native or WebGl rendering mode
• setAliasTexParameters Sets alias texture parameters:
  GL_TEXTURE_MIN_FILTER = GL_NEAREST
  GL_TEXTURE_MAG_FILTER = GL_NEAREST
  supported only in native or WebGl rendering mode
• on 注册事件目标的特定事件类型回调。
• off 删除之前用同类型，回调，目标或 useCapture 注册的事件监听器，如果只传递 type，将会删除 type 类型的所有事件监听器。
• targetOff 在当前 EventTarget 上删除指定目标（target 参数）注册的所有事件监听器。 这个函数无法删除当前 EventTarget 的所有事件监听器，也无法删除 target 参数所注册的所有事件监听器。 这个函数只能删除 target 参数在当前 EventTarget 上注册的所有事件监听器。
• once 注册事件目标的特定事件类型回调，回调会在第一时间被触发后删除自身。
• dispatchEvent 分发事件到事件流中。
• emit 该对象直接发送事件， 这种方法不会对事件传播到任何其他对象。
• destroy 销毁该对象，并释放所有它对其它对象的引用。
  销毁后，CCObject 不再可用。您可以在访问对象之前使用 cc.isValid(obj) 来检查对象是否已被销毁。 实际销毁操作会延迟到当前帧渲染前执行。
• _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)
• _deserialize Init this object from the custom serialized data.

Details

属性（properties）

url

贴图文件的 url，当贴图不是由文件创建时值可能为空

loaded

贴图是否已经成功加载

width

贴图像素宽度

height

贴图像素高度

pixelFormat

Pixel format of the texture.

pixelWidth

Width in pixels.

pixelHeight

Height in pixels.

_uuid

_name

_objFlags

name

该对象的名称。

示例

obj.name = "New Obj";

isValid

表示该对象是否可用（被销毁后将不可用）。

示例

cc.log(obj.isValid);

方法

update

Update texture options, not available in Canvas render mode. image, format, premultiplyAlpha can not be updated in native.

参数列表

• options Object
  • image DOMImageElement
  • mipmap Boolean
  • format PixelFormat
  • minFilter Filter
  • magFilter Filter
  • wrapS WrapMode
  • wrapT WrapMode
  • premultiplyAlpha Boolean

getPixelWidth

Get width in pixels.

getPixelHeight

Get height of in pixels.

getContentSize

Get content size.

getContentSizeInPixels

Get content size in pixels.

initWithElement

Init with HTML element.

参数列表

• element HTMLImageElement | HTMLCanvasElement

示例

var img = new Image();
img.src = dataURL;
texture.initWithElement(img);
texture.handleLoadedTexture();

initWithData

Intializes with a texture2d with data.

参数列表

• data TypedArray
• pixelFormat Number
• pixelsWidth Number
• pixelsHeight Number
• contentSize Size contentSize is deprecated and ignored

initWithImage

Initializes a texture from a UIImage object. Extensions to make it easy to create a CCTexture2D object from an image file. Note that RGBA type textures will have their alpha premultiplied - use the blending mode (gl.ONE, gl.ONE_MINUS_SRC_ALPHA).

参数列表

• uiImage HTMLImageElement

getHtmlElementObj

HTMLElement Object getter, available only on web. In most case, it will return null, because we are recycling the dom image element for better loading performance and lower image cache memory usage.

isLoaded

Check whether texture is loaded.

handleLoadedTexture

Handler of texture loaded event.

参数列表

• premultiplied Boolean

description

Description of cc.Texture2D.

releaseTexture

Release texture.

getPixelFormat

Pixel format of the texture.

hasPremultipliedAlpha

Whether or not the texture has their Alpha premultiplied, support only in WebGl rendering mode.

hasMipmaps

Whether or not use mipmap, support only in WebGl rendering mode.

setTexParameters

Sets the min filter, mag filter, wrap s and wrap t texture parameters.
If the texture size is NPOT (non power of 2), then in can only use gl.CLAMPTO_EDGE in gl.TEXTURE_WRAP{S,T}.

参数列表

• texParams Object | Number texParams object or minFilter
• magFilter Number
• wrapS Texture2D.WrapMode
• wrapT Texture2D.WrapMode

setAntiAliasTexParameters

sets antialias texture parameters:

• GL_TEXTURE_MIN_FILTER = GL_NEAREST
  
• GL_TEXTURE_MAG_FILTER = GL_NEAREST
  supported only in native or WebGl rendering mode

setAliasTexParameters

Sets alias texture parameters:
GL_TEXTURE_MIN_FILTER = GL_NEAREST
GL_TEXTURE_MAG_FILTER = GL_NEAREST
supported only in native or WebGl rendering mode

on

注册事件目标的特定事件类型回调。

参数列表

• type String A string representing the event type to listen for.
• callback Function The callback that will be invoked when the event is dispatched.

                         The callback is ignored if it is a duplicate (the callbacks are unique).
  

  • event Event event
• target Object The target (this object) to invoke the callback, can be null
• useCapture Boolean When set to true, the capture argument prevents callback

                         from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
                         When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
                         Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
  

示例

node.on(cc.Node.EventType.TOUCH_END, function (event) {
    cc.log("this is callback");
}, node);

off

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

参数列表

• type String A string representing the event type being removed.
• callback Function The callback to remove.
• target Object The target (this object) to invoke the callback, if it's not given, only callback without target will be removed
• useCapture Boolean Specifies whether the callback being removed was registered as a capturing callback or not.

                         If not specified, useCapture defaults to false. If a callback was registered twice,
                         one with capture and one without, each must be removed separately. Removal of a capturing callback
                         does not affect a non-capturing version of the same listener, and vice versa.
  

示例

// register touchEnd eventListener
var touchEnd = node.on(cc.Node.EventType.TOUCH_END, function (event) {
    cc.log("this is callback");
}, node);
// remove touch end event listener
node.off(cc.Node.EventType.TOUCH_END, touchEnd, node);
// remove all touch end event listeners
node.off(cc.Node.EventType.TOUCH_END);

targetOff

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

参数列表

• target Object The target to be searched for all related listeners

once

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

参数列表

• type String A string representing the event type to listen for.
• callback Function The callback that will be invoked when the event is dispatched.

                         The callback is ignored if it is a duplicate (the callbacks are unique).
  

  • event Event event
• target Object The target (this object) to invoke the callback, can be null
• useCapture Boolean When set to true, the capture argument prevents callback

                         from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE.
                         When false, callback will NOT be invoked when event's eventPhase attribute value is CAPTURING_PHASE.
                         Either way, callback will be invoked when event's eventPhase attribute value is AT_TARGET.
  

示例

node.once(cc.Node.EventType.TOUCH_END, function (event) {
    cc.log("this is callback");
}, node);

dispatchEvent

分发事件到事件流中。

参数列表

• event Event The Event object that is dispatched into the event flow

emit

该对象直接发送事件， 这种方法不会对事件传播到任何其他对象。

参数列表

• message String the message to send
• detail Any whatever argument the message needs

destroy

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

示例

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)

参数列表

• exporting Boolean

_deserialize

Init this object from the custom serialized data.

参数列表

• data Object the serialized json data
• ctx _Deserializer