Carbon


GetGWorldDevice

Header: QDOffscreen.h Carbon status: Supported

Obtains a handle to the GDevice structure associated with an offscreen graphics world.

GDHandle GetGWorldDevice (
    GWorldPtr offscreenGWorld
);
Parameter descriptions
offscreenGWorld

A pointer to an offscreen graphics world. The pointer returned to your application by the NewGWorld function.

function result

A handle to the GDevice structure associated with the offscreen graphics world specified by the offscreenGWorld parameter.

If you created the offscreen world by specifying the noNewDevice flag, the GDevice structure is for one of the screen devices or is the GDevice structure that you specified to NewGWorld or UpdateGWorld.

If you point to a GrafPort or CGrafPort structure in the offscreenGWorld parameter, GetGWorldDevice returns the current device.

SPECIAL CONSIDERATIONS

The GetGWorldDevice function may move or purge memory blocks in the application heap; do not call this function at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)