@@ -12,6 +12,7 @@ version 0.7.2 - xxx . Demos: organized tests folder (issue #280) . Demos: Atlas and Sprites uses TintBy and TintTo (issue #204) . Director: Attach uses 'bounds' not 'frame' (issue #233) + . Documentation: API doc documents free functions (issue #314) . Menu: an empty menu can be crated (issue #277) . Particles: Use by default fire.pvr (issue #276) . Particles: resetSystem actually resets the system (issue #252) CHANGELOG @@ -12,23 +12,34 @@ * */ +/** + @file + Drawing OpenGL ES primitives. + - drawPoint + - drawLine + - drawPoly + - drawCircle + + You can change the color, width and other property by calling the + glColor4ub(), glLineWitdh(), etc.. + */ /** draws a point given x and y coordinate - * @warning This function needs optimizations. Try not to use it. + * @warning This function needs optimizations. */ void drawPoint( float x, float y ); /** draws a line given x1,y1 and x2,y2 coordinates - * @warning This function needs optimizations. Try not to use it. + * @warning This function needs optimizations. */ void drawLine(float x1, float y1, float x2, float y2); /** draws a poligon given a pointer to float coordiantes and the number of vertices - * @warning This function needs optimizations. Try not to use it. + * @warning This function needs optimizations. */ void drawPoly( float *poli, int points ); /** draws a circle given the center, radius and number of segments - * @warning This function needs optimizations. Try not to use it. + * @warning This function needs optimizations. */ void drawCircle( float x, float y, float radius, float angle, int segs); cocos2d/Primitives.h @@ -26,6 +26,19 @@ * Code based on Chipmunk's CGPoint.h file */ +/** + @file + CGPoint extentions based on Chipmunk's cpVect file. + These extensions work both with CGPoint and cpVect. + + Examples: + - CGPointAdd( CGPointMake(1,1), CGPointMake(2,2) ); // CG way (prefered way) + - cpvadd( cpv(1,1), cpv(2,2) ); // chipmunk's way + - CGPointAdd( cpv(1,1), cpv(2,2) ); // mixing chipmunk and CG (avoid) + - cpvadd( CGPointMake(1,1), CGPointMake(2,2) ); // mixing chipmunk and CG (avoid) + */ + + #import <CoreGraphics/CGGeometry.h> #import <math.h> @@ -33,8 +46,7 @@ @return CGPoint @since v0.7.2 */ -static inline CGPoint -CGPointAdd(const CGPoint v1, const CGPoint v2) +static inline CGPoint CGPointAdd(const CGPoint v1, const CGPoint v2) { return CGPointMake(v1.x + v2.x, v1.y + v2.y); } cocos2d/Support/CGPointExtension.h @@ -7,6 +7,11 @@ //#ifndef TGA_LIB //#define TGA_LIB +/** + @file + TGA image support + */ + enum { TGA_OK, TGA_ERROR_FILE_OPEN, @@ -32,19 +37,19 @@ typedef struct sImageTGA { int flipped; } tImageTGA; -// load the image header fields. We only keep those that matter! +/// load the image header fields. We only keep those that matter! void tgaLoadHeader(FILE *file, tImageTGA *info); -// loads the image pixels. You shouldn't call this function directly +/// loads the image pixels. You shouldn't call this function directly void tgaLoadImageData(FILE *file, tImageTGA *info); -// this is the function to call when we want to load an image +/// this is the function to call when we want to load an image tImageTGA * tgaLoad(const char *filename); -// converts RGB to greyscale +// /converts RGB to greyscale void tgaRGBtogreyscale(tImageTGA *info); -// releases the memory used for the image +/// releases the memory used for the image void tgaDestroy(tImageTGA *info); //#endif // TGA_LIB cocos2d/Support/TGAlib.h @@ -33,9 +33,11 @@ * SOFTWARE. */ -/* Based on Chipmunk cpArray. - ccArray stores ids and retains/releases them appropriately. - And it's way faster than NSMutableArray. +/** + @file + Based on Chipmunk cpArray. + ccArray stores ids and retains/releases them appropriately. + And it's way faster than NSMutableArray. */ #ifndef CC_ARRAY_H cocos2d/Support/ccArray.h @@ -8,7 +8,14 @@ #import <OpenGLES/ES1/gl.h> +/** + @file + cocos2d OpenGL GLU implementation + */ + +/** OpenGL gluLookAt implementation */ void gluLookAt(float eyeX, float eyeY, float eyeZ, float lookAtX, float lookAtY, float lookAtZ, float upX, float upY, float upZ); +/** OpenGL gluPerspective implementation */ void gluPerspective(GLfloat fovy, GLfloat aspect, GLfloat zNear, GLfloat zFar); #endif /* __COCOS2D_GLU_H */ cocos2d/Support/glu.h @@ -317,13 +317,13 @@ EXTRACT_PRIVATE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. -EXTRACT_STATIC = NO +EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. -EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_CLASSES = NO # This flag is only useful for Objective-C code. When set to YES local # methods, which are defined in the implementation section but not in doxygen.config 8560f13b0ea2fb78eb7c2da3aeb5b4eae46dbad3 ricardoquesada ricardoquesada@79afc9a6-2f50-0410-804d-6f1bdedaafc9 http://github.com/funkaster/cocos2d-iphone/commit/cbf5af21c08c5c6363aa465ec957ac7325a3c5ef cbf5af21c08c5c6363aa465ec957ac7325a3c5ef 2009-04-12T00:47:26-07:00 2009-04-12T00:47:26-07:00 fixed issue #314 78ecfc2b75b0f6e672a727f590447fadeee3f1c0 ricardoquesada ricardoquesada@79afc9a6-2f50-0410-804d-6f1bdedaafc9