Skip to content

Class VulkanInstance

Namespace: Apogee.Graphics.Vulkan
Assembly: Apogee.Graphics.dll

The loader's instance plus the debug messenger that forwards validation and driver messages to the log and counts errors.

public sealed class VulkanInstance : IDisposable

Inheritance

object ← VulkanInstance

Implements

IDisposable

Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()

Properties

Commands

public VkInstanceCommands Commands { get; }

Property Value

VkInstanceCommands

ErrorCount

Errors the validation layer or the driver reported since the instance was created (or since ).

public int ErrorCount { get; }

Property Value

int

Handle

public VkInstance Handle { get; }

Property Value

VkInstance

HasDebugUtils

public bool HasDebugUtils { get; }

Property Value

bool

LoaderVersion

The instance version the loader supports.

public static uint LoaderVersion { get; }

Property Value

uint

PortabilityEnumeration

The loader enumerates portability (layered) implementations such as MoltenVK; devices then need VK_KHR_portability_subset.

public bool PortabilityEnumeration { get; }

Property Value

bool

ValidationEnabled

public bool ValidationEnabled { get; }

Property Value

bool

WarningCount

public int WarningCount { get; }

Property Value

int

Methods

Create(VulkanInstanceOptions)

public static VulkanInstance Create(VulkanInstanceOptions options)

Parameters

options VulkanInstanceOptions

Returns

VulkanInstance

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

public void Dispose()

TakeErrors()

Returns the error messages collected so far (at most 100) and clears the count.

public string[] TakeErrors()

Returns

string[]

TryCreate(VulkanInstanceOptions, out VulkanInstance?, out string?)

Creates an instance, or returns false with the reason (no Vulkan loader, no driver, a missing layer that was demanded).

public static bool TryCreate(VulkanInstanceOptions options, out VulkanInstance? instance, out string? error)

Parameters

options VulkanInstanceOptions

instance VulkanInstance?

error string?

Returns

bool