TweetFollow Us on Twitter

VBL Task Animation
Volume Number:5
Issue Number:2
Column Tag:C Workshop

Related Info: Vert. Retrace Mgr

VBL Task Animation

By Dick Chandler, Ben Lomond, CA

Note: Source code files accompanying article are located on MacTech CD-ROM or source code disks.

Dick Chandler is a Software Engineer at Apple Computer. His major interests are graphics and networks. This is his first article for MacTutor. In this article, Dick shows us how to do some cute animation of fingers drumming on the desktop!

What is a VBL task? A VBL or Vertical BLanking interrupt occurs when the beam of the display tube returns to the top of the screen. This happens on a regular interval (60 times a second). This is a convenient time to take care of recurrent system tasks such as: increment tickcount, check stack/heap boundries for collision, check and update cursor for movement, etc.

The information for executing each of these tasks is placed in a structure called appropriately enough a ‘VBLTask’ and is installed in the vertical retrace queue. Once this is done the system automatically executes the task at a regular interval.

You can place your own tasks on the queue for the system to execute. VBL tasks are a marvelous way of doing some types of graphic animation for the following reasons:

° You don’t have to worry about the speed of your animation on a faster/slower machine, the VBL will execute at the frequency of ticks you select (barring any unusually long tasks such as a disk inserted event hogging your time).

° You won’t get the flicker you see on the screen when trying to do moderately fast animation. This flicker occurs when the screen redraws itself half way through drawing your graphic.

° Plus once you’ve loaded a task on the queue, you needn’t worry about the task until you want to remove it.

Like almost everything else in programming, vbl tasks are easy once you’ve done one (after that its all copy and paste). This example program installs a vbl task which displays a number of icons sequentially. It could easily be modified to move the icons (or bitmaps) around the screen creating game graphics.

The main program is fairly straight forward. The only unusual thing you might find is the declaration of the ‘SetUpA5’ and ‘RestoreA5’ calls. If your task uses any global variables at all, you must insure that the A5 register contains the address of the boundary between the application globals and the application parameters. This is important since you can’t be sure from where the vbl task will be called.

The program basically opens a simple window, installs our vbl task, waits for a button click then exits after removing the task.

/*********************************************
 vblTask.c
*             an VBL task animation example
*
*       Written by Dick Chandler
*       
*This program is intentionally kept as 
*simple as possible, so that it could be 
*easily entered and/or understood.  
*Therefore there are no calls made to 
*check events nor any menus implemented.  ********************************************/

/*****  the only includes we’ll need  *****/
#include<types.h>
#include<quickdraw.h>
#include<windows.h>
#include<toolutils.h>
#include<events.h>
#include<Retrace.h>
#include<OSUtils.h>
#include<Strings.h>

/*****  define our own ‘A5’ routines  *****/
pascal void SetUpA5a() extern 0x2f0d;
pascal void SetUpA5b() extern 0x2a78;
pascal void SetUpA5c() extern 0x0904;

#define  SetUpA5() SetUpA5a(); SetUpA5b(), SetUpA5c()

/* just for readibility
#define NOT !

pascal void RestoreA5() extern 0x2a5f;

/*****  Globals  *****/
/* location of icons displayed */ 
Rect  iconRec = {30,30,62,62};
/* window rectangle */
Rect  boundsRect = {30,30,120,120};

/* tasks VBL record */ 
VBLTask StatusTask;
/* task routines */ 
void vblTask(), installTask(), removeTask();             
/* time between icons */
long    interval;

/*****  constants  *****/
#define FIRST_ICON 1000
#define LAST_ICON1005
#define MAX_NUMBER_ICONS  (LAST_ICON - FIRST_ICON) +1
#define SECONDS  60

/*********************************************
 the main program
********************************************/
int main()
{
WindowRecordeditWindowRecord;
WindowPtr editWindowPtr;

 InitGraf (&qd.thePort);  
 InitWindows();  
 /*
 * open a small, simple (and humble) 
 * window  
 */
 editWindowPtr = NewWindow(&editWindowRecord,&boundsRect, “”, true,
 1, (-1), false,  nil);
 SetPort( editWindowPtr );
 /*
 * set the interval time between icons  
 * and install our task on vbl queue   
 */
 interval = SECONDS/8;
 installTask( &StatusTask );
 /*
 * run until the button is clicked 
 */
 while  ( NOT Button() )  ;
 /*
 * clean up and exit
 */
 removeTask ( &StatusTask );
 CloseWindow(editWindowPtr);
 return 0;
}

The function ‘installTask’ sets up the required parameters for the vbl task. These parameters are passed via a ‘VBLTask’ record when the task is installed with the toolbox call ‘VInstall’.

° ‘vblAddr’ is the address of the function we’ve written and want the system to execute.

° ‘vblCount’ is the count, in ticks, to wait before calling the vblTask for the first time. We will reset this value everytime the task is executed if we want it to be reexecuted.

° ‘vblPhase’ allows you an additional offset before calling vblTask for the first time only. This would be useful if you wanted to install several graphic image tasks but did not want them to all look in sync.

° ‘qType’ designates the task a vbl task.

The function ‘removeTask’ simply removes the task from the queue with the toolbox call ‘VRemove’.

/************** NAME:installTask
*INPUT: a pointer to a VBL task record
*
*FUNCTION:installs our vblTask after 
*setting the vbl parameters 
********************************************/
void installTask( StatusTask )
VBLTask *StatusTaskPtr; 
{
 StatusTaskPtr->vblAddr   = vblTask;
 StatusTaskPtr->vblCount  = 10;
 StatusTaskPtr->vblPhase  = 0;
 StatusTaskPtr->qType     = vType;
 VInstall (StatusTaskPtr);
}

/************* NAME: removeTask
*INPUT: a pointer to a VBL task record
*
*FUNCTION:removes our vbl task
*******************************************/
void removeTask ( StatusTask )
VBLTask *StatusTaskPtr;
{
 VRemove(StatusTask);
}

‘vblTask’ is our routine which we loaded into the vbl record and installed. The routine sets up and later restores the A5 register so we can use our own global varibles. It is important to note that you cannot make any calls to the memory manager, and you cannot rely on locked handles being valid. These caveats are outlined in the ‘Vertical Retrace Manager’, Inside Macintosh V 1-3.

‘vblTask’ decides which of our icons to display next and then displays it if it finds the icon. Notice that we must reset the ‘vblCount’ each time or the task will not be called again.

/*******************
 NAME:vblTask    
*
*FUNCTIONS: our actual vbl task which gets 
*called every ‘interval’ ticks
********************************************/
void vblTask()
{
static long icons; 
Handle  tempIcon;
static long timeIcon = FIRST_ICON; 

 SetUpA5(); /* set up A5 register */
 icons = MAX_NUMBER_ICONS;
 StatusTask.vblCount = interval; timeIcon++; /*bumpicon */
 if( timeIcon > LAST_ICON ) 
 timeIcon = FIRST_ICON;
 tempIcon = GetIcon( timeIcon )
 if( tempIcon )
 PlotIcon( &iconRec, tempIcon );
 RestoreA5();  /* preserve A5 register */
}

The only resources you will need are icons to display. I attached six ‘drumming fingers’ icons [included in the source code disk.-Ed] I used in the program thanks to graphic artists Irene Welch and Shelley van Bronkhorst. However, you can attach any number of icons you wish as long as you change the defined constants ‘FIRST_ICON’ and ‘LAST_ICON’.

The program can be compiled and linked with the following commands. You can either paste in the resources with ResEdit, or derez and rez the resources into the application.

derez vblTaskResources Types.r SysTypes.r > vblTask.r
Rez Types.r SysTypes.r vblTask.r -o vblTask -a

SetFile -a B vblTask -c MOBY -t APPL

C -g vblTask.c
Link  vblTask.c.o 
 “HD:MPW:CLibraries:”CRuntime.o 
 “HD:MPW:CLibraries:”CInterface.o 
 -o vblTask

VBL Animation Problems

David Oster

Berkeley, CA

I am appalled by Dick Chandler’s article, “VBL Task Animation” in the February 1989 issue of MacTutor. Yes, his program works, but only because it is a top. Any real program that tries the technique he describes will fail miserably.

Look, his VBL task calls GetIcon and PlotIcon at VBL interrupt time. In his application, the main loop just busy waits for the user to press the Button. A real application would be calling GetNextEvent(), or doing something. For example, each time the user looks at a menu. When the menu goes away, it slams those bits back and deallocates the handle.

GetIcon calls GetResource(). What if the VBL task calls it while the Memory Manager is shuffling the heap to allocate memory for the main loop. Crash city. PlotIcon calls CopyBits(), which clips against the clipRgn and visRgn of the underlying grafPort. What if the VBL task calls it while the Memory Manager is shuffling the heap to allocate memory for the main loop? Crash city.

Even if your program is clean, you do not know what trap patches the user has installed: Maybe he is using an INIT that overrides some trap your program needs, and the override will do memory allocation. For example, Dick’s program calls Button() from its main loop, and many INITs override button, so they will get called while the mouse is down.

So, you can only do animation at interrupt time if you can guarantee that no user or system task will allocate memory in the main loop.

Dick’s program doesn’t guarantee this, since it calls Button() from its main loop, and Button() may have been overriden by an INIT. Since there is so little the main loop can safely do, you might as well give up on VBL Task animation, and just do animation in your main loop, busy waiting until TickCount changes to pause between animation frames.

 
AAPL
$97.67
Apple Inc.
+0.64
MSFT
$44.50
Microsoft Corpora
+0.10
GOOG
$589.02
Google Inc.
-4.33

MacTech Search:
Community Search:

Software Updates via MacUpdate

TinkerTool 5.3 - Expanded preference set...
TinkerTool is an application that gives you access to additional preference settings Apple has built into Mac OS X. This allows to activate hidden features in the operating system and in some of the... Read more
Audio Hijack Pro 2.11.0 - Record and enh...
Audio Hijack Pro drastically changes the way you use audio on your computer, giving you the freedom to listen to audio when you want and how you want. Record and enhance any audio with Audio Hijack... Read more
Intermission 1.1.1 - Pause and rewind li...
Intermission allows you to pause and rewind live audio from any application on your Mac. Intermission will buffer up to 3 hours of audio, allowing users to skip through any assortment of audio... Read more
Autopano Giga 3.6 - Stitch multiple imag...
Autopano Giga allows you to stitch 2, 20, or 2,000 images. Version 3.0 integrates impressive new features that will definitely make you adopt Autopano Pro or Autopano Giga: Choose between 9... Read more
Airfoil 4.8.7 - Send audio from any app...
Airfoil allows you to send any audio to AirPort Express units, Apple TVs, and even other Macs and PCs, all in sync! It's your audio - everywhere. With Airfoil you can take audio from any... Read more
Microsoft Remote Desktop 8.0.8 - Connect...
With Microsoft Remote Desktop, you can connect to a remote PC and your work resources from almost anywhere. Experience the power of Windows with RemoteFX in a Remote Desktop client designed to help... Read more
xACT 2.30 - Audio compression toolkit. (...
xACT stands for X Aaudio Compression Toolkit, an application that encodes and decodes FLAC, SHN, Monkey’s Audio, TTA, Wavpack, and Apple Lossless files. It also can encode these formats to MP3, AAC... Read more
Firefox 31.0 - Fast, safe Web browser. (...
Firefox for Mac offers a fast, safe Web browsing experience. Browse quickly, securely, and effortlessly. With its industry-leading features, Firefox is the choice of Web development professionals... Read more
Little Snitch 3.3.3 - Alerts you to outg...
Little Snitch gives you control over your private outgoing data. Track background activityAs soon as your computer connects to the Internet, applications often have permission to send any... Read more
Thunderbird 31.0 - Email client from Moz...
As of July 2012, Thunderbird has transitioned to a new governance model, with new features being developed by the broader free software and open source community, and security fixes and improvements... Read more

Latest Forum Discussions

See All

Reddme for iPhone - The Reddit Client (...
Reddme for iPhone - The Reddit Client 1.0 Device: iOS iPhone Category: News Price: $.99, Version: 1.0 (iTunes) Description: Reddme for iPhone is an iOS 7-optimized Reddit client that offers a refreshing new way to experience Reddit... | Read more »
Jacob Jones and the Bigfoot Mystery : Ep...
Jacob Jones and the Bigfoot Mystery : Episode 2 1.0 Device: iOS Universal Category: Games Price: $1.99, Version: 1.0 (iTunes) Description: Jacob Jones is back in Episode 2 of one of Apples 'Best of 2013' games and an App Store... | Read more »
New Trailer For Outcast Odyssey, A New K...
New Trailer For Outcast Odyssey, A New Kind of Card Battler Posted by Jennifer Allen on July 25th, 2014 [ permalink ] Out this Fall is a new kind of card battle game: Outcast Odyssey. | Read more »
Garfield: Survival of the Fattest Coming...
Garfield: Survival of the Fattest Coming to iOS this Fall Posted by Jennifer Allen on July 25th, 2014 [ permalink ] Who loves lasagna? Me. Also everyone’s favorite grumpy fat cat, Garfield. | Read more »
Happy Flock Review
Happy Flock Review By Andrew Fisher on July 25th, 2014 Our Rating: :: HERD IT ALL BEFOREUniversal App - Designed for iPhone and iPad Underneath the gloss of Happy Flock’s visuals is a game of very little substance. It’s cute, but... | Read more »
Square Register Updates Adds Offline Pay...
Square Register Updates Adds Offline Payments Posted by Ellis Spice on July 25th, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Looking For Group – Hearthstone’s Curse...
For the first time since its release (which has thankfully been a much shorter window for iPad players than their PC counterparts), Blizzard’s wildly successful Hearthstone: Heroes of Warcraft CCG is sporting some brand new content: the single... | Read more »
Poptile Review
Poptile Review By Jennifer Allen on July 25th, 2014 Our Rating: :: SIMPLY FUNUniversal App - Designed for iPhone and iPad Simple yet a little bit glorious, Poptile is a satisfying entertaining puzzle game with oodles of the ‘one... | Read more »
Modern Combat 5: Blackout Review
Modern Combat 5: Blackout Review By Brittany Vincent on July 25th, 2014 Our Rating: :: LESS QQ, MORE PEW PEWUniversal App - Designed for iPhone and iPad The fifth entry into the blockbuster Modern Combat series is what mobile... | Read more »
Watch and Share Mobile Gameplay Videos W...
Watch and Share Mobile Gameplay Videos With Kamcord Posted by Jennifer Allen on July 25th, 2014 [ permalink ] iPhone App - Designed for the iPhone, compatible with the iPad | Read more »

Price Scanner via MacPrices.net

iMacs on sale for $150 off MSRP, $250 off for...
Best Buy has iMacs on sale for up to $160 off MSRP for a limited time. Choose free home shipping or free instant local store pickup (if available). Prices are valid for online orders only, in-store... Read more
Mac minis on sale for $100 off MSRP, starting...
Best Buy has Mac minis on sale for $100 off MSRP. Choose free shipping or free instant local store pickup. Prices are for online orders only, in-store prices may vary: 2.5GHz Mac mini: $499.99 2.3GHz... Read more
Global Tablet Market Grows 11% in Q2/14 Notwi...
Worldwide tablet sales grew 11.0 percent year over year in the second quarter of 2014, with shipments reaching 49.3 million units according to preliminary data from the International Data Corporation... Read more
New iPhone 6 Models to Have Staggered Release...
Digitimes’ Cage Chao and Steve Shen report that according to unnamed sources in Apple’s upstream iPhone supply chain, the new 5.5-inch iPhone will be released several months later than the new 4.7-... Read more
New iOS App Helps People Feel Good About thei...
Mobile shoppers looking for big savings at their favorite stores can turn to the Goodshop app, a new iOS app with the latest coupons and deals at more than 5,000 online stores. In addition to being a... Read more
Save on 5th generation refurbished iPod touch...
The Apple Store has Apple Certified Refurbished 5th generation iPod touches available starting at $149. Apple’s one-year warranty is included with each model, and shipping is free. Many, but not all... Read more
What Should Apple’s Next MacBook Priority Be;...
Stabley Times’ Phil Moore says that after expanding its iMac lineup with a new low end model, Apple’s next Mac hardware decision will be how it wants to approach expanding its MacBook lineup as well... Read more
ArtRage For iPhone Painting App Free During C...
ArtRage for iPhone is currently being offered for free (regularly $1.99) during Comic-Con San Diego #SDCC, July 24-27, in celebration of the upcoming ArtRage 4.5 and other 64-bit versions of the... Read more
With The Apple/IBM Alliance, Is The iPad Now...
Almost since the iPad was rolled out in 2010, and especially after Apple made a 128 GB storage configuration available in 2012, there’s been debate over whether the iPad is a serious tool for... Read more
MacBook Airs on sale starting at $799, free s...
B&H Photo has the new 2014 MacBook Airs on sale for up to $100 off MSRP for a limited time. Shipping is free, and B&H charges NY sales tax only. They also include free copies of Parallels... Read more

Jobs Board

*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
Sr Software Lead Engineer, *Apple* Online S...
Sr Software Lead Engineer, Apple Online Store Publishing Systems Keywords: Company: Apple Job Code: E3PCAK8MgYYkw Location (City or ZIP): Santa Clara Status: Full Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
*Apple* Solutions Consultant (ASC) - Apple (...
**Job Summary** The ASC is an Apple employee who serves as an Apple brand ambassador and influencer in a Reseller's store. The ASC's role is to grow Apple Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.