ClockDisplay
(font=None, interval=0.25, format='%(fps).2f', color=(0.5, 0.5, 0.5, 0.5), clock=None)¶Display current clock values, such as FPS.
This is a convenience class for displaying diagnostics such as the framerate. See the module documentation for example usage.
Variables: | label – The label which is displayed. |
---|
Warning
Deprecated. This class presents values that are often misleading, as they reflect the rate of clock ticks, not displayed framerate. Use pyglet.window.FPSDisplay instead.
Constructor:
__init__
(font=None, interval=0.25, format='%(fps).2f', color=(0.5, 0.5, 0.5, 0.5), clock=None)¶Create a ClockDisplay.
All parameters are optional. By default, a large translucent font will be used to display the FPS to two decimal places.
Parameters: |
|
---|
Methods:
draw
()Method called each frame to render the label. unschedule
()Remove the display from its clock’s schedule. update_text
([dt])Scheduled method to update the label text.
ClockDisplay.
draw
()¶Method called each frame to render the label.
ClockDisplay.
unschedule
()¶Remove the display from its clock’s schedule.
ClockDisplay uses Clock.schedule_interval to periodically update its display label. Even if the ClockDisplay is not being used any more, its update method will still be scheduled, which can be a resource drain. Call this method to unschedule the update method and allow the ClockDisplay to be garbage collected.
Note
Since pyglet 1.1
ClockDisplay.
update_text
(dt=0)¶Scheduled method to update the label text.