SDL_GetRenderMetalCommandEncoder - Man Page

Defined in SDL3/SDL_render.h

#include "SDL3/SDL.h"

void * SDL_GetRenderMetalCommandEncoder(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> .

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!

renderer

the renderer to query.

Returns an id<MTLRenderCommandEncoder> on success, or NULL if the renderer isn't a Metal renderer or there was an error.

This function should only be called on the main thread.

This function is available since SDL 3.2.0.

·(3), SDL_GetRenderMetalLayer(3)

SDL_GetRenderMetalLayer(3).