moderngl_window.timers

class moderngl_window.timers.base.BaseTimer[source]

A timer controls the time passed into the the render function. This can be used in creative ways to control the current time such as basing it on current location in an audio file.

All methods must be implemented.

property fps: float: Get the current frames per second.

property fps_average: float: get the average fps since the timer was started

property is_paused: bool

The pause state of the timer

Type:: bool

property is_running: bool

Is the timer currently running?

Type:: bool

next_frame() → tuple[float, float][source]

Get timer information for the next frame.

Returns:: The frametime and current time
Return type:: tuple[float, float]

pause() → None[source]: Pause the timer

start() → None[source]: Start the timer initially or resume after pause

stop() → tuple[float, float][source]

Stop the timer. Should only be called once when stopping the timer.

Returns:: tuple[float, float]> Current position in the timer, actual running duration

property time: float

Get or set the current time. This can be used to jump around in the timeline.

Returns:: The current time in seconds
Return type:: float

toggle_pause() → None[source]: Toggle pause state

class moderngl_window.timers.clock.Timer(**kwargs: Any)[source]

Bases: BaseTimer

Timer based on python time.

property fps: float: Get the current frames per second.

property fps_average: float: The average fps since the timer was started