From 6d20b65a9e274cbf2e3fa8a98f9abecbd7a4492b Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Tue, 31 Dec 2024 17:58:37 +0000
Subject: [PATCH] Sync SDL3 wiki -> header
[ci skip]
---
include/SDL3/SDL_storage.h | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/include/SDL3/SDL_storage.h b/include/SDL3/SDL_storage.h
index 3116e9fb54e0f..cdd31b471c5d4 100644
--- a/include/SDL3/SDL_storage.h
+++ b/include/SDL3/SDL_storage.h
@@ -264,6 +264,10 @@ extern SDL_DECLSPEC bool SDLCALL SDL_GetStorageFileSize(SDL_Storage *storage, co
* Synchronously read a file from a storage container into a client-provided
* buffer.
*
+ * The value of `length` must match the length of the file exactly; call
+ * SDL_GetStorageFileSize() to get this value. This behavior may be relaxed in
+ * a future release.
+ *
* \param storage a storage container to read from.
* \param path the relative path of the file to read.
* \param destination a client-provided buffer to read the file into.