#include <SDL3/SDL_video.h>
#include <SDL3/SDL_begin_code.h>
#include <SDL3/SDL_close_code.h>

Include dependency graph for SDL_metal.h:

This graph shows which files directly or indirectly include this file:

Typedefs
typedef void *	SDL_MetalView

Functions
Metal support functions
SDL_MetalView	SDL_Metal_CreateView (SDL_Window *window)
void	SDL_Metal_DestroyView (SDL_MetalView view)
void *	SDL_Metal_GetLayer (SDL_MetalView view)

Typedef Documentation

◆ SDL_MetalView

typedef void* SDL_MetalView

CategoryMetal

Functions to creating Metal layers and views on SDL windows.

This provides some platform-specific glue for Apple platforms. Most macOS and iOS apps can use SDL without these functions, but this API they can be useful for specific OS-level integration tasks. A handle to a CAMetalLayer-backed NSView (macOS) or UIView (iOS/tvOS).

Since: This datatype is available since SDL 3.2.0.

Definition at line 48 of file SDL_metal.h.

Function Documentation

◆ SDL_Metal_CreateView()

SDL_MetalView SDL_Metal_CreateView ( SDL_Window * window )

extern

Create a CAMetalLayer-backed NSView/UIView and attach it to the specified window.

On macOS, this does not associate a MTLDevice with the CAMetalLayer on its own. It is up to user code to do that.

The returned handle can be casted directly to a NSView or UIView. To access the backing CAMetalLayer, call SDL_Metal_GetLayer().

Parameters

window the window.

Returns: handle NSView or UIView.

\threadsafety This function should only be called on the main thread.

Since: This function is available since SDL 3.2.0.

See also: SDL_Metal_DestroyView; SDL_Metal_GetLayer

References window.

◆ SDL_Metal_DestroyView()

void SDL_Metal_DestroyView ( SDL_MetalView view )

extern

Destroy an existing SDL_MetalView object.

This should be called before SDL_DestroyWindow, if SDL_Metal_CreateView was called after SDL_CreateWindow.

Parameters

view	the SDL_MetalView object.

\threadsafety This function should only be called on the main thread.

Since: This function is available since SDL 3.2.0.

See also: SDL_Metal_CreateView

◆ SDL_Metal_GetLayer()

void * SDL_Metal_GetLayer ( SDL_MetalView view )

extern

Get a pointer to the backing CAMetalLayer for the given view.

Parameters

view	the SDL_MetalView object.

Returns: a pointer.

\threadsafety This function should only be called on the main thread.

Since: This function is available since SDL 3.2.0.

Typedefs

Functions

Typedef Documentation

◆ SDL_MetalView

CategoryMetal

Function Documentation

◆ SDL_Metal_CreateView()

◆ SDL_Metal_DestroyView()

◆ SDL_Metal_GetLayer()