Skip to content

File: ShaderFlow/Modules/Frametimer.py

ShaderFlow.Modules.Frametimer

ShaderFrametimer

Bases: ShaderModule

Source code in Projects/ShaderFlow/ShaderFlow/Modules/Frametimer.py
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
@define
class ShaderFrametimer(ShaderModule):
    frametimes: deque[float] = Factory(deque)
    history: float = 2

    @property
    def length(self) -> int:
        return max(int(self.history * self.scene.fps), 10)

    # Framerate manipulation

    def update(self):
        if (self.scene.rdt == 0):
            return
        self.frametimes.append(self.scene.rdt)
        while len(self.frametimes) > self.length:
            self.frametimes.popleft()

    def percent(self, percent: float=1) -> float:
        cut = int(len(self.frametimes) * (percent/100))
        return numpy.sort(self.frametimes)[-cut:]

    def __safe__(self, value):
        return value if value < 1e8 else 0

    # # Frametimes

    def frametime_average(self, percent: float=100) -> float:
        frametimes = self.percent(percent)
        return sum(frametimes) / (len(frametimes) + 1e-9)

    @property
    def frametime_maximum(self) -> float:
        return max(self.frametimes)

    @property
    def frametime_minimum(self) -> float:
        return min(self.frametimes)

    # # Framerates

    def framerate_average(self, percent: float=100) -> float:
        return self.__safe__(1.0 / (self.frametime_average(percent) + 1e-9))

    @property
    def framerate_maximum(self) -> float:
        return self.__safe__(1.0 / (self.frametime_minimum + 1e-9))

    @property
    def framerate_minimum(self) -> float:
        return self.__safe__(1.0 / (self.frametime_maximum + 1e-9))

    # ShaderFlow

    def ui(self):
        imgui.plot_lines(
            (
                f"Target  {self.scene.fps:7.3f} fps\n"
                f"Average {self.framerate_average(100):7.3f} fps\n"
                # f"Low 10% {self.framerate_average(10):7.3f} fps\n"
                # f"Low  1% {self.framerate_average(1):7.3f} fps\n"
                f"Maximum {self.framerate_maximum:7.3f} fps\n"
                f"Minimum {self.framerate_minimum:7.3f} fps\n"
            ),
            numpy.array(self.frametimes, dtype=numpy.float32),
            scale_min = 0,
            graph_size = (0, 70)
        )

        if (state := imgui.input_float("History (Seconds)", self.history, 0.5, 0.5, "%.2f"))[0]:
            self.history = max(0, state[1])

frametimes

frametimes: deque[float] = Factory(deque)

history

history: float = 2

length

length: int

update

update()
Source code in Projects/ShaderFlow/ShaderFlow/Modules/Frametimer.py
21
22
23
24
25
26
def update(self):
    if (self.scene.rdt == 0):
        return
    self.frametimes.append(self.scene.rdt)
    while len(self.frametimes) > self.length:
        self.frametimes.popleft()

percent

percent(percent: float = 1) -> float
Source code in Projects/ShaderFlow/ShaderFlow/Modules/Frametimer.py
28
29
30
def percent(self, percent: float=1) -> float:
    cut = int(len(self.frametimes) * (percent/100))
    return numpy.sort(self.frametimes)[-cut:]

__safe__

__safe__(value)
Source code in Projects/ShaderFlow/ShaderFlow/Modules/Frametimer.py
32
33
def __safe__(self, value):
    return value if value < 1e8 else 0

frametime_average

frametime_average(percent: float = 100) -> float
Source code in Projects/ShaderFlow/ShaderFlow/Modules/Frametimer.py
37
38
39
def frametime_average(self, percent: float=100) -> float:
    frametimes = self.percent(percent)
    return sum(frametimes) / (len(frametimes) + 1e-9)

frametime_maximum

frametime_maximum: float

frametime_minimum

frametime_minimum: float

framerate_average

framerate_average(percent: float = 100) -> float
Source code in Projects/ShaderFlow/ShaderFlow/Modules/Frametimer.py
51
52
def framerate_average(self, percent: float=100) -> float:
    return self.__safe__(1.0 / (self.frametime_average(percent) + 1e-9))

framerate_maximum

framerate_maximum: float

framerate_minimum

framerate_minimum: float

ui

ui()
Source code in Projects/ShaderFlow/ShaderFlow/Modules/Frametimer.py
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def ui(self):
    imgui.plot_lines(
        (
            f"Target  {self.scene.fps:7.3f} fps\n"
            f"Average {self.framerate_average(100):7.3f} fps\n"
            # f"Low 10% {self.framerate_average(10):7.3f} fps\n"
            # f"Low  1% {self.framerate_average(1):7.3f} fps\n"
            f"Maximum {self.framerate_maximum:7.3f} fps\n"
            f"Minimum {self.framerate_minimum:7.3f} fps\n"
        ),
        numpy.array(self.frametimes, dtype=numpy.float32),
        scale_min = 0,
        graph_size = (0, 70)
    )

    if (state := imgui.input_float("History (Seconds)", self.history, 0.5, 0.5, "%.2f"))[0]:
        self.history = max(0, state[1])