table of contents
- experimental 3.1.0+ds-1
SDL_GetRenderMetalCommandEncoder(3) | SDL3 FUNCTIONS | SDL_GetRenderMetalCommandEncoder(3) |
NAME¶
SDL_GetRenderMetalCommandEncoder - Get the Metal command encoder for the current frame
SYNOPSIS¶
#include "SDL3/SDL.h"
void* SDL_GetRenderMetalCommandEncoder(SDL_Renderer *renderer);
DESCRIPTION¶
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!
FUNCTION PARAMETERS¶
- renderer
- The renderer to query
RETURN VALUE¶
Returns an id<MTLRenderCommandEncoder> on success, or NULL if the renderer isn't a Metal renderer or there was an error.
AVAILABILITY¶
This function is available since SDL 3.0.0.
SEE ALSO¶
SDL 3.1.0 | SDL |