diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2024-09-16 13:35:39 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2024-09-16 13:35:39 +0200 |
| commit | 903f15d0fbf301b3ec822924021c0098c5df658e (patch) | |
| tree | fed01c1d32db7b05fb17065e7b20d143d357c420 | |
| parent | 4215dfdff728554c910da81a4479fc8c53fff9cd (diff) | |
| parent | 3a1160bff1b969db64bae11f54c7e89ff52391a1 (diff) | |
| download | redot-engine-903f15d0fbf301b3ec822924021c0098c5df658e.tar.gz | |
Merge pull request #96975 from Kiisu-Master/fix-docs-typo-render-time-function
Fix typo in RenderingServer docs
| -rw-r--r-- | doc/classes/RenderingServer.xml | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/classes/RenderingServer.xml b/doc/classes/RenderingServer.xml index cea9a4cec4..58e88a3bdc 100644 --- a/doc/classes/RenderingServer.xml +++ b/doc/classes/RenderingServer.xml @@ -3721,7 +3721,7 @@ <return type="float" /> <param index="0" name="viewport" type="RID" /> <description> - Returns the GPU time taken to render the last frame in milliseconds. To get a complete readout of GPU time spent to render the scene, sum the render times of all viewports that are drawn every frame. Unlike [method Engine.get_frames_per_second], this method accurately reflects GPU utilization even if framerate is capped via V-Sync or [member Engine.max_fps]. See also [method viewport_get_measured_render_time_gpu]. + Returns the GPU time taken to render the last frame in milliseconds. To get a complete readout of GPU time spent to render the scene, sum the render times of all viewports that are drawn every frame. Unlike [method Engine.get_frames_per_second], this method accurately reflects GPU utilization even if framerate is capped via V-Sync or [member Engine.max_fps]. See also [method viewport_get_measured_render_time_cpu]. [b]Note:[/b] Requires measurements to be enabled on the specified [param viewport] using [method viewport_set_measure_render_time]. Otherwise, this method returns [code]0.0[/code]. [b]Note:[/b] When GPU utilization is low enough during a certain period of time, GPUs will decrease their power state (which in turn decreases core and memory clock speeds). This can cause the reported GPU time to increase if GPU utilization is kept low enough by a framerate cap (compared to what it would be at the GPU's highest power state). Keep this in mind when benchmarking using [method viewport_get_measured_render_time_gpu]. This behavior can be overridden in the graphics driver settings at the cost of higher power usage. </description> |