Inside Macintosh: Apple Game Sprockets Guide /

Chapter 2 - DrawSprocket / DrawSprocket Reference

DrawSprocket Functions / Drawing and Double Buffering

DSpContext_GetMaxFrameRate

Use the DSpContext_GetMaxFrameRate function to find out what a context's maximum frame rate is set to.

OSStatus DSpContext_GetMaxFrameRate (
DSpContextReference inContext,
UInt32 *outMaxFPS);

inContext

A reference to the context whose maximum frame rate you want to get.

outMaxFPS

On exit, the maximum frame rate in frames per second.

function result

A result code.

DESCRIPTION

The DSpContext_GetMaxFrameRate function returns, in the outMaxFPS parameter, the maximum frame rate for the context specified in the inContext parameter. The frame rate returned is not necessarily the same as the maximum frame rate passed by the most recent call to the DSpContext_SetMaxFrameRate function. If 0 is returned as the maximum frame rate, there are no frame rate restrictions in place.

CALLING RESTRICTIONS

Do not call this function during an interrupt.