blob: 9c6fdc25df0c116b9fb524b48e0606a0151a5318 [file] [log] [blame]
* MVKInstance.h
* Copyright (c) 2014-2018 The Brenwill Workshop Ltd. (
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* See the License for the specific language governing permissions and
* limitations under the License.
#pragma once
#include "MVKLayers.h"
#include "MVKSurface.h"
#include "MVKBaseObject.h"
#include "vk_mvk_moltenvk.h"
#include <vector>
#include <unordered_map>
#include <string>
class MVKPhysicalDevice;
#pragma mark -
#pragma mark MVKInstance
/** Represents a Vulkan instance. */
class MVKInstance : public MVKDispatchableObject {
/** Returns the function pointer corresponding to the specified named entry point. */
inline PFN_vkVoidFunction getProcAddr(const char* pName) { return _procAddrMap[pName]; }
* If pPhysicalDevices is null, the value of pCount is updated with the number of
* physical devices supported by this instance.
* If pPhysicalDevices is not null, then pCount physical devices are copied into the array.
* If the number of available physical devices is less than pCount, the value of pCount is
* updated to indicate the number of physical devices actually returned in the array.
* Returns VK_SUCCESS if successful. Returns VK_INCOMPLETE if the number of physical
* devices available in this instance is larger than the specified pCount. Returns other
* values if an error occurs.
VkResult getPhysicalDevices(uint32_t* pCount, VkPhysicalDevice* pPhysicalDevices);
/** Returns the driver layer. */
MVKLayer* getDriverLayer() { return MVKLayerManager::globalManager()->getDriverLayer(); }
/** Creates and returns a new object. */
MVKSurface* createSurface(const Vk_PLATFORM_SurfaceCreateInfoMVK* pCreateInfo,
const VkAllocationCallbacks* pAllocator);
/** Destroys the specified object. */
void destroySurface(MVKSurface* mvkSrfc,
const VkAllocationCallbacks* pAllocator);
/** Returns the MoltenVK configuration settings. */
const MVKConfiguration* getMoltenVKConfiguration() { return &_mvkConfig; }
/** Returns the MoltenVK configuration settings. */
void setMoltenVKConfiguration(MVKConfiguration* mvkConfig) { _mvkConfig = *mvkConfig; }
/** The list of Vulkan extensions, indicating whether each has been enabled by the app. */
const MVKExtensionList _enabledExtensions;
#pragma mark Object Creation
/** Constructs an instance from the specified instance config. */
MVKInstance(const VkInstanceCreateInfo* pCreateInfo);
~MVKInstance() override;
* Returns a reference to this object suitable for use as a Vulkan API handle.
* This is the compliment of the getMVKInstance() method.
inline VkInstance getVkInstance() { return (VkInstance)getVkHandle(); }
* Retrieves the MVKInstance instance referenced by the VkInstance handle.
* This is the compliment of the getVkInstance() method.
static inline MVKInstance* getMVKInstance(VkInstance vkInstance) {
return (MVKInstance*)getDispatchableObject(vkInstance);
void initProcAddrs();
void initConfig();
void logVersions();
VkResult verifyLayers(uint32_t count, const char* const* names);
MVKConfiguration _mvkConfig;
VkApplicationInfo _appInfo;
std::vector<MVKPhysicalDevice*> _physicalDevices;
std::unordered_map<std::string, PFN_vkVoidFunction> _procAddrMap;