RenderTexture Class

Extends Texture2D

Module: cc

Render textures are textures that can be rendered to.

Index

Properties

• genMipmaps Boolean Sets whether generate mipmaps for the texture
• packable Boolean Sets whether texture can be packed into texture atlas.
• loaded Boolean Whether the texture is loaded or not
• width Number Texture width in pixel
• height Number Texture height in pixel
• url String Points to the true url of this asset's native object, only valid when asset is loaded and asyncLoadAsset is not enabled.
• 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

• initWithSize Init the render texture with size.
• readPixels Get pixels from render texture, the pixels data stores in a RGBA Uint8Array.
• getImpl Get renderer texture implementation object
• update Update texture options, not available in Canvas render mode.
• initWithElement Init with HTML element.
• initWithData Intializes with a texture2d with data in Uint8Array.
• getHtmlElementObj HTMLElement Object getter, available only on web....
• 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.
• handleLoadedTexture Handler of texture loaded event.
• description Description of cc.Texture2D.
• releaseTexture Release texture, please use destroy instead.
• setTexParameters Sets the wrap s and wrap t options.
• setFilters Sets the minFilter and magFilter options
• setFlipY Sets the flipY options
• setPremultiplyAlpha Sets the premultiply alpha options
• 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.
• hasEventListener Checks whether the EventTarget object has any callback registered for a specific type of event.
• 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 Send an event with the event object.
• _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

genMipmaps

Sets whether generate mipmaps for the texture

packable

Sets whether texture can be packed into texture atlas. If need use texture uv in custom Effect, please sets packable to false.

loaded

Whether the texture is loaded or not

width

Texture width in pixel

height

Texture height in pixel

url

Points to the true url of this asset's native object, only valid when asset is loaded and asyncLoadAsset is not enabled. The difference between nativeUrl and url is that the latter is final path, there is no needs to transform url by md5 and subpackage. Besides, url may points to temporary path or cached path on mini game platform which has cache mechanism (WeChat etc). If you want to make use of the native file on those platforms, you should use url instead of nativeUrl.

nativeUrl

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

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

_uuid

_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

initWithSize

Init the render texture with size.

Parameters

• width Number
• height Number
• depthStencilFormat Number

readPixels

Get pixels from render texture, the pixels data stores in a RGBA Uint8Array. It will return a new (width height 4) length Uint8Array by default。 You can specify a data to store the pixels to reuse the data, you and can specify other params to specify the texture region to read.

Parameters

• data Uint8Array
• x Number
• y Number
• w Number
• h Number

getImpl

Get renderer texture implementation object extended from render.Texture2D

update

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

Parameters

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

initWithElement

Init with HTML element.

Parameters

• element HTMLImageElement | HTMLCanvasElement

Examples

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

initWithData

Intializes with a texture2d with data in Uint8Array.

Parameters

• data TypedArray
• pixelFormat Number
• pixelsWidth Number
• pixelsHeight Number

getHtmlElementObj

HTMLElement Object getter, available only on web.
Note: texture is packed into texture atlas by default
you should set texture.packable as false before getting Html element object.

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.

getPixelFormat

Pixel format of the texture.

hasPremultipliedAlpha

Whether or not the texture has their Alpha premultiplied.

handleLoadedTexture

Handler of texture loaded event. Since v2.0, you don't need to invoke this function, it will be invoked automatically after texture loaded.

Parameters

• premultiplied Boolean

description

Description of cc.Texture2D.

releaseTexture

Release texture, please use destroy instead.

setTexParameters

Sets the wrap s and wrap t options.
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

• wrapS Texture2D.WrapMode
• wrapT Texture2D.WrapMode

setFilters

Sets the minFilter and magFilter options

Parameters

• minFilter Texture2D.Filter
• magFilter Texture2D.Filter

setFlipY

Sets the flipY options

Parameters

• flipY Boolean

setPremultiplyAlpha

Sets the premultiply alpha options

Parameters

• premultiply Boolean

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

应 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

hasEventListener

Checks whether the EventTarget object has any callback registered for a specific type of event.

Parameters

• type String The type of event.

on

Register an callback of a specific event type on the EventTarget. This type of event should be triggered via emit.

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

  • arg1 Any arg1
  • arg2 Any arg2
  • arg3 Any arg3
  • arg4 Any arg4
  • arg5 Any arg5
• target Object The target (this object) to invoke the callback, can be null

Examples

eventTarget.on('fire', function () {
    cc.log("fire in the hole");
}, 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

Examples

// register fire eventListener
var callback = eventTarget.on('fire', function () {
    cc.log("fire in the hole");
}, target);
// remove fire event listener
eventTarget.off('fire', callback, target);
// remove all fire event listeners
eventTarget.off('fire');

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

  • arg1 Any arg1
  • arg2 Any arg2
  • arg3 Any arg3
  • arg4 Any arg4
  • arg5 Any arg5
• target Object The target (this object) to invoke the callback, can be null

Examples

eventTarget.once('fire', function () {
    cc.log("this is the callback and will be invoked only once");
}, node);

dispatchEvent

Send an event with the event object.

Parameters

• event Event

_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

Events

load Event

Module: cc

This event is emitted when the asset is loaded

Index

Details