sdl

FORK: Simple Directmedia Layer
git clone https://git.neptards.moe/neptards/sdl.git
Log | Files | Refs

SDL_metal.h (3773B)

      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.
     59  *  To access the backing CAMetalLayer, call SDL_Metal_GetLayer().
     60  *
     61  *  \note \a window must be created with the SDL_WINDOW_METAL flag.
     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  *  \brief 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  *  \sa SDL_Metal_CreateView
     75  */
     76 extern DECLSPEC void SDLCALL SDL_Metal_DestroyView(SDL_MetalView view);
     77 
     78 /**
     79  *  \brief Get a pointer to the backing CAMetalLayer for the given view.
     80  *
     81  *  \sa SDL_MetalCreateView
     82  */
     83 extern DECLSPEC void *SDLCALL SDL_Metal_GetLayer(SDL_MetalView view);
     84 
     85 /**
     86  *  \brief Get the size of a window's underlying drawable in pixels (for use
     87  *         with setting viewport, scissor & etc).
     88  *
     89  *  \param window   SDL_Window from which the drawable size should be queried
     90  *  \param w        Pointer to variable for storing the width in pixels,
     91  *                  may be NULL
     92  *  \param h        Pointer to variable for storing the height in pixels,
     93  *                  may be NULL
     94  *
     95  * This may differ from SDL_GetWindowSize() if we're rendering to a high-DPI
     96  * drawable, i.e. the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a
     97  * platform with high-DPI support (Apple calls this "Retina"), and not disabled
     98  * by the \c SDL_HINT_VIDEO_HIGHDPI_DISABLED hint.
     99  *
    100  *  \note On macOS high-DPI support must be enabled for an application by
    101  *        setting NSHighResolutionCapable to true in its Info.plist.
    102  *
    103  *  \sa SDL_GetWindowSize()
    104  *  \sa SDL_CreateWindow()
    105  */
    106 extern DECLSPEC void SDLCALL SDL_Metal_GetDrawableSize(SDL_Window* window, int *w,
    107                                                        int *h);
    108 
    109 /* @} *//* Metal support functions */
    110 
    111 /* Ends C function definitions when using C++ */
    112 #ifdef __cplusplus
    113 }
    114 #endif
    115 #include "close_code.h"
    116 
    117 #endif /* SDL_metal_h_ */