cocos2d-x  3.0Beta0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ccMacros.h File Reference
#include "platform/CCCommon.h"
#include "CCStdC.h"
#include "ccConfig.h"

Macros

#define _USE_MATH_DEFINES
#define CCASSERT(cond, msg)
#define CCAssert   CCASSERT
#define CC_SWAP(x, y, type)
 simple macro that swaps 2 variables More...
 
#define CCRANDOM_MINUS1_1()   ((2.0f*((float)rand()/RAND_MAX))-1.0f)
 returns a random float between -1 and 1 More...
 
#define CCRANDOM_0_1()   ((float)rand()/RAND_MAX)
 returns a random float between 0 and 1 More...
 
#define CC_DEGREES_TO_RADIANS(__ANGLE__)   ((__ANGLE__) * 0.01745329252f)
 converts degrees to radians More...
 
#define CC_RADIANS_TO_DEGREES(__ANGLE__)   ((__ANGLE__) * 57.29577951f)
 converts radians to degrees More...
 
#define kRepeatForever   (UINT_MAX -1)
#define CC_BLEND_SRC   GL_ONE
 default gl blend src function. More...
 
#define CC_BLEND_DST   GL_ONE_MINUS_SRC_ALPHA
#define CC_NODE_DRAW_SETUP()
 Helpful macro that setups the GL server state, the correct GL program and sets the Model View Projection matrix. More...
 
#define CC_DIRECTOR_END()
 Stops and removes the director from memory. More...
 
#define CC_CONTENT_SCALE_FACTOR()   Director::getInstance()->getContentScaleFactor()
 On Mac it returns 1; On iPhone it returns 2 if RetinaDisplay is On. More...
 
#define CC_RECT_PIXELS_TO_POINTS(__rect_in_pixels__)
 RETINA DISPLAY ENABLED. More...
 
#define CC_RECT_POINTS_TO_PIXELS(__rect_in_points_points__)
 Converts a rect in points to pixels. More...
 
#define CC_POINT_PIXELS_TO_POINTS(__pixels__)   Point( (__pixels__).x / CC_CONTENT_SCALE_FACTOR(), (__pixels__).y / CC_CONTENT_SCALE_FACTOR())
 Converts a rect in pixels to points. More...
 
#define CC_POINT_POINTS_TO_PIXELS(__points__)   Point( (__points__).x * CC_CONTENT_SCALE_FACTOR(), (__points__).y * CC_CONTENT_SCALE_FACTOR())
 Converts a rect in points to pixels. More...
 
#define CC_SIZE_PIXELS_TO_POINTS(__size_in_pixels__)   Size( (__size_in_pixels__).width / CC_CONTENT_SCALE_FACTOR(), (__size_in_pixels__).height / CC_CONTENT_SCALE_FACTOR())
#define CC_SIZE_POINTS_TO_PIXELS(__size_in_points__)   Size( (__size_in_points__).width * CC_CONTENT_SCALE_FACTOR(), (__size_in_points__).height * CC_CONTENT_SCALE_FACTOR())
#define FLT_EPSILON   1.192092896e-07F
#define DISALLOW_COPY_AND_ASSIGN(TypeName)
#define CC_HOST_IS_BIG_ENDIAN   (bool)(*(unsigned short *)"\0\xff" < 0x100)
 Helper macros which converts 4-byte little/big endian integral number to the machine native number representation. More...
 
#define CC_SWAP32(i)   ((i & 0x000000ff) << 24 | (i & 0x0000ff00) << 8 | (i & 0x00ff0000) >> 8 | (i & 0xff000000) >> 24)
#define CC_SWAP16(i)   ((i & 0x00ff) << 8 | (i &0xff00) >> 8)
#define CC_SWAP_INT32_LITTLE_TO_HOST(i)   ((CC_HOST_IS_BIG_ENDIAN == true)? CC_SWAP32(i) : (i) )
#define CC_SWAP_INT16_LITTLE_TO_HOST(i)   ((CC_HOST_IS_BIG_ENDIAN == true)? CC_SWAP16(i) : (i) )
#define CC_SWAP_INT32_BIG_TO_HOST(i)   ((CC_HOST_IS_BIG_ENDIAN == true)? (i) : CC_SWAP32(i) )
#define CC_SWAP_INT16_BIG_TO_HOST(i)   ((CC_HOST_IS_BIG_ENDIAN == true)? (i): CC_SWAP16(i) )
#define CC_PROFILER_DISPLAY_TIMERS()   do {} while (0)
 Profiling Macros. More...
 
#define CC_PROFILER_PURGE_ALL()   do {} while (0)
#define CC_PROFILER_START(__name__)   do {} while (0)
#define CC_PROFILER_STOP(__name__)   do {} while (0)
#define CC_PROFILER_RESET(__name__)   do {} while (0)
#define CC_PROFILER_START_CATEGORY(__cat__, __name__)   do {} while(0)
#define CC_PROFILER_STOP_CATEGORY(__cat__, __name__)   do {} while(0)
#define CC_PROFILER_RESET_CATEGORY(__cat__, __name__)   do {} while(0)
#define CC_PROFILER_START_INSTANCE(__id__, __name__)   do {} while(0)
#define CC_PROFILER_STOP_INSTANCE(__id__, __name__)   do {} while(0)
#define CC_PROFILER_RESET_INSTANCE(__id__, __name__)   do {} while(0)
#define CHECK_GL_ERROR_DEBUG()
#define CC_INCREMENT_GL_DRAWS(__n__)   g_uNumberOfDraws += __n__
#define AnimationFrameDisplayedNotification   "CCAnimationFrameDisplayedNotification"
 Notifications. More...
 

Variables

unsigned int CC_DLL g_uNumberOfDraws
var g_uNumberOfDraws
local g_uNumberOfDraws

Macro Definition Documentation

#define _USE_MATH_DEFINES
var _USE_MATH_DEFINES
local _USE_MATH_DEFINES
#define
AnimationFrameDisplayedNotification   "CCAnimationFrameDisplayedNotification"

Notifications.

Notification name when a SpriteFrame is displayed

var
AnimationFrameDisplayedNotification   "CCAnimationFrameDisplayedNotification"

Notifications.

Notification name when a SpriteFrame is displayed

#define CC_BLEND_DST   GL_ONE_MINUS_SRC_ALPHA
var CC_BLEND_DST   GL_ONE_MINUS_SRC_ALPHA
local CC_BLEND_DST   GL_ONE_MINUS_SRC_ALPHA
#define CC_BLEND_SRC   GL_ONE

default gl blend src function.

Compatible with premultiplied alpha images.

var CC_BLEND_SRC   GL_ONE

default gl blend src function.

Compatible with premultiplied alpha images.

local CC_BLEND_SRC   GL_ONE

default gl blend src function.

Compatible with premultiplied alpha images.

#define CC_CONTENT_SCALE_FACTOR ( )    Director::getInstance()->getContentScaleFactor()

On Mac it returns 1; On iPhone it returns 2 if RetinaDisplay is On.

Otherwise it returns 1

var CC_CONTENT_SCALE_FACTOR ( )    Director::getInstance()->getContentScaleFactor()

On Mac it returns 1; On iPhone it returns 2 if RetinaDisplay is On.

Otherwise it returns 1

#define CC_DEGREES_TO_RADIANS (   __ANGLE__)    ((__ANGLE__) * 0.01745329252f)

converts degrees to radians

var CC_DEGREES_TO_RADIANS (   var)    ((__ANGLE__) * 0.01745329252f)

converts degrees to radians

local CC_DEGREES_TO_RADIANS (   local)    ((__ANGLE__) * 0.01745329252f)

converts degrees to radians

#define CC_DIRECTOR_END ( )
Value:
do { \
Director *__director = Director::getInstance(); \
__director->end(); \
} while(0)

Stops and removes the director from memory.

Removes the GLView from its parent

Since
v0.99.4
var CC_DIRECTOR_END ( )
Value:
do { \
Director *__director = Director::getInstance(); \
__director->end(); \
} while(0)

Stops and removes the director from memory.

Removes the GLView from its parent

Since
v0.99.4
local CC_DIRECTOR_END ( )
Value:
do { \
Director *__director = Director::getInstance(); \
__director->end(); \
} while(0)

Stops and removes the director from memory.

Removes the GLView from its parent

Since
v0.99.4
#define CC_HOST_IS_BIG_ENDIAN   (bool)(*(unsigned short *)"\0\xff" < 0x100)

Helper macros which converts 4-byte little/big endian integral number to the machine native number representation.

It should work same as apples CFSwapInt32LittleToHost(..)when define returns true it means that our architecture uses big endian

#define CC_INCREMENT_GL_DRAWS (   __n__)    g_uNumberOfDraws += __n__
#define CC_NODE_DRAW_SETUP ( )
Value:
do { \
CCASSERT(getShaderProgram(), "No shader program set for this node"); \
{ \
getShaderProgram()->use(); \
getShaderProgram()->setUniformsForBuiltins(_modelViewTransform); \
} \
} while(0)

Helpful macro that setups the GL server state, the correct GL program and sets the Model View Projection matrix.

Since
v2.0
var CC_NODE_DRAW_SETUP ( )
Value:
do { \
CCASSERT(getShaderProgram(), "No shader program set for this node"); \
{ \
getShaderProgram()->use(); \
getShaderProgram()->setUniformsForBuiltins(_modelViewTransform); \
} \
} while(0)

Helpful macro that setups the GL server state, the correct GL program and sets the Model View Projection matrix.

Since
v2.0
local CC_NODE_DRAW_SETUP ( )
Value:
do { \
CCASSERT(getShaderProgram(), "No shader program set for this node"); \
{ \
getShaderProgram()->use(); \
getShaderProgram()->setUniformsForBuiltins(_modelViewTransform); \
} \
} while(0)

Helpful macro that setups the GL server state, the correct GL program and sets the Model View Projection matrix.

Since
v2.0
#define CC_POINT_PIXELS_TO_POINTS (   __pixels__)    Point( (__pixels__).x / CC_CONTENT_SCALE_FACTOR(), (__pixels__).y / CC_CONTENT_SCALE_FACTOR())

Converts a rect in pixels to points.

var CC_POINT_PIXELS_TO_POINTS (   var)    Point( (__pixels__).x / CC_CONTENT_SCALE_FACTOR(), (__pixels__).y / CC_CONTENT_SCALE_FACTOR())

Converts a rect in pixels to points.

local CC_POINT_PIXELS_TO_POINTS (   local)    Point( (__pixels__).x / CC_CONTENT_SCALE_FACTOR(), (__pixels__).y / CC_CONTENT_SCALE_FACTOR())

Converts a rect in pixels to points.

#define CC_POINT_POINTS_TO_PIXELS (   __points__)    Point( (__points__).x * CC_CONTENT_SCALE_FACTOR(), (__points__).y * CC_CONTENT_SCALE_FACTOR())

Converts a rect in points to pixels.

#define CC_PROFILER_DISPLAY_TIMERS ( )    do {} while (0)

Profiling Macros.

var CC_PROFILER_DISPLAY_TIMERS ( )    do {} while (0)

Profiling Macros.

local CC_PROFILER_DISPLAY_TIMERS ( )    do {} while (0)

Profiling Macros.

#define CC_PROFILER_PURGE_ALL ( )    do {} while (0)
var CC_PROFILER_PURGE_ALL ( )    do {} while (0)
local CC_PROFILER_PURGE_ALL ( )    do {} while (0)
#define CC_PROFILER_RESET (   __name__)    do {} while (0)
var CC_PROFILER_RESET (   var)    do {} while (0)
local CC_PROFILER_RESET (   local)    do {} while (0)
#define CC_PROFILER_RESET_CATEGORY (   __cat__,
  __name__ 
)    do {} while(0)
var CC_PROFILER_RESET_CATEGORY (   var,
  var 
)    do {} while(0)
local CC_PROFILER_RESET_CATEGORY (   local,
  local 
)    do {} while(0)
#define CC_PROFILER_RESET_INSTANCE (   __id__,
  __name__ 
)    do {} while(0)
var CC_PROFILER_RESET_INSTANCE (   var,
  var 
)    do {} while(0)
local CC_PROFILER_RESET_INSTANCE (   local,
  local 
)    do {} while(0)
#define CC_PROFILER_START (   __name__)    do {} while (0)
local CC_PROFILER_START (   local)    do {} while (0)
#define CC_PROFILER_START_CATEGORY (   __cat__,
  __name__ 
)    do {} while(0)
#define CC_PROFILER_START_INSTANCE (   __id__,
  __name__ 
)    do {} while(0)
var CC_PROFILER_START_INSTANCE (   var,
  var 
)    do {} while(0)
#define CC_PROFILER_STOP (   __name__)    do {} while (0)
var CC_PROFILER_STOP (   var)    do {} while (0)
local CC_PROFILER_STOP (   local)    do {} while (0)
#define CC_PROFILER_STOP_CATEGORY (   __cat__,
  __name__ 
)    do {} while(0)
var CC_PROFILER_STOP_CATEGORY (   var,
  var 
)    do {} while(0)
local CC_PROFILER_STOP_CATEGORY (   local,
  local 
)    do {} while(0)
#define CC_PROFILER_STOP_INSTANCE (   __id__,
  __name__ 
)    do {} while(0)
var CC_PROFILER_STOP_INSTANCE (   var,
  var 
)    do {} while(0)
local CC_PROFILER_STOP_INSTANCE (   local,
  local 
)    do {} while(0)
#define CC_RADIANS_TO_DEGREES (   __ANGLE__)    ((__ANGLE__) * 57.29577951f)

converts radians to degrees

var CC_RADIANS_TO_DEGREES (   var)    ((__ANGLE__) * 57.29577951f)

converts radians to degrees

#define CC_RECT_PIXELS_TO_POINTS (   __rect_in_pixels__)
Value:
Rect( (__rect_in_pixels__).origin.x / CC_CONTENT_SCALE_FACTOR(), (__rect_in_pixels__).origin.y / CC_CONTENT_SCALE_FACTOR(), \
(__rect_in_pixels__).size.width / CC_CONTENT_SCALE_FACTOR(), (__rect_in_pixels__).size.height / CC_CONTENT_SCALE_FACTOR() )

RETINA DISPLAY ENABLED.

Converts a rect in pixels to points

#define CC_RECT_POINTS_TO_PIXELS (   __rect_in_points_points__)
Value:
Rect( (__rect_in_points_points__).origin.x * CC_CONTENT_SCALE_FACTOR(), (__rect_in_points_points__).origin.y * CC_CONTENT_SCALE_FACTOR(), \
(__rect_in_points_points__).size.width * CC_CONTENT_SCALE_FACTOR(), (__rect_in_points_points__).size.height * CC_CONTENT_SCALE_FACTOR() )

Converts a rect in points to pixels.

#define CC_SIZE_PIXELS_TO_POINTS (   __size_in_pixels__)    Size( (__size_in_pixels__).width / CC_CONTENT_SCALE_FACTOR(), (__size_in_pixels__).height / CC_CONTENT_SCALE_FACTOR())
var CC_SIZE_PIXELS_TO_POINTS (   var)    Size( (__size_in_pixels__).width / CC_CONTENT_SCALE_FACTOR(), (__size_in_pixels__).height / CC_CONTENT_SCALE_FACTOR())
local CC_SIZE_PIXELS_TO_POINTS (   local)    Size( (__size_in_pixels__).width / CC_CONTENT_SCALE_FACTOR(), (__size_in_pixels__).height / CC_CONTENT_SCALE_FACTOR())
#define CC_SIZE_POINTS_TO_PIXELS (   __size_in_points__)    Size( (__size_in_points__).width * CC_CONTENT_SCALE_FACTOR(), (__size_in_points__).height * CC_CONTENT_SCALE_FACTOR())
var CC_SIZE_POINTS_TO_PIXELS (   var)    Size( (__size_in_points__).width * CC_CONTENT_SCALE_FACTOR(), (__size_in_points__).height * CC_CONTENT_SCALE_FACTOR())
local CC_SIZE_POINTS_TO_PIXELS (   local)    Size( (__size_in_points__).width * CC_CONTENT_SCALE_FACTOR(), (__size_in_points__).height * CC_CONTENT_SCALE_FACTOR())
#define CC_SWAP (   x,
  y,
  type 
)
Value:
{ type temp = (x); \
x = y; y = temp; \
}

simple macro that swaps 2 variables

local CC_SWAP (   local,
  local,
  local 
)
Value:
{ type temp = (x); \
x = y; y = temp; \
}

simple macro that swaps 2 variables

#define CC_SWAP16 (   i)    ((i & 0x00ff) << 8 | (i &0xff00) >> 8)
var CC_SWAP16 (   var)    ((i & 0x00ff) << 8 | (i &0xff00) >> 8)
local CC_SWAP16 (   local)    ((i & 0x00ff) << 8 | (i &0xff00) >> 8)
#define CC_SWAP32 (   i)    ((i & 0x000000ff) << 24 | (i & 0x0000ff00) << 8 | (i & 0x00ff0000) >> 8 | (i & 0xff000000) >> 24)
var CC_SWAP32 (   var)    ((i & 0x000000ff) << 24 | (i & 0x0000ff00) << 8 | (i & 0x00ff0000) >> 8 | (i & 0xff000000) >> 24)
local CC_SWAP32 (   local)    ((i & 0x000000ff) << 24 | (i & 0x0000ff00) << 8 | (i & 0x00ff0000) >> 8 | (i & 0xff000000) >> 24)
#define CC_SWAP_INT16_BIG_TO_HOST (   i)    ((CC_HOST_IS_BIG_ENDIAN == true)? (i): CC_SWAP16(i) )
var CC_SWAP_INT16_BIG_TO_HOST (   var)    ((CC_HOST_IS_BIG_ENDIAN == true)? (i): CC_SWAP16(i) )
#define
CC_SWAP_INT16_LITTLE_TO_HOST
(   i)    ((CC_HOST_IS_BIG_ENDIAN == true)? CC_SWAP16(i) : (i) )
#define CC_SWAP_INT32_BIG_TO_HOST (   i)    ((CC_HOST_IS_BIG_ENDIAN == true)? (i) : CC_SWAP32(i) )
var CC_SWAP_INT32_BIG_TO_HOST (   var)    ((CC_HOST_IS_BIG_ENDIAN == true)? (i) : CC_SWAP32(i) )
local CC_SWAP_INT32_BIG_TO_HOST (   local)    ((CC_HOST_IS_BIG_ENDIAN == true)? (i) : CC_SWAP32(i) )
#define
CC_SWAP_INT32_LITTLE_TO_HOST
(   i)    ((CC_HOST_IS_BIG_ENDIAN == true)? CC_SWAP32(i) : (i) )
#define CCASSERT (   cond,
  msg 
)
#define CCAssert   CCASSERT
var CCAssert   CCASSERT
local CCAssert   CCASSERT
#define CCRANDOM_0_1 ( )    ((float)rand()/RAND_MAX)

returns a random float between 0 and 1

var CCRANDOM_0_1 ( )    ((float)rand()/RAND_MAX)

returns a random float between 0 and 1

local CCRANDOM_0_1 ( )    ((float)rand()/RAND_MAX)

returns a random float between 0 and 1

#define CCRANDOM_MINUS1_1 ( )    ((2.0f*((float)rand()/RAND_MAX))-1.0f)

returns a random float between -1 and 1

var CCRANDOM_MINUS1_1 ( )    ((2.0f*((float)rand()/RAND_MAX))-1.0f)

returns a random float between -1 and 1

local CCRANDOM_MINUS1_1 ( )    ((2.0f*((float)rand()/RAND_MAX))-1.0f)

returns a random float between -1 and 1

#define CHECK_GL_ERROR_DEBUG ( )
var CHECK_GL_ERROR_DEBUG ( )
local CHECK_GL_ERROR_DEBUG ( )
#define DISALLOW_COPY_AND_ASSIGN (   TypeName)
Value:
TypeName(const TypeName&);\
void operator=(const TypeName&)
var DISALLOW_COPY_AND_ASSIGN (   var)
Value:
TypeName(const TypeName&);\
void operator=(const TypeName&)
local DISALLOW_COPY_AND_ASSIGN (   local)
Value:
TypeName(const TypeName&);\
void operator=(const TypeName&)
#define FLT_EPSILON   1.192092896e-07F
#define kRepeatForever   (UINT_MAX -1)
var kRepeatForever   (UINT_MAX -1)
local kRepeatForever   (UINT_MAX -1)

Variable Documentation

unsigned int CC_DLL
g_uNumberOfDraws
var g_uNumberOfDraws
local g_uNumberOfDraws