mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-12-10 08:32:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

include: Removed some SDL2 references in the documentation.

Browse Source
This commit is contained in:
Ryan C. Gordon
2024-04-13 09:23:22 -04:00
parent 98e9f361a8
commit f01b34fd8d
6 changed files with 19 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
include/SDL3/SDL_render.h
View File

@@ -2099,10 +2099,10 @@ extern DECLSPEC void *SDLCALL SDL_GetRenderMetalLayer(SDL_Renderer *renderer);
* This function returns `void *`, so SDL doesn't have to include Metal's
* headers, but it can be safely cast to an `id<MTLRenderCommandEncoder>`.
*
* Note that as of SDL 2.0.18, this will return NULL if Metal refuses to give
* SDL a drawable to render to, which might happen if the window is
* hidden/minimized/offscreen. This doesn't apply to command encoders for
* render targets, just the window's backbuffer. Check your return values!
* This will return NULL if Metal refuses to give SDL a drawable to render
* to, which might happen if the window is hidden/minimized/offscreen. This
* doesn't apply to command encoders for render targets, just the window's
* backbuffer. Check your return values!
*
* \param renderer The renderer to query
* \returns an `id<MTLRenderCommandEncoder>` on success, or NULL if the