SDL  2.0
vk_layer.h
Go to the documentation of this file.
1 //
2 // File: vk_layer.h
3 //
4 /*
5  * Copyright (c) 2015-2017 The Khronos Group Inc.
6  * Copyright (c) 2015-2017 Valve Corporation
7  * Copyright (c) 2015-2017 LunarG, Inc.
8  *
9  * Licensed under the Apache License, Version 2.0 (the "License");
10  * you may not use this file except in compliance with the License.
11  * You may obtain a copy of the License at
12  *
13  * http://www.apache.org/licenses/LICENSE-2.0
14  *
15  * Unless required by applicable law or agreed to in writing, software
16  * distributed under the License is distributed on an "AS IS" BASIS,
17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18  * See the License for the specific language governing permissions and
19  * limitations under the License.
20  *
21  */
22 
23 /* Need to define dispatch table
24  * Core struct can then have ptr to dispatch table at the top
25  * Along with object ptrs for current and next OBJ
26  */
27 #pragma once
28 
29 #include "vulkan.h"
30 #if defined(__GNUC__) && __GNUC__ >= 4
31 #define VK_LAYER_EXPORT __attribute__((visibility("default")))
32 #elif defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590)
33 #define VK_LAYER_EXPORT __attribute__((visibility("default")))
34 #else
35 #define VK_LAYER_EXPORT
36 #endif
37 
38 #define MAX_NUM_UNKNOWN_EXTS 250
39 
40  // Loader-Layer version negotiation API. Versions add the following features:
41  // Versions 0/1 - Initial. Doesn't support vk_layerGetPhysicalDeviceProcAddr
42  // or vk_icdNegotiateLoaderLayerInterfaceVersion.
43  // Version 2 - Add support for vk_layerGetPhysicalDeviceProcAddr and
44  // vk_icdNegotiateLoaderLayerInterfaceVersion.
45 #define CURRENT_LOADER_LAYER_INTERFACE_VERSION 2
46 #define MIN_SUPPORTED_LOADER_LAYER_INTERFACE_VERSION 1
47 
48 #define VK_CURRENT_CHAIN_VERSION 1
49 
50 // Typedef for use in the interfaces below
51 typedef PFN_vkVoidFunction (VKAPI_PTR *PFN_GetPhysicalDeviceProcAddr)(VkInstance instance, const char* pName);
52 
53 // Version negotiation values
58 
59 // Version negotiation structures
60 typedef struct VkNegotiateLayerInterface {
62  void *pNext;
68 
69 // Version negotiation functions
71 
72 // Function prototype for unknown physical device extension command
73 typedef VkResult(VKAPI_PTR *PFN_PhysDevExt)(VkPhysicalDevice phys_device);
74 
75 // ------------------------------------------------------------------------------------------------
76 // CreateInstance and CreateDevice support structures
77 
78 /* Sub type of structure for instance and device loader ext of CreateInfo.
79  * When sType == VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO
80  * or sType == VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO
81  * then VkLayerFunction indicates struct type pointed to by pNext
82  */
83 typedef enum VkLayerFunction_ {
87 
88 typedef struct VkLayerInstanceLink_ {
89  struct VkLayerInstanceLink_ *pNext;
93 
94 /*
95  * When creating the device chain the loader needs to pass
96  * down information about it's device structure needed at
97  * the end of the chain. Passing the data via the
98  * VkLayerDeviceInfo avoids issues with finding the
99  * exact instance being used.
100  */
101 typedef struct VkLayerDeviceInfo_ {
102  void *device_info;
105 
106 typedef VkResult (VKAPI_PTR *PFN_vkSetInstanceLoaderData)(VkInstance instance,
107  void *object);
109  void *object);
110 
111 typedef struct {
112  VkStructureType sType; // VK_STRUCTURE_TYPE_LOADER_INSTANCE_CREATE_INFO
113  const void *pNext;
114  VkLayerFunction function;
115  union {
118  } u;
120 
121 typedef struct VkLayerDeviceLink_ {
122  struct VkLayerDeviceLink_ *pNext;
126 
127 typedef struct {
128  VkStructureType sType; // VK_STRUCTURE_TYPE_LOADER_DEVICE_CREATE_INFO
129  const void *pNext;
130  VkLayerFunction function;
131  union {
134  } u;
136 
137 #ifdef __cplusplus
138 extern "C" {
139 #endif
140 
142 
143 typedef enum VkChainType {
148 } VkChainType;
149 
150 typedef struct VkChainHeader {
154 } VkChainHeader;
155 
158  VkResult(VKAPI_PTR *pfnNextLayer)(const struct VkEnumerateInstanceExtensionPropertiesChain *, const char *, uint32_t *,
161 
162 #if defined(__cplusplus)
163  inline VkResult CallDown(const char *pLayerName, uint32_t *pPropertyCount, VkExtensionProperties *pProperties) const {
164  return pfnNextLayer(pNextLink, pLayerName, pPropertyCount, pProperties);
165  }
166 #endif
168 
173 
174 #if defined(__cplusplus)
175  inline VkResult CallDown(uint32_t *pPropertyCount, VkLayerProperties *pProperties) const {
176  return pfnNextLayer(pNextLink, pPropertyCount, pProperties);
177  }
178 #endif
180 
183  VkResult(VKAPI_PTR *pfnNextLayer)(const struct VkEnumerateInstanceVersionChain *, uint32_t *);
185 
186 #if defined(__cplusplus)
187  inline VkResult CallDown(uint32_t *pApiVersion) const {
188  return pfnNextLayer(pNextLink, pApiVersion);
189  }
190 #endif
192 
193 #ifdef __cplusplus
194 }
195 #endif
VkNegotiateLayerInterface::pfnGetInstanceProcAddr
PFN_vkGetInstanceProcAddr pfnGetInstanceProcAddr
Definition: vk_layer.h:64
VkLayerInstanceCreateInfo
Definition: vk_layer.h:111
LAYER_NEGOTIATE_INTERFACE_STRUCT
Definition: vk_layer.h:56
PFN_vkGetInstanceProcAddr
PFN_vkVoidFunction(VKAPI_PTR * PFN_vkGetInstanceProcAddr)(VkInstance instance, const char *pName)
Definition: vulkan_core.h:2859
VK_CHAIN_TYPE_ENUMERATE_INSTANCE_LAYER_PROPERTIES
Definition: vk_layer.h:146
VkNegotiateLayerInterface::pfnGetPhysicalDeviceProcAddr
PFN_GetPhysicalDeviceProcAddr pfnGetPhysicalDeviceProcAddr
Definition: vk_layer.h:66
PFN_vkVoidFunction
void(VKAPI_PTR * PFN_vkVoidFunction)(void)
Definition: vulkan_core.h:2024
VK_CHAIN_TYPE_ENUMERATE_INSTANCE_VERSION
Definition: vk_layer.h:147
VK_CHAIN_TYPE_UNKNOWN
Definition: vk_layer.h:144
VkEnumerateInstanceVersionChain::header
VkChainHeader header
Definition: vk_layer.h:182
VkChainHeader::size
uint32_t size
Definition: vk_layer.h:153
VkChainType
VkChainType
Definition: vk_layer.h:143
VkLayerDeviceCreateInfo
Definition: vk_layer.h:127
VK_CHAIN_TYPE_ENUMERATE_INSTANCE_EXTENSION_PROPERTIES
Definition: vk_layer.h:145
VkEnumerateInstanceVersionChain
Definition: vk_layer.h:181
VkEnumerateInstanceVersionChain::VkResult
VkResult(VKAPI_PTR *pfnNextLayer)(const struct VkEnumerateInstanceVersionChain *
VkEnumerateInstanceLayerPropertiesChain::pNextLink
uint32_t VkLayerProperties *const struct VkEnumerateInstanceLayerPropertiesChain * pNextLink
Definition: vk_layer.h:172
VK_LOADER_DATA_CALLBACK
Definition: vk_layer.h:85
PFN_vkSetInstanceLoaderData
VkResult(VKAPI_PTR * PFN_vkSetInstanceLoaderData)(VkInstance instance, void *object)
Definition: vk_layer.h:106
VkNegotiateLayerStructType
VkNegotiateLayerStructType
Definition: vk_layer.h:54
object
GLuint object
Definition: SDL_opengl_glext.h:6057
VKAPI_ATTR
#define VKAPI_ATTR
Definition: vk_platform.h:51
VkResult
VkResult
Definition: vulkan_core.h:120
PFN_PhysDevExt
VkResult(VKAPI_PTR * PFN_PhysDevExt)(VkPhysicalDevice phys_device)
Definition: vk_layer.h:73
VkLayerDeviceInfo
Definition: vk_layer.h:101
VkNegotiateLayerInterface::sType
VkNegotiateLayerStructType sType
Definition: vk_layer.h:61
VkChainHeader::type
VkChainType type
Definition: vk_layer.h:151
VKAPI_CALL
#define VKAPI_CALL
Definition: vk_platform.h:52
VK_LAYER_LINK_INFO
Definition: vk_layer.h:84
VKAPI_PTR
#define VKAPI_PTR
Definition: vk_platform.h:53
vulkan.h
VkEnumerateInstanceExtensionPropertiesChain::header
VkChainHeader header
Definition: vk_layer.h:157
VkLayerInstanceCreateInfo::pNext
const void * pNext
Definition: vk_layer.h:113
VkEnumerateInstanceVersionChain::pNextLink
uint32_t *const struct VkEnumerateInstanceVersionChain * pNextLink
Definition: vk_layer.h:184
VkChainHeader
Definition: vk_layer.h:150
VkChainHeader::version
uint32_t version
Definition: vk_layer.h:152
PFN_vkGetDeviceProcAddr
PFN_vkVoidFunction(VKAPI_PTR * PFN_vkGetDeviceProcAddr)(VkDevice device, const char *pName)
Definition: vulkan_core.h:2860
VkLayerDeviceCreateInfo::pNext
const void * pNext
Definition: vk_layer.h:129
VkLayerInstanceCreateInfo::pfnSetInstanceLoaderData
PFN_vkSetInstanceLoaderData pfnSetInstanceLoaderData
Definition: vk_layer.h:117
VkLayerDeviceCreateInfo::pfnSetDeviceLoaderData
PFN_vkSetDeviceLoaderData pfnSetDeviceLoaderData
Definition: vk_layer.h:133
VkStructureType
VkStructureType
Definition: vulkan_core.h:159
PFN_vkNegotiateLoaderLayerInterfaceVersion
VkResult(VKAPI_PTR * PFN_vkNegotiateLoaderLayerInterfaceVersion)(VkNegotiateLayerInterface *pVersionStruct)
Definition: vk_layer.h:70
VkLayerDeviceInfo::device_info
void * device_info
Definition: vk_layer.h:102
VkLayerDeviceCreateInfo::sType
VkStructureType sType
Definition: vk_layer.h:128
VkEnumerateInstanceLayerPropertiesChain
Definition: vk_layer.h:169
PFN_vkSetDeviceLoaderData
VkResult(VKAPI_PTR * PFN_vkSetDeviceLoaderData)(VkDevice device, void *object)
Definition: vk_layer.h:108
uint32_t
unsigned int uint32_t
Definition: SDL_config_windows.h:63
VkNegotiateLayerInterface
Definition: vk_layer.h:60
VkEnumerateInstanceExtensionPropertiesChain::VkResult
VkResult(VKAPI_PTR *pfnNextLayer)(const struct VkEnumerateInstanceExtensionPropertiesChain *
VkNegotiateLayerInterface::loaderLayerInterfaceVersion
uint32_t loaderLayerInterfaceVersion
Definition: vk_layer.h:63
VkEnumerateInstanceLayerPropertiesChain::VkResult
VkResult(VKAPI_PTR *pfnNextLayer)(const struct VkEnumerateInstanceLayerPropertiesChain *
VkLayerInstanceCreateInfo::pLayerInfo
VkLayerInstanceLink * pLayerInfo
Definition: vk_layer.h:116
vkNegotiateLoaderLayerInterfaceVersion
VKAPI_ATTR VkResult VKAPI_CALL vkNegotiateLoaderLayerInterfaceVersion(VkNegotiateLayerInterface *pVersionStruct)
VkLayerProperties
Definition: vulkan_core.h:2052
VkLayerFunction
VkLayerFunction
Definition: vk_layer.h:83
VkLayerDeviceInfo::pfnNextGetInstanceProcAddr
PFN_vkGetInstanceProcAddr pfnNextGetInstanceProcAddr
Definition: vk_layer.h:103
VkNegotiateLayerInterface::pNext
void * pNext
Definition: vk_layer.h:62
VkExtensionProperties
Definition: vulkan_core.h:2047
VkLayerInstanceCreateInfo::sType
VkStructureType sType
Definition: vk_layer.h:112
LAYER_NEGOTIATE_UNINTIALIZED
Definition: vk_layer.h:55
VkEnumerateInstanceExtensionPropertiesChain::pNextLink
const char uint32_t VkExtensionProperties *const struct VkEnumerateInstanceExtensionPropertiesChain * pNextLink
Definition: vk_layer.h:160
device
static SDL_AudioDeviceID device
Definition: loopwave.c:37
VkEnumerateInstanceLayerPropertiesChain::header
VkChainHeader header
Definition: vk_layer.h:170
VkEnumerateInstanceExtensionPropertiesChain
Definition: vk_layer.h:156
PFN_GetPhysicalDeviceProcAddr
PFN_vkVoidFunction(VKAPI_PTR * PFN_GetPhysicalDeviceProcAddr)(VkInstance instance, const char *pName)
Definition: vk_layer.h:51
VkNegotiateLayerInterface::pfnGetDeviceProcAddr
PFN_vkGetDeviceProcAddr pfnGetDeviceProcAddr
Definition: vk_layer.h:65
VkLayerDeviceCreateInfo::pLayerInfo
VkLayerDeviceLink * pLayerInfo
Definition: vk_layer.h:132