From d7d6d8e283d69fc4348dd4136b89f03de2d00aae Mon Sep 17 00:00:00 2001
From: SDL Wiki Bot <[EMAIL REDACTED]>
Date: Mon, 7 Apr 2025 16:26:59 +0000
Subject: [PATCH] Sync SDL3 wiki -> header
[ci skip]
---
include/SDL3/SDL_render.h | 29 +++++++++++++++++++----------
1 file changed, 19 insertions(+), 10 deletions(-)
diff --git a/include/SDL3/SDL_render.h b/include/SDL3/SDL_render.h
index 17bed4514dd09..dc5107d62570b 100644
--- a/include/SDL3/SDL_render.h
+++ b/include/SDL3/SDL_render.h
@@ -285,9 +285,12 @@ extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRenderer(SDL_Window *window
*
* With the SDL GPU renderer:
*
- * - `SDL_PROP_RENDERER_CREATE_GPU_SHADERS_SPIRV_BOOLEAN`: the app is able to provide SPIR-V shaders to SDL_GPURenderState, optional.
- * - `SDL_PROP_RENDERER_CREATE_GPU_SHADERS_DXIL_BOOLEAN`: the app is able to provide DXIL shaders to SDL_GPURenderState, optional.
- * - `SDL_PROP_RENDERER_CREATE_GPU_SHADERS_MSL_BOOLEAN`: the app is able to provide MSL shaders to SDL_GPURenderState, optional.
+ * - `SDL_PROP_RENDERER_CREATE_GPU_SHADERS_SPIRV_BOOLEAN`: the app is able to
+ * provide SPIR-V shaders to SDL_GPURenderState, optional.
+ * - `SDL_PROP_RENDERER_CREATE_GPU_SHADERS_DXIL_BOOLEAN`: the app is able to
+ * provide DXIL shaders to SDL_GPURenderState, optional.
+ * - `SDL_PROP_RENDERER_CREATE_GPU_SHADERS_MSL_BOOLEAN`: the app is able to
+ * provide MSL shaders to SDL_GPURenderState, optional.
*
* With the vulkan renderer:
*
@@ -336,17 +339,23 @@ extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRendererWithProperties(SDL_
#define SDL_PROP_RENDERER_CREATE_VULKAN_PRESENT_QUEUE_FAMILY_INDEX_NUMBER "SDL.renderer.create.vulkan.present_queue_family_index"
/**
- * Create a 2D GPU rendering context for a window, with support for the specified shader format.
+ * Create a 2D GPU rendering context for a window, with support for the
+ * specified shader format.
*
- * This is a convenience function to create a SDL GPU backed renderer, intended to be used with SDL_GPURenderState.
- * The resulting renderer will support shaders in one of the specified shader formats.
+ * This is a convenience function to create a SDL GPU backed renderer,
+ * intended to be used with SDL_GPURenderState. The resulting renderer will
+ * support shaders in one of the specified shader formats.
*
- * If no available GPU driver supports any of the specified shader formats, this function will fail.
+ * If no available GPU driver supports any of the specified shader formats,
+ * this function will fail.
*
* \param window the window where rendering is displayed.
- * \param format_flags a bitflag indicating which shader formats the app is able to provide.
- * \param device a pointer filled with the associated GPU device, or NULL on error.
- * \returns a valid rendering context or NULL if there was an error; call SDL_GetError() for more information.
+ * \param format_flags a bitflag indicating which shader formats the app is
+ * able to provide.
+ * \param device a pointer filled with the associated GPU device, or NULL on
+ * error.
+ * \returns a valid rendering context or NULL if there was an error; call
+ * SDL_GetError() for more information.
*
* \threadsafety This function should only be called on the main thread.
*