macro Enum
Module: _decorator
Parent Module: cc
Predefined constants
Index
INVALID_INDEXNODE_TAG_INVALIDPIPI2FLT_MAXFLT_MINRADDEGUINT_MAXREPEAT_FOREVERFLT_EPSILONONEZEROSRC_ALPHASRC_ALPHA_SATURATESRC_COLORDST_ALPHADST_COLORONE_MINUS_SRC_ALPHAONE_MINUS_SRC_COLORONE_MINUS_DST_ALPHAONE_MINUS_DST_COLORONE_MINUS_CONSTANT_ALPHAONE_MINUS_CONSTANT_COLORLINEARBLEND_DSTWEB_ORIENTATION_PORTRAITWEB_ORIENTATION_LANDSCAPE_LEFTWEB_ORIENTATION_PORTRAIT_UPSIDE_DOWNWEB_ORIENTATION_LANDSCAPE_RIGHTORIENTATION_PORTRAITORIENTATION_LANDSCAPEORIENTATION_AUTOVERTEX_ATTRIB_FLAG_NONEVERTEX_ATTRIB_FLAG_POSITIONVERTEX_ATTRIB_FLAG_COLORVERTEX_ATTRIB_FLAG_TEX_COORDSVERTEX_ATTRIB_FLAG_POS_COLOR_TEXGL_ALLVERTEX_ATTRIB_POSITIONVERTEX_ATTRIB_COLORVERTEX_ATTRIB_TEX_COORDSVERTEX_ATTRIB_MAXUNIFORM_PMATRIXUNIFORM_MVMATRIXUNIFORM_MVPMATRIXUNIFORM_TIMEUNIFORM_SINTIMEUNIFORM_COSTIMEUNIFORM_RANDOM01UNIFORM_SAMPLERUNIFORM_MAXSHADER_POSITION_TEXTURECOLORSHADER_SPRITE_POSITION_TEXTURECOLORSHADER_POSITION_TEXTURECOLORALPHATESTSHADER_SPRITE_POSITION_TEXTURECOLORALPHATESTSHADER_POSITION_COLORSHADER_SPRITE_POSITION_COLORSHADER_POSITION_TEXTURESHADER_POSITION_TEXTURE_UCOLORSHADER_POSITION_TEXTUREA8COLORSHADER_POSITION_UCOLORSHADER_POSITION_LENGTHTEXTURECOLORUNIFORM_PMATRIX_SUNIFORM_MVMATRIX_SUNIFORM_MVPMATRIX_SUNIFORM_TIME_SUNIFORM_SINTIME_SUNIFORM_COSTIME_SUNIFORM_RANDOM01_SUNIFORM_SAMPLER_SUNIFORM_ALPHA_TEST_VALUE_SATTRIBUTE_NAME_COLORATTRIBUTE_NAME_POSITIONATTRIBUTE_NAME_TEX_COORDITEM_SIZECURRENT_ITEMZOOM_ACTION_TAGNORMAL_TAGSELECTED_TAGDISABLE_TAGFIX_ARTIFACTS_BY_STRECHING_TEXELFIX_ARTIFACTS_BY_STRECHING_TEXEL_TMXDIRECTOR_STATS_POSITIONDIRECTOR_FPS_INTERVALCOCOSNODE_RENDER_SUBPIXELSPRITEBATCHNODE_RENDER_SUBPIXELAUTO_PREMULTIPLIED_ALPHA_FOR_PNGOPTIMIZE_BLEND_FUNC_FOR_PREMULTIPLIED_ALPHATEXTURE_NPOT_SUPPORTUSE_LA88_LABELSSPRITE_DEBUG_DRAWLABELBMFONT_DEBUG_DRAWLABELATLAS_DEBUG_DRAWENABLE_STACKABLE_ACTIONSENABLE_GL_STATE_CACHETOUCH_TIMEOUTBATCH_VERTEX_COUNTENABLE_GC_FOR_NATIVE_OBJECTSENABLE_TILEDMAP_CULLINGDOWNLOAD_MAX_CONCURRENTENABLE_TRANSPARENT_CANVASENABLE_WEBGL_ANTIALIASENABLE_CULLINGBLEND_SRC
Details
INVALID_INDEX
NODE_TAG_INVALID
Default Node tag
PI
PI is the ratio of a circle's circumference to its diameter.
PI2
PI * 2
FLT_MAX
Maximum float value
FLT_MIN
Minimum float value
RAD
PI / 180
DEG
One degree
UINT_MAX
Maximum unsigned int value
REPEAT_FOREVER
FLT_EPSILON
ONE
ZERO
SRC_ALPHA
SRC_ALPHA_SATURATE
SRC_COLOR
DST_ALPHA
DST_COLOR
ONE_MINUS_SRC_ALPHA
ONE_MINUS_SRC_COLOR
ONE_MINUS_DST_ALPHA
ONE_MINUS_DST_COLOR
ONE_MINUS_CONSTANT_ALPHA
ONE_MINUS_CONSTANT_COLOR
LINEAR
the constant variable equals gl.LINEAR for texture
BLEND_DST
default gl blend dst function. Compatible with premultiplied alpha images.
WEB_ORIENTATION_PORTRAIT
Device oriented vertically, home button on the bottom (UIDeviceOrientationPortrait)
WEB_ORIENTATION_LANDSCAPE_LEFT
Device oriented horizontally, home button on the right (UIDeviceOrientationLandscapeLeft)
WEB_ORIENTATION_PORTRAIT_UPSIDE_DOWN
Device oriented vertically, home button on the top (UIDeviceOrientationPortraitUpsideDown)
WEB_ORIENTATION_LANDSCAPE_RIGHT
Device oriented horizontally, home button on the left (UIDeviceOrientationLandscapeRight)
ORIENTATION_PORTRAIT
Oriented vertically
ORIENTATION_LANDSCAPE
Oriented horizontally
ORIENTATION_AUTO
Oriented automatically
VERTEX_ATTRIB_FLAG_NONE
VERTEX_ATTRIB_FLAG_POSITION
VERTEX_ATTRIB_FLAG_COLOR
VERTEX_ATTRIB_FLAG_TEX_COORDS
VERTEX_ATTRIB_FLAG_POS_COLOR_TEX
GL_ALL
GL server side states
VERTEX_ATTRIB_POSITION
VERTEX_ATTRIB_COLOR
VERTEX_ATTRIB_TEX_COORDS
VERTEX_ATTRIB_MAX
SHADER_POSITION_TEXTURECOLOR
SHADER_SPRITE_POSITION_TEXTURECOLOR
SHADER_POSITION_TEXTURECOLORALPHATEST
SHADER_SPRITE_POSITION_TEXTURECOLORALPHATEST
SHADER_POSITION_COLOR
SHADER_SPRITE_POSITION_COLOR
SHADER_POSITION_TEXTURE
SHADER_POSITION_TEXTURE_UCOLOR
SHADER_POSITION_TEXTUREA8COLOR
SHADER_POSITION_UCOLOR
SHADER_POSITION_LENGTHTEXTURECOLOR
ATTRIBUTE_NAME_COLOR
ATTRIBUTE_NAME_POSITION
ATTRIBUTE_NAME_TEX_COORD
ITEM_SIZE
default size for font size
CURRENT_ITEM
default tag for current item
ZOOM_ACTION_TAG
default tag for zoom action tag
NORMAL_TAG
default tag for normal
SELECTED_TAG
default selected tag
DISABLE_TAG
default disabled tag
FIX_ARTIFACTS_BY_STRECHING_TEXEL
If enabled, the texture coordinates will be calculated by using this formula:
- texCoord.left = (rect.x*2+1) / (texture.wide*2);
- texCoord.right = texCoord.left + (rect.width*2-2)/(texture.wide*2);
The same for bottom and top.
This formula prevents artifacts by using 99% of the texture.
The "correct" way to prevent artifacts is by expand the texture's border with the same color by 1 pixel
Affected nodes:
- _ccsg.Sprite
Disabled by default. To enabled set it to 1.
To modify it, in Web engine please refer to CCMacro.js, in JSB please refer to CCConfig.h
FIX_ARTIFACTS_BY_STRECHING_TEXEL_TMX
If enabled, the texture coordinates will be calculated by using this formula:
- texCoord.left = (rect.x*2+1) / (texture.wide*2);
- texCoord.right = texCoord.left + (rect.width*2-2)/(texture.wide*2);
The same for bottom and top.
This formula prevents artifacts by using 99% of the texture.
The "correct" way to prevent artifacts is by expand the texture's border with the same color by 1 pixel
Affected nodes:
- _ccsg.TMXLayer
Enabled by default. To disabled set it to 0.
To modify it, in Web engine please refer to CCMacro.js, in JSB please refer to CCConfig.h
DIRECTOR_STATS_POSITION
Position of the FPS (Default: 0,0 (bottom-left corner))
To modify it, in Web engine please refer to CCMacro.js, in JSB please refer to CCConfig.h
DIRECTOR_FPS_INTERVAL
Seconds between FPS updates.
0.5 seconds, means that the FPS number will be updated every 0.5 seconds.
Having a bigger number means a more reliable FPS
Default value: 0.1f
To modify it, in Web engine please refer to CCMacro.js, in JSB please refer to CCConfig.h
COCOSNODE_RENDER_SUBPIXEL
If enabled, the ccsg.Node objects (_ccsg.Sprite, _ccsg.Label,etc) will be able to render in subpixels.
If disabled, integer pixels will be used.
To enable set it to 1. Enabled by default.
To modify it, in Web engine please refer to CCMacro.js, in JSB please refer to CCConfig.h
SPRITEBATCHNODE_RENDER_SUBPIXEL
If enabled, the _ccsg.Sprite objects rendered with cc.SpriteBatchNode will be able to render in subpixels.
If disabled, integer pixels will be used.
To enable set it to 1. Enabled by default.
To modify it, in Web engine please refer to CCMacro.js, in JSB please refer to CCConfig.h
AUTO_PREMULTIPLIED_ALPHA_FOR_PNG
Automatically premultiply alpha for remote PNG resources.
OPTIMIZE_BLEND_FUNC_FOR_PREMULTIPLIED_ALPHA
If most of your images have pre-multiplied alpha, set it to 1 (if you are going to use .PNG/.JPG file images).
Only set to 0 if ALL your images by-pass Apple UIImage loading system (eg: if you use libpng or PVR images)
To enable set it to a value different than 0. Enabled by default.
To modify it, in Web engine please refer to CCMacro.js, in JSB please refer to CCConfig.h
TEXTURE_NPOT_SUPPORT
If enabled, NPOT textures will be used where available. Only 3rd gen (and newer) devices support NPOT textures.
NPOT textures have the following limitations:
- They can't have mipmaps
- They only accept GL_CLAMP_TO_EDGE in GL_TEXTURE_WRAP_{S,T}
To enable set it to a value different than 0. Disabled by default.
This value governs only the PNG, GIF, BMP, images.
This value DOES NOT govern the PVR (PVR.GZ, PVR.CCZ) files. If NPOT PVR is loaded, then it will create an NPOT texture ignoring this value.
To modify it, in Web engine please refer to CCMacro.js, in JSB please refer to CCConfig.h
USE_LA88_LABELS
If enabled, it will use LA88 (Luminance Alpha 16-bit textures) for CCLabelTTF objects.
If it is disabled, it will use A8 (Alpha 8-bit textures).
LA88 textures are 6% faster than A8 textures, but they will consume 2x memory.
This feature is enabled by default.
SPRITE_DEBUG_DRAW
If enabled, all subclasses of _ccsg.Sprite will draw a bounding box
Useful for debugging purposes only. It is recommend to leave it disabled.
To enable set it to a value different than 0. Disabled by default:
0 -- disabled
1 -- draw bounding box
2 -- draw texture box
LABELBMFONT_DEBUG_DRAW
If enabled, all subclasses of cc.LabelBMFont will draw a bounding box
Useful for debugging purposes only. It is recommend to leave it disabled.
To enable set it to a value different than 0. Disabled by default.
LABELATLAS_DEBUG_DRAW
If enabled, all subclasses of cc.LabelAtlas will draw a bounding box
Useful for debugging purposes only. It is recommend to leave it disabled.
To enable set it to a value different than 0. Disabled by default.
ENABLE_STACKABLE_ACTIONS
If enabled, actions that alter the position property (eg: CCMoveBy, CCJumpBy, CCBezierBy, etc..) will be stacked.
If you run 2 or more 'position' actions at the same time on a node, then end position will be the sum of all the positions.
If disabled, only the last run action will take effect.
ENABLE_GL_STATE_CACHE
If enabled, cocos2d will maintain an OpenGL state cache internally to avoid unnecessary switches.
In order to use them, you have to use the following functions, instead of the the GL ones:
- cc.gl.useProgram() instead of glUseProgram()
- cc.gl.deleteProgram() instead of glDeleteProgram()
- cc.gl.blendFunc() instead of glBlendFunc()
If this functionality is disabled, then cc.gl.useProgram(), cc.gl.deleteProgram(), cc.gl.blendFunc() will call the GL ones, without using the cache.
It is recommend to enable whenever possible to improve speed.
If you are migrating your code from GL ES 1.1, then keep it disabled. Once all your code works as expected, turn it on.
TOUCH_TIMEOUT
The timeout to determine whether a touch is no longer active and should be removed.
The reason to add this timeout is due to an issue in X5 browser core,
when X5 is presented in wechat on Android, if a touch is glissed from the bottom up, and leave the page area,
no touch cancel event is triggered, and the touch will be considered active forever.
After multiple times of this action, our maximum touches number will be reached and all new touches will be ignored.
So this new mechanism can remove the touch that should be inactive if it's not updated during the last 5000 milliseconds.
Though it might remove a real touch if it's just not moving for the last 5 seconds which is not easy with the sensibility of mobile touch screen.
You can modify this value to have a better behavior if you find it's not enough.
BATCH_VERTEX_COUNT
The maximum vertex count for a single batched draw call.
ENABLE_GC_FOR_NATIVE_OBJECTS
JSB only, using JS object life cycle to control C++ object or inversely,
it indicates two different memory model controled by the native macro CC_ENABLE_GC_FOR_NATIVE_OBJECTS.
Modify the JS macro value won't have any effect.
ENABLE_TILEDMAP_CULLING
Whether or not enabled tiled map auto culling. If you set the TiledMap skew or rotation, then need to manually disable this, otherwise, the rendering will be wrong.
DOWNLOAD_MAX_CONCURRENT
The max concurrent task number for the downloader
ENABLE_TRANSPARENT_CANVAS
Boolean that indicates if the canvas contains an alpha channel, default sets to false for better performance.
Though if you want to make your canvas background transparent and show other dom elements at the background,
you can set it to true before cc.game.run.
Web only.
ENABLE_WEBGL_ANTIALIAS
Boolean that indicates if the WebGL context is created with antialias option turned on, default value is false.
Set it to true could make your game graphics slightly smoother, like texture hard edges when rotated.
Whether to use this really depend on your game design and targeted platform,
device with retina display usually have good detail on graphics with or without this option,
you probably don't want antialias if your game style is pixel art based.
Also, it could have great performance impact with some browser / device using software MSAA.
You can set it to true before cc.game.run.
Web only.
ENABLE_CULLING
Whether or not enable auto culling.
If your game have more dynamic objects, we suggest to disable auto culling.
If your game have more static objects, we suggest to enable auto culling.
BLEND_SRC
default gl blend src function. Compatible with premultiplied alpha images.
