vk_icd.h
Go to the documentation of this file.
//
// File: vk_icd.h
//
/*
* Copyright (c) 2015-2016 The Khronos Group Inc.
* Copyright (c) 2015-2016 Valve Corporation
* Copyright (c) 2015-2016 LunarG, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#ifndef VKICD_H
#define VKICD_H
#include "vulkan.h"
#include <stdbool.h>
// Loader-ICD version negotiation API. Versions add the following features:
// Version 0 - Initial. Doesn't support vk_icdGetInstanceProcAddr
// or vk_icdNegotiateLoaderICDInterfaceVersion.
// Version 1 - Add support for vk_icdGetInstanceProcAddr.
// Version 2 - Add Loader/ICD Interface version negotiation
// via vk_icdNegotiateLoaderICDInterfaceVersion.
// Version 3 - Add ICD creation/destruction of KHR_surface objects.
// Version 4 - Add unknown physical device extension qyering via
// vk_icdGetPhysicalDeviceProcAddr.
// Version 5 - Tells ICDs that the loader is now paying attention to the
// application version of Vulkan passed into the ApplicationInfo
// structure during vkCreateInstance. This will tell the ICD
// that if the loader is older, it should automatically fail a
// call for any API version > 1.0. Otherwise, the loader will
// manually determine if it can support the expected version.
#define CURRENT_LOADER_ICD_INTERFACE_VERSION 5
#define MIN_SUPPORTED_LOADER_ICD_INTERFACE_VERSION 0
#define MIN_PHYS_DEV_EXTENSION_ICD_INTERFACE_VERSION 4
typedef VkResult(VKAPI_PTR *PFN_vkNegotiateLoaderICDInterfaceVersion)(uint32_t *pVersion);
// This is defined in vk_layer.h which will be found by the loader, but if an ICD is building against this
// file directly, it won't be found.
#ifndef PFN_GetPhysicalDeviceProcAddr
typedef PFN_vkVoidFunction(VKAPI_PTR *PFN_GetPhysicalDeviceProcAddr)(VkInstance instance, const char *pName);
#endif
/*
* The ICD must reserve space for a pointer for the loader's dispatch
* table, at the start of <each object>.
* The ICD must initialize this variable using the SET_LOADER_MAGIC_VALUE macro.
*/
#define ICD_LOADER_MAGIC 0x01CDC0DE
typedef union {
uintptr_t loaderMagic;
void *loaderData;
} VK_LOADER_DATA;
static inline void set_loader_magic_value(void *pNewObject) {
VK_LOADER_DATA *loader_info = (VK_LOADER_DATA *)pNewObject;
loader_info->loaderMagic = ICD_LOADER_MAGIC;
}
static inline bool valid_loader_magic_value(void *pNewObject) {
const VK_LOADER_DATA *loader_info = (VK_LOADER_DATA *)pNewObject;
return (loader_info->loaderMagic & 0xffffffff) == ICD_LOADER_MAGIC;
}
/*
* Windows and Linux ICDs will treat VkSurfaceKHR as a pointer to a struct that
* contains the platform-specific connection and surface information.
*/
typedef enum {
VK_ICD_WSI_PLATFORM_MIR,
VK_ICD_WSI_PLATFORM_WAYLAND,
VK_ICD_WSI_PLATFORM_WIN32,
VK_ICD_WSI_PLATFORM_XCB,
VK_ICD_WSI_PLATFORM_XLIB,
VK_ICD_WSI_PLATFORM_ANDROID,
VK_ICD_WSI_PLATFORM_MACOS,
VK_ICD_WSI_PLATFORM_IOS,
VK_ICD_WSI_PLATFORM_DISPLAY
} VkIcdWsiPlatform;
typedef struct {
VkIcdWsiPlatform platform;
} VkIcdSurfaceBase;
#ifdef VK_USE_PLATFORM_MIR_KHR
typedef struct {
VkIcdSurfaceBase base;
MirConnection *connection;
MirSurface *mirSurface;
} VkIcdSurfaceMir;
#endif // VK_USE_PLATFORM_MIR_KHR
#ifdef VK_USE_PLATFORM_WAYLAND_KHR
typedef struct {
VkIcdSurfaceBase base;
struct wl_display *display;
struct wl_surface *surface;
} VkIcdSurfaceWayland;
#endif // VK_USE_PLATFORM_WAYLAND_KHR
#ifdef VK_USE_PLATFORM_WIN32_KHR
typedef struct {
VkIcdSurfaceBase base;
HINSTANCE hinstance;
HWND hwnd;
} VkIcdSurfaceWin32;
#endif // VK_USE_PLATFORM_WIN32_KHR
#ifdef VK_USE_PLATFORM_XCB_KHR
typedef struct {
VkIcdSurfaceBase base;
xcb_connection_t *connection;
xcb_window_t window;
} VkIcdSurfaceXcb;
#endif // VK_USE_PLATFORM_XCB_KHR
#ifdef VK_USE_PLATFORM_XLIB_KHR
typedef struct {
VkIcdSurfaceBase base;
Display *dpy;
Window window;
} VkIcdSurfaceXlib;
#endif // VK_USE_PLATFORM_XLIB_KHR
#ifdef VK_USE_PLATFORM_ANDROID_KHR
typedef struct {
VkIcdSurfaceBase base;
struct ANativeWindow *window;
} VkIcdSurfaceAndroid;
#endif // VK_USE_PLATFORM_ANDROID_KHR
#ifdef VK_USE_PLATFORM_MACOS_MVK
typedef struct {
VkIcdSurfaceBase base;
const void *pView;
} VkIcdSurfaceMacOS;
#endif // VK_USE_PLATFORM_MACOS_MVK
#ifdef VK_USE_PLATFORM_IOS_MVK
typedef struct {
VkIcdSurfaceBase base;
const void *pView;
} VkIcdSurfaceIOS;
#endif // VK_USE_PLATFORM_IOS_MVK
typedef struct {
VkIcdSurfaceBase base;
VkDisplayModeKHR displayMode;
uint32_t planeIndex;
uint32_t planeStackIndex;
VkSurfaceTransformFlagBitsKHR transform;
float globalAlpha;
VkDisplayPlaneAlphaFlagBitsKHR alphaMode;
VkExtent2D imageExtent;
} VkIcdSurfaceDisplay;
#endif // VKICD_H
PFN_GetPhysicalDeviceProcAddr
PFN_vkVoidFunction(VKAPI_PTR * PFN_GetPhysicalDeviceProcAddr)(VkInstance instance, const char *pName)
Definition: vk_icd.h:52
VK_ICD_WSI_PLATFORM_IOS
@ VK_ICD_WSI_PLATFORM_IOS
Definition: vk_icd.h:90
PFN_vkVoidFunction
void(VKAPI_PTR * PFN_vkVoidFunction)(void)
Definition: vulkan_core.h:2024
surface
EGLSurface surface
Definition: eglext.h:248
dpy
return Display return Display Bool Bool int int int return Display XEvent Bool(*) XPointer return Display return Display dpy)
Definition: SDL_x11sym.h:44
VkIcdSurfaceBase::platform
VkIcdWsiPlatform platform
Definition: vk_icd.h:95
VK_ICD_WSI_PLATFORM_ANDROID
@ VK_ICD_WSI_PLATFORM_ANDROID
Definition: vk_icd.h:88
VkIcdSurfaceDisplay::imageExtent
VkExtent2D imageExtent
Definition: vk_icd.h:167
PFN_vkNegotiateLoaderICDInterfaceVersion
VkResult(VKAPI_PTR * PFN_vkNegotiateLoaderICDInterfaceVersion)(uint32_t *pVersion)
Definition: vk_icd.h:47
VK_LOADER_DATA
Definition: vk_icd.h:63
VK_ICD_WSI_PLATFORM_XLIB
@ VK_ICD_WSI_PLATFORM_XLIB
Definition: vk_icd.h:87
VK_LOADER_DATA::loaderMagic
uintptr_t loaderMagic
Definition: vk_icd.h:64
VkIcdSurfaceDisplay
Definition: vk_icd.h:159
valid_loader_magic_value
static bool valid_loader_magic_value(void *pNewObject)
Definition: vk_icd.h:73
VkIcdSurfaceDisplay::base
VkIcdSurfaceBase base
Definition: vk_icd.h:160
VkDisplayPlaneAlphaFlagBitsKHR
VkDisplayPlaneAlphaFlagBitsKHR
Definition: vulkan_core.h:4956
window
EGLSurface EGLNativeWindowType * window
Definition: eglext.h:1025
VkResult
VkResult
Definition: vulkan_core.h:120
VK_ICD_WSI_PLATFORM_WIN32
@ VK_ICD_WSI_PLATFORM_WIN32
Definition: vk_icd.h:85
VkIcdSurfaceDisplay::globalAlpha
float globalAlpha
Definition: vk_icd.h:165
VkIcdSurfaceDisplay::planeStackIndex
uint32_t planeStackIndex
Definition: vk_icd.h:163
VKAPI_PTR
#define VKAPI_PTR
Definition: vk_platform.h:53
vulkan.h
set_loader_magic_value
static void set_loader_magic_value(void *pNewObject)
Definition: vk_icd.h:68
VkIcdSurfaceBase
Definition: vk_icd.h:94
VkExtent2D
Definition: vulkan_core.h:2359
VkSurfaceTransformFlagBitsKHR
VkSurfaceTransformFlagBitsKHR
Definition: vulkan_core.h:4709
VkIcdSurfaceDisplay::planeIndex
uint32_t planeIndex
Definition: vk_icd.h:162
VK_ICD_WSI_PLATFORM_MACOS
@ VK_ICD_WSI_PLATFORM_MACOS
Definition: vk_icd.h:89
uint32_t
unsigned int uint32_t
Definition: SDL_config_windows.h:63
VK_ICD_WSI_PLATFORM_WAYLAND
@ VK_ICD_WSI_PLATFORM_WAYLAND
Definition: vk_icd.h:84
VK_ICD_WSI_PLATFORM_XCB
@ VK_ICD_WSI_PLATFORM_XCB
Definition: vk_icd.h:86
VK_ICD_WSI_PLATFORM_DISPLAY
@ VK_ICD_WSI_PLATFORM_DISPLAY
Definition: vk_icd.h:91
VK_LOADER_DATA::loaderData
void * loaderData
Definition: vk_icd.h:65
VK_ICD_WSI_PLATFORM_MIR
@ VK_ICD_WSI_PLATFORM_MIR
Definition: vk_icd.h:83
ICD_LOADER_MAGIC
#define ICD_LOADER_MAGIC
Definition: vk_icd.h:61
VkIcdSurfaceDisplay::alphaMode
VkDisplayPlaneAlphaFlagBitsKHR alphaMode
Definition: vk_icd.h:166
VkIcdSurfaceDisplay::transform
VkSurfaceTransformFlagBitsKHR transform
Definition: vk_icd.h:164
VkIcdSurfaceDisplay::displayMode
VkDisplayModeKHR displayMode
Definition: vk_icd.h:161
VkIcdWsiPlatform
VkIcdWsiPlatform
Definition: vk_icd.h:82
uintptr_t
unsigned int uintptr_t
Definition: SDL_config_windows.h:70