diff options
| author | 3gg <3gg@shellblade.net> | 2024-05-04 16:51:29 -0700 |
|---|---|---|
| committer | 3gg <3gg@shellblade.net> | 2024-05-04 16:51:29 -0700 |
| commit | 8222bfe56d4dabe8d92fc4b25ea1b0163b16f3e1 (patch) | |
| tree | 763389e42276035ac134d94eb1dc32293b88d807 /src/contrib/SDL-2.30.2/include/SDL_metal.h | |
Initial commit.
Diffstat (limited to 'src/contrib/SDL-2.30.2/include/SDL_metal.h')
| -rw-r--r-- | src/contrib/SDL-2.30.2/include/SDL_metal.h | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/src/contrib/SDL-2.30.2/include/SDL_metal.h b/src/contrib/SDL-2.30.2/include/SDL_metal.h new file mode 100644 index 0000000..50f7b2a --- /dev/null +++ b/src/contrib/SDL-2.30.2/include/SDL_metal.h | |||
| @@ -0,0 +1,113 @@ | |||
| 1 | /* | ||
| 2 | Simple DirectMedia Layer | ||
| 3 | Copyright (C) 1997-2024 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 | * 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 | * \since This function is available since SDL 2.0.12. | ||
| 62 | * | ||
| 63 | * \sa SDL_Metal_DestroyView | ||
| 64 | * \sa SDL_Metal_GetLayer | ||
| 65 | */ | ||
| 66 | extern DECLSPEC SDL_MetalView SDLCALL SDL_Metal_CreateView(SDL_Window * window); | ||
| 67 | |||
| 68 | /** | ||
| 69 | * Destroy an existing SDL_MetalView object. | ||
| 70 | * | ||
| 71 | * This should be called before SDL_DestroyWindow, if SDL_Metal_CreateView was | ||
| 72 | * called after SDL_CreateWindow. | ||
| 73 | * | ||
| 74 | * \since This function is available since SDL 2.0.12. | ||
| 75 | * | ||
| 76 | * \sa SDL_Metal_CreateView | ||
| 77 | */ | ||
| 78 | extern DECLSPEC void SDLCALL SDL_Metal_DestroyView(SDL_MetalView view); | ||
| 79 | |||
| 80 | /** | ||
| 81 | * Get a pointer to the backing CAMetalLayer for the given view. | ||
| 82 | * | ||
| 83 | * \since This function is available since SDL 2.0.14. | ||
| 84 | * | ||
| 85 | * \sa SDL_Metal_CreateView | ||
| 86 | */ | ||
| 87 | extern DECLSPEC void *SDLCALL SDL_Metal_GetLayer(SDL_MetalView view); | ||
| 88 | |||
| 89 | /** | ||
| 90 | * Get the size of a window's underlying drawable in pixels (for use with | ||
| 91 | * setting viewport, scissor & etc). | ||
| 92 | * | ||
| 93 | * \param window SDL_Window from which the drawable size should be queried | ||
| 94 | * \param w Pointer to variable for storing the width in pixels, may be NULL | ||
| 95 | * \param h Pointer to variable for storing the height in pixels, may be NULL | ||
| 96 | * | ||
| 97 | * \since This function is available since SDL 2.0.14. | ||
| 98 | * | ||
| 99 | * \sa SDL_GetWindowSize | ||
| 100 | * \sa SDL_CreateWindow | ||
| 101 | */ | ||
| 102 | extern DECLSPEC void SDLCALL SDL_Metal_GetDrawableSize(SDL_Window* window, int *w, | ||
| 103 | int *h); | ||
| 104 | |||
| 105 | /* @} *//* Metal support functions */ | ||
| 106 | |||
| 107 | /* Ends C function definitions when using C++ */ | ||
| 108 | #ifdef __cplusplus | ||
| 109 | } | ||
| 110 | #endif | ||
| 111 | #include "close_code.h" | ||
| 112 | |||
| 113 | #endif /* SDL_metal_h_ */ | ||
