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
$99.26
Apple Inc.
+0.08
MSFT
$45.91
Microsoft Corpora
+0.01
GOOG
$569.90
Google Inc.
+1.63

MacTech Search:
Community Search:

Software Updates via MacUpdate

Cocktail Family License (5 Macs) 7.6.1 -...
Cocktail is a general purpose utility for OS X that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more
Cocktail 8.0 Beta 2 - General maintenanc...
Cocktail is a general purpose utility for OS X that lets you clean, repair and optimize your Mac. It is a powerful digital toolset that helps hundreds of thousands of Mac users around the world get... Read more
QuickBooks 2015 16.0.0.1352 R1 - Financi...
QuickBooks 2015 helps you manage your business easily and efficiently. Organize your finances all in one place, track money going in and out of your business, and spot areas where you can save.... Read more
Mac DVDRipper Pro 5.0.1 - Copy, backup,...
Mac DVDRipper Pro is the DVD backup solution that lets you protect your DVDs from scratches, save your batteries by reading your movies from your hard disk, manage your collection with just a few... Read more
Apple OS X bash Update 1.0 - Fix for sec...
The OS X bash Update fixes a security flaw in the bash UNIX shell on OS X 10.9.5 (also on OS X 10.8 and 10.7 [see Related Links below]). OS X 10.9.5 or later Downloads for OS X 10.8 and OS X 10.7 in... Read more
SyncTwoFolders 2.0.5 - Syncs two user-sp...
SyncTwoFolders simply synchronizes two folders. It supports synchronization across mounted network drives and it is a possibility to run a simulation showing in a log what will be done. Please visit... Read more
FinderPop 2.5.7 - Classic Mac utility, n...
FinderPop is a Universal preference pane that extends OS X's contextual menus using a FinderPop Items folder much as the Apple Menu Items folder used to do for the Apple menu. It has other features... Read more
VueScan 9.4.45 - Scanner software with a...
VueScan is a scanning program that works with most high-quality flatbed and film scanners to produce scans that have excellent color fidelity and color balance. VueScan is easy to use, and has... Read more
LibreOffice 4.3.2.2 - Free Open Source o...
LibreOffice is an office suite (word processor, spreadsheet, presentations, drawing tool) compatible with other major office suites. The Document Foundation is coordinating development and... Read more
calibre 2.4 - Complete e-library managem...
Calibre is a complete e-book library manager. Organize your collection, convert your books to multiple formats, and sync with all of your devices. Let Calibre be your multi-tasking digital... Read more

Latest Forum Discussions

See All

The Maze Runner Review
The Maze Runner Review By Lee Hamlet on October 2nd, 2014 Our Rating: :: A NICE CHANGE OF PACEUniversal App - Designed for iPhone and iPad The Maze Runner is a surprisingly enjoyable movie tie-in that will succeed in keeping... | Read more »
RPG Soul of Deva (Games)
RPG Soul of Deva 1.0.0 Device: iOS Universal Category: Games Price: $3.99, Version: 1.0.0 (iTunes) Description: SPECIAL PRICE56% OFF(USD 8.99 -> USD 3.99)!!! Demons attack humans, and humans live in fear of them...Set off on a... | Read more »
Banner Saga (Games)
Banner Saga 1.0.17 Device: iOS Universal Category: Games Price: $9.99, Version: 1.0.17 (iTunes) Description: NOTE: The Banner Saga does NOT run on iPhone 4. iPhone 4S and more modern devices recommended. | Read more »
Beatbuddy HD (Games)
Beatbuddy HD 1.0.2 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.2 (iTunes) Description: **IMPORTANT** Beatbuddy runs only on iPhone 6, 6 Plus, 5, 5c, 5s, iPad 4, iPad Mini Retina and iPad Air. | Read more »
Spirits of Spring (Games)
Spirits of Spring 1.0.1 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.1 (iTunes) Description: From the creators of the award-winning empathy game, Papo & Yo, comes a tale about finding strength. | Read more »
I am a brave knight (Games)
I am a brave knight 1.0 Device: iOS Universal Category: Games Price: $.99, Version: 1.0 (iTunes) Description: Do you have ten minutes to live a life? | Read more »
iKeywi - Customizable 5-Row Keyboard (U...
iKeywi - Customizable 5-Row Keyboard 1.0 Device: iOS Universal Category: Utilities Price: $.99, Version: 1.0 (iTunes) Description: Want to add an extra row to your iPhone/iPad? One of the most popular keyboard extension in iOS... | Read more »
Manage Your Cloud – Wunderlist Now Suppo...
Manage Your Cloud – Wunderlist Now Supports Dropbox Posted by Jessica Fisher on October 1st, 2014 [ permalink ] Universal App - Designed for iPhone and iPad | Read more »
Nexticy Review
Nexticy Review By Jennifer Allen on October 1st, 2014 Our Rating: :: IDEAL FORM CREATIONiPad Only App - Designed for the iPad Nexticy allows you to make your own forms for research purposes or to organize your business better. It’s... | Read more »
Tiny Troopers: Alliance Marches onto the...
Tiny Troopers: Alliance Marches onto the App Store Tomorrow Posted by Jessica Fisher on October 1st, 2014 [ permalink ] Tiny Troopers: Alliance, by Kukouri, is a | Read more »

Price Scanner via MacPrices.net

Apple drops prices on refurbished 27-inch iMa...
The Apple Store has dropped prices on Apple Certified Refurbished 27″ iMacs, now available for up to $340 off the cost of new models. Apple’s one-year warranty is standard, and shipping is free: - 27... Read more
Logitech Type+ iPad Air Keyboard Case: Laptop...
If you want to make your iPad Air look and feel more like a laptop for productivity use, as well as protect it from impacts, spills, and scratches while on the move, the new Logitech Type+, a... Read more
ASUS, Lenovo, and Amazon Slug It Out For Tabl...
According to market intelligence firm ABI Research, Apple and Samsung have led the touchscreen tablet market by a substantial margin since Apple energized the category back in 2010. However, ABI says... Read more
Branded Tablet Growth Expected to Disappoint...
ABI Research says the 200 million annual shipments milestone for branded tablets continues to elude OEM vendors, and overall growth for 2014 is set to come in at a disappointing 2.5 percent. Apple... Read more
Amazon offers 13-inch MacBook Air for $899, $...
Amazon.com has the 13″ 1.4GHz 128GB MacBook Air on sale for $100 off MSRP including free shipping: - 13″ 1.4GHz 128GB MacBook Air: $899.99 Read more
Apple resting On Its iPhone Laurels? – The ‘B...
Apple calls its new iPhone 6 and 6 Plus “The Biggest Advancements in iPhone History,” but does reality live up to the hype? “Seldom have so many waited so breathlessly for so little,” tweeted veteran... Read more
Roundup of Apple Mac and iPad Education disco...
Purchase a new Mac or iPad at The Apple Store for Education and take up to $300 off MSRP. All teachers, students, and staff of any educational institution qualify for the discount. Shipping is free,... Read more
Apple Boycotts German Magazine Computer Bild...
Apple has revoked its PR accreditation of Germany’s Computer Bild, Europe’s best-selling PC magazine, in reaction to Bild’s posting of a “#Bentgate” YouTube video. Axel Telzerow, editor in chief of... Read more
iPhone 6 & iPhone 6 Plus Available in Chi...
Apple has announced that iPhone 6 and iPhone 6 Plus will be available in China beginning Friday, October 17 from the Apple Online Store (http://www.apple.com), Apple’s retail stores, and an expansive... Read more
MacBook Airs on sale for $100 off MSRP, start...
Best Buy has the new 2014 MacBook Airs on sale for $100 off MSRP on their online store. Choose free home shipping or free local store pickup (if available). Prices valid for online orders only, in-... Read more

Jobs Board

*Apple* Retail - Multiple Positions (US) - A...
Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, you're also the Read more
*Apple* Retail - Multiple Positions (US) - A...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
Senior Event Manager, *Apple* Retail Market...
…This senior level position is responsible for leading and imagining the Apple Retail Team's global event strategy. Delivering an overarching brand story; in-store, 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
Project Manager / Business Analyst, WW *Appl...
…a senior project manager / business analyst to work within our Worldwide Apple Fulfillment Operations and the Business Process Re-engineering team. This role will work Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.