devela::_dep::sdl3::sys::render

Function SDL_GetRenderMetalCommandEncoder

pub unsafe extern "C" fn SDL_GetRenderMetalCommandEncoder(
    renderer: *mut SDL_Renderer,
) -> *mut c_void
Available on crate feature dep_sdl3 only.
Expand description

Get the Metal command encoder for the current frame.

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!

§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.

§Thread safety

This function should only be called on the main thread.

§Availability

This function is available since SDL 3.2.0.

§See also