Clock

Functions

sfClock *sfClock_create(void)

Create a new clock and start it.

Returns:

A new sfClock object

sfClock *sfClock_copy(const sfClock *clock)

Create a new clock by copying an existing one.

Parameters:

• clock – Clock to copy

Returns:

A new sfClock object which is a copy of clock

void sfClock_destroy(const sfClock *clock)

Destroy a clock.

Parameters:

• clock – Clock to destroy

sfTime sfClock_getElapsedTime(const sfClock *clock)

Get the time elapsed in a clock.

This function returns the time elapsed since the last call to sfClock_restart (or the construction of the object if sfClock_restart has not been called).

Parameters:

• clock – Clock object

Returns:

Time elapsed

bool sfClock_isRunning(const sfClock *clock)

Check whether the clock is running.

Parameters:

• clock – Clock object

Returns:

true if the clock is running, false otherwise

void sfClock_start(sfClock *clock)

Start the clock.

See also

stop

Parameters:

• clock – Clock object

void sfClock_stop(sfClock *clock)

Stop the clock.

See also

start

Parameters:

• clock – Clock object

sfTime sfClock_restart(sfClock *clock)

Restart a clock.

This function puts the time counter back to zero. It also returns the time elapsed since the clock was started.

Parameters:

• clock – Clock object

Returns:

Time elapsed

sfTime sfClock_reset(sfClock *clock)

Reset the clock.

This function puts the time counter back to zero, returns the elapsed time, and leaves the clock in a paused state.

See also

restart

Parameters:

• clock – Clock object

Returns:

Time elapsed