1 // Copyright 2018 The SwiftShader Authors. All Rights Reserved.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14
15 #ifndef VK_INSTANCE_HPP_
16 #define VK_INSTANCE_HPP_
17
18 #include "VkObject.hpp"
19
20 namespace vk {
21
22 class DebugUtilsMessenger;
23
24 class Instance
25 {
26 public:
GetAllocationScope()27 static constexpr VkSystemAllocationScope GetAllocationScope() { return VK_SYSTEM_ALLOCATION_SCOPE_INSTANCE; }
28
29 Instance(const VkInstanceCreateInfo *pCreateInfo, void *mem, VkPhysicalDevice physicalDevice, DebugUtilsMessenger *messenger);
30 void destroy(const VkAllocationCallbacks *pAllocator);
31
ComputeRequiredAllocationSize(const VkInstanceCreateInfo *)32 static size_t ComputeRequiredAllocationSize(const VkInstanceCreateInfo *) { return 0; }
33
34 VkResult getPhysicalDevices(uint32_t *pPhysicalDeviceCount, VkPhysicalDevice *pPhysicalDevices) const;
35 VkResult getPhysicalDeviceGroups(uint32_t *pPhysicalDeviceGroupCount,
36 VkPhysicalDeviceGroupProperties *pPhysicalDeviceGroupProperties) const;
37
38 void submitDebugUtilsMessage(VkDebugUtilsMessageSeverityFlagBitsEXT messageSeverity, VkDebugUtilsMessageTypeFlagsEXT messageTypes, const VkDebugUtilsMessengerCallbackDataEXT *pCallbackData);
39
40 private:
41 VkPhysicalDevice physicalDevice = VK_NULL_HANDLE;
42
43 // This debug messenger (when available) is owned by the instance and created via passing a
44 // chained struct to vkCreateInstance. This should be destroyed with the instance.
45 DebugUtilsMessenger *messenger = nullptr;
46 };
47
48 using DispatchableInstance = DispatchableObject<Instance, VkInstance>;
49
Cast(VkInstance object)50 static inline Instance *Cast(VkInstance object)
51 {
52 return DispatchableInstance::Cast(object);
53 }
54
55 } // namespace vk
56
57 #endif // VK_INSTANCE_HPP_
58