SDL 3.0
SDL_metal.h
Go to the documentation of this file.
1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2023 Sam Lantinga <slouken@libsdl.org>
4
5 This software is provided 'as-is', without any express or implied
6 warranty. In no event will the authors be held liable for any damages
7 arising from the use of this software.
8
9 Permission is granted to anyone to use this software for any purpose,
10 including commercial applications, and to alter it and redistribute it
11 freely, subject to the following restrictions:
12
13 1. The origin of this software must not be misrepresented; you must not
14 claim that you wrote the original software. If you use this software
15 in a product, an acknowledgment in the product documentation would be
16 appreciated but is not required.
17 2. Altered source versions must be plainly marked as such, and must not be
18 misrepresented as being the original software.
19 3. This notice may not be removed or altered from any source distribution.
20*/
21
22/**
23 * \file SDL_metal.h
24 *
25 * \brief Header file for functions to creating Metal layers and views on SDL windows.
26 */
27
28#ifndef SDL_metal_h_
29#define SDL_metal_h_
30
31#include <SDL3/SDL_video.h>
32
33#include <SDL3/SDL_begin_code.h>
34/* Set up for C function definitions, even when using C++ */
35#ifdef __cplusplus
36extern "C" {
37#endif
38
39/**
40 * \brief A handle to a CAMetalLayer-backed NSView (macOS) or UIView (iOS/tvOS).
41 *
42 * \note This can be cast directly to an NSView or UIView.
43 */
44typedef void *SDL_MetalView;
45
46/**
47 * \name Metal support functions
48 */
49/* @{ */
50
51/**
52 * Create a CAMetalLayer-backed NSView/UIView and attach it to the specified
53 * window.
54 *
55 * On macOS, this does *not* associate a MTLDevice with the CAMetalLayer on
56 * its own. It is up to user code to do that.
57 *
58 * The returned handle can be casted directly to a NSView or UIView. To access
59 * the backing CAMetalLayer, call SDL_Metal_GetLayer().
60 *
61 * \param window the window
62 * \returns handle NSView or UIView
63 *
64 * \since This function is available since SDL 3.0.0.
65 *
66 * \sa SDL_Metal_DestroyView
67 * \sa SDL_Metal_GetLayer
68 */
69extern DECLSPEC SDL_MetalView SDLCALL SDL_Metal_CreateView(SDL_Window * window);
70
71/**
72 * Destroy an existing SDL_MetalView object.
73 *
74 * This should be called before SDL_DestroyWindow, if SDL_Metal_CreateView was
75 * called after SDL_CreateWindow.
76 *
77 * \param view the SDL_MetalView object
78 *
79 * \since This function is available since SDL 3.0.0.
80 *
81 * \sa SDL_Metal_CreateView
82 */
83extern DECLSPEC void SDLCALL SDL_Metal_DestroyView(SDL_MetalView view);
84
85/**
86 * Get a pointer to the backing CAMetalLayer for the given view.
87 *
88 * \param view the SDL_MetalView object
89 * \returns a pointer
90 *
91 * \since This function is available since SDL 3.0.0.
92 *
93 * \sa SDL_Metal_CreateView
94 */
95extern DECLSPEC void *SDLCALL SDL_Metal_GetLayer(SDL_MetalView view);
96
97/* @} *//* Metal support functions */
98
99/* Ends C function definitions when using C++ */
100#ifdef __cplusplus
101}
102#endif
103#include <SDL3/SDL_close_code.h>
104
105#endif /* SDL_metal_h_ */
void * SDL_MetalView
A handle to a CAMetalLayer-backed NSView (macOS) or UIView (iOS/tvOS).
Definition: SDL_metal.h:44
void * SDL_Metal_GetLayer(SDL_MetalView view)
void SDL_Metal_DestroyView(SDL_MetalView view)
SDL_MetalView SDL_Metal_CreateView(SDL_Window *window)
Header file for SDL video functions.
struct SDL_Window SDL_Window
The type used to identify a window.
Definition: SDL_video.h:124