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.

 

Community Search:
MacTech Search:

Software Updates via MacUpdate

pwSafe 4.0.1 - Secure password managemen...
pwSafe provides simple and secure password management across devices and computers. pwSafe uses iCloud to keep your password databases backed-up and synced between Macs and iOS devices. It is... Read more
WALTR 1.5.4 - Drag-and-drop any media fi...
WALTR is designed to make it easy to upload and convert any music or video file to an iPad or iPhone format for native playback. It supports a huge variety of media file types, including MP3, MP4,... Read more
Audio Hijack 3.1 - Record and enhance au...
Audio Hijack (was 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... Read more
PopChar 7.1 - Floating window shows avai...
We're also selling a 5-license family pack for only $25.99! PopChar helps you get the most out of your font collection. With its crystal-clear interface, PopChar X provides a frustration-free way to... Read more
BBEdit 11.1.1 - Powerful text and HTML e...
BBEdit is the leading professional HTML and text editor for the Mac. Specifically crafted in response to the needs of Web authors and software developers, this award-winning product provides a... Read more
Picasa 3.9.139 - Organize, edit, and sha...
Picasa and Picasa Web Albums allows you to organize, edit, and upload your photos to the Web from your computer in quick, simple steps. Arrange your photos into folders and albums and erase their... Read more
Mac DVDRipper Pro 5.0.5 - 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
NetShade 6.2 - Browse privately using an...
This promotion is for NetShade and 1 year of Proxy and VPN services NetShade is an anonymous proxy and VPN app+service for Mac. Unblock your Internet through NetShade's high-speed proxy and VPN... Read more
CrossOver 14.1.3 - Run Windows apps on y...
CrossOver can get your Windows productivity applications and PC games up and running on your Mac quickly and easily. CrossOver runs the Windows software that you need on Mac at home, in the office,... Read more
Little Snitch 3.5.3 - Alerts you about o...
Little Snitch gives you control over your private outgoing data. Track background activity As soon as your computer connects to the Internet, applications often have permission to send any... Read more

Block Fortress has a Big New Update for...
Block Fortress is a survival-style game that's as fun as it is blocky. It's also just gotten a rather sizeable update that adds a lot more cool stuff. [Read more] | Read more »
Simple and Surreal Star Base Sim rymdkap...
I really like rymdkapsel. Not just because I'm a sucker for games that are cleverly simple or highly stylisitc, but because it's fun and challenging. Actually it's extremely challenging, which is why I was excited to learn that it's getting a couple... | Read more »
Check out the anticipated Angel Stone in...
Fincon has finally revealed Angel Stone in action in the first ever official gameplay trailer for the anticipated hack and slasher. Angel Stone is set in a post-apocalyptic world in which humanity is in danger of being wiped out by the demonic... | Read more »
Moleskine Timepage is an All-New Calenda...
Moleskine Timepage is a bit of a departure for the notebook manufacturer (since it has little to do with notebooks), but it certainly carries their simple and elegant style quite well. [Read more] | Read more »
Jog on Over and Check Out the New Runtas...
Runtastic has put out a fair number of apps to help you sleep, track excercise, and train various parts of your body. Now it's time for your legs to have their own time in the spotlight with Runtastic Leg Trainer. [Read more] | Read more »
It's Lights Out in the Upcoming Pla...
Ember’s Journey is a stark puzzle platformer with a twist: the entire game is played in darkness. The only light you can see by is the one emanating from your own character. [Read more] | Read more »
MooVee - Your Movies Guru (Entertainmen...
MooVee - Your Movies Guru 1.0 Device: iOS iPhone Category: Entertainment Price: $1.99, Version: 1.0 (iTunes) Description: MooVee helps you effortlessly manage your movies, on your iPhone. | Read more »
Geometry Wars 3: Dimensions (Games)
Geometry Wars 3: Dimensions 1.0.0 Device: iOS Universal Category: Games Price: $4.99, Version: 1.0.0 (iTunes) Description: Enjoy the next chapter in the award-winning Geometry Wars franchise and enjoy stunning, console-quality... | Read more »
CHAOS RINGS Ⅲ (Games)
CHAOS RINGS Ⅲ 1.0.0 Device: iOS Universal Category: Games Price: $19.99, Version: 1.0.0 (iTunes) Description: The newest addition to the popular smartphone RPG series is finally here! ・CHAOS RINGS Overview | Read more »
The Popular Insight Series of Travel Gui...
Getting around in a country when you can't understand the primary language can be tough. Fortunately there are several options available to help wold travellers with the important stuff like giving directions to a cab driver or asking where the... | Read more »

Price Scanner via MacPrices.net

Top Markets Saturation To Slow Global Smartph...
According to a new mobile phone forecast from the International Data Corporation (IDC) Worldwide Quarterly Mobile Phone Tracker, smartphone shipments are expected to grow 11.3% in 2015 — down from 27... Read more
Apple refurbished 2014 13-inch Retina MacBook...
The Apple Store has Apple Certified Refurbished 2014 13″ Retina MacBook Pros available for up to $400 off original MSRP, starting at $979. An Apple one-year warranty is included with each model, and... Read more
What Would the ideal Apple Productivity Platf...
For the past four years I’ve kept a foot in both the Mac and iPad camps respectively. my daily computing hours divided about 50/50 between the two devices with remarkable consistency. However, there’... Read more
PageMeUp 1.2.1 Ten Dollar Page Layout Applica...
Paris, France-based Softobe, an OS X software development company, has announced that their PageMeUp v. 1.2.1, is available on the Mac App Store for $9.99. The license can be installed on up to 5... Read more
Eight New Products For USB Type-C Application...
Fresco Logic, specialists in advanced connectivity technologies and ICs, has introduced two new product families targeting the Type-C connector recently introduced across a number of consumer... Read more
Scripps National Spelling Bee Launches Buzzwo...
Scripps National Spelling Bee fans can monitor the action at the 2015 Spelling Bee with the new Buzzworthy app for iOS, Android and Windows mobile devices. The free Buzzworthy app provides friendly... Read more
13-inch 2.5GHz MacBook Pro on sale for $120 o...
B&H Photo has the 13″ 2.5GHz MacBook Pro on sale for $979 including free shipping plus NY sales tax only. Their price is $120 off MSRP, and it’s the lowest price for this model (except for Apple’... Read more
27-inch 3.3GHz 5K iMac on sale for $1899, $10...
B&H Photo has the new 27″ 3.3GHz 5K iMac on sale for $1899.99 including free shipping plus NY tax only. Their price is $100 off MSRP. Read more
Save up to $50 on iPad Air 2, NY tax only, fr...
B&H Photo has iPad Air 2s on sale for up to $50 off MSRP including free shipping plus NY sales tax only: - 16GB iPad Air 2 WiFi: $469 $30 off - 64GB iPad Air 2 WiFi: $549.99 $50 off - 128GB iPad... Read more
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

Jobs Board

*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
Program Manager, *Apple* Community Support...
**Job Summary** Apple Support Communities ( discussions. apple .com) helps customers get the most from their Apple products and services by providing access to Read more
Senior Data Scientist, *Apple* Retail - Onl...
**Job Summary** Apple Retail - Online sells Apple products to customers around the world. In addition to selling Apple products with unique services such as iPad Read more
*Apple* Solutions Consultant - Retail Sales...
**Job Summary** As an Apple Solutions Consultant (ASC) you are the link between our customers and our products. Your role is to drive the Apple business in a retail Read more
*Apple* Watch SW Application Project Manager...
**Job Summary** The Apple Watch software team is looking for an Application Engineering Project Manager to work on new projects for Apple . The successful candidate Read more
All contents are Copyright 1984-2011 by Xplain Corporation. All rights reserved. Theme designed by Icreon.