 | |
Vulkan | |
A VulkanInstance is an object is an object that is used to get the available Vulkan API version, enumerate the available physical devices and create a VulkanDevice.
There is usually only one VulkanInstance per application.
A VulkanInstance can be created by using Create(EngineCreateOptions) method.
But usually it is created when creating a VulkanDevice method by calling VulkanDevice.Create method.
Inheritance HierarchyNamespace: Ab4d.SharpEngine.Vulkan
Assembly: Ab4d.SharpEngine (in Ab4d.SharpEngine.dll) Version: 1.0.8740+deb2991acfe86a95cca780cd4f82bcae2805c1a5
SyntaxC#
public class VulkanInstance : IDisposable
The VulkanInstance type exposes the following members.
Properties| Name | Description | |
|---|---|---|
  | AllInstanceExtensionNames | |
| AllInstanceExtensions | |
| AllPhysicalDeviceDetails | |
| ApiVersion | |
| DebugReportExt | |
| DebugUtilsExt | |
| EnabledInstanceExtensionNames | Gets an array of Instance extension names that are enabled for this Vulkan Instance. To quickly check if an extension is enabled, you can also check the EnabledInstanceExtensions property (note that this does not include all extensions but only extensions that are supported by SharpEngine). |
| EnabledInstanceExtensions | Gets a SupportedInstanceExtensions that can be used to quickly check which Instance Extensions are enabled on this Vulkan Instance. This value can include only extension names that are supported by SharpEngine (and defined in SupportedInstanceExtensions enum). This value includes also extensions that are promoted to the current Vulkan API (and are not explicitly specified in the EnabledInstanceExtensionNames array). To get an array of all enabled extensions see the EnabledInstanceExtensionNames. |
| FirstVulkanInstance | FirstVulkanInstance is a static instance of the first VulkanInstance object that is created. It is used when creating an instance of VulkanDevice object. |
| Instance | |
| IsAdditionalValidationEnabled | Gets a Boolean that specifies if the additional validations that are specified by the AdditionalValidationFeatures array are enabled. |
| IsDebugReportExtensionEnabled | |
| IsDebugUtilsExtensionEnabled | |
| IsDisposed | |
| IsStandardValidationEnabled | |
| IsVulkanSurfaceSupported | |
| KhrSurfaceExt | |
| Win32SurfaceExt |
Methods| Name | Description | |
|---|---|---|
 | Create | Create a new vulkan instance. |
| Dispose | Dispose |
 | Dispose(Boolean) | Dispose |
| EnumeratePhysicalDevices | |
| Finalize |
Destructor
(Overrides ObjectFinalize) |
| GetAllAvailableInstanceLayerNames | |
| GetBestPhysicalDevice(SurfaceKHR) | |
| GetBestPhysicalDevice(PhysicalDeviceDetails, SurfaceKHR) | |
| GetDeviceScore | |
| GetFirstSupportedPhysicalDevice(SurfaceKHR) | |
| GetFirstSupportedPhysicalDevice(PhysicalDeviceDetails, SurfaceKHR) | |
| GetOrCreateSurfaceDetails | |
| GetRequiredInstanceExtensionNames |
Fields| Name | Description | |
|---|---|---|
 | CreateOptions | |
| DefaultVulkanApiVersion | |
| EngineName | |
| MinRequiredVulkanApiVersion | |
| Vk |
See Also