Sync SDL3 wiki -> header

This commit is contained in:
SDL Wiki Bot
2024-09-30 17:23:50 +00:00
parent afdf325fb4
commit dcc7560a5c

View File

@@ -3316,7 +3316,8 @@ extern SDL_DECLSPEC void SDLCALL SDL_ReleaseWindowFromGPUDevice(
* \param window an SDL_Window that has been claimed. * \param window an SDL_Window that has been claimed.
* \param swapchain_composition the desired composition of the swapchain. * \param swapchain_composition the desired composition of the swapchain.
* \param present_mode the desired present mode for the swapchain. * \param present_mode the desired present mode for the swapchain.
* \returns true if successful, false on error; call SDL_GetError() for more information. * \returns true if successful, false on error; call SDL_GetError() for more
* information.
* *
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
* *
@@ -3350,22 +3351,24 @@ extern SDL_DECLSPEC SDL_GPUTextureFormat SDLCALL SDL_GetGPUSwapchainTextureForma
* When a swapchain texture is acquired on a command buffer, it will * When a swapchain texture is acquired on a command buffer, it will
* automatically be submitted for presentation when the command buffer is * automatically be submitted for presentation when the command buffer is
* submitted. The swapchain texture should only be referenced by the command * submitted. The swapchain texture should only be referenced by the command
* buffer used to acquire it. The swapchain texture handle can be filled in with NULL under * buffer used to acquire it. The swapchain texture handle can be filled in
* certain conditions. This is not necessarily an error. If this function * with NULL under certain conditions. This is not necessarily an error. If
* returns false then there is an error. * this function returns false then there is an error.
* *
* The swapchain texture is managed by * The swapchain texture is managed by the implementation and must not be
* the implementation and must not be freed by the user. You MUST NOT * freed by the user. You MUST NOT call this function from any thread other
* call this function from any thread other than the one that created the * than the one that created the window.
* window.
* *
* \param command_buffer a command buffer. * \param command_buffer a command buffer.
* \param window a window that has been claimed. * \param window a window that has been claimed.
* \param swapchain_texture a pointer filled in with a swapchain texture * \param swapchain_texture a pointer filled in with a swapchain texture
* handle. * handle.
* \param swapchain_texture_width a pointer filled in with the swapchain texture width, may be NULL. * \param swapchain_texture_width a pointer filled in with the swapchain
* \param swapchain_texture_height a pointer filled in with the swapchain texture height, may be NULL. * texture width, may be NULL.
* \returns true on success, false on error; call SDL_GetError() for more information. * \param swapchain_texture_height a pointer filled in with the swapchain
* texture height, may be NULL.
* \returns true on success, false on error; call SDL_GetError() for more
* information.
* *
* \since This function is available since SDL 3.0.0. * \since This function is available since SDL 3.0.0.
* *