Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / vulkan-validation-layers / 831c183417705004ea225726d450b7259e7384c7 / . / include / vk_layer.h
blob: 692a2c0f58046c12b1808e6fb2672cee49162720 [file] [log] [blame]
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600[diff] [blame]1/* Need to define dispatch table
2 * Core struct can then have ptr to dispatch table at the top
3 * Along with object ptrs for current and next OBJ
4 */
5#pragma once
6
7#include "vulkan.h"
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600[diff] [blame]8#include "vk_debug_report_lunarg.h"
9#include "vk_debug_marker_lunarg.h"
Ian Elliott338dedb2015-08-21 15:09:33 -0600[diff] [blame]10#include "vk_ext_khr_swapchain.h"
11#include "vk_ext_khr_device_swapchain.h"
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600[diff] [blame]12#if defined(__GNUC__) && __GNUC__ >= 4
13# define VK_LAYER_EXPORT __attribute__((visibility("default")))
14#elif defined(__SUNPRO_C) && (__SUNPRO_C >= 0x590)
15# define VK_LAYER_EXPORT __attribute__((visibility("default")))
16#else
17# define VK_LAYER_EXPORT
18#endif
19
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]20typedef void * (*PFN_vkGPA)(void* obj, const char * pName);
21
Jon Ashburn301c5f02015-04-06 10:58:22 -0600[diff] [blame]22typedef struct VkBaseLayerObject_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600[diff] [blame]23{
Jon Ashburn79b78ac2015-05-05 14:22:52 -0600[diff] [blame]24 PFN_vkGPA pGPA;
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]25 void* nextObject;
26 void* baseObject;
Jon Ashburn301c5f02015-04-06 10:58:22 -0600[diff] [blame]27} VkBaseLayerObject;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600[diff] [blame]28
Jon Ashburn301c5f02015-04-06 10:58:22 -0600[diff] [blame]29typedef struct VkLayerDispatchTable_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600[diff] [blame]30{
Jon Ashburn1245cec2015-05-18 13:20:15 -0600[diff] [blame]31 PFN_vkGetDeviceProcAddr GetDeviceProcAddr;
Courtney Goeltzenleuchterbe637992015-06-25 18:01:43 -0600[diff] [blame]32 PFN_vkCreateDevice CreateDevice;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]33 PFN_vkDestroyDevice DestroyDevice;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]34 PFN_vkGetDeviceQueue GetDeviceQueue;
35 PFN_vkQueueSubmit QueueSubmit;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]36 PFN_vkQueueWaitIdle QueueWaitIdle;
37 PFN_vkDeviceWaitIdle DeviceWaitIdle;
38 PFN_vkAllocMemory AllocMemory;
39 PFN_vkFreeMemory FreeMemory;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]40 PFN_vkMapMemory MapMemory;
41 PFN_vkUnmapMemory UnmapMemory;
Courtney Goeltzenleuchtera569a502015-04-29 17:16:21 -0600[diff] [blame]42 PFN_vkFlushMappedMemoryRanges FlushMappedMemoryRanges;
43 PFN_vkInvalidateMappedMemoryRanges InvalidateMappedMemoryRanges;
Courtney Goeltzenleuchterd040c5c2015-07-09 21:57:28 -0600[diff] [blame]44 PFN_vkGetDeviceMemoryCommitment GetDeviceMemoryCommitment;
Mark Lobodzinski83d4e6a2015-07-03 15:58:09 -0600[diff] [blame]45 PFN_vkGetImageSparseMemoryRequirements GetImageSparseMemoryRequirements;
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]46 PFN_vkGetImageMemoryRequirements GetImageMemoryRequirements;
47 PFN_vkGetBufferMemoryRequirements GetBufferMemoryRequirements;
48 PFN_vkBindImageMemory BindImageMemory;
49 PFN_vkBindBufferMemory BindBufferMemory;
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -0500[diff] [blame]50 PFN_vkQueueBindSparseBufferMemory QueueBindSparseBufferMemory;
Mark Lobodzinski83d4e6a2015-07-03 15:58:09 -0600[diff] [blame]51 PFN_vkQueueBindSparseImageOpaqueMemory QueueBindSparseImageOpaqueMemory;
Mark Lobodzinskifb9f5642015-05-11 17:21:15 -0500[diff] [blame]52 PFN_vkQueueBindSparseImageMemory QueueBindSparseImageMemory;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]53 PFN_vkCreateFence CreateFence;
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]54 PFN_vkDestroyFence DestroyFence;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]55 PFN_vkGetFenceStatus GetFenceStatus;
56 PFN_vkResetFences ResetFences;
57 PFN_vkWaitForFences WaitForFences;
58 PFN_vkCreateSemaphore CreateSemaphore;
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]59 PFN_vkDestroySemaphore DestroySemaphore;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]60 PFN_vkQueueSignalSemaphore QueueSignalSemaphore;
61 PFN_vkQueueWaitSemaphore QueueWaitSemaphore;
62 PFN_vkCreateEvent CreateEvent;
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]63 PFN_vkDestroyEvent DestroyEvent;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]64 PFN_vkGetEventStatus GetEventStatus;
65 PFN_vkSetEvent SetEvent;
66 PFN_vkResetEvent ResetEvent;
67 PFN_vkCreateQueryPool CreateQueryPool;
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]68 PFN_vkDestroyQueryPool DestroyQueryPool;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]69 PFN_vkGetQueryPoolResults GetQueryPoolResults;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]70 PFN_vkCreateBuffer CreateBuffer;
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]71 PFN_vkDestroyBuffer DestroyBuffer;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]72 PFN_vkCreateBufferView CreateBufferView;
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]73 PFN_vkDestroyBufferView DestroyBufferView;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]74 PFN_vkCreateImage CreateImage;
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]75 PFN_vkDestroyImage DestroyImage;
Tony Barbour426b9052015-06-24 16:06:58 -0600[diff] [blame]76 PFN_vkGetImageSubresourceLayout GetImageSubresourceLayout;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]77 PFN_vkCreateImageView CreateImageView;
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]78 PFN_vkDestroyImageView DestroyImageView;
Courtney Goeltzenleuchter0b29b0d2015-06-24 18:24:19 -0600[diff] [blame]79 PFN_vkCreateShaderModule CreateShaderModule;
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]80 PFN_vkDestroyShaderModule DestroyShaderModule;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]81 PFN_vkCreateShader CreateShader;
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]82 PFN_vkDestroyShader DestroyShader;
Jon Ashburn0d60d272015-07-09 15:02:25 -0600[diff] [blame]83 PFN_vkCreatePipelineCache CreatePipelineCache;
84 PFN_vkDestroyPipelineCache DestroyPipelineCache;
85 PFN_vkGetPipelineCacheSize GetPipelineCacheSize;
86 PFN_vkGetPipelineCacheData GetPipelineCacheData;
87 PFN_vkMergePipelineCaches MergePipelineCaches;
88 PFN_vkCreateGraphicsPipelines CreateGraphicsPipelines;
89 PFN_vkCreateComputePipelines CreateComputePipelines;
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]90 PFN_vkDestroyPipeline DestroyPipeline;
Mark Lobodzinski556f7212015-04-17 14:11:39 -0500[diff] [blame]91 PFN_vkCreatePipelineLayout CreatePipelineLayout;
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]92 PFN_vkDestroyPipelineLayout DestroyPipelineLayout;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]93 PFN_vkCreateSampler CreateSampler;
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]94 PFN_vkDestroySampler DestroySampler;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]95 PFN_vkCreateDescriptorSetLayout CreateDescriptorSetLayout;
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]96 PFN_vkDestroyDescriptorSetLayout DestroyDescriptorSetLayout;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]97 PFN_vkCreateDescriptorPool CreateDescriptorPool;
Tony Barbourde4124d2015-07-03 10:33:54 -0600[diff] [blame]98 PFN_vkDestroyDescriptorPool DestroyDescriptorPool;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]99 PFN_vkResetDescriptorPool ResetDescriptorPool;
100 PFN_vkAllocDescriptorSets AllocDescriptorSets;
Tony Barbourb857d312015-07-10 10:50:45 -0600[diff] [blame]101 PFN_vkFreeDescriptorSets FreeDescriptorSets;
Chia-I Wu8cd8ecd2015-05-25 16:27:55 +0800[diff] [blame]102 PFN_vkUpdateDescriptorSets UpdateDescriptorSets;
Jon Ashburna25465c2015-07-23 18:48:20 -0600[diff] [blame]103 PFN_vkCreateFramebuffer CreateFramebuffer;
104 PFN_vkDestroyFramebuffer DestroyFramebuffer;
105 PFN_vkCreateRenderPass CreateRenderPass;
106 PFN_vkDestroyRenderPass DestroyRenderPass;
107 PFN_vkGetRenderAreaGranularity GetRenderAreaGranularity;
Cody Northropf02f9f82015-07-09 18:08:05 -0600[diff] [blame]108 PFN_vkCreateCommandPool CreateCommandPool;
109 PFN_vkDestroyCommandPool DestroyCommandPool;
110 PFN_vkResetCommandPool ResetCommandPool;
Courtney Goeltzenleuchter831c1832015-10-23 14:21:05 -0600[diff] [blame^]111 PFN_vkAllocCommandBuffers AllocCommandBuffers;
112 PFN_vkFreeCommandBuffers FreeCommandBuffers;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]113 PFN_vkBeginCommandBuffer BeginCommandBuffer;
114 PFN_vkEndCommandBuffer EndCommandBuffer;
115 PFN_vkResetCommandBuffer ResetCommandBuffer;
116 PFN_vkCmdBindPipeline CmdBindPipeline;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]117 PFN_vkCmdBindDescriptorSets CmdBindDescriptorSets;
Courtney Goeltzenleuchter46962942015-04-16 13:38:46 -0600[diff] [blame]118 PFN_vkCmdBindVertexBuffers CmdBindVertexBuffers;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]119 PFN_vkCmdBindIndexBuffer CmdBindIndexBuffer;
Courtney Goeltzenleuchter09772bb2015-09-17 15:06:17 -0600[diff] [blame]120 PFN_vkCmdSetViewport CmdSetViewport;
Courtney Goeltzenleuchter932cdb52015-09-21 11:44:06 -0600[diff] [blame]121 PFN_vkCmdSetScissor CmdSetScissor;
Courtney Goeltzenleuchter09772bb2015-09-17 15:06:17 -0600[diff] [blame]122 PFN_vkCmdSetLineWidth CmdSetLineWidth;
123 PFN_vkCmdSetDepthBias CmdSetDepthBias;
124 PFN_vkCmdSetBlendConstants CmdSetBlendConstants;
125 PFN_vkCmdSetDepthBounds CmdSetDepthBounds;
126 PFN_vkCmdSetStencilCompareMask CmdSetStencilCompareMask;
127 PFN_vkCmdSetStencilWriteMask CmdSetStencilWriteMask;
128 PFN_vkCmdSetStencilReference CmdSetStencilReference;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]129 PFN_vkCmdDraw CmdDraw;
130 PFN_vkCmdDrawIndexed CmdDrawIndexed;
131 PFN_vkCmdDrawIndirect CmdDrawIndirect;
132 PFN_vkCmdDrawIndexedIndirect CmdDrawIndexedIndirect;
133 PFN_vkCmdDispatch CmdDispatch;
134 PFN_vkCmdDispatchIndirect CmdDispatchIndirect;
135 PFN_vkCmdCopyBuffer CmdCopyBuffer;
136 PFN_vkCmdCopyImage CmdCopyImage;
137 PFN_vkCmdBlitImage CmdBlitImage;
138 PFN_vkCmdCopyBufferToImage CmdCopyBufferToImage;
139 PFN_vkCmdCopyImageToBuffer CmdCopyImageToBuffer;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]140 PFN_vkCmdUpdateBuffer CmdUpdateBuffer;
141 PFN_vkCmdFillBuffer CmdFillBuffer;
142 PFN_vkCmdClearColorImage CmdClearColorImage;
Chris Forbes2951d7d2015-06-22 17:21:59 +1200[diff] [blame]143 PFN_vkCmdClearDepthStencilImage CmdClearDepthStencilImage;
Courtney Goeltzenleuchter9feb0732015-10-15 16:51:05 -0600[diff] [blame]144 PFN_vkCmdClearAttachments CmdClearAttachments;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]145 PFN_vkCmdResolveImage CmdResolveImage;
146 PFN_vkCmdSetEvent CmdSetEvent;
147 PFN_vkCmdResetEvent CmdResetEvent;
148 PFN_vkCmdWaitEvents CmdWaitEvents;
149 PFN_vkCmdPipelineBarrier CmdPipelineBarrier;
150 PFN_vkCmdBeginQuery CmdBeginQuery;
151 PFN_vkCmdEndQuery CmdEndQuery;
152 PFN_vkCmdResetQueryPool CmdResetQueryPool;
153 PFN_vkCmdWriteTimestamp CmdWriteTimestamp;
Courtney Goeltzenleuchter98049062015-04-15 18:21:13 -0600[diff] [blame]154 PFN_vkCmdCopyQueryPoolResults CmdCopyQueryPoolResults;
Jon Ashburna25465c2015-07-23 18:48:20 -0600[diff] [blame]155 PFN_vkCmdPushConstants CmdPushConstants;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]156 PFN_vkCmdBeginRenderPass CmdBeginRenderPass;
Chia-I Wuc278df82015-07-07 11:50:03 +0800[diff] [blame]157 PFN_vkCmdNextSubpass CmdNextSubpass;
Courtney Goeltzenleuchter382489d2015-04-10 08:34:15 -0600[diff] [blame]158 PFN_vkCmdEndRenderPass CmdEndRenderPass;
Chia-I Wu88eaa3b2015-06-26 15:34:39 +0800[diff] [blame]159 PFN_vkCmdExecuteCommands CmdExecuteCommands;
Ian Elliott338dedb2015-08-21 15:09:33 -0600[diff] [blame]160 PFN_vkGetSurfacePropertiesKHR GetSurfacePropertiesKHR;
161 PFN_vkGetSurfaceFormatsKHR GetSurfaceFormatsKHR;
162 PFN_vkGetSurfacePresentModesKHR GetSurfacePresentModesKHR;
163 PFN_vkCreateSwapchainKHR CreateSwapchainKHR;
164 PFN_vkDestroySwapchainKHR DestroySwapchainKHR;
165 PFN_vkGetSwapchainImagesKHR GetSwapchainImagesKHR;
166 PFN_vkAcquireNextImageKHR AcquireNextImageKHR;
167 PFN_vkQueuePresentKHR QueuePresentKHR;
Jon Ashburn301c5f02015-04-06 10:58:22 -0600[diff] [blame]168} VkLayerDispatchTable;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600[diff] [blame]169
Jon Ashburn9a9bb642015-05-04 16:27:53 -0600[diff] [blame]170typedef struct VkLayerInstanceDispatchTable_
171{
172 PFN_vkGetInstanceProcAddr GetInstanceProcAddr;
Jon Ashburn52c1d732015-05-12 17:23:55 -0600[diff] [blame]173 PFN_vkCreateInstance CreateInstance;
Jon Ashburn9a9bb642015-05-04 16:27:53 -0600[diff] [blame]174 PFN_vkDestroyInstance DestroyInstance;
175 PFN_vkEnumeratePhysicalDevices EnumeratePhysicalDevices;
Chris Forbesd7576302015-06-21 22:55:02 +1200[diff] [blame]176 PFN_vkGetPhysicalDeviceFeatures GetPhysicalDeviceFeatures;
Jon Ashburna25465c2015-07-23 18:48:20 -0600[diff] [blame]177 PFN_vkGetPhysicalDeviceImageFormatProperties GetPhysicalDeviceImageFormatProperties;
Courtney Goeltzenleuchter4da96aa2015-07-12 12:52:09 -0600[diff] [blame]178 PFN_vkGetPhysicalDeviceFormatProperties GetPhysicalDeviceFormatProperties;
Mark Lobodzinski83d4e6a2015-07-03 15:58:09 -0600[diff] [blame]179 PFN_vkGetPhysicalDeviceSparseImageFormatProperties GetPhysicalDeviceSparseImageFormatProperties;
Tony Barbour426b9052015-06-24 16:06:58 -0600[diff] [blame]180 PFN_vkGetPhysicalDeviceProperties GetPhysicalDeviceProperties;
Cody Northropef72e2a2015-08-03 17:04:53 -0600[diff] [blame]181 PFN_vkGetPhysicalDeviceQueueFamilyProperties GetPhysicalDeviceQueueFamilyProperties;
Tony Barbour426b9052015-06-24 16:06:58 -0600[diff] [blame]182 PFN_vkGetPhysicalDeviceMemoryProperties GetPhysicalDeviceMemoryProperties;
Courtney Goeltzenleuchter74c4ce92015-09-14 17:22:16 -0600[diff] [blame]183 PFN_vkEnumerateDeviceExtensionProperties EnumerateDeviceExtensionProperties;
184 PFN_vkEnumerateDeviceLayerProperties EnumerateDeviceLayerProperties;
Ian Elliott338dedb2015-08-21 15:09:33 -0600[diff] [blame]185 PFN_vkGetPhysicalDeviceSurfaceSupportKHR GetPhysicalDeviceSurfaceSupportKHR;
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600[diff] [blame]186 PFN_vkDbgCreateMsgCallback DbgCreateMsgCallback;
187 PFN_vkDbgDestroyMsgCallback DbgDestroyMsgCallback;
Jon Ashburn9a9bb642015-05-04 16:27:53 -0600[diff] [blame]188} VkLayerInstanceDispatchTable;
189
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600[diff] [blame]190// LL node for tree of dbg callback functions
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600[diff] [blame]191typedef struct VkLayerDbgFunctionNode_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600[diff] [blame]192{
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600[diff] [blame]193 VkDbgMsgCallback msgCallback;
194 PFN_vkDbgMsgCallback pfnMsgCallback;
195 VkFlags msgFlags;
196 const void *pUserData;
197 struct VkLayerDbgFunctionNode_ *pNext;
198} VkLayerDbgFunctionNode;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600[diff] [blame]199
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600[diff] [blame]200typedef enum VkLayerDbgAction_
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600[diff] [blame]201{
202 VK_DBG_LAYER_ACTION_IGNORE = 0x0,
203 VK_DBG_LAYER_ACTION_CALLBACK = 0x1,
204 VK_DBG_LAYER_ACTION_LOG_MSG = 0x2,
Courtney Goeltzenleuchterb94f0512015-10-05 14:41:34 -0600[diff] [blame]205 VK_DBG_LAYER_ACTION_BREAK = 0x4,
206 VK_DBG_LAYER_ACTION_DEBUG_OUTPUT = 0x8,
Courtney Goeltzenleuchter1c7c65d2015-06-10 17:39:03 -0600[diff] [blame]207} VkLayerDbgAction;
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600[diff] [blame]208
Courtney Goeltzenleuchter89e99e62015-04-08 18:04:29 -0600[diff] [blame]209// ------------------------------------------------------------------------------------------------
210// API functions