Texture2D Class

Extends Asset, EventTarget(mixin)

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" != (pixelsWidth, pixelsHight) 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 could be empty if the texture wasn't created via a file.
  • 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.
  • 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.
  • _native String Serializable url for native asset.
  • _nativeAsset Object The underlying native asset of this asset if one is available.
  • _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.
  • 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.
  • getHtmlElementObj HTMLElement Object getter, available only on web.
  • isLoaded Check whether texture is loaded.
  • handleLoadedTexture Handler of texture loaded event.
  • description Description of cc.Texture2D.
  • destroy Destory this texture and immediately release its video memory.
  • getPixelFormat Pixel format of the texture.
  • hasPremultipliedAlpha Whether or not the texture has their Alpha premultiplied,...
  • 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.
  • setAntiAliasTexParameters sets antialias texture parameters: ...
  • setAliasTexParameters Sets alias texture parameters: ...
  • 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,...
  • targetOff Removes all callbacks previously registered with the same target (passed as parameter).
  • once Register an callback of a specific event type on the EventTarget,...
  • dispatchEvent Dispatches an event into the event flow.
  • emit Send an event to this object directly, this method will not propagate the event to any other objects.
  • toString Returns the asset's url.
  • serialize 应 AssetDB 要求提供这个方法
  • createNode Create a new node using this asset in the scene....
  • _setRawAsset Set native file name for this asset.
  • _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.
Events
  • load This event is emitted when the asset is loaded

Details

Properties

url

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

meta description
Type String
Defined in cocos2d/core/textures/CCTexture2D.js:205
width

Texture width in pixel

meta description
Type Number
Defined in cocos2d/core/textures/CCTexture2D.js:218
height

Texture height in pixel

meta description
Type Number
Defined in cocos2d/core/textures/CCTexture2D.js:227
pixelFormat

Pixel format of the texture.

meta description
Type Number
Defined in cocos2d/core/textures/CCTexture2D.js:1027
pixelWidth

Width in pixels.

meta description
Type Number
Defined in cocos2d/core/textures/CCTexture2D.js:1034
Deprecated please use width instead
pixelHeight

Height in pixels.

meta description
Type Number
Defined in cocos2d/core/textures/CCTexture2D.js:1042
Deprecated please use height instead
loaded

Whether the asset is loaded or not

meta description
Type Boolean
Defined in cocos2d/core/assets/CCAsset.js:57
nativeUrl

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

meta description
Type String
Defined in cocos2d/core/assets/CCAsset.js:70
_native

Serializable url for native asset.

meta description
Type String
Defined in cocos2d/core/assets/CCAsset.js:108
_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.

meta description
Type Object
Defined in cocos2d/core/assets/CCAsset.js:116
_uuid
meta description
Type String
Defined in cocos2d/core/assets/CCRawAsset.js:46
_name
meta description
Type String
Defined in cocos2d/core/platform/CCObject.js:76
_objFlags
meta description
Type Number
Defined in cocos2d/core/platform/CCObject.js:83
name

The name of the object.

meta description
Type String
Defined in cocos2d/core/platform/CCObject.js:243
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.

meta description
Type Boolean
Defined in cocos2d/core/platform/CCObject.js:261
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

update

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

meta description
Defined in cocos2d/core/textures/CCTexture2D.js:282
Parameters
getPixelWidth

Get width in pixels.

meta description
Returns Number
Defined in cocos2d/core/textures/CCTexture2D.js:303
Deprecated use width or height property instead
getPixelHeight

Get height of in pixels.

meta description
Returns Number
Defined in cocos2d/core/textures/CCTexture2D.js:313
Deprecated use width or height property instead
getContentSize

Get content size.

meta description
Returns Size
Defined in cocos2d/core/textures/CCTexture2D.js:323
Deprecated use width or height property instead
getContentSizeInPixels

Get content size in pixels.

meta description
Returns Size
Defined in cocos2d/core/textures/CCTexture2D.js:333
Deprecated use width or height property instead
initWithElement

Init with HTML element.

meta description
Defined in cocos2d/core/textures/CCTexture2D.js:343
Parameters
  • element HTMLImageElement | HTMLCanvasElement
Examples
var img = new Image();
img.src = dataURL;
texture.initWithElement(img);
texture.handleLoadedTexture();
initWithData

Intializes with a texture2d with data.

meta description
Returns Boolean
Defined in cocos2d/core/textures/CCTexture2D.js:362
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).

meta description
Returns Boolean
Defined in cocos2d/core/textures/CCTexture2D.js:377
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.

meta description
Returns HTMLImageElement | HTMLCanvasElement
Defined in cocos2d/core/textures/CCTexture2D.js:390
isLoaded

Check whether texture is loaded.

meta description
Returns Boolean
Defined in cocos2d/core/textures/CCTexture2D.js:428
Deprecated use `loaded` property instead
handleLoadedTexture

Handler of texture loaded event.

meta description
Defined in cocos2d/core/textures/CCTexture2D.js:441
description

Description of cc.Texture2D.

meta description
Returns String
Defined in cocos2d/core/textures/CCTexture2D.js:458
destroy

Destory this texture and immediately release its video memory. (Inherit from cc.Object.destroy)
After destroy, this object is not usable any more. You can use cc.isValid(obj) to check whether the object is destroyed before accessing it.

meta description
Defined in cocos2d/core/textures/CCTexture2D.js:474
getPixelFormat

Pixel format of the texture.

meta description
Returns Number
Defined in cocos2d/core/textures/CCTexture2D.js:490
hasPremultipliedAlpha

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

meta description
Returns Boolean
Defined in cocos2d/core/textures/CCTexture2D.js:500
hasMipmaps

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

meta description
Returns Boolean
Defined in cocos2d/core/textures/CCTexture2D.js:510
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}.

meta description
Defined in cocos2d/core/textures/CCTexture2D.js:519
Deprecated use update function with filter and wrap options instead
Parameters
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
meta description
Defined in cocos2d/core/textures/CCTexture2D.js:548
Deprecated use update function with filter options instead
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

meta description
Defined in cocos2d/core/textures/CCTexture2D.js:560
Deprecated use update function with filter options instead
on

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

meta description
Returns Function
Defined in cocos2d/core/event/event-target.js:218
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).
    
  • 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.

meta description
Defined in cocos2d/core/event/event-target.js:275
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.

meta description
Defined in cocos2d/core/event/event-target.js:330
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.

meta description
Defined in cocos2d/core/event/event-target.js:352
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).
    
  • 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.

meta description
Defined in cocos2d/core/event/event-target.js:397
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.

meta description
Defined in cocos2d/core/event/event-target.js:411
Parameters
  • message String the message to send
  • detail Any whatever argument the message needs
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.

meta description
Returns String
Defined in cocos2d/core/assets/CCAsset.js:165
serialize

应 AssetDB 要求提供这个方法

meta description
Returns String
Defined in cocos2d/core/assets/CCAsset.js:179
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.

meta description
Defined in cocos2d/core/assets/CCAsset.js:190
Parameters
_setRawAsset

Set native file name for this asset.

meta description
Defined in cocos2d/core/assets/CCAsset.js:205
Parameters
_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; } } }

meta description
Defined in cocos2d/core/platform/CCObject.js:428
_onPreDestroy

Called before the object being destroyed.

meta description
Defined in cocos2d/core/platform/CCObject.js:461
_serialize

The customized serialization for this object. (Editor Only)

meta description
Returns object
Defined in cocos2d/core/platform/CCObject.js:486
Parameters
_deserialize

Init this object from the custom serialized data.

meta description
Defined in cocos2d/core/platform/CCObject.js:496
Parameters
  • data Object the serialized json data
  • ctx _Deserializer

Events

load Event

Module: cc

This event is emitted when the asset is loaded

Index

Details

results matching ""

    No results matching ""