Skip to content
Iris-style effects for use in Cocos2D projects.
Objective-C C
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


Cocos2D Iris Effects

This project contains two classes which provide iris style effects for Cocos2D projects. The classes depend on the gfDrawFilledRect() and gfDrawInvertedCircle() functions contained in GFDrawingPrimitives.h.

This project has been updated to support Retina displays. (Thanks snakewa!)


This is a scene transition which presents a closing iris over the outgoing scene which subsequently opens on the incoming scene. The iris shape can be customized.

Basic usage:

   CGPoint center = ccp([CCDirector sharedDirector].winSize.width / 2, 
                        [CCDirector sharedDirector].winSize.height / 2);
   CCTransition* trans = [CCTransitionIris transitionWithDuration:2.0f 

   [[CCDirector sharedDirector] replaceScene:trans];

In this case we create a transition which will close over the outgoing scene with a circular shape. The screen will be filled entirely with black and will then open on the incoming scene.

The total duration of the closing and opening is 2 seconds.

Because we aren't using a sprite mask the transition draws the entire overlay using OpenGL calls for maximum crispness.

Here's a more advanced example:

   CGPoint center = ccp(300, 300);
   CCTransition* trans = [CCTransitionIris transitionWithDuration:2.0f 

   [[CCDirector sharedDirector] replaceScene:trans];

Here we use an offset point for the irisPosition. We could use the location of a touch or a character on screen.

The radius is still 0, however if we wanted the iris to not close completely we could increase that value. This could be used to highlight a particular onscreen element which will carry over from one scene to another.

The mask parameter is the name of a square sprite which will be used as the opening for the iris. The mask should be fully white at the edges and fully transparent in the center for best results. The sprite will be rendered in the color specified by the color parameter.

You can supply any size sprite for the mask, however higher resolution sprites will have a crisper edge when enlarged. If you just want a circle, omit the mask parameter and the iris will be drawn using OpenGL and will look much better.


TODO: Create spotlight

Other info

This has been tested with Cocos2D 0.99.5 Beta 3

I'm sure this code can be improved. Can't wait to hear your suggestions and corrections.

License: (GNU LGPL v3 with an extension)

If you use this for anything, let me know. I'd be super stoked.

You can’t perform that action at this time.