• 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 GrVkInterface_DEFINED
9 #define GrVkInterface_DEFINED
10 
11 #include "SkRefCnt.h"
12 
13 #include "vk/GrVkDefines.h"
14 
15 ////////////////////////////////////////////////////////////////////////////////
16 
17 /**
18  * The default interface is returned by GrVkCreateInterface. This function's
19  * implementation is platform-specific.
20  */
21 
22 struct GrVkInterface;
23 
24 /**
25  * Creates a GrVkInterface.
26  */
27 const GrVkInterface* GrVkCreateInterface(VkInstance instance, VkDevice device,
28                                          uint32_t extensionFlags);
29 
30 
31 /**
32  * GrContext uses the following interface to make all calls into Vulkan. When a
33  * GrContext is created it is given a GrVkInterface. All functions that should be
34  * available based on the Vulkan's version must be non-NULL or GrContext creation
35  * will fail. This can be tested with the validate() method.
36  */
37 struct SK_API GrVkInterface : public SkRefCnt {
38 private:
39     // simple wrapper class that exists only to initialize a pointer to NULL
40     template <typename FNPTR_TYPE> class VkPtr {
41     public:
VkPtrGrVkInterface42         VkPtr() : fPtr(NULL) {}
43         VkPtr operator=(FNPTR_TYPE ptr) { fPtr = ptr; return *this; }
FNPTR_TYPEGrVkInterface44         operator FNPTR_TYPE() const { return fPtr; }
45     private:
46         FNPTR_TYPE fPtr;
47     };
48 
49     typedef SkRefCnt INHERITED;
50 
51 public:
52     GrVkInterface();
53 
54     // Validates that the GrVkInterface supports its advertised standard. This means the necessary
55     // function pointers have been initialized for Vulkan version.
56     bool validate(uint32_t extensionFlags) const;
57 
58     /**
59      * The function pointers are in a struct so that we can have a compiler generated assignment
60      * operator.
61      */
62     struct Functions {
63         VkPtr<PFN_vkCreateInstance> fCreateInstance;
64         VkPtr<PFN_vkDestroyInstance> fDestroyInstance;
65         VkPtr<PFN_vkEnumeratePhysicalDevices> fEnumeratePhysicalDevices;
66         VkPtr<PFN_vkGetPhysicalDeviceFeatures> fGetPhysicalDeviceFeatures;
67         VkPtr<PFN_vkGetPhysicalDeviceFormatProperties> fGetPhysicalDeviceFormatProperties;
68         VkPtr<PFN_vkGetPhysicalDeviceImageFormatProperties> fGetPhysicalDeviceImageFormatProperties;
69         VkPtr<PFN_vkGetPhysicalDeviceProperties> fGetPhysicalDeviceProperties;
70         VkPtr<PFN_vkGetPhysicalDeviceQueueFamilyProperties> fGetPhysicalDeviceQueueFamilyProperties;
71         VkPtr<PFN_vkGetPhysicalDeviceMemoryProperties> fGetPhysicalDeviceMemoryProperties;
72         VkPtr<PFN_vkCreateDevice> fCreateDevice;
73         VkPtr<PFN_vkDestroyDevice> fDestroyDevice;
74         VkPtr<PFN_vkEnumerateInstanceExtensionProperties> fEnumerateInstanceExtensionProperties;
75         VkPtr<PFN_vkEnumerateDeviceExtensionProperties> fEnumerateDeviceExtensionProperties;
76         VkPtr<PFN_vkEnumerateInstanceLayerProperties> fEnumerateInstanceLayerProperties;
77         VkPtr<PFN_vkEnumerateDeviceLayerProperties> fEnumerateDeviceLayerProperties;
78         VkPtr<PFN_vkGetDeviceQueue> fGetDeviceQueue;
79         VkPtr<PFN_vkQueueSubmit> fQueueSubmit;
80         VkPtr<PFN_vkQueueWaitIdle> fQueueWaitIdle;
81         VkPtr<PFN_vkDeviceWaitIdle> fDeviceWaitIdle;
82         VkPtr<PFN_vkAllocateMemory> fAllocateMemory;
83         VkPtr<PFN_vkFreeMemory> fFreeMemory;
84         VkPtr<PFN_vkMapMemory> fMapMemory;
85         VkPtr<PFN_vkUnmapMemory> fUnmapMemory;
86         VkPtr<PFN_vkFlushMappedMemoryRanges> fFlushMappedMemoryRanges;
87         VkPtr<PFN_vkInvalidateMappedMemoryRanges> fInvalidateMappedMemoryRanges;
88         VkPtr<PFN_vkGetDeviceMemoryCommitment> fGetDeviceMemoryCommitment;
89         VkPtr<PFN_vkBindBufferMemory> fBindBufferMemory;
90         VkPtr<PFN_vkBindImageMemory> fBindImageMemory;
91         VkPtr<PFN_vkGetBufferMemoryRequirements> fGetBufferMemoryRequirements;
92         VkPtr<PFN_vkGetImageMemoryRequirements> fGetImageMemoryRequirements;
93         VkPtr<PFN_vkGetImageSparseMemoryRequirements> fGetImageSparseMemoryRequirements;
94         VkPtr<PFN_vkGetPhysicalDeviceSparseImageFormatProperties> fGetPhysicalDeviceSparseImageFormatProperties;
95         VkPtr<PFN_vkQueueBindSparse> fQueueBindSparse;
96         VkPtr<PFN_vkCreateFence> fCreateFence;
97         VkPtr<PFN_vkDestroyFence> fDestroyFence;
98         VkPtr<PFN_vkResetFences> fResetFences;
99         VkPtr<PFN_vkGetFenceStatus> fGetFenceStatus;
100         VkPtr<PFN_vkWaitForFences> fWaitForFences;
101         VkPtr<PFN_vkCreateSemaphore> fCreateSemaphore;
102         VkPtr<PFN_vkDestroySemaphore> fDestroySemaphore;
103         VkPtr<PFN_vkCreateEvent> fCreateEvent;
104         VkPtr<PFN_vkDestroyEvent> fDestroyEvent;
105         VkPtr<PFN_vkGetEventStatus> fGetEventStatus;
106         VkPtr<PFN_vkSetEvent> fSetEvent;
107         VkPtr<PFN_vkResetEvent> fResetEvent;
108         VkPtr<PFN_vkCreateQueryPool> fCreateQueryPool;
109         VkPtr<PFN_vkDestroyQueryPool> fDestroyQueryPool;
110         VkPtr<PFN_vkGetQueryPoolResults> fGetQueryPoolResults;
111         VkPtr<PFN_vkCreateBuffer> fCreateBuffer;
112         VkPtr<PFN_vkDestroyBuffer> fDestroyBuffer;
113         VkPtr<PFN_vkCreateBufferView> fCreateBufferView;
114         VkPtr<PFN_vkDestroyBufferView> fDestroyBufferView;
115         VkPtr<PFN_vkCreateImage> fCreateImage;
116         VkPtr<PFN_vkDestroyImage> fDestroyImage;
117         VkPtr<PFN_vkGetImageSubresourceLayout> fGetImageSubresourceLayout;
118         VkPtr<PFN_vkCreateImageView> fCreateImageView;
119         VkPtr<PFN_vkDestroyImageView> fDestroyImageView;
120         VkPtr<PFN_vkCreateShaderModule> fCreateShaderModule;
121         VkPtr<PFN_vkDestroyShaderModule> fDestroyShaderModule;
122         VkPtr<PFN_vkCreatePipelineCache> fCreatePipelineCache;
123         VkPtr<PFN_vkDestroyPipelineCache> fDestroyPipelineCache;
124         VkPtr<PFN_vkGetPipelineCacheData> fGetPipelineCacheData;
125         VkPtr<PFN_vkMergePipelineCaches> fMergePipelineCaches;
126         VkPtr<PFN_vkCreateGraphicsPipelines> fCreateGraphicsPipelines;
127         VkPtr<PFN_vkCreateComputePipelines> fCreateComputePipelines;
128         VkPtr<PFN_vkDestroyPipeline> fDestroyPipeline;
129         VkPtr<PFN_vkCreatePipelineLayout> fCreatePipelineLayout;
130         VkPtr<PFN_vkDestroyPipelineLayout> fDestroyPipelineLayout;
131         VkPtr<PFN_vkCreateSampler> fCreateSampler;
132         VkPtr<PFN_vkDestroySampler> fDestroySampler;
133         VkPtr<PFN_vkCreateDescriptorSetLayout> fCreateDescriptorSetLayout;
134         VkPtr<PFN_vkDestroyDescriptorSetLayout> fDestroyDescriptorSetLayout;
135         VkPtr<PFN_vkCreateDescriptorPool> fCreateDescriptorPool;
136         VkPtr<PFN_vkDestroyDescriptorPool> fDestroyDescriptorPool;
137         VkPtr<PFN_vkResetDescriptorPool> fResetDescriptorPool;
138         VkPtr<PFN_vkAllocateDescriptorSets> fAllocateDescriptorSets;
139         VkPtr<PFN_vkFreeDescriptorSets> fFreeDescriptorSets;
140         VkPtr<PFN_vkUpdateDescriptorSets> fUpdateDescriptorSets;
141         VkPtr<PFN_vkCreateFramebuffer> fCreateFramebuffer;
142         VkPtr<PFN_vkDestroyFramebuffer> fDestroyFramebuffer;
143         VkPtr<PFN_vkCreateRenderPass> fCreateRenderPass;
144         VkPtr<PFN_vkDestroyRenderPass> fDestroyRenderPass;
145         VkPtr<PFN_vkGetRenderAreaGranularity> fGetRenderAreaGranularity;
146         VkPtr<PFN_vkCreateCommandPool> fCreateCommandPool;
147         VkPtr<PFN_vkDestroyCommandPool> fDestroyCommandPool;
148         VkPtr<PFN_vkResetCommandPool> fResetCommandPool;
149         VkPtr<PFN_vkAllocateCommandBuffers> fAllocateCommandBuffers;
150         VkPtr<PFN_vkFreeCommandBuffers> fFreeCommandBuffers;
151         VkPtr<PFN_vkBeginCommandBuffer> fBeginCommandBuffer;
152         VkPtr<PFN_vkEndCommandBuffer> fEndCommandBuffer;
153         VkPtr<PFN_vkResetCommandBuffer> fResetCommandBuffer;
154         VkPtr<PFN_vkCmdBindPipeline> fCmdBindPipeline;
155         VkPtr<PFN_vkCmdSetViewport> fCmdSetViewport;
156         VkPtr<PFN_vkCmdSetScissor> fCmdSetScissor;
157         VkPtr<PFN_vkCmdSetLineWidth> fCmdSetLineWidth;
158         VkPtr<PFN_vkCmdSetDepthBias> fCmdSetDepthBias;
159         VkPtr<PFN_vkCmdSetBlendConstants> fCmdSetBlendConstants;
160         VkPtr<PFN_vkCmdSetDepthBounds> fCmdSetDepthBounds;
161         VkPtr<PFN_vkCmdSetStencilCompareMask> fCmdSetStencilCompareMask;
162         VkPtr<PFN_vkCmdSetStencilWriteMask> fCmdSetStencilWriteMask;
163         VkPtr<PFN_vkCmdSetStencilReference> fCmdSetStencilReference;
164         VkPtr<PFN_vkCmdBindDescriptorSets> fCmdBindDescriptorSets;
165         VkPtr<PFN_vkCmdBindIndexBuffer> fCmdBindIndexBuffer;
166         VkPtr<PFN_vkCmdBindVertexBuffers> fCmdBindVertexBuffers;
167         VkPtr<PFN_vkCmdDraw> fCmdDraw;
168         VkPtr<PFN_vkCmdDrawIndexed> fCmdDrawIndexed;
169         VkPtr<PFN_vkCmdDrawIndirect> fCmdDrawIndirect;
170         VkPtr<PFN_vkCmdDrawIndexedIndirect> fCmdDrawIndexedIndirect;
171         VkPtr<PFN_vkCmdDispatch> fCmdDispatch;
172         VkPtr<PFN_vkCmdDispatchIndirect> fCmdDispatchIndirect;
173         VkPtr<PFN_vkCmdCopyBuffer> fCmdCopyBuffer;
174         VkPtr<PFN_vkCmdCopyImage> fCmdCopyImage;
175         VkPtr<PFN_vkCmdBlitImage> fCmdBlitImage;
176         VkPtr<PFN_vkCmdCopyBufferToImage> fCmdCopyBufferToImage;
177         VkPtr<PFN_vkCmdCopyImageToBuffer> fCmdCopyImageToBuffer;
178         VkPtr<PFN_vkCmdUpdateBuffer> fCmdUpdateBuffer;
179         VkPtr<PFN_vkCmdFillBuffer> fCmdFillBuffer;
180         VkPtr<PFN_vkCmdClearColorImage> fCmdClearColorImage;
181         VkPtr<PFN_vkCmdClearDepthStencilImage> fCmdClearDepthStencilImage;
182         VkPtr<PFN_vkCmdClearAttachments> fCmdClearAttachments;
183         VkPtr<PFN_vkCmdResolveImage> fCmdResolveImage;
184         VkPtr<PFN_vkCmdSetEvent> fCmdSetEvent;
185         VkPtr<PFN_vkCmdResetEvent> fCmdResetEvent;
186         VkPtr<PFN_vkCmdWaitEvents> fCmdWaitEvents;
187         VkPtr<PFN_vkCmdPipelineBarrier> fCmdPipelineBarrier;
188         VkPtr<PFN_vkCmdBeginQuery> fCmdBeginQuery;
189         VkPtr<PFN_vkCmdEndQuery> fCmdEndQuery;
190         VkPtr<PFN_vkCmdResetQueryPool> fCmdResetQueryPool;
191         VkPtr<PFN_vkCmdWriteTimestamp> fCmdWriteTimestamp;
192         VkPtr<PFN_vkCmdCopyQueryPoolResults> fCmdCopyQueryPoolResults;
193         VkPtr<PFN_vkCmdPushConstants> fCmdPushConstants;
194         VkPtr<PFN_vkCmdBeginRenderPass> fCmdBeginRenderPass;
195         VkPtr<PFN_vkCmdNextSubpass> fCmdNextSubpass;
196         VkPtr<PFN_vkCmdEndRenderPass> fCmdEndRenderPass;
197         VkPtr<PFN_vkCmdExecuteCommands> fCmdExecuteCommands;
198 
199         VkPtr<PFN_vkCreateDebugReportCallbackEXT> fCreateDebugReportCallbackEXT;
200         VkPtr<PFN_vkDebugReportMessageEXT> fDebugReportMessageEXT;
201         VkPtr<PFN_vkDestroyDebugReportCallbackEXT> fDestroyDebugReportCallbackEXT;
202     } fFunctions;
203 
204 };
205 
206 #endif
207