Search code examples
ioscocos2d-iphonechipmunk

Where to find reference to functions, which come with Chipmunk?

I'm new to iPhone development. I installed cocos2d with chipmunk and try to make a simple project from some tutorial.

When I encounter chipmunk functions (like cpSpaceAddShape, cpSegmentShapeNew, etc.) where can I find them documented?

Chipmunk API documentation seems to contain only class reference... so can't I find the functions documented in Chipmunk API reference? Where then?

Solution

  • Since you said "class reference" you were probably looking at the Objective-Chipmunk API Reference which is for the commercial Objective-C port of Chipmunk.

    The Chipmunk functions are all documented in the Chipmunk API Reference created by doxygen. I haven't been able to find it online however (same goes for Box2D API Reference) so I started hosting these API References myself.

    For example, here's the documentation for cpSpaceAddShape and cpSegmentShapeNew (at the bottom).