SDL_GetRenderMetalCommandEncoder - Get the Metal command encoder for the current frame.
Contents
Availability
This function is available since SDL 3.2.0.
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>.
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.
Name
SDL_GetRenderMetalCommandEncoder - Get the Metal command encoder for the current frame.
Return Value
Returns an id<MTLRenderCommandEncoder> on success, or NULL if the renderer isn't a Metal renderer or
there was an error.
See Also
SDL_GetRenderMetalLayer(3) Simple Directmedia Layer SDL 3.2.20 SDL_GetRenderMetalCommandEncoder(3)
Synopsis
#include<SDL3/SDL_render.h>void*SDL_GetRenderMetalCommandEncoder(SDL_Renderer*renderer);
Thread Safety
This function should only be called on the main thread.
