Subversion Repositories Games.Prince of Persia

Rev

Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.   Simple DirectMedia Layer
  3.   Copyright (C) 2017, Mark Callow
  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_vulkan.h
  24.  *
  25.  *  Header file for functions to creating Vulkan surfaces on SDL windows.
  26.  */
  27.  
  28. #ifndef SDL_vulkan_h_
  29. #define SDL_vulkan_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. /* Avoid including vulkan.h, don't define VkInstance if it's already included */
  40. #ifdef VULKAN_H_
  41. #define NO_SDL_VULKAN_TYPEDEFS
  42. #endif
  43. #ifndef NO_SDL_VULKAN_TYPEDEFS
  44. #define VK_DEFINE_HANDLE(object) typedef struct object##_T* object;
  45.  
  46. #if defined(__LP64__) || defined(_WIN64) || defined(__x86_64__) || defined(_M_X64) || defined(__ia64) || defined (_M_IA64) || defined(__aarch64__) || defined(__powerpc64__)
  47. #define VK_DEFINE_NON_DISPATCHABLE_HANDLE(object) typedef struct object##_T *object;
  48. #else
  49. #define VK_DEFINE_NON_DISPATCHABLE_HANDLE(object) typedef uint64_t object;
  50. #endif
  51.  
  52. VK_DEFINE_HANDLE(VkInstance)
  53. VK_DEFINE_NON_DISPATCHABLE_HANDLE(VkSurfaceKHR)
  54.  
  55. #endif /* !NO_SDL_VULKAN_TYPEDEFS */
  56.  
  57. typedef VkInstance SDL_vulkanInstance;
  58. typedef VkSurfaceKHR SDL_vulkanSurface; /* for compatibility with Tizen */
  59.  
  60. /**
  61.  *  \name Vulkan support functions
  62.  *
  63.  *  \note SDL_Vulkan_GetInstanceExtensions & SDL_Vulkan_CreateSurface API
  64.  *        is compatable with Tizen's implementation of Vulkan in SDL.
  65.  */
  66. /* @{ */
  67.  
  68. /**
  69.  *  \brief Dynamically load a Vulkan loader library.
  70.  *
  71.  *  \param [in] path The platform dependent Vulkan loader library name, or
  72.  *              \c NULL to open the default Vulkan loader library.
  73.  *
  74.  *  \return \c 0 on success, or \c -1 if the library couldn't be loaded.
  75.  *
  76.  *  This should be done after initializing the video driver, but before
  77.  *  creating any Vulkan windows. If no Vulkan loader library is loaded, the
  78.  *  default library will be loaded upon creation of the first Vulkan window.
  79.  *
  80.  *  \note If you specify a non-NULL \a path, you should retrieve all of the
  81.  *        Vulkan functions used in your program from the dynamic library using
  82.  *        \c SDL_Vulkan_GetVkGetInstanceProcAddr() unless you can guarantee
  83.  *        \a path points to the same vulkan loader library that you linked to.
  84.  *
  85.  *  \note On Apple devices, if \a path is NULL, SDL will attempt to find
  86.  *        the vkGetInstanceProcAddr address within all the mach-o images of
  87.  *        the current process. This is because the currently (v0.17.0)
  88.  *        recommended MoltenVK (Vulkan on Metal) usage is as a static library.
  89.  *        If it is not found then SDL will attempt to load \c libMoltenVK.dylib.
  90.  *        Applications using the dylib alternative therefore do not need to do
  91.  *        anything special when calling SDL.
  92.  *
  93.  *  \note On non-Apple devices, SDL requires you to either not link to the
  94.  *        Vulkan loader or link to a dynamic library version. This limitation
  95.  *        may be removed in a future version of SDL.
  96.  *
  97.  *  \note This function will fail if there are no working Vulkan drivers
  98.  *        installed.
  99.  *
  100.  *  \sa SDL_Vulkan_GetVkGetInstanceProcAddr()
  101.  *  \sa SDL_Vulkan_UnloadLibrary()
  102.  */
  103. extern DECLSPEC int SDLCALL SDL_Vulkan_LoadLibrary(const char *path);
  104.  
  105. /**
  106.  *  \brief Get the address of the \c vkGetInstanceProcAddr function.
  107.  *
  108.  *  \note This should be called after either calling SDL_Vulkan_LoadLibrary
  109.  *        or creating an SDL_Window with the SDL_WINDOW_VULKAN flag.
  110.  */
  111. extern DECLSPEC void *SDLCALL SDL_Vulkan_GetVkGetInstanceProcAddr(void);
  112.  
  113. /**
  114.  *  \brief Unload the Vulkan loader library previously loaded by
  115.  *         \c SDL_Vulkan_LoadLibrary().
  116.  *
  117.  *  \sa SDL_Vulkan_LoadLibrary()
  118.  */
  119. extern DECLSPEC void SDLCALL SDL_Vulkan_UnloadLibrary(void);
  120.  
  121. /**
  122.  *  \brief Get the names of the Vulkan instance extensions needed to create
  123.  *         a surface with \c SDL_Vulkan_CreateSurface().
  124.  *
  125.  *  \param [in]     window Window for which the required Vulkan instance
  126.  *                  extensions should be retrieved
  127.  *  \param [in,out] count pointer to an \c unsigned related to the number of
  128.  *                  required Vulkan instance extensions
  129.  *  \param [out]    names \c NULL or a pointer to an array to be filled with the
  130.  *                  required Vulkan instance extensions
  131.  *
  132.  *  \return \c SDL_TRUE on success, \c SDL_FALSE on error.
  133.  *
  134.  *  If \a pNames is \c NULL, then the number of required Vulkan instance
  135.  *  extensions is returned in pCount. Otherwise, \a pCount must point to a
  136.  *  variable set to the number of elements in the \a pNames array, and on
  137.  *  return the variable is overwritten with the number of names actually
  138.  *  written to \a pNames. If \a pCount is less than the number of required
  139.  *  extensions, at most \a pCount structures will be written. If \a pCount
  140.  *  is smaller than the number of required extensions, \c SDL_FALSE will be
  141.  *  returned instead of \c SDL_TRUE, to indicate that not all the required
  142.  *  extensions were returned.
  143.  *
  144.  *  \note The returned list of extensions will contain \c VK_KHR_surface
  145.  *        and zero or more platform specific extensions
  146.  *
  147.  *  \note The extension names queried here must be enabled when calling
  148.  *        VkCreateInstance, otherwise surface creation will fail.
  149.  *
  150.  *  \note \c window should have been created with the \c SDL_WINDOW_VULKAN flag.
  151.  *
  152.  *  \code
  153.  *  unsigned int count;
  154.  *  // get count of required extensions
  155.  *  if(!SDL_Vulkan_GetInstanceExtensions(window, &count, NULL))
  156.  *      handle_error();
  157.  *
  158.  *  static const char *const additionalExtensions[] =
  159.  *  {
  160.  *      VK_EXT_DEBUG_REPORT_EXTENSION_NAME, // example additional extension
  161.  *  };
  162.  *  size_t additionalExtensionsCount = sizeof(additionalExtensions) / sizeof(additionalExtensions[0]);
  163.  *  size_t extensionCount = count + additionalExtensionsCount;
  164.  *  const char **names = malloc(sizeof(const char *) * extensionCount);
  165.  *  if(!names)
  166.  *      handle_error();
  167.  *
  168.  *  // get names of required extensions
  169.  *  if(!SDL_Vulkan_GetInstanceExtensions(window, &count, names))
  170.  *      handle_error();
  171.  *
  172.  *  // copy additional extensions after required extensions
  173.  *  for(size_t i = 0; i < additionalExtensionsCount; i++)
  174.  *      names[i + count] = additionalExtensions[i];
  175.  *
  176.  *  VkInstanceCreateInfo instanceCreateInfo = {};
  177.  *  instanceCreateInfo.enabledExtensionCount = extensionCount;
  178.  *  instanceCreateInfo.ppEnabledExtensionNames = names;
  179.  *  // fill in rest of instanceCreateInfo
  180.  *
  181.  *  VkInstance instance;
  182.  *  // create the Vulkan instance
  183.  *  VkResult result = vkCreateInstance(&instanceCreateInfo, NULL, &instance);
  184.  *  free(names);
  185.  *  \endcode
  186.  *
  187.  *  \sa SDL_Vulkan_CreateSurface()
  188.  */
  189. extern DECLSPEC SDL_bool SDLCALL SDL_Vulkan_GetInstanceExtensions(
  190.                                                                                                                 SDL_Window *window,
  191.                                                                                                                 unsigned int *pCount,
  192.                                                                                                                 const char **pNames);
  193.  
  194. /**
  195.  *  \brief Create a Vulkan rendering surface for a window.
  196.  *
  197.  *  \param [in]  window   SDL_Window to which to attach the rendering surface.
  198.  *  \param [in]  instance handle to the Vulkan instance to use.
  199.  *  \param [out] surface  pointer to a VkSurfaceKHR handle to receive the
  200.  *                        handle of the newly created surface.
  201.  *
  202.  *  \return \c SDL_TRUE on success, \c SDL_FALSE on error.
  203.  *
  204.  *  \code
  205.  *  VkInstance instance;
  206.  *  SDL_Window *window;
  207.  *
  208.  *  // create instance and window
  209.  *
  210.  *  // create the Vulkan surface
  211.  *  VkSurfaceKHR surface;
  212.  *  if(!SDL_Vulkan_CreateSurface(window, instance, &surface))
  213.  *      handle_error();
  214.  *  \endcode
  215.  *
  216.  *  \note \a window should have been created with the \c SDL_WINDOW_VULKAN flag.
  217.  *
  218.  *  \note \a instance should have been created with the extensions returned
  219.  *        by \c SDL_Vulkan_CreateSurface() enabled.
  220.  *
  221.  *  \sa SDL_Vulkan_GetInstanceExtensions()
  222.  */
  223. extern DECLSPEC SDL_bool SDLCALL SDL_Vulkan_CreateSurface(
  224.                                                                                                 SDL_Window *window,
  225.                                                                                                 VkInstance instance,
  226.                                                                                                 VkSurfaceKHR* surface);
  227.  
  228. /**
  229.  *  \brief Get the size of a window's underlying drawable in pixels (for use
  230.  *         with setting viewport, scissor & etc).
  231.  *
  232.  *  \param window   SDL_Window from which the drawable size should be queried
  233.  *  \param w        Pointer to variable for storing the width in pixels,
  234.  *                  may be NULL
  235.  *  \param h        Pointer to variable for storing the height in pixels,
  236.  *                  may be NULL
  237.  *
  238.  * This may differ from SDL_GetWindowSize() if we're rendering to a high-DPI
  239.  * drawable, i.e. the window was created with SDL_WINDOW_ALLOW_HIGHDPI on a
  240.  * platform with high-DPI support (Apple calls this "Retina"), and not disabled
  241.  * by the \c SDL_HINT_VIDEO_HIGHDPI_DISABLED hint.
  242.  *
  243.  *  \sa SDL_GetWindowSize()
  244.  *  \sa SDL_CreateWindow()
  245.  */
  246. extern DECLSPEC void SDLCALL SDL_Vulkan_GetDrawableSize(SDL_Window * window,
  247.                                                         int *w, int *h);
  248.  
  249. /* @} *//* Vulkan support functions */
  250.  
  251. /* Ends C function definitions when using C++ */
  252. #ifdef __cplusplus
  253. }
  254. #endif
  255. #include "close_code.h"
  256.  
  257. #endif /* SDL_vulkan_h_ */
  258.