SDL  2.0
SDL_metal.h
Go to the documentation of this file.
1 /*
2  Simple DirectMedia Layer
3  Copyright (C) 1997-2020 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  * 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 "SDL_video.h"
32 
33 #include "begin_code.h"
34 /* Set up for C function definitions, even when using C++ */
35 #ifdef __cplusplus
36 extern "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  */
44 typedef void *SDL_MetalView;
45 
46 /**
47  * \name Metal support functions
48  */
49 /* @{ */
50 
51 /**
52  * \brief Create a CAMetalLayer-backed NSView/UIView and attach it to the
53  * specified window.
54  *
55  * On macOS, this does *not* associate a MTLDevice with the CAMetalLayer on its
56  * own. It is up to user code to do that.
57  *
58  * The returned handle can be casted directly to a NSView or UIView, and the
59  * CAMetalLayer can be accessed from the view's 'layer' property.
60  *
61  * \code
62  * SDL_MetalView metalview = SDL_Metal_CreateView(window);
63  * UIView *uiview = (__bridge UIView *)metalview;
64  * CAMetalLayer *metallayer = (CAMetalLayer *)uiview.layer;
65  * // [...]
66  * SDL_Metal_DestroyView(metalview);
67  * \endcode
68  *
69  * \sa SDL_Metal_DestroyView
70  */
72 
73 /**
74  * \brief Destroy an existing SDL_MetalView object.
75  *
76  * This should be called before SDL_DestroyWindow, if SDL_Metal_CreateView was
77  * called after SDL_CreateWindow.
78  *
79  * \sa SDL_Metal_CreateView
80  */
82 
83 /* @} *//* Metal support functions */
84 
85 /* Ends C function definitions when using C++ */
86 #ifdef __cplusplus
87 }
88 #endif
89 #include "close_code.h"
90 
91 #endif /* SDL_metal_h_ */
DECLSPEC
#define DECLSPEC
Definition: SDL_internal.h:48
SDLCALL
#define SDLCALL
Definition: SDL_internal.h:49
SDL_Metal_DestroyView
void SDL_Metal_DestroyView(SDL_MetalView view)
Destroy an existing SDL_MetalView object.
Definition: SDL_video.c:4231
SDL_MetalView
void * SDL_MetalView
A handle to a CAMetalLayer-backed NSView (macOS) or UIView (iOS/tvOS).
Definition: SDL_metal.h:44
close_code.h
SDL_Window
The type used to identify a window.
Definition: SDL_sysvideo.h:75
begin_code.h
window
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
SDL_Metal_CreateView
SDL_MetalView SDL_Metal_CreateView(SDL_Window *window)
Create a CAMetalLayer-backed NSView/UIView and attach it to the specified window.
Definition: SDL_video.c:4218
SDL_video.h