eden-emu/SDL
15
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-06-02 18:07:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Sync SDL3 wiki -> header

Browse source 
[ci skip]
This commit is contained in:
SDL Wiki Bot 2025-04-07 16:26:59 +00:00
parent f7b7188837
commit d7d6d8e283
1 changed files with 19 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

29
include/SDL3/SDL_render.h
View file

@ -285,9 +285,12 @@ extern SDL_DECLSPEC SDL_Renderer * SDLCALL SDL_CreateRenderer(SDL_Window *window
* *
* With the SDL GPU renderer: * 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_SPIRV_BOOLEAN`: the app is able to
* - `SDL_PROP_RENDERER_CREATE_GPU_SHADERS_DXIL_BOOLEAN`: the app is able to provide DXIL shaders to SDL_GPURenderState, optional. * provide SPIR-V 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_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: * 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" #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. * This is a convenience function to create a SDL GPU backed renderer,
* The resulting renderer will support shaders in one of the specified shader formats. * 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 window the window where rendering is displayed.
* \param format_flags a bitflag indicating which shader formats the app is able to provide. * \param format_flags a bitflag indicating which shader formats the app is
* \param device a pointer filled with the associated GPU device, or NULL on error. * able to provide.
* \returns a valid rendering context or NULL if there was an error; call SDL_GetError() for more information. * \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. * \threadsafety This function should only be called on the main thread.
* *