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

Sketch 47.1 - Design app for UX/UI for i...
Sketch is an innovative and fresh look at vector drawing. Its intentionally minimalist design is based upon a drawing space of unlimited size and layers, free of palettes, panels, menus, windows, and... Read more
Cocktail 11.0.1 - General maintenance an...
Cocktail is a general purpose utility for macOS 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
Path Finder 7.6.1 - Powerful, award-winn...
Path Finder makes you a master of file management. Take full control over your file system. Save your time: compare and synchronize folders, view hidden files, use Dual Pane and full keyboard... Read more
Slack 2.8.2 - Collaborative communicatio...
Slack is a collaborative communication app that simplifies real-time messaging, archiving, and search for modern working teams. Version 2.8.2: A small release containing nothing but another Electron... Read more
Smultron 10.0.2 - Easy-to-use, powerful...
Smultron 10 is an elegant and powerful text editor that is easy to use. You can use Smultron 10 to create or edit any text document. Everything from a web page, a note or a script to any single piece... Read more
Capto 1.2.5 - $29.99
Capto (was Voila) is an easy-to-use app that takes capturing, recording, video and image editing to the next level. With an intelligent file manager and quick sharing options, Capto is perfect for... Read more
ScreenFlow 7.1.1 - Create screen recordi...
ScreenFlow is powerful, easy-to-use screencasting software for the Mac. With ScreenFlow you can record the contents of your entire monitor while also capturing your video camera, microphone and your... Read more
Xcode 9.0.1 - Integrated development env...
Xcode includes everything developers need to create great applications for Mac, iPhone, iPad, and Apple Watch. Xcode provides developers a unified workflow for user interface design, coding, testing... Read more
TotalFinder 1.10.2 - Adds tabs, hotkeys,...
TotalFinder is a universally acclaimed navigational companion for your Mac. Enhance your Mac's Finder with features so smart and convenient, you won't believe you ever lived without them. Features... Read more
Adobe Flash Player 27.0.0.170 - Plug-in...
Adobe Flash Player is a cross-platform, browser-based application runtime that provides uncompromised viewing of expressive applications, content, and videos across browsers and operating systems.... Read more

The best deals on the App Store this wee...
Happy Tuesday, dear readers. Your favorite part of the week as officially arrived. It's time to take a look at the best deals in games. Things are admittedly a bit sparse, but there are a few diamonds in the rough to see you through if you're... | Read more »
Be the last person standing in Legacy of...
Yoozoo Games’ popular action MMO Legacy of Discord is getting a huge new update to celebrate its first anniversary. Perhaps the biggest change is the addition of an exciting survival mode titled Last Guardian. This new survival mode will pit you... | Read more »
Home Street guide - how to make friends...
From the creators of Food Street comes Home Street, a new simulation game that tasks you with building a social network and designing a beautiful home. It's a bit like The Sims, but you won't have to worry about the daily chores involved (feeding,... | Read more »
Color Ballz guide - how to bounce to the...
Color Ballz is an addictive new arcade title from Ketchapp Studios. It takes old school mechanics from games like Brickles and puts a fun twist on it. Your job? To catch balls with a paddle and send them back into a chute to be carried back to... | Read more »
Q&A: A-33 Studio explains why Combat...
When it comes to mobile FPS, it’s often tricky to get the fundamentals right on a platform lacking a physical controller, large display and hefty RAM. With Combat Squad: Project Wednesday, A-33 Studio bravely took on the challenge of making a... | Read more »
Taichi Panda 3: Dragon Hunter guide - ti...
Taichi Panda 3: Dragon Hunter launched this week to players all over the world. It's a beautiful mobile MMORPG that blends elements of Eastern and Western fantasy. It reminds us of a mix between World of Warcraft and Jade Empire. MMO's can have a... | Read more »
The best new games we played this week -...
Phew. It has been a week, but now it's time to relax, put your feet up, and enjoy some brand new mobile games. It was a bit of slow week, but there's still plenty of new titles to add to your collection. Here are four of our favorites. [Read... | Read more »
Yoink - Improved Drag and Drop (Product...
Yoink - Improved Drag and Drop 1.0 Device: iOS Universal Category: Productivity Price: $2.99, Version: 1.0 (iTunes) Description: Yoink for iPad and iPhone lets you easily and quickly store items you drag, copy or share, for later use... | Read more »
Cottage Garden (Games)
Cottage Garden 1.11 Device: iOS Universal Category: Games Price: $4.99, Version: 1.11 (iTunes) Description: | Read more »
Into the Dead 2 guide - how to survive t...
Into the Dead 2 is an endless gunner, of sorts, with a lot of grit and satisfying gunplay behind it. The game looks amazing, and tells an effective story to boot. Plus, it has some quality voice acting behind it to really bring the story to life... | Read more »

Price Scanner via MacPrices.net

13″ MacBook Pros on sale for up to $120 off M...
B&H Photo has 2017 13″ MacBook Pros in stock today and on sale for up to $120 off MSRP, each including free shipping plus NY & NJ sales tax only: – 13-inch 2.3GHz/128GB Space Gray MacBook... Read more
15″ MacBook Pros on sale for up to $200 off M...
B&H Photo has 15″ MacBook Pros on sale for up to $200 off MSRP. Shipping is free, and B&H charges sales tax in NY & NJ only: – 15″ 2.8GHz MacBook Pro Space Gray (MPTR2LL/A): $2249, $150... Read more
Roundup of Apple Certified Refurbished iMacs,...
Apple has a full line of Certified Refurbished 2017 21″ and 27″ iMacs available starting at $1019 and ranging up to $350 off original MSRP. Apple’s one-year warranty is standard, and shipping is free... Read more
Sale! 27″ 3.8GHz 5K iMac for $2098, save $201...
Amazon has the 27″ 3.8GHz 5K iMac (MNED2LL/A) on sale today for $2098 including free shipping. Their price is $201 off MSRP, and it’s the lowest price available for this model (Apple’s $1949... Read more
Sale! 10″ Apple WiFi iPad Pros for up to $100...
B&H Photo has 10.5″ WiFi iPad Pros in stock today and on sale for $50-$100 off MSRP. Each iPad includes free shipping, and B&H charges sales tax in NY & NJ only: – 10.5″ 64GB iPad Pro: $... Read more
Apple iMacs on sale for up to $130 off MSRP w...
B&H Photo has 21-inch and 27-inch iMacs in stock and on sale for up to $130 off MSRP including free shipping. B&H charges sales tax in NY & NJ only: – 27″ 3.8GHz iMac (MNED2LL/A): $2179 $... Read more
2017 3.5GHz 6-Core Mac Pro on sale for $2799,...
B&H Photo has the 2017 3.5GHz 6-Core Mac Pro (MD878LL/A) on sale today for $2799 including free shipping plus NY & NJ sales tax only . Their price is $200 off MSRP. Read more
12″ 1.2GHz Space Gray MacBook on sale for $11...
Amazon has the 2017 12″ 1.2GHz Space Gray Retina MacBook on sale for $100 off MSRP. Shipping is free: 12″ 1.2GHz Space Gray MacBook: $1199.99 $100 off MSRP Read more
Bare Bones Software Releases macOS High Sierr...
Bare Bones Software has announced the release and immediate availability of BBEdit 12.0, a significant upgrade to its professional strength text and code editor. BBEdit 12 introduces a new foundation... Read more
Yale Announces Availability of Apple HomeKit-...
Yale Locks & Hardware has announced that Apple HomeKit support for its Assure Lock family is available this month. The new Yale iM1 Network Module, which provides support for the Apple Home app... Read more

Jobs Board

Lead *Apple* Solution Consultant - Apple In...
…develop a team of diverse partner employees focusing on excellence to deliver the Apple story. Even when you're not present, you will maintain a consistent influence Read more
watchOS Frameworks Engineering Manager, *App...
Job Summary Join the team that is shaping the future of software development for Apple Watch! Apple is looking for an exceptional software engineering leader to Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description:SalesSpecialist - Retail Customer Service and SalesTransform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions - Apple,...
Job Description: Sales Specialist - Retail Customer Service and Sales Transform Apple Store visitors into loyal Apple customers. When customers enter the store, Read more
*Apple* Retail - Multiple Positions - Farmin...
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.