TweetFollow Us on Twitter

June 96 - Graphical Truffles: Dynamic Display Dilemmas

Graphical Truffles: Dynamic Display Dilemmas

CAMERON ESFAHANI and KENT "LIDBOY" MILLER

In the Dark Ages, an application could examine the graphics environment once and gather all the information it needed to know. After the System 7.1.2 Renaissance, the Display Manager made the graphics environment dynamic, which provided many new features (and introduced a few implementation issues). In Issue 24 of develop, the Graphical Truffles column described some important features of the Display Manager. Here we'll discuss some common pitfalls that can cause an application to fail in a dynamic display environment -- and ways you can overcome them.

If you use QuickDraw routines in an existing application, your application may already support some aspects of the Display Manager without requiring any extra work on your part. An example we touch on in this column is the graphics mirroring feature, which allows users to make two graphics devices display the same image. QuickDraw, whose routines have already been updated to support the Display Manager, accomplishes graphics mirroring by overlapping the gdRects (global bounds) of the graphics devices. QuickDraw's internal version of DeviceLoop behaves correctly by detecting when devices overlap, then rendering the image properly for each device. This allows overlapping devices to have different color tables or bit depths and still be imaged correctly.

On this issue's CD, we've included a sample application, SuperFly, which illustrates several techniques you can use to support a dynamic environment in your application. Some of the sample code in this column is excerpted from SuperFly.

COMMON ERRORS

When we were integrating the Display Manager into new system software releases, we encountered some common problems that existing applications had when running in a dynamic display environment. Here's a list of suggestions regarding things that might have worked in the past but won't work now; we'll examine each error in turn and suggest a solution.

  • Don't forget to account for mirrored graphics devices when walking the device list.

  • Don't assume that just because your application uses only one logical display, it's drawing on only one physical device.

  • Don't cache the graphics devices and their state on application startup.

  • Don't assume that the menu bar will never move.

  • Don't assume that menus will be drawn on only one display.

  • Don't draw directly to the screen and bypass QuickDraw without checking for the mirrored case.

  • Don't assume that certain 680x0 registers will contain the same values inside a DeviceLoop drawing procedure as when DeviceLoop was called.

Don't forget to account for mirrored graphics devices when walking the device list. When writing applications in the past, some programmers assumed that graphics devices would never overlap. For example, you might assume that if a certain rectangle is fully contained within a gdRect, it isn't on any other device. To implement highlighting, your application might walk the device list and invert the selection if the global rectangle of what you want to highlight intersects the gdRect of that device. However, when there are two displays with the same gdRect in the device list, the first inversion accomplishes the highlighting but the second inversion restores the highlighted area to the original -- unhighlighted -- state.

Solution: Use DeviceLoop for your drawing. If you want to write your own version of DeviceLoop for some reason, make sure that it handles overlapping displays. You could solve the inverting problem by designing an algorithm to guarantee that each rectangle in global space is highlighted only once. The MyHiliteRect routine in Listing 1 is an example of a suitable algorithm.

The code in Listing 1 solves the highlighting problem by keeping track of the global area that has been highlighted. When DMGetNextScreenDevice returns a mirrored device (which will already have been highlighted by the first QuickDraw call), the SectRgn will fail and that device will not be highlighted again.

Listing 1. Highlighting a global rectangle only once

OSErr MyHiliteRect(Rect* hiliteRect)
{
   RgnHandle    hiliteRgn, gdRectRgn, tempRgn;
   GDHandle    theGDevice;
   
   hiliteRgn = NewRgn();
   if (hiliteRgn == nil) 
      return (QDError());
   gdRectRgn = NewRgn();
   if (gdRectRgn == nil) 
      return (QDError());
   tempRgn = NewRgn()
   if (tempRgn == nil)
      return (QDError());
      
   // Make hiliteRect into a region.
   RectRgn(hiliteRgn, hiliteRect);
   
   // Get the first screen device from the Display Manager.
   // Tell it to return only active screen devices so that we won't
   // have to check here.
   theGDevice = DMGetFirstScreenDevice(true);
   
   // Loop until we run out of hiliteRgn or GDevices.
   while ((theGDevice) && (!EmptyRgn(hiliteRgn)) {
      // Does this device's rect intersect hiliteRgn?
      RectRgn(&(**theGDevice).gdRect, gdRectRgn);
      SectRgn(hiliteRgn, gdRectRgn, &tempRgn);
      // If it does, highlight it.
      if (!EmptyRgn(tempRgn)) {
         // Highlight the area described by tempRgn.
         ...
         // Take the area we just highlighted out of the region to
         // highlight. 
         DiffRgn(hiliteRgn, tempRgn, hiliteRgn);
      }
      theGDevice = DMGetNextScreenDevice(theGDevice, true);
   }   
   DisposeRgn(hiliteRgn);
   DisposeRgn(gdRectRgn);
   DisposeRgn(tempRgn);
}
Another solution is given in the sample code in the GDeviceUtilities.cp file on this issue's CD. The function BuildAListOfUniqueDevices builds a list of all graphics devices but eliminates mirrored devices. An application could cache this list and use it for highlighting. However, the list could be invalidated if the user changes the device configuration. The application should register with the Display Manager so that it will be notified (through a notification callback or an Apple event) if the graphics world has changed.

Don't assume that just because your application uses only one logical display, it's drawing on only one physical device. Some applications assume that they're using only one piece of graphics hardware when they're actually using multiple physical devices. An example of this is a multimedia player that searches through graphics devices and uses the first device it finds that meets its criteria for bit depth or size. This technique causes a problem when the application uses Toolbox calls specific to one physical graphics device, such as using SetEntries to animate the color table. If mirroring is turned on, this changes the color table of only one device; the second physical device still has the old color table.

Solution: If you use Toolbox calls specific to one physical graphics device, make sure you do it for all devices that overlap your application's windows and not just the first one you find. As shown in Listing 2, you could use DeviceLoop to accomplish this by calling SetEntries in your DeviceLoop drawing procedure. Or you could use the Palette Manager instead of SetEntries.

Listing 2. Calling SetEntries for overlapping devices

OSErr MySavvySetEntries(WindowRef aWindow, CTabHandle newColorTable)
{
   RgnHandle              tempWindowStructRgn;
   DeviceLoopDrawingUPP   setEntriesDeviceLoopRD;
   OSErr                  theErr = noErr;

   tempWindowStructRgn = NewRgn();
   // Was there a problem making the region?
   if ((theErr = QDError()) != noErr)
      return (theErr);
   GetWindowStructureRgn(aWindow, tempWindowStructRgn);
   
   // We want to get called for every display that intersects our
   // window.
   setEntriesDeviceLoopRD =
       NewDeviceLoopDrawingProc(SetEntriesDeviceLoop);
   DeviceLoop(tempWindowStructRgn, setEntriesDeviceLoopRD,
       (long) newColorTable, singleDevices);
   DisposeRoutineDescriptor(setEntriesDeviceLoopRD);
   DisposeRgn(tempWindowStructRgn);
   return (theErr);
}

static pascal void SetEntriesDeviceLoop(short depth,
      short deviceFlags, GDHandle targetDevice, long userData)
{
#pragma unused(depth, deviceFlags)
   CTabHandle   newColorTable = (CTabHandle) userData;
   GDHandle      savedCurrentGDevice;

   // Since we'll be changing the current GDevice, we need to save
   // and restore it.
   savedCurrentGDevice = GetGDevice();

   // SetEntries applies to the current GDevice, so make targetDevice
   // the current GDevice.
   SetGDevice(targetDevice);

   // Insert the entire table into targetDevice. Do it in indexed
   // mode.
   SetEntries(-1, 255, &(**newColorTable).ctTable[0]);

   // Restore the old current GDevice.
   SetGDevice(savedCurrentGDevice);
}
Don't cache the graphics devices and their state on application startup. With the Display Manager, many things about the graphics world can change, such as the following:

  • Users can change resolutions on multiple-scan displays.

  • Users can deactivate displays with the Monitors & Sound control panel (system software version 7.5.2 and later).

  • Graphics mirroring could be off when the application is launched and turned on while it's running.

  • Users can put their PowerBooks to sleep and attach or remove an external display.
If your application doesn't respond to these changes, it might present an inconsistent interface to the user. For example, the MPW Shell used to cache the gdRect of the main display and pass it to SizeWindow and MoveWindow. So if users changed the resolution of a display, they couldn't grow or move windows beyond the previous size of the display.

Solution: If the Display Manager is present, you should watch for Display Manager notifications to detect changes in the graphics world. (See "Receiving and Responding to Display Manager Events.") Specialized pieces of code, such as extensions or components, can register a callback procedure with the Display Manager. To avoid problems, you should use this method instead of patching to determine when the display environment changes. (Display Manager 2.0 and later even notifies you when the bit depth changes.) Better yet, don't cache device information at all unless your code absolutely needs the extra ounce of performance.


    RECEIVING AND RESPONDING TO DISPLAY MANAGER EVENTS

    The Display Manager has been available since System 7 and is built into system software version 7.1.2 and later. If the Display Manager isn't around, the application can count on devices not moving around and changing sizes.

    An application must set the isDisplayManagerAware flag in its 'SIZE' resource to receive Display Manager events in its main event loop. If your application sets this flag, it's responsible for moving its windows if the graphics world changes, making sure that the windows all remain visible. If it doesn't set this flag, the Display Manager will automatically move windows for your application. Even if your application lets the Display Manager handle its windows automatically, it can still register for Display Manager events by using a callback procedure. The callback procedure is passed an Apple event that the application has to parse.

    The Graphical Truffles column in develop Issue 25 describes this in more detail.


The Display Manager passes all the information about the old and new display configurations to the application when the world changes. The Apple event-handling code on this issue's CD shows some ways to handle Display Manager events. For instance, to detect whether any of the graphics devices have moved, we parse the Apple event and compare the old and new gdRects:
AEGetNthDesc(&DisplayID, 1, typeWildCard, 
   &tempWord, &OldConfig);
AEGetKeyPtr(&OldConfig, keyDeviceRect,
   typeWildCard, (UInt32 *) &returnType,
   &oldRect, sizeof(Rect), nil);
AEGetNthDesc(&DisplayID, 2, typeWildCard,
   &tempWord, &NewConfig);
AEGetKeyPtr(&NewConfig, keyDeviceRect,
   typeWildCard, (UInt32 *) &returnType, 
   &newRect, sizeof(Rect), nil);      
if (!EqualRect(&oldRect, &newRect))
   HandleGDevicesMoved();
Don't assume that the menu bar will never move. This is especially a problem with games or multimedia applications that would like to hide the menu bar. Most applications hide the menu bar by adding the menu bar area to the gray region. (The pointer to the gray region is stored in the GrayRgn global variable and can be retrieved with the Window Manager function GetGrayRgn.) When the user moves the menu bar from one display to another (using the Monitors or Monitors & Sound control panel), the Display Manager reconstructs the gray region. If the application wants to show the menu bar again, it removes the old menu bar area from the rebuilt gray region, but this will not accurately reflect the available screen real estate. This top strip, where the menu bar was, would be lost.

As shown in Figure 1, the menu bar was on the display on the left before the application was launched. The application saved the menu bar location and added it to the gray region so that it could draw there. As shown in Figure 2, when the application quit, it subtracted the old menu bar area back out of the gray region. Since the menu bar was moved, this part of the gray region is now lost. No desktop is drawn where the menu bar used to be (the black rectangle).

Figure 1. Original location of menu bar

Figure 2. Gray region lost because menu bar movedSolution: Become Display Manager-aware and get notified by the Display Manager when the menu bar moves.

Don't assume that menus will be drawn on only one display. In the past, it was a safe assumption that the menu bar would be drawn on only one device at a time, so anything that wanted to draw in the menu bar (such as an MDEF) needed to know about only one display and a single bit depth. Since developers typically don't use DeviceLoop to draw menus or draw in the menu bar, sometimes images are drawn incorrectly when there are overlapped displays, especially on displays with different bit depths. An example would be a menu that contains color, like the Label menu in the Finder.

Solution: If you draw directly to the menu bar or to your menus and bypass QuickDraw, use DeviceLoop. Note that drawing in the menu bar with standard QuickDraw calls works fine in the mirrored case because QuickDraw takes care of the overlapping case for you.

Don't draw directly to the screen and bypass QuickDraw without checking for the mirrored case. Obviously, if an application draws directly to the screen and mirroring is on, the other displays will not reflect any of the drawing.

Solution: Always allow the user to go back to a more "compatible" mode that uses QuickDraw. If the application detects that mirroring is on (by calling DMIsMirroringOn), consider falling back to CopyBits to get your data to the screen.

Don't assume that certain 680x0 registers will contain the same values inside a DeviceLoop drawing procedure as when DeviceLoop was called. We discovered this bug when we made DeviceLoop PowerPC-native for mirroring performance. Some developers who write their DeviceLoop drawing procedure in 680x0 assembly language rely on the fact that the value of A6 when the drawing procedure was called is the same as when DeviceLoop was called. Application developers relied on this to enable them to share stack frames between the caller of DeviceLoop and the DeviceLoop drawing procedure. This will not work if a PowerPC-only version of DeviceLoop is present, so it will not work under Mac OS 8. If you write your DeviceLoop drawing procedure in a high-level language like C, however, you don't have to worry about this problem.

Solution: If you want to share data with your DeviceLoop drawing procedure, use the userData refCon supplied with DeviceLoop. If you need to rely on A6 remaining constant, one solution would be to pass in the A6 of the DeviceLoop caller in the userData parameter and set that to the A6 of the DeviceLoop drawing procedure. Be sure to save and restore the original A6 of the DeviceLoop drawing procedure.

SUCCEEDING IN A CHANGING GRAPHICS WORLD

The Display Manager offers many new features that enable users to configure their graphics devices dynamically. However, this dynamic display environment invalidates certain assumptions that developers might have made when programming in a static graphics environment. This column should start you thinking about these issues. Although the Display Manager does attempt to preserve compatibility with existing applications by moving windows around and preserving graphics device information, it can't fix everything. Your application needs to be able to function in a changing graphics world.

KENT "LIDBOY" MILLER, in a recent attempt to reshape the course of history, has renounced the use of caffeine on a by-minute basis. Lidboy hails from the halls of Apple, where he can be seen pacing in his fuzzy bear slippers. He considers the pinnacle of western culture to have been achieved by the rock group known as Rancid, although he occasionally reads from literary quarterlies on the sly. Were Lidboy to be granted one wish, a side of rice from Taco Bell would no doubt be involved. The single most used word in his vocabulary is "Salsa!"*

CAMERON ESFAHANI (cameron_esfahani@powertalk.apple.com, AppleLink DIRTY) began his career in the spaghetti westerns of Sergio Leone. Industry analysts felt that by going off into that area he would cut himself off from the mainstream and ruin his career, but Cameron felt it was more important to follow his dreams. Now at Apple Computer and looking back, he feels that his spaghetti western period was one of the most exciting and rewarding of his life. He therefore dedicates this column to the memory of Sergio Leone.*

Thanks to Tom Dowdy, Ian Hendry, Mike Marinkovich, and Mike Puckett for reviewing this column.*

 
AAPL
$524.94
Apple Inc.
+5.93
MSFT
$40.01
Microsoft Corpora
-0.39
GOOG
$536.10
Google Inc.
-20.44

MacTech Search:
Community Search:

Software Updates via MacUpdate

VMware Fusion 6.0.3 - Run Windows apps a...
VMware Fusion allows you to create a Virtual Machine on your Mac and run Windows (including Windows 8.1) and Windows software on your Mac. Run your favorite Windows applications alongside Mac... Read more
Tweetbot 1.5.1 - Popular iOS twitter cli...
Tweetbot is a full-featured OS X Twitter client with a lot of personality. Whether it's the meticulously-crafted interface, sounds and animation, or features like multiple timelines and column views... Read more
Mac DVDRipper Pro 4.1.7 - 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
PDFpenPro 6.2 - Advanced PDF toolkit for...
PDFpenPro allows users to edit PDF's easily. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Even correct text and edit graphics! Create... Read more
PDFpen 6.2 - Edit and annotate PDFs with...
PDFpen allows users to easily edit PDF's. Add text, images and signatures. Fill out PDF forms. Merge or split PDF documents. Reorder and delete pages. Even correct text and edit graphics! Features... Read more
Monolingual 1.5.9 - Remove unwanted OS X...
Monolingual is a program for removing unnecesary language resources from OS X, in order to reclaim several hundred megabytes of disk space. It requires a 64-bit capable Intel-based Mac and at least... Read more
Maya 2015 - Professional 3D modeling and...
Maya is an award-winning software and powerful, integrated 3D modeling, animation, visual effects, and rendering solution. Because Maya is based on an open architecture, all your work can be scripted... Read more
Starcraft II: Wings of Liberty 1.1.1.180...
Download the patch by launching the Starcraft II game and downloading it through the Battle.net connection within the app. Starcraft II: Wings of Liberty is a strategy game played in real-time. You... Read more
Sibelius 7.5.0 - Music notation solution...
Sibelius is the world's best-selling music notation software for Mac. It is as intuitive to use as a pen, yet so powerful that it does most things in less than the blink of an eye. The demo includes... Read more
Typinator 5.9 - Speedy and reliable text...
Typinator turbo-charges your typing productivity. Type a little. Typinator does the rest. We've all faced projects that require repetitive typing tasks. With Typinator, you can store commonly used... Read more

Latest Forum Discussions

See All

Have a Special Dead Trigger 2 Easter Bas...
Have a Special Dead Trigger 2 Easter Basket Full of Goodies, Courtesy of Madfinger Games Posted by Rob Rich on April 18th, 2014 [ permalink ] Dead Trigger 2 | Read more »
Almost All of Playdek’s Library is on Sa...
Almost All of Playdek’s Library is on Sale Right Now, and You Should Check it Out Posted by Rob Rich on April 18th, 2014 [ permalink ] Playdek has released quite a few great iOS ports of board and card games over the years, and now most of them... | Read more »
Zynga Launches Brand New Farmville Exper...
Zynga Launches Brand New Farmville Experience with Farmville 2: Country Escape Posted by Tre Lawrence on April 18th, 2014 [ permalink ] | Read more »
David. Review
David. Review By Cata Modorcea on April 18th, 2014 Our Rating: :: MINIMALISTIC IN A DIFFERENT WAYUniversal App - Designed for iPhone and iPad David is a minimalistic game wrapped inside of a soothing atmosphere in which the hero... | Read more »
Eyefi Unveils New Eyefi Cloud Service Th...
Eyefi Unveils New Eyefi Cloud Service That Allows Users to Share Media Across Personal Devices Posted by Tre Lawrence on April 18th, 2014 [ permalink ] | Read more »
Tales from the Dragon Mountain: The Lair...
Tales from the Dragon Mountain: The Lair Review By Jennifer Allen on April 18th, 2014 Our Rating: :: STEADY ADVENTURINGiPad Only App - Designed for the iPad Treading a safe path, Tales from the Dragon Mountain: The Lair is a... | Read more »
Yahoo Updates Flickr App with Advanced E...
Yahoo Updates Flickr App with Advanced Editing Features and More Posted by Tre Lawrence on April 18th, 2014 [ permalink ] | Read more »
My Incredible Body - A Kid's App to...
My Incredible Body - A Kid's App to Learn about the Human Body 1.1.00 Device: iOS Universal Category: Education Price: $2.99, Version: 1.1.00 (iTunes) Description: Wouldn’t it be cool to look inside yourself and see what was going on... | Read more »
Trials Frontier Review
Trials Frontier Review By Carter Dotson on April 18th, 2014 Our Rating: :: A ROUGH LANDINGUniversal App - Designed for iPhone and iPad Trials Frontier finally brings the famed stunt racing franchise to mobile, but how much does its... | Read more »
Evernote Business Notebook by Moleskin I...
Evernote Business Notebook by Moleskin Introduced – Support Available in Evernote for iOS Posted by Tre Lawrence on April 18th, 2014 [ permalink ] | Read more »

Price Scanner via MacPrices.net

Free HopTo 2.2 Helps Enhance Your Productivit...
The HopTo app helps you do more on your iPad by providing more and easier adaccess to files and documents. Version 2.2 adds Egnyte and HopTo’s Mac OSX File Connector. If you already have the hopTo... Read more
National Distracted Driving Awareness Month:...
As the country recognizes National Distracted Driving Awareness Month, Sprint is reminding wireless consumers to focus on driving while behind the wheel, to not text or email while driving, and to... Read more
13-inch 2.4GHz Retina MacBook Pro available f...
Abt has the 13″ 2.4GHz 128GB Retina MacBook Pro available for $1229 including free shipping. Their price is $70 off MSRP. Read more
iMacs on sale for up to $160 off MSRP this we...
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
iPad Airs on sale this weekend for up to $100...
Best Buy has WiFi iPad Airs on sale for $50 off MSRP and WiFi + Cellular iPad Airs on sale for $100 off MSRP on their online store for a limited time, with prices now starting at $449. Choose free... Read more
Apple restocks refurbished Mac minis starting...
The Apple Store has restocked Apple Certified Refurbished Mac minis for up to $150 off the cost of new models. Apple’s one-year warranty is included with each mini, and shipping is free: - 2.5GHz Mac... Read more
Hyundai Brings Apple CarPlay To The 2015 Sona...
Hyundai Motor America has announced it will bring Apple CarPlay functionality to the 2015 Sonata. CarPlay is pitched as a smarter, safer and easier way to use iPhone in the car and gives iPhone users... Read more
Updated iPads Coming Sooner Than We Had Thoug...
MacRumors, cites KGI securities analyst Ming Chi Kuo, well-respected as an Apple product prognisticator, saying that Apple will introduce an upgraded iPad Air and iPad mini in 2014/Q3, meaning the... Read more
Toshiba Unveils New High And Low End Laptop M...
Toshiba has announced new laptop models covering both the high-end and low-end of the notebook computer spectrum. Toshiba 4K Ultra HD Laptop Toshiba’s new Satellite P55t features one of the world’s... Read more
Save up to $270 with Apple refurbished 13-inc...
The Apple Store has Apple Certified Refurbished October 2013 13″ Retina MacBook Pros available starting at $1099, with models up to $270 off MSRP. Apple’s one-year warranty is standard, and shipping... Read more

Jobs Board

*Apple* Automotive Parts Department position...
Apple Automotive is one of the fastest growing dealer…and it shows. Consider making the switch to the Apple Automotive Group today! At Apple Automotive, we 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* Retail - Manager - Holyoke - Apple I...
Job Summary Keeping an Apple Store thriving requires a diverse set of leadership skills, and as a Manager, you’re a master of them all. In the store’s fast-paced, Read more
*Apple* Retail - Manager - Apple (United Sta...
Job SummaryKeeping an Apple Store thriving requires a diverse set of leadership skills, and as a Manager, you're a master of them all. In the store's fast-paced, dynamic 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.