Struct vulkano::library::VulkanLibrary

pub struct VulkanLibrary { /* private fields */ }

A loaded library containing a valid Vulkan implementation.

Implementations

impl VulkanLibrary

pub fn new() -> Result<Arc<Self>, LoadingError>

Loads the default Vulkan library for this system.

pub fn with_loader(
    loader: impl Loader + 'static
) -> Result<Arc<Self>, LoadingError>

Loads a custom Vulkan library.

pub fn fns(&self) -> &EntryFunctions

Returns pointers to the raw global Vulkan functions of the library.

pub fn api_version(&self) -> Version

Returns the highest Vulkan version that is supported for instances.

pub fn extension_properties(&self) -> &[ExtensionProperties]

Returns the extension properties reported by the core library.

pub fn supported_extensions(&self) -> &InstanceExtensions

Returns the extensions that are supported by the core library.

pub fn layer_properties(
    &self
) -> Result<impl ExactSizeIterator<Item = LayerProperties>, OomError>

Returns the list of layers that are available when creating an instance.

On success, this function returns an iterator that produces LayerProperties objects. In order to enable a layer, you need to pass its name (returned by LayerProperties::name()) when creating the Instance.

Note: The available layers may change between successive calls to this function, so each call may return different results. It is possible that one of the layers enumerated here is no longer available when you create the Instance. This will lead to an error when calling Instance::new.

Examples

use vulkano::VulkanLibrary;

let library = VulkanLibrary::new().unwrap();

for layer in library.layer_properties().unwrap() {
    println!("Available layer: {}", layer.name());
}

pub fn layer_extension_properties(
    &self,
    layer: &str
) -> Result<Vec<ExtensionProperties>, VulkanError>

Returns the extension properties that are reported by the given layer.

pub fn supported_layer_extensions(
    &self,
    layer: &str
) -> Result<InstanceExtensions, VulkanError>

Returns the extensions that are supported by the given layer.

pub fn supported_extensions_with_layers<'a>(
    &self,
    layers: impl IntoIterator<Item = &'a str>
) -> Result<InstanceExtensions, VulkanError>

Returns the union of the extensions that are supported by the core library and all the given layers.

pub unsafe fn get_instance_proc_addr(
    &self,
    instance: Instance,
    name: *const c_char
) -> PFN_vkVoidFunction

Calls get_instance_proc_addr on the underlying loader.

Trait Implementations

impl Debug for VulkanLibrary

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.