Inside Macintosh: Apple Game Sprockets Guide /

Chapter 2 - DrawSprocket / DrawSprocket Reference

DrawSprocket Functions / Using Alternate Buffers

DSpContext_GetUnderlayAltBuffer

You can use the DSpContext_GetUnderlayAltBuffer function to get the current underlay associated with a context.

OSStatus DSpContext_GetUnderlayAltBuffer (
DSpContextReference inContext,
DSpAltBufferReference *outUnderlay);

inContext

A reference to the context whose underlay you want to get.

outUnderlay

On exit, a reference to the alternate buffer that holds the underlay.

function result

A result code.

DESCRIPTION

The DSpContext_GetUnderlayAltBuffer function takes, in the inContext parameter, a reference to a context and returns, in the outUnderlay parameter, a reference to the alternate buffer that holds the current underlay for that context.

CALLING RESTRICTIONS

Do not call this function during an interrupt.