From 5db7694f22dcbd1ac628dfc18eea294aa802f7be Mon Sep 17 00:00:00 2001
From: Vittorio Romeo <[EMAIL REDACTED]>
Date: Mon, 31 Mar 2025 16:39:05 +0200
Subject: [PATCH] Add performance disclaimer in `SDL_GetPowerInfo`
documentation
(cherry picked from commit 032d696021a8bba9074fd4b8b531d5ee0aa087a4)
---
include/SDL3/SDL_power.h | 3 +++
1 file changed, 3 insertions(+)
diff --git a/include/SDL3/SDL_power.h b/include/SDL3/SDL_power.h
index 4056ce3c8e44e..19180461e939c 100644
--- a/include/SDL3/SDL_power.h
+++ b/include/SDL3/SDL_power.h
@@ -79,6 +79,9 @@ typedef enum SDL_PowerState
* It's possible a platform can only report battery percentage or time left
* but not both.
*
+ * On some platforms, retrieving power supply details might be expensive. It
+ * is not recommended to invoke this function every frame.
+ *
* \param seconds a pointer filled in with the seconds of battery life left,
* or NULL to ignore. This will be filled in with -1 if we
* can't determine a value or there is no battery.