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
$101.32
Apple Inc.
+0.74
MSFT
$45.15
Microsoft Corpora
-0.07
GOOG
$582.56
Google Inc.
-0.81

MacTech Search:
Community Search:

Software Updates via MacUpdate

Garmin Express 3.2.17.0 - Manage your Ga...
Garmin Express is your essential tool for managing your Garmin devices. Update maps, golf courses and device software. You can even register your device. Update maps Update software Register your... Read more
Audio Hijack Pro 2.11.1 - 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
calibre 2.0.0 - Complete e-library manag...
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
Apple iMovie 10.0.5 - Edit personal vide...
With an all-new design, Apple iMovie lets you enjoy your videos like never before. Browse your clips more easily, instantly share your favorite moments, and create beautiful HD movies and Hollywood-... Read more
Apple Keynote 6.2.2 - Apple's prese...
Apple Keynote makes it simple to create and deliver beautiful presentations. Powerful tools and dazzling effects bring your ideas to life. You can work seamlessly between Mac and iOS devices. And... Read more
Apple Numbers 3.2.2 - Apple's sprea...
With Apple Numbers, sophisticated spreadsheets are just the start. The whole sheet is your canvas. Just add dramatic interactive charts, tables, and images that paint a revealing picture of your data... Read more
OpenOffice 4.1.1 - Free and open-source...
OpenOffice.org is both an Open Source product and a project. The product is a multi-platform office productivity suite. It includes the key desktop applications, such as a word processor,... Read more
Pages 5.2.2 - Apple's word processo...
Apple Pages is a powerful word processor that gives you everything you need to create documents that look beautiful. And read beautifully. It lets you work seamlessly between Mac and iOS devices. And... Read more
Quicken 2015 2.0.1 - Complete personal f...
The new Quicken 2015 helps you manage all your personal finances in one place, so you can see where you're spending and where you can save. Quicken automatically categorizes your financial... Read more
CleanMyMac 2.2.7 - Delete files that was...
CleanMyMac makes space for the things you love. Sporting a range of ingenious new features, CleanMyMac 2 lets you safely and intelligently scan and clean your entire system, delete large, unused... Read more

Latest Forum Discussions

See All

Trolls vs Vikings Update Adds Over One H...
Trolls vs Vikings Update Adds Over One Hundred Levels, Reduces Item Cost, and More Posted by Ellis Spice on August 22nd, 2014 [ permalink ] | Read more »
SNK Celebrates the 20th Anniversary of T...
SNK Celebrates the 20th Anniversary of The King of Fighters With a Big Sale Posted by Ellis Spice on August 22nd, 2014 [ permalink ] | Read more »
It Came From Canada: Star Wars: Commande...
With a brand new Star Wars trilogy on the horizon, prepare yourselves for Disney and George Lucas’s space fantasy throwback to be more omnipresent than ever before. So it should come as no surprise that new adventures in that galaxy far, far away... | Read more »
Swing Copters Review
Swing Copters Review By Jordan Minor on August 22nd, 2014 Our Rating: :: DIE TRYINGUniversal App - Designed for iPhone and iPad The creator of Flappy Bird is back with a vengeance.   | Read more »
Beam Me an Update Scotty – Star Trek Tre...
Beam Me an Update Scotty – Star Trek Trexels Receives its Biggest Update Yet Posted by Jessica Fisher on August 22nd, 2014 [ permalink ] | Read more »
The Outcast Review
The Outcast Review By Nadia Oxford on August 22nd, 2014 Our Rating: :: HANDS OFF. WAY OFF.Universal App - Designed for iPhone and iPad It’s easy to see what The Outcast is trying for, but its execution needs a lot of work.   | Read more »
HeroCraft Unveils New iOS Game, Marble D...
HeroCraft Unveils New iOS Game, Marble Duel Posted by Jessica Fisher on August 22nd, 2014 [ permalink ] HeroCraft is developing a new chain popper game called Marble Duel, wh | Read more »
Brain+ Review
Brain+ Review By Nadia Oxford on August 22nd, 2014 Our Rating: :: DIM BULBUniversal App - Designed for iPhone and iPad Brain+ is just another entry in an over-saturated brain-training marketplace – and not a particularly fun entry... | Read more »
The Witcher Battle Arena – New Gameplay...
The Witcher Battle Arena – New Gameplay Trailer Revealed Posted by Jessica Fisher on August 22nd, 2014 [ permalink ] Based in the Witcher universe, | Read more »
Max Gentlemen Review
Max Gentlemen Review By Jennifer Allen on August 22nd, 2014 Our Rating: :: OUTSTAYING ITS WELCOMEiPhone App - Designed for the iPhone, compatible with the iPad Max Gentlemen seems pretty quirky initially but that appeal wears thin... | Read more »

Price Scanner via MacPrices.net

Updated Mac Price Trackers
We’ve updated our Mac Price Trackers with the latest information on prices, bundles, and availability on systems from Apple’s authorized internet/catalog resellers: - 15″ MacBook Pros - 13″ MacBook... Read more
Leftover 15-inch 2.0GHz Retina MacBook Pros a...
B&H Photo has leftover previous-generation 15″ 2.0GHz Retina MacBook Pros now available for $1599 including free shipping plus NY sales tax only. Their price is $400 off original MSRP. B&H... Read more
Pro.Calendar – New Productivity App for iPad...
Austin, Texas based mobile business and productivity app developer LightArrow, Inc. has announced Pro.Calendar, a powerful and intuitive calendar app with eight versatile calendar options including... Read more
SanDisk Ultra II SSD — Supercharge Your Syste...
SanDisk Corporation has announced the new SanDisk Ultra II SSD with enhanced SSD Dashboard. The new drive is designed to deliver a cost-effective and easy upgrade solution for PC owners looking to... Read more
Samsung and Barnes & Noble Introduce New...
Samsung Electronics America and NOOK Media, a subsidiary of Barnes & Noble, Inc. have announced the introduction of the new Samsung Galaxy Tab 4 NOOK, a 7-inch tablet combining Samsung’s leading... Read more
21-inch iMacs on sale for up to $150 off MSRP
B&H Photo has 21″ iMacs on sale for up to $150 off MSRP including free shipping plus NY sales tax only. B&H will also include a free copy of Parallels Desktop software: - 21″ 2.7GHz iMac: $... Read more
27-inch 3.2GHz iMac on sale for $1698, save $...
Abt has the 27″ 3.2GHz iMac on sale for $1698 including free shipping. Their price is $101 off MSRP. Read more
Mac Backup Guru 2.0 Drive Backup/Cloneing Uti...
Mac Backup Guru developer MacDaddy has released Mac Backup Guru 2.0, offering new and enhanced advanced features, such as bootable backups, synchronised volumes and folders, and a Snapshot mode that... Read more
Operate GE’s New Free-Standing KItchen Range...
Think you accidentally left the oven on? Switch it off while on the go. The new free-standing Profile™ Series gas and electric ranges are GE’s second cooking appliances, following their wall oven, to... Read more
Parallels Announces Parallels Desktop 10 for...
The no. 1-selling software for running Windows applications on a Mac becomes an even easier choice for millions of consumers and IT professionals worldwide with the launch of the most powerful... Read more

Jobs Board

Position Opening at *Apple* - Apple (United...
…customers purchase our products, you're the one who helps them get more out of their new Apple technology. Your day in the Apple Store is filled with a range of Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** As businesses discover the power of Apple computers and mobile devices, it's your job - as a Solutions Engineer - to show them how to introduce these Read more
Position Opening at *Apple* - Apple (United...
**Job Summary** At the Apple Store, you connect business professionals and entrepreneurs with the tools they need in order to put Apple solutions to work in their 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
*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
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.