• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2015 Google Inc.
3  *
4  * Use of this source code is governed by a BSD-style license that can be
5  * found in the LICENSE file.
6  */
7 
8 #ifndef skgpu_VulkanInterface_DEFINED
9 #define skgpu_VulkanInterface_DEFINED
10 
11 #include "include/core/SkRefCnt.h"
12 
13 #include "include/gpu/vk/VulkanTypes.h"
14 
15 namespace skgpu {
16 
17 class VulkanExtensions;
18 
19 ////////////////////////////////////////////////////////////////////////////////
20 
21 /**
22  * Skia Vulkan uses the following interface to make all calls into Vulkan. When a Ganesh or Graphite
23  * Context is created it is given a VulkanInterface. All functions that should be available based on
24  * the Vulkan's version must be non-NULL or Context creation will fail. This can be tested with the
25  * validate() method.
26  */
27 struct VulkanInterface : public SkRefCnt {
28 private:
29     // simple wrapper class that exists only to initialize a pointer to NULL
30     template <typename FNPTR_TYPE> class VkPtr {
31     public:
VkPtrVulkanInterface32         VkPtr() : fPtr(nullptr) {}
33         VkPtr operator=(FNPTR_TYPE ptr) { fPtr = ptr; return *this; }
FNPTR_TYPEVulkanInterface34         operator FNPTR_TYPE() const { return fPtr; }
35     private:
36         FNPTR_TYPE fPtr;
37     };
38 
39     using INHERITED = SkRefCnt;
40 
41 public:
42     VulkanInterface(VulkanGetProc getProc,
43                     VkInstance instance,
44                     VkDevice device,
45                     uint32_t instanceVersion,
46                     uint32_t physicalDeviceVersion,
47                     const VulkanExtensions*);
48 
49     // Validates that the VulkanInterface supports its advertised standard. This means the necessary
50     // function pointers have been initialized for Vulkan version.
51     bool validate(uint32_t instanceVersion, uint32_t physicalDeviceVersion,
52                   const VulkanExtensions*) const;
53 
54     /**
55      * The function pointers are in a struct so that we can have a compiler generated assignment
56      * operator.
57      */
58     struct Functions {
59         VkPtr<PFN_vkCreateInstance> fCreateInstance;
60         VkPtr<PFN_vkDestroyInstance> fDestroyInstance;
61         VkPtr<PFN_vkEnumeratePhysicalDevices> fEnumeratePhysicalDevices;
62         VkPtr<PFN_vkGetPhysicalDeviceFeatures> fGetPhysicalDeviceFeatures;
63         VkPtr<PFN_vkGetPhysicalDeviceFormatProperties> fGetPhysicalDeviceFormatProperties;
64         VkPtr<PFN_vkGetPhysicalDeviceImageFormatProperties> fGetPhysicalDeviceImageFormatProperties;
65         VkPtr<PFN_vkGetPhysicalDeviceProperties> fGetPhysicalDeviceProperties;
66         VkPtr<PFN_vkGetPhysicalDeviceQueueFamilyProperties> fGetPhysicalDeviceQueueFamilyProperties;
67         VkPtr<PFN_vkGetPhysicalDeviceMemoryProperties> fGetPhysicalDeviceMemoryProperties;
68         VkPtr<PFN_vkCreateDevice> fCreateDevice;
69         VkPtr<PFN_vkDestroyDevice> fDestroyDevice;
70         VkPtr<PFN_vkEnumerateInstanceExtensionProperties> fEnumerateInstanceExtensionProperties;
71         VkPtr<PFN_vkEnumerateDeviceExtensionProperties> fEnumerateDeviceExtensionProperties;
72         VkPtr<PFN_vkEnumerateInstanceLayerProperties> fEnumerateInstanceLayerProperties;
73         VkPtr<PFN_vkEnumerateDeviceLayerProperties> fEnumerateDeviceLayerProperties;
74         VkPtr<PFN_vkGetDeviceQueue> fGetDeviceQueue;
75         VkPtr<PFN_vkQueueSubmit> fQueueSubmit;
76         VkPtr<PFN_vkQueueWaitIdle> fQueueWaitIdle;
77         VkPtr<PFN_vkDeviceWaitIdle> fDeviceWaitIdle;
78         VkPtr<PFN_vkAllocateMemory> fAllocateMemory;
79         VkPtr<PFN_vkFreeMemory> fFreeMemory;
80         VkPtr<PFN_vkMapMemory> fMapMemory;
81         VkPtr<PFN_vkUnmapMemory> fUnmapMemory;
82         VkPtr<PFN_vkFlushMappedMemoryRanges> fFlushMappedMemoryRanges;
83         VkPtr<PFN_vkInvalidateMappedMemoryRanges> fInvalidateMappedMemoryRanges;
84         VkPtr<PFN_vkGetDeviceMemoryCommitment> fGetDeviceMemoryCommitment;
85         VkPtr<PFN_vkBindBufferMemory> fBindBufferMemory;
86         VkPtr<PFN_vkBindImageMemory> fBindImageMemory;
87         VkPtr<PFN_vkGetBufferMemoryRequirements> fGetBufferMemoryRequirements;
88         VkPtr<PFN_vkGetImageMemoryRequirements> fGetImageMemoryRequirements;
89         VkPtr<PFN_vkGetImageSparseMemoryRequirements> fGetImageSparseMemoryRequirements;
90         VkPtr<PFN_vkGetPhysicalDeviceSparseImageFormatProperties> fGetPhysicalDeviceSparseImageFormatProperties;
91         VkPtr<PFN_vkQueueBindSparse> fQueueBindSparse;
92         VkPtr<PFN_vkCreateFence> fCreateFence;
93         VkPtr<PFN_vkDestroyFence> fDestroyFence;
94         VkPtr<PFN_vkResetFences> fResetFences;
95         VkPtr<PFN_vkGetFenceStatus> fGetFenceStatus;
96         VkPtr<PFN_vkWaitForFences> fWaitForFences;
97         VkPtr<PFN_vkCreateSemaphore> fCreateSemaphore;
98         VkPtr<PFN_vkDestroySemaphore> fDestroySemaphore;
99         VkPtr<PFN_vkCreateEvent> fCreateEvent;
100         VkPtr<PFN_vkDestroyEvent> fDestroyEvent;
101         VkPtr<PFN_vkGetEventStatus> fGetEventStatus;
102         VkPtr<PFN_vkSetEvent> fSetEvent;
103         VkPtr<PFN_vkResetEvent> fResetEvent;
104         VkPtr<PFN_vkCreateQueryPool> fCreateQueryPool;
105         VkPtr<PFN_vkDestroyQueryPool> fDestroyQueryPool;
106         VkPtr<PFN_vkGetQueryPoolResults> fGetQueryPoolResults;
107         VkPtr<PFN_vkCreateBuffer> fCreateBuffer;
108         VkPtr<PFN_vkDestroyBuffer> fDestroyBuffer;
109         VkPtr<PFN_vkCreateBufferView> fCreateBufferView;
110         VkPtr<PFN_vkDestroyBufferView> fDestroyBufferView;
111         VkPtr<PFN_vkCreateImage> fCreateImage;
112         VkPtr<PFN_vkDestroyImage> fDestroyImage;
113         VkPtr<PFN_vkGetImageSubresourceLayout> fGetImageSubresourceLayout;
114         VkPtr<PFN_vkCreateImageView> fCreateImageView;
115         VkPtr<PFN_vkDestroyImageView> fDestroyImageView;
116         VkPtr<PFN_vkCreateShaderModule> fCreateShaderModule;
117         VkPtr<PFN_vkDestroyShaderModule> fDestroyShaderModule;
118         VkPtr<PFN_vkCreatePipelineCache> fCreatePipelineCache;
119         VkPtr<PFN_vkDestroyPipelineCache> fDestroyPipelineCache;
120         VkPtr<PFN_vkGetPipelineCacheData> fGetPipelineCacheData;
121         VkPtr<PFN_vkMergePipelineCaches> fMergePipelineCaches;
122         VkPtr<PFN_vkCreateGraphicsPipelines> fCreateGraphicsPipelines;
123         VkPtr<PFN_vkCreateComputePipelines> fCreateComputePipelines;
124         VkPtr<PFN_vkDestroyPipeline> fDestroyPipeline;
125         VkPtr<PFN_vkCreatePipelineLayout> fCreatePipelineLayout;
126         VkPtr<PFN_vkDestroyPipelineLayout> fDestroyPipelineLayout;
127         VkPtr<PFN_vkCreateSampler> fCreateSampler;
128         VkPtr<PFN_vkDestroySampler> fDestroySampler;
129         VkPtr<PFN_vkCreateDescriptorSetLayout> fCreateDescriptorSetLayout;
130         VkPtr<PFN_vkDestroyDescriptorSetLayout> fDestroyDescriptorSetLayout;
131         VkPtr<PFN_vkCreateDescriptorPool> fCreateDescriptorPool;
132         VkPtr<PFN_vkDestroyDescriptorPool> fDestroyDescriptorPool;
133         VkPtr<PFN_vkResetDescriptorPool> fResetDescriptorPool;
134         VkPtr<PFN_vkAllocateDescriptorSets> fAllocateDescriptorSets;
135         VkPtr<PFN_vkFreeDescriptorSets> fFreeDescriptorSets;
136         VkPtr<PFN_vkUpdateDescriptorSets> fUpdateDescriptorSets;
137         VkPtr<PFN_vkCreateFramebuffer> fCreateFramebuffer;
138         VkPtr<PFN_vkDestroyFramebuffer> fDestroyFramebuffer;
139         VkPtr<PFN_vkCreateRenderPass> fCreateRenderPass;
140         VkPtr<PFN_vkDestroyRenderPass> fDestroyRenderPass;
141         VkPtr<PFN_vkGetRenderAreaGranularity> fGetRenderAreaGranularity;
142         VkPtr<PFN_vkCreateCommandPool> fCreateCommandPool;
143         VkPtr<PFN_vkDestroyCommandPool> fDestroyCommandPool;
144         VkPtr<PFN_vkResetCommandPool> fResetCommandPool;
145         VkPtr<PFN_vkAllocateCommandBuffers> fAllocateCommandBuffers;
146         VkPtr<PFN_vkFreeCommandBuffers> fFreeCommandBuffers;
147         VkPtr<PFN_vkBeginCommandBuffer> fBeginCommandBuffer;
148         VkPtr<PFN_vkEndCommandBuffer> fEndCommandBuffer;
149         VkPtr<PFN_vkResetCommandBuffer> fResetCommandBuffer;
150         VkPtr<PFN_vkCmdBindPipeline> fCmdBindPipeline;
151         VkPtr<PFN_vkCmdSetViewport> fCmdSetViewport;
152         VkPtr<PFN_vkCmdSetScissor> fCmdSetScissor;
153         VkPtr<PFN_vkCmdSetLineWidth> fCmdSetLineWidth;
154         VkPtr<PFN_vkCmdSetDepthBias> fCmdSetDepthBias;
155         VkPtr<PFN_vkCmdSetBlendConstants> fCmdSetBlendConstants;
156         VkPtr<PFN_vkCmdSetDepthBounds> fCmdSetDepthBounds;
157         VkPtr<PFN_vkCmdSetStencilCompareMask> fCmdSetStencilCompareMask;
158         VkPtr<PFN_vkCmdSetStencilWriteMask> fCmdSetStencilWriteMask;
159         VkPtr<PFN_vkCmdSetStencilReference> fCmdSetStencilReference;
160         VkPtr<PFN_vkCmdBindDescriptorSets> fCmdBindDescriptorSets;
161         VkPtr<PFN_vkCmdBindIndexBuffer> fCmdBindIndexBuffer;
162         VkPtr<PFN_vkCmdBindVertexBuffers> fCmdBindVertexBuffers;
163         VkPtr<PFN_vkCmdDraw> fCmdDraw;
164         VkPtr<PFN_vkCmdDrawIndexed> fCmdDrawIndexed;
165         VkPtr<PFN_vkCmdDrawIndirect> fCmdDrawIndirect;
166         VkPtr<PFN_vkCmdDrawIndexedIndirect> fCmdDrawIndexedIndirect;
167         VkPtr<PFN_vkCmdDispatch> fCmdDispatch;
168         VkPtr<PFN_vkCmdDispatchIndirect> fCmdDispatchIndirect;
169         VkPtr<PFN_vkCmdCopyBuffer> fCmdCopyBuffer;
170         VkPtr<PFN_vkCmdCopyImage> fCmdCopyImage;
171         VkPtr<PFN_vkCmdBlitImage> fCmdBlitImage;
172         VkPtr<PFN_vkCmdCopyBufferToImage> fCmdCopyBufferToImage;
173         VkPtr<PFN_vkCmdCopyImageToBuffer> fCmdCopyImageToBuffer;
174         VkPtr<PFN_vkCmdUpdateBuffer> fCmdUpdateBuffer;
175         VkPtr<PFN_vkCmdFillBuffer> fCmdFillBuffer;
176         VkPtr<PFN_vkCmdClearColorImage> fCmdClearColorImage;
177         VkPtr<PFN_vkCmdClearDepthStencilImage> fCmdClearDepthStencilImage;
178         VkPtr<PFN_vkCmdClearAttachments> fCmdClearAttachments;
179         VkPtr<PFN_vkCmdResolveImage> fCmdResolveImage;
180         VkPtr<PFN_vkCmdSetEvent> fCmdSetEvent;
181         VkPtr<PFN_vkCmdResetEvent> fCmdResetEvent;
182         VkPtr<PFN_vkCmdWaitEvents> fCmdWaitEvents;
183         VkPtr<PFN_vkCmdPipelineBarrier> fCmdPipelineBarrier;
184         VkPtr<PFN_vkCmdBeginQuery> fCmdBeginQuery;
185         VkPtr<PFN_vkCmdEndQuery> fCmdEndQuery;
186         VkPtr<PFN_vkCmdResetQueryPool> fCmdResetQueryPool;
187         VkPtr<PFN_vkCmdWriteTimestamp> fCmdWriteTimestamp;
188         VkPtr<PFN_vkCmdCopyQueryPoolResults> fCmdCopyQueryPoolResults;
189         VkPtr<PFN_vkCmdPushConstants> fCmdPushConstants;
190         VkPtr<PFN_vkCmdBeginRenderPass> fCmdBeginRenderPass;
191         VkPtr<PFN_vkCmdNextSubpass> fCmdNextSubpass;
192         VkPtr<PFN_vkCmdEndRenderPass> fCmdEndRenderPass;
193         VkPtr<PFN_vkCmdExecuteCommands> fCmdExecuteCommands;
194 
195         // Functions for VK_KHR_get_physical_device_properties2 or vulkan 1.1
196         VkPtr<PFN_vkGetPhysicalDeviceFeatures2> fGetPhysicalDeviceFeatures2;
197         VkPtr<PFN_vkGetPhysicalDeviceProperties2> fGetPhysicalDeviceProperties2;
198         VkPtr<PFN_vkGetPhysicalDeviceFormatProperties2> fGetPhysicalDeviceFormatProperties2;
199         VkPtr<PFN_vkGetPhysicalDeviceImageFormatProperties2> fGetPhysicalDeviceImageFormatProperties2;
200         VkPtr<PFN_vkGetPhysicalDeviceQueueFamilyProperties2> fGetPhysicalDeviceQueueFamilyProperties2;
201         VkPtr<PFN_vkGetPhysicalDeviceMemoryProperties2> fGetPhysicalDeviceMemoryProperties2;
202         VkPtr<PFN_vkGetPhysicalDeviceSparseImageFormatProperties2> fGetPhysicalDeviceSparseImageFormatProperties2;
203 
204         // Functions for VK_KHR_get_memory_requirements2 or vulkan 1.1
205         VkPtr<PFN_vkGetImageMemoryRequirements2> fGetImageMemoryRequirements2;
206         VkPtr<PFN_vkGetBufferMemoryRequirements2> fGetBufferMemoryRequirements2;
207         VkPtr<PFN_vkGetImageSparseMemoryRequirements2> fGetImageSparseMemoryRequirements2;
208 
209         //Functions for VK_KHR_bind_memory2
210         VkPtr<PFN_vkBindBufferMemory2> fBindBufferMemory2;
211         VkPtr<PFN_vkBindImageMemory2> fBindImageMemory2;
212 
213         // Functions for VK_KHR_maintenance1 or vulkan 1.1
214         VkPtr<PFN_vkTrimCommandPool> fTrimCommandPool;
215 
216         // Functions for VK_KHR_maintenance3 or vulkan 1.1
217         VkPtr<PFN_vkGetDescriptorSetLayoutSupport> fGetDescriptorSetLayoutSupport;
218 
219         // Functions for VK_KHR_external_memory_capabilities
220         VkPtr<PFN_vkGetPhysicalDeviceExternalBufferProperties> fGetPhysicalDeviceExternalBufferProperties;
221 
222         // Functions for YCBCRConversion
223         VkPtr<PFN_vkCreateSamplerYcbcrConversion> fCreateSamplerYcbcrConversion;
224         VkPtr<PFN_vkDestroySamplerYcbcrConversion> fDestroySamplerYcbcrConversion;
225 
226 #ifdef SK_BUILD_FOR_ANDROID
227         // Functions for VK_ANDROID_external_memory_android_hardware_buffer
228         VkPtr<PFN_vkGetAndroidHardwareBufferPropertiesANDROID> fGetAndroidHardwareBufferProperties;
229         VkPtr<PFN_vkGetMemoryAndroidHardwareBufferANDROID> fGetMemoryAndroidHardwareBuffer;
230 #endif
231 
232     } fFunctions;
233 };
234 
235 } // namespace skgpu
236 
237 #endif // skgpu_VulkanInterface_DEFINED
238