Inside Macintosh: Apple Game Sprockets Guide /

Chapter 2 - DrawSprocket / DrawSprocket Reference

DrawSprocket Functions / Using Alternate Buffers

DSpContext_GetOverlayAltBuffer

You can use the DSpContext_GetOverlayAltBuffer function to get the current overlay associated with a context.

OSStatus DSpContext_GetOverlayAltBuffer (
DSpContextReference inContext,
DSpAltBufferReference *outOverlay);

inContext

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

outOverlay

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

function result

A result code.

DESCRIPTION

The DSpContext_GetOverlayAltBuffer function takes, in the inContext parameter, a reference to a context and returns, in the outOverlay parameter, a reference to the alternate buffer that holds the current overlay for that context.

CALLING RESTRICTIONS

Do not call this function during an interrupt.