(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetRenderMetalLayer

Get the CAMetalLayer associated with the given Metal renderer.

Header File

Defined in <SDL3/SDL_render.h>

Syntax

void * SDL_GetRenderMetalLayer(SDL_Renderer *renderer);

Function Parameters

SDL_Renderer *

renderer

the renderer to query.

Return Value

(void *) Returns a CAMetalLayer * on success, or NULL if the renderer isn't a Metal renderer.

Remarks

This function returns void *, so SDL doesn't have to include Metal's headers, but it can be safely cast to a CAMetalLayer *.

Thread Safety

This function should only be called on the main thread.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_GetRenderMetalCommandEncoder

---

CategoryAPI, CategoryAPIFunction, CategoryRender

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.