Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / vulkan-validation-layers / abd077275dc71dca9ec970c1e6c44217eb058482 / . / include / vulkan / vk_layer.h
blob: ea1371523bbba2b48594ebd831d197a5ba258126 [file] [log] [blame]
Courtney Goeltzenleuchter64d1a712015-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
David Pinedo9316d3b2015-11-06 12:54:48 -0700[diff] [blame]7#include "vulkan/vulkan.h"
David Pinedoabd07722015-11-24 09:00:24 -0700[diff] [blame^]8#include "vulkan/vk_lunarg_debug_report.h"
9#include "vulkan/vk_lunarg_debug_marker.h"
David Pinedo9316d3b2015-11-06 12:54:48 -0700[diff] [blame]10#include "vulkan/vk_ext_khr_swapchain.h"
11#include "vulkan/vk_ext_khr_device_swapchain.h"
Courtney Goeltzenleuchter64d1a712015-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
Jon Ashburnfc1031e2015-11-17 15:31:02 -0700[diff] [blame]20typedef void * (VKAPI_PTR *PFN_vkGPA)(void* obj, const char * pName);
Jon Ashburnbacb0f52015-04-06 10:58:22 -0600[diff] [blame]21typedef struct VkBaseLayerObject_
Courtney Goeltzenleuchter64d1a712015-04-08 18:04:29 -0600[diff] [blame]22{
Jon Ashburnf6b33db2015-05-05 14:22:52 -0600[diff] [blame]23 PFN_vkGPA pGPA;
Tony Barbour1d2cd3f2015-07-03 10:33:54 -0600[diff] [blame]24 void* nextObject;
25 void* baseObject;
Jon Ashburnbacb0f52015-04-06 10:58:22 -0600[diff] [blame]26} VkBaseLayerObject;
Courtney Goeltzenleuchter64d1a712015-04-08 18:04:29 -0600[diff] [blame]27
Jon Ashburnbacb0f52015-04-06 10:58:22 -0600[diff] [blame]28typedef struct VkLayerDispatchTable_
Courtney Goeltzenleuchter64d1a712015-04-08 18:04:29 -0600[diff] [blame]29{
Jon Ashburn8d1b0b52015-05-18 13:20:15 -0600[diff] [blame]30 PFN_vkGetDeviceProcAddr GetDeviceProcAddr;
Courtney Goeltzenleuchterca173b82015-06-25 18:01:43 -0600[diff] [blame]31 PFN_vkCreateDevice CreateDevice;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]32 PFN_vkDestroyDevice DestroyDevice;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]33 PFN_vkGetDeviceQueue GetDeviceQueue;
34 PFN_vkQueueSubmit QueueSubmit;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]35 PFN_vkQueueWaitIdle QueueWaitIdle;
36 PFN_vkDeviceWaitIdle DeviceWaitIdle;
Chia-I Wu3432a0c2015-10-27 18:04:07 +0800[diff] [blame]37 PFN_vkAllocateMemory AllocateMemory;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]38 PFN_vkFreeMemory FreeMemory;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]39 PFN_vkMapMemory MapMemory;
40 PFN_vkUnmapMemory UnmapMemory;
Courtney Goeltzenleuchterf69f8a22015-04-29 17:16:21 -0600[diff] [blame]41 PFN_vkFlushMappedMemoryRanges FlushMappedMemoryRanges;
42 PFN_vkInvalidateMappedMemoryRanges InvalidateMappedMemoryRanges;
Courtney Goeltzenleuchterfb71f222015-07-09 21:57:28 -0600[diff] [blame]43 PFN_vkGetDeviceMemoryCommitment GetDeviceMemoryCommitment;
Mark Lobodzinski16e8bef2015-07-03 15:58:09 -0600[diff] [blame]44 PFN_vkGetImageSparseMemoryRequirements GetImageSparseMemoryRequirements;
Tony Barbour1d2cd3f2015-07-03 10:33:54 -0600[diff] [blame]45 PFN_vkGetImageMemoryRequirements GetImageMemoryRequirements;
46 PFN_vkGetBufferMemoryRequirements GetBufferMemoryRequirements;
47 PFN_vkBindImageMemory BindImageMemory;
48 PFN_vkBindBufferMemory BindBufferMemory;
Chia-I Wu1ff4c3d2015-10-26 16:55:27 +0800[diff] [blame]49 PFN_vkQueueBindSparse QueueBindSparse;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]50 PFN_vkCreateFence CreateFence;
Tony Barbour1d2cd3f2015-07-03 10:33:54 -0600[diff] [blame]51 PFN_vkDestroyFence DestroyFence;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]52 PFN_vkGetFenceStatus GetFenceStatus;
53 PFN_vkResetFences ResetFences;
54 PFN_vkWaitForFences WaitForFences;
55 PFN_vkCreateSemaphore CreateSemaphore;
Tony Barbour1d2cd3f2015-07-03 10:33:54 -0600[diff] [blame]56 PFN_vkDestroySemaphore DestroySemaphore;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]57 PFN_vkCreateEvent CreateEvent;
Tony Barbour1d2cd3f2015-07-03 10:33:54 -0600[diff] [blame]58 PFN_vkDestroyEvent DestroyEvent;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]59 PFN_vkGetEventStatus GetEventStatus;
60 PFN_vkSetEvent SetEvent;
61 PFN_vkResetEvent ResetEvent;
62 PFN_vkCreateQueryPool CreateQueryPool;
Tony Barbour1d2cd3f2015-07-03 10:33:54 -0600[diff] [blame]63 PFN_vkDestroyQueryPool DestroyQueryPool;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]64 PFN_vkGetQueryPoolResults GetQueryPoolResults;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]65 PFN_vkCreateBuffer CreateBuffer;
Tony Barbour1d2cd3f2015-07-03 10:33:54 -0600[diff] [blame]66 PFN_vkDestroyBuffer DestroyBuffer;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]67 PFN_vkCreateBufferView CreateBufferView;
Tony Barbour1d2cd3f2015-07-03 10:33:54 -0600[diff] [blame]68 PFN_vkDestroyBufferView DestroyBufferView;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]69 PFN_vkCreateImage CreateImage;
Tony Barbour1d2cd3f2015-07-03 10:33:54 -0600[diff] [blame]70 PFN_vkDestroyImage DestroyImage;
Tony Barbour59a47322015-06-24 16:06:58 -0600[diff] [blame]71 PFN_vkGetImageSubresourceLayout GetImageSubresourceLayout;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]72 PFN_vkCreateImageView CreateImageView;
Tony Barbour1d2cd3f2015-07-03 10:33:54 -0600[diff] [blame]73 PFN_vkDestroyImageView DestroyImageView;
Courtney Goeltzenleuchter2d2cb682015-06-24 18:24:19 -0600[diff] [blame]74 PFN_vkCreateShaderModule CreateShaderModule;
Tony Barbour1d2cd3f2015-07-03 10:33:54 -0600[diff] [blame]75 PFN_vkDestroyShaderModule DestroyShaderModule;
Jon Ashburnc669cc62015-07-09 15:02:25 -0600[diff] [blame]76 PFN_vkCreatePipelineCache CreatePipelineCache;
77 PFN_vkDestroyPipelineCache DestroyPipelineCache;
Jon Ashburnc669cc62015-07-09 15:02:25 -0600[diff] [blame]78 PFN_vkGetPipelineCacheData GetPipelineCacheData;
79 PFN_vkMergePipelineCaches MergePipelineCaches;
80 PFN_vkCreateGraphicsPipelines CreateGraphicsPipelines;
81 PFN_vkCreateComputePipelines CreateComputePipelines;
Tony Barbour1d2cd3f2015-07-03 10:33:54 -0600[diff] [blame]82 PFN_vkDestroyPipeline DestroyPipeline;
Mark Lobodzinski0fadf5f2015-04-17 14:11:39 -0500[diff] [blame]83 PFN_vkCreatePipelineLayout CreatePipelineLayout;
Tony Barbour1d2cd3f2015-07-03 10:33:54 -0600[diff] [blame]84 PFN_vkDestroyPipelineLayout DestroyPipelineLayout;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]85 PFN_vkCreateSampler CreateSampler;
Tony Barbour1d2cd3f2015-07-03 10:33:54 -0600[diff] [blame]86 PFN_vkDestroySampler DestroySampler;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]87 PFN_vkCreateDescriptorSetLayout CreateDescriptorSetLayout;
Tony Barbour1d2cd3f2015-07-03 10:33:54 -0600[diff] [blame]88 PFN_vkDestroyDescriptorSetLayout DestroyDescriptorSetLayout;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]89 PFN_vkCreateDescriptorPool CreateDescriptorPool;
Tony Barbour1d2cd3f2015-07-03 10:33:54 -0600[diff] [blame]90 PFN_vkDestroyDescriptorPool DestroyDescriptorPool;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]91 PFN_vkResetDescriptorPool ResetDescriptorPool;
Chia-I Wu3432a0c2015-10-27 18:04:07 +0800[diff] [blame]92 PFN_vkAllocateDescriptorSets AllocateDescriptorSets;
Tony Barbour34ec6922015-07-10 10:50:45 -0600[diff] [blame]93 PFN_vkFreeDescriptorSets FreeDescriptorSets;
Chia-I Wu9d00ed72015-05-25 16:27:55 +0800[diff] [blame]94 PFN_vkUpdateDescriptorSets UpdateDescriptorSets;
Jon Ashburn42540ef2015-07-23 18:48:20 -0600[diff] [blame]95 PFN_vkCreateFramebuffer CreateFramebuffer;
96 PFN_vkDestroyFramebuffer DestroyFramebuffer;
97 PFN_vkCreateRenderPass CreateRenderPass;
98 PFN_vkDestroyRenderPass DestroyRenderPass;
99 PFN_vkGetRenderAreaGranularity GetRenderAreaGranularity;
Cody Northrope62183e2015-07-09 18:08:05 -0600[diff] [blame]100 PFN_vkCreateCommandPool CreateCommandPool;
101 PFN_vkDestroyCommandPool DestroyCommandPool;
102 PFN_vkResetCommandPool ResetCommandPool;
Chia-I Wu3432a0c2015-10-27 18:04:07 +0800[diff] [blame]103 PFN_vkAllocateCommandBuffers AllocateCommandBuffers;
Courtney Goeltzenleuchterbee18a92015-10-23 14:21:05 -0600[diff] [blame]104 PFN_vkFreeCommandBuffers FreeCommandBuffers;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]105 PFN_vkBeginCommandBuffer BeginCommandBuffer;
106 PFN_vkEndCommandBuffer EndCommandBuffer;
107 PFN_vkResetCommandBuffer ResetCommandBuffer;
108 PFN_vkCmdBindPipeline CmdBindPipeline;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]109 PFN_vkCmdBindDescriptorSets CmdBindDescriptorSets;
Courtney Goeltzenleuchterf68ad722015-04-16 13:38:46 -0600[diff] [blame]110 PFN_vkCmdBindVertexBuffers CmdBindVertexBuffers;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]111 PFN_vkCmdBindIndexBuffer CmdBindIndexBuffer;
Courtney Goeltzenleuchter49c73082015-09-17 15:06:17 -0600[diff] [blame]112 PFN_vkCmdSetViewport CmdSetViewport;
Courtney Goeltzenleuchter078f8172015-09-21 11:44:06 -0600[diff] [blame]113 PFN_vkCmdSetScissor CmdSetScissor;
Courtney Goeltzenleuchter49c73082015-09-17 15:06:17 -0600[diff] [blame]114 PFN_vkCmdSetLineWidth CmdSetLineWidth;
115 PFN_vkCmdSetDepthBias CmdSetDepthBias;
116 PFN_vkCmdSetBlendConstants CmdSetBlendConstants;
117 PFN_vkCmdSetDepthBounds CmdSetDepthBounds;
118 PFN_vkCmdSetStencilCompareMask CmdSetStencilCompareMask;
119 PFN_vkCmdSetStencilWriteMask CmdSetStencilWriteMask;
120 PFN_vkCmdSetStencilReference CmdSetStencilReference;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]121 PFN_vkCmdDraw CmdDraw;
122 PFN_vkCmdDrawIndexed CmdDrawIndexed;
123 PFN_vkCmdDrawIndirect CmdDrawIndirect;
124 PFN_vkCmdDrawIndexedIndirect CmdDrawIndexedIndirect;
125 PFN_vkCmdDispatch CmdDispatch;
126 PFN_vkCmdDispatchIndirect CmdDispatchIndirect;
127 PFN_vkCmdCopyBuffer CmdCopyBuffer;
128 PFN_vkCmdCopyImage CmdCopyImage;
129 PFN_vkCmdBlitImage CmdBlitImage;
130 PFN_vkCmdCopyBufferToImage CmdCopyBufferToImage;
131 PFN_vkCmdCopyImageToBuffer CmdCopyImageToBuffer;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]132 PFN_vkCmdUpdateBuffer CmdUpdateBuffer;
133 PFN_vkCmdFillBuffer CmdFillBuffer;
134 PFN_vkCmdClearColorImage CmdClearColorImage;
Chris Forbesd9be82b2015-06-22 17:21:59 +1200[diff] [blame]135 PFN_vkCmdClearDepthStencilImage CmdClearDepthStencilImage;
Courtney Goeltzenleuchterc9323e02015-10-15 16:51:05 -0600[diff] [blame]136 PFN_vkCmdClearAttachments CmdClearAttachments;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]137 PFN_vkCmdResolveImage CmdResolveImage;
138 PFN_vkCmdSetEvent CmdSetEvent;
139 PFN_vkCmdResetEvent CmdResetEvent;
140 PFN_vkCmdWaitEvents CmdWaitEvents;
141 PFN_vkCmdPipelineBarrier CmdPipelineBarrier;
142 PFN_vkCmdBeginQuery CmdBeginQuery;
143 PFN_vkCmdEndQuery CmdEndQuery;
144 PFN_vkCmdResetQueryPool CmdResetQueryPool;
145 PFN_vkCmdWriteTimestamp CmdWriteTimestamp;
Courtney Goeltzenleuchter1dbc8e22015-04-15 18:21:13 -0600[diff] [blame]146 PFN_vkCmdCopyQueryPoolResults CmdCopyQueryPoolResults;
Jon Ashburn42540ef2015-07-23 18:48:20 -0600[diff] [blame]147 PFN_vkCmdPushConstants CmdPushConstants;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]148 PFN_vkCmdBeginRenderPass CmdBeginRenderPass;
Chia-I Wu08accc62015-07-07 11:50:03 +0800[diff] [blame]149 PFN_vkCmdNextSubpass CmdNextSubpass;
Courtney Goeltzenleuchterfb4efc62015-04-10 08:34:15 -0600[diff] [blame]150 PFN_vkCmdEndRenderPass CmdEndRenderPass;
Chia-I Wu0b50a1c2015-06-26 15:34:39 +0800[diff] [blame]151 PFN_vkCmdExecuteCommands CmdExecuteCommands;
Ian Elliott7e40db92015-08-21 15:09:33 -0600[diff] [blame]152 PFN_vkGetSurfacePropertiesKHR GetSurfacePropertiesKHR;
153 PFN_vkGetSurfaceFormatsKHR GetSurfaceFormatsKHR;
154 PFN_vkGetSurfacePresentModesKHR GetSurfacePresentModesKHR;
155 PFN_vkCreateSwapchainKHR CreateSwapchainKHR;
156 PFN_vkDestroySwapchainKHR DestroySwapchainKHR;
157 PFN_vkGetSwapchainImagesKHR GetSwapchainImagesKHR;
158 PFN_vkAcquireNextImageKHR AcquireNextImageKHR;
159 PFN_vkQueuePresentKHR QueuePresentKHR;
Jon Ashburnbacb0f52015-04-06 10:58:22 -0600[diff] [blame]160} VkLayerDispatchTable;
Courtney Goeltzenleuchter64d1a712015-04-08 18:04:29 -0600[diff] [blame]161
Jon Ashburnfbb4e252015-05-04 16:27:53 -0600[diff] [blame]162typedef struct VkLayerInstanceDispatchTable_
163{
164 PFN_vkGetInstanceProcAddr GetInstanceProcAddr;
Jon Ashburn71836d92015-05-12 17:23:55 -0600[diff] [blame]165 PFN_vkCreateInstance CreateInstance;
Jon Ashburnfbb4e252015-05-04 16:27:53 -0600[diff] [blame]166 PFN_vkDestroyInstance DestroyInstance;
167 PFN_vkEnumeratePhysicalDevices EnumeratePhysicalDevices;
Chris Forbesbc0bb772015-06-21 22:55:02 +1200[diff] [blame]168 PFN_vkGetPhysicalDeviceFeatures GetPhysicalDeviceFeatures;
Jon Ashburn42540ef2015-07-23 18:48:20 -0600[diff] [blame]169 PFN_vkGetPhysicalDeviceImageFormatProperties GetPhysicalDeviceImageFormatProperties;
Courtney Goeltzenleuchter2caec862015-07-12 12:52:09 -0600[diff] [blame]170 PFN_vkGetPhysicalDeviceFormatProperties GetPhysicalDeviceFormatProperties;
Mark Lobodzinski16e8bef2015-07-03 15:58:09 -0600[diff] [blame]171 PFN_vkGetPhysicalDeviceSparseImageFormatProperties GetPhysicalDeviceSparseImageFormatProperties;
Tony Barbour59a47322015-06-24 16:06:58 -0600[diff] [blame]172 PFN_vkGetPhysicalDeviceProperties GetPhysicalDeviceProperties;
Cody Northropd0802882015-08-03 17:04:53 -0600[diff] [blame]173 PFN_vkGetPhysicalDeviceQueueFamilyProperties GetPhysicalDeviceQueueFamilyProperties;
Tony Barbour59a47322015-06-24 16:06:58 -0600[diff] [blame]174 PFN_vkGetPhysicalDeviceMemoryProperties GetPhysicalDeviceMemoryProperties;
Courtney Goeltzenleuchter35985f62015-09-14 17:22:16 -0600[diff] [blame]175 PFN_vkEnumerateDeviceExtensionProperties EnumerateDeviceExtensionProperties;
176 PFN_vkEnumerateDeviceLayerProperties EnumerateDeviceLayerProperties;
Ian Elliott7e40db92015-08-21 15:09:33 -0600[diff] [blame]177 PFN_vkGetPhysicalDeviceSurfaceSupportKHR GetPhysicalDeviceSurfaceSupportKHR;
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600[diff] [blame]178 PFN_vkDbgCreateMsgCallback DbgCreateMsgCallback;
179 PFN_vkDbgDestroyMsgCallback DbgDestroyMsgCallback;
Jon Ashburnfbb4e252015-05-04 16:27:53 -0600[diff] [blame]180} VkLayerInstanceDispatchTable;
181
Courtney Goeltzenleuchter64d1a712015-04-08 18:04:29 -0600[diff] [blame]182// LL node for tree of dbg callback functions
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600[diff] [blame]183typedef struct VkLayerDbgFunctionNode_
Courtney Goeltzenleuchter64d1a712015-04-08 18:04:29 -0600[diff] [blame]184{
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600[diff] [blame]185 VkDbgMsgCallback msgCallback;
186 PFN_vkDbgMsgCallback pfnMsgCallback;
187 VkFlags msgFlags;
188 const void *pUserData;
189 struct VkLayerDbgFunctionNode_ *pNext;
190} VkLayerDbgFunctionNode;
Courtney Goeltzenleuchter64d1a712015-04-08 18:04:29 -0600[diff] [blame]191
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600[diff] [blame]192typedef enum VkLayerDbgAction_
Courtney Goeltzenleuchter64d1a712015-04-08 18:04:29 -0600[diff] [blame]193{
194 VK_DBG_LAYER_ACTION_IGNORE = 0x0,
195 VK_DBG_LAYER_ACTION_CALLBACK = 0x1,
196 VK_DBG_LAYER_ACTION_LOG_MSG = 0x2,
Courtney Goeltzenleuchter5907ac42015-10-05 14:41:34 -0600[diff] [blame]197 VK_DBG_LAYER_ACTION_BREAK = 0x4,
198 VK_DBG_LAYER_ACTION_DEBUG_OUTPUT = 0x8,
Courtney Goeltzenleuchterf579fa62015-06-10 17:39:03 -0600[diff] [blame]199} VkLayerDbgAction;
Courtney Goeltzenleuchter64d1a712015-04-08 18:04:29 -0600[diff] [blame]200
Courtney Goeltzenleuchter64d1a712015-04-08 18:04:29 -0600[diff] [blame]201// ------------------------------------------------------------------------------------------------
202// API functions