Texture2D Class

Extends RawAsset

Module: cc Parent Module: 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!

Index

Properties

• url String The url of the texture, this coule be empty if the texture wasn't created via a file.
• loaded Boolean Whether the texture is loaded or not
• width Number Texture width in pixel
• height Number Texture height in pixel
• 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 The name of the object.
• isValid Boolean Indicates whether the object is not yet destroyed.

Methods

• 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 Register an callback of a specific event type on the EventTarget.
• off Removes the listeners previously registered with the same type, callback, target and or useCapture, if only type is passed as parameter, all listeners registered with that type will be removed.
• targetOff Removes all callbacks previously registered with the same target (passed as parameter). This is not for removing all listeners in the current event target, and this is not for removing all listeners the target parameter have registered. It's only for removing all listeners (callback and target couple) registered on the current event target by the target parameter.
• once Register an callback of a specific event type on the EventTarget, the callback will remove itself after the first time it is triggered.
• dispatchEvent Dispatches an event into the event flow. The event target is the EventTarget object upon which the dispatchEvent() method is called.
• emit Send an event to this object directly, this method will not propagate the event to any other objects. The event will be created from the supplied message, you can get the "detail" argument from event.detail.
• destroy Destroy this Object, and release all its own references to other objects.
  Actual object destruction will delayed until before rendering.
  After destroy, this CCObject is not usable any more. You can use cc.isValid(obj) to check whether the object is destroyed before accessing it.
• _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

The url of the texture, this coule be empty if the texture wasn't created via a file.

loaded

Whether the texture is loaded or not

width

Texture width in pixel

height

Texture height in pixel

pixelFormat

Pixel format of the texture.

pixelWidth

Width in pixels.

pixelHeight

Height in pixels.

_uuid

_name

_objFlags

name

The name of the object.

Examples

obj.name = "New Obj";

isValid

Indicates whether the object is not yet destroyed.

Examples

cc.log(obj.isValid);

Methods

update

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

Parameters

• 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.

Parameters

• element HTMLImageElement | HTMLCanvasElement

Examples

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

initWithData

Intializes with a texture2d with data.

Parameters

• 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).

Parameters

• 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.

Parameters

• 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}.

Parameters

• 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

Register an callback of a specific event type on the EventTarget.

Parameters

• 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.
  

Examples

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

off

Removes the listeners previously registered with the same type, callback, target and or useCapture, if only type is passed as parameter, all listeners registered with that type will be removed.

Parameters

• 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.
  

Examples

// 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

Removes all callbacks previously registered with the same target (passed as parameter). This is not for removing all listeners in the current event target, and this is not for removing all listeners the target parameter have registered. It's only for removing all listeners (callback and target couple) registered on the current event target by the target parameter.

Parameters

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

once

Register an callback of a specific event type on the EventTarget, the callback will remove itself after the first time it is triggered.

Parameters

• 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.
  

Examples

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

dispatchEvent

Dispatches an event into the event flow. The event target is the EventTarget object upon which the dispatchEvent() method is called.

Parameters

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

emit

Send an event to this object directly, this method will not propagate the event to any other objects. The event will be created from the supplied message, you can get the "detail" argument from event.detail.

Parameters

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

destroy

Destroy this Object, and release all its own references to other objects.
Actual object destruction will delayed until before rendering.
After destroy, this CCObject is not usable any more. 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