#include "SDL.h"Go to the source code of this file.
Data Structures | |
| struct | FPSmanager |
| Structure holding the state and timing information of the framerate controller. More... | |
Defines | |
| #define | FPS_UPPER_LIMIT 200 |
| Highest possible rate supported by framerate controller in Hz (1/s). | |
| #define | FPS_LOWER_LIMIT 1 |
| Lowest possible rate supported by framerate controller in Hz (1/s). | |
| #define | FPS_DEFAULT 30 |
| Default rate of framerate controller in Hz (1/s). | |
Functions | |
| SDL_FRAMERATE_SCOPE void | SDL_initFramerate (FPSmanager *manager) |
| Initialize the framerate manager. | |
| SDL_FRAMERATE_SCOPE int | SDL_setFramerate (FPSmanager *manager, int rate) |
| Set the framerate in Hz. | |
| SDL_FRAMERATE_SCOPE int | SDL_getFramerate (FPSmanager *manager) |
| Return the current target framerate in Hz. | |
| SDL_FRAMERATE_SCOPE int | SDL_getFramecount (FPSmanager *manager) |
| Return the current framecount. | |
| SDL_FRAMERATE_SCOPE void | SDL_framerateDelay (FPSmanager *manager) |
| Delay execution to maintain a constant framerate and calculate fps. | |
| #define FPS_DEFAULT 30 |
Default rate of framerate controller in Hz (1/s).
Definition at line 37 of file SDL_framerate.h.
| #define FPS_LOWER_LIMIT 1 |
Lowest possible rate supported by framerate controller in Hz (1/s).
Definition at line 32 of file SDL_framerate.h.
| #define FPS_UPPER_LIMIT 200 |
Highest possible rate supported by framerate controller in Hz (1/s).
Definition at line 27 of file SDL_framerate.h.
| SDL_FRAMERATE_SCOPE void SDL_framerateDelay | ( | FPSmanager * | manager | ) |
Delay execution to maintain a constant framerate and calculate fps.
Generate a delay to accomodate currently set framerate. Call once in the graphics/rendering loop. If the computer cannot keep up with the rate (i.e. drawing too slow), the delay is zero and the delay interpolation is reset.
| manager | Pointer to the framerate manager. |
Definition at line 99 of file SDL_framerate.c.
| SDL_FRAMERATE_SCOPE int SDL_getFramecount | ( | FPSmanager * | manager | ) |
Return the current framecount.
Get the current framecount from the framerate manager. A frame is counted each time SDL_framerateDelay is called.
| manager | Pointer to the framerate manager. |
Definition at line 81 of file SDL_framerate.c.
| SDL_FRAMERATE_SCOPE int SDL_getFramerate | ( | FPSmanager * | manager | ) |
Return the current target framerate in Hz.
Get the currently set framerate of the manager.
| manager | Pointer to the framerate manager. |
Definition at line 62 of file SDL_framerate.c.
| SDL_FRAMERATE_SCOPE void SDL_initFramerate | ( | FPSmanager * | manager | ) |
Initialize the framerate manager.
Initialize the framerate manager, set default framerate of 30Hz and reset delay interpolation.
| manager | Pointer to the framerate manager. |
Definition at line 19 of file SDL_framerate.c.
| SDL_FRAMERATE_SCOPE int SDL_setFramerate | ( | FPSmanager * | manager, | |
| int | rate | |||
| ) |
Set the framerate in Hz.
Sets a new framerate for the manager and reset delay interpolation. Rate values must be between FPS_LOWER_LIMIT and FPS_UPPER_LIMIT inclusive to be accepted.
| manager | Pointer to the framerate manager. | |
| rate | The new framerate in Hz (frames per second). |
Definition at line 41 of file SDL_framerate.c.
1.6.2