<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Time routines</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="pandoc" />
<link rel="stylesheet" href="pandoc.css" type="text/css" />
<script type="text/javascript" src="autosuggest.js"></script>
<script type="text/javascript" src="search_index.js"></script>
</head>
<body>
<div class="sidebar">
<div><ul
><li
><a href="index.html"
><strong
>Contents</strong
></a
></li
><li
><a href="config.html"
>Configuration files</a
></li
><li
><a href="display.html"
>Display</a
></li
><li
><a href="events.html"
>Events</a
></li
><li
><a href="file.html"
>File I/O</a
></li
><li
><a href="fshook.html"
>Filesystem</a
></li
><li
><a href="fixed.html"
>Fixed point math</a
></li
><li
><a href="graphics.html"
>Graphics</a
></li
><li
><a href="joystick.html"
>Joystick</a
></li
><li
><a href="keyboard.html"
>Keyboard</a
></li
><li
><a href="memory.html"
>Memory</a
></li
><li
><a href="mouse.html"
>Mouse</a
></li
><li
><a href="path.html"
>Path</a
></li
><li
><a href="state.html"
>State</a
></li
><li
><a href="system.html"
>System</a
></li
><li
><a href="threads.html"
>Threads</a
></li
><li
><a href="time.html"
>Time</a
></li
><li
><a href="timer.html"
>Timer</a
></li
><li
><a href="transformations.html"
>Transformations</a
></li
><li
><a href="utf8.html"
>UTF-8</a
></li
><li
><a href="misc.html"
>Miscellaneous</a
></li
><li
><a href="platform.html"
>Platform-specific</a
></li
><li
><a href="direct3d.html"
>Direct3D</a
></li
><li
><a href="opengl.html"
>OpenGL</a
></div>
</li
></ul
><div><ul
><li
><a href="index.html#addons"
><strong
>Addons</strong
></a
></li
><li
><a href="audio.html"
>Audio addon</a
></li
><li
><a href="acodec.html"
>Audio codecs</a
></li
><li
><a href="color.html"
>Color addon</a
></li
><li
><a href="font.html"
>Font addons</a
></li
><li
><a href="image.html"
>Image I/O addon</a
></li
><li
><a href="memfile.html"
>Memfile addon</a
></li
><li
><a href="native_dialog.html"
>Native dialogs addon</a
></li
><li
><a href="physfs.html"
>PhysicsFS addon</a
></li
><li
><a href="primitives.html"
>Primitives addon</a
></div>
</li
></ul
><div class="searchbox">
<script type="text/javascript">
function on_search(index, control) {
for (i = 0; i < search_index.length; i++) {
if (search_index[i] == control.keywords[index]) {
break;
}
}
location.href = search_urls[i];
}
</script>Search<br /> <input type="text" name="q" id="q" size="15" autocomplete="off" /><br /><script type="text/javascript"> new autosuggest("q", search_index, null, on_search); </script>
</div>
</div>
<div class="content">
<h1 class="title">Time routines</h1>
<div id="TOC"
><ul
><li
><a href="#allegro_timeout"
>ALLEGRO_TIMEOUT</a
></li
><li
><a href="#al_get_time"
>al_get_time</a
></li
><li
><a href="#al_current_time"
>al_current_time</a
></li
><li
><a href="#al_init_timeout"
>al_init_timeout</a
></li
><li
><a href="#al_rest"
>al_rest</a
></li
></ul
></div
>
<p
>These functions are declared in the main Allegro header file:</p
><pre
><code
>#include <allegro5/allegro.h>
</code
></pre
><h1 id="allegro_timeout"
><a href="#TOC"
>ALLEGRO_TIMEOUT</a
></h1
><pre
><code
>typedef struct ALLEGRO_TIMEOUT ALLEGRO_TIMEOUT;
</code
></pre
><p
>Represent a timeout value. The size of the structure is known so can be statically allocated. The contents are private.</p
><p
>See also: <a href="time.html#al_init_timeout"
>al_init_timeout</a
></p
><h1 id="al_get_time"
><a href="#TOC"
>al_get_time</a
></h1
><pre
><code
>double al_get_time(void)
</code
></pre
><p
>Return the number of seconds since the Allegro library was initialised. The return value is undefined if Allegro is uninitialised. The resolution depends on the used driver, but typically can be in the order of microseconds.</p
><h1 id="al_current_time"
><a href="#TOC"
>al_current_time</a
></h1
><p
>Alternate spelling of <a href="time.html#al_get_time"
>al_get_time</a
>.</p
><h1 id="al_init_timeout"
><a href="#TOC"
>al_init_timeout</a
></h1
><pre
><code
>void al_init_timeout(ALLEGRO_TIMEOUT *timeout, double seconds)
</code
></pre
><p
>Set timeout value of some number of seconds after the function call.</p
><p
>See also: <a href="time.html#allegro_timeout"
>ALLEGRO_TIMEOUT</a
>, <a href="events.html#al_wait_for_event_until"
>al_wait_for_event_until</a
></p
><h1 id="al_rest"
><a href="#TOC"
>al_rest</a
></h1
><pre
><code
>void al_rest(double seconds)
</code
></pre
><p
>Waits for the specified number seconds. This tells the system to pause the current thread for the given amount of time. With some operating systems, the accuracy can be in the order of 10ms. That is, even</p
><pre
><code
>al_rest(0.000001)
</code
></pre
><p
>might pause for something like 10ms. Also see the section <Timer routines> on easier ways to time your program without using up all CPU.</p
>
<p class="timestamp">
Allegro version 5.0.3
- Last updated: 2011-05-22 02:32:07 UTC
</p>
</div>
</body>
</html>
