From 2c4fc2e5492bb6793c49580eb8e42a81e0e00bee Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Fri, 6 Dec 2024 21:46:49 +0000
Subject: [PATCH] Sync SDL3 wiki -> header
[ci skip]
---
include/SDL3/SDL_gpu.h | 21 ++++++++++++++-------
1 file changed, 14 insertions(+), 7 deletions(-)
diff --git a/include/SDL3/SDL_gpu.h b/include/SDL3/SDL_gpu.h
index 5cfb487bc5241..29eac2c3a9012 100644
--- a/include/SDL3/SDL_gpu.h
+++ b/include/SDL3/SDL_gpu.h
@@ -3499,19 +3499,26 @@ extern SDL_DECLSPEC bool SDLCALL SDL_SetGPUSwapchainParameters(
/**
* Configures the maximum allowed number of frames in flight.
*
- * The default value when the device is created is 2.
- * This means that after you have submitted 2 frames for presentation, if the GPU has not finished working on the first frame, SDL_AcquireGPUSwapchainTexture() will block or return false depending on the present mode.
+ * The default value when the device is created is 2. This means that after
+ * you have submitted 2 frames for presentation, if the GPU has not finished
+ * working on the first frame, SDL_AcquireGPUSwapchainTexture() will block or
+ * return false depending on the present mode.
*
- * Higher values increase throughput at the expense of visual latency.
- * Lower values decrease visual latency at the expense of throughput.
+ * Higher values increase throughput at the expense of visual latency. Lower
+ * values decrease visual latency at the expense of throughput.
*
- * Note that calling this function will stall and flush the command queue to prevent synchronization issues.
+ * Note that calling this function will stall and flush the command queue to
+ * prevent synchronization issues.
*
* The minimum value of allowed frames in flight is 1, and the maximum is 3.
*
* \param device a GPU context.
- * \param allowed_frames_in_flight the maximum number of frames that can be pending on the GPU before AcquireSwapchainTexture blocks or returns false.
- * \returns true if successful, false on error; call SDL_GetError() for more information.
+ * \param allowed_frames_in_flight the maximum number of frames that can be
+ * pending on the GPU before
+ * AcquireSwapchainTexture blocks or returns
+ * false.
+ * \returns true if successful, false on error; call SDL_GetError() for more
+ * information.
*
* \since This function is available since SDL 3.2.0.
*/