Galaxie EveLoop 0.1.5 documentation


Navigation:   | Index   | Search   | Top   | Up   | Prev   | Next   |
Table of Content: |glxeveloop.fps module |FPS |FPS.fps_increment |FPS.fps_max_increment |FPS.fps_min_increment |FPS.max |FPS.min |FPS.value |

© Copyright 2021-2024, Galaxie EveLoop Team all right reserved.

Top » glxeveloop » glxeveloop package » glxeveloop.fps module

glxeveloop.fps module

class glxeveloop.fps.FPS[source]

Bases: DebugProperty

property fps_increment

Get the Timer fps_increment property value.

Returns:

fps_increment property value. (in fps)

Return type:

float

property fps_max_increment

fps_max_increment is the upper allowed increment value

The self-correcting timing will try to adjust value property in range of fps_min_increment to fps_max_increment

Default Value:: 100.0

Returns:

Timer fps_max_increment property value. (in rate)

Return type:

float

Raises:

TypeError – if fps_max_increment parameter is not a float type

property fps_min_increment

Get the smaller of step increment

The Timer fps_min_increment property value.

See Timer.set_fps_min_increment() for more information’s

Returns:

fps_min_increment property value. (in rate)

Return type:

float

property max
The maximum Frames number per second allowed before the Timer start to rate

limit the rate property.

It can be considered as the max value of the CLAMP process.

Note

By default, it has no limit fps_max = float(“inf”)

Returns:

fps_max property value. (in fps)

Return type:

float

property min
The min Frames number per second allowed before the Timer stop to apply

a rate limit to the value property. (in rate)

It can be considered as the min value of the CLAMP process

Returns:

min property value. (in fps)

Return type:

float

property value

The property value, store the actual speed rate of the MainLoop, it property is use by the class Timer, and will be updated at each loop iteration.

By set value property before call MainLoop.start() , it imposes to start with it value, and slide to the max

Note

If set the value will be clamped between min and max properties value.

Warning

That not correspond exactly to a true movies or game FPS, it corresponds more about how many times 1 second is divided..

Returns:

value property. (in rate)

Return type:

float or int

Raises:

TypeError – if parameter is not a float`|:py:data:`int type or None

Top » glxeveloop » glxeveloop package » glxeveloop.fps module

© Copyright 2021-2024, Galaxie EveLoop Team all right reserved.
This page is licensed under the GNU General Public License v3 or later (GPLv3+).
Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.
See History and License for more information.

Last updated on None.
Created using Sphinx 7.3.7.