Struct ash::Entry

pub struct Entry { /* private fields */ }

Holds the Vulkan functions independent of a particular instance

Implementations

impl Entry

Vulkan core 1.0

pub unsafe fn load() -> Result<Self, LoadingError>

Load default Vulkan library for the current platform

Prefer this over linked when your application can gracefully handle environments that lack Vulkan support, and when the build environment might not have Vulkan development packages installed (e.g. the Vulkan SDK, or Ubuntu’s libvulkan-dev).

Safety

dlopening native libraries is inherently unsafe. The safety guidelines for Library::new() and Library::get() apply here.

No Vulkan functions loaded directly or indirectly from this Entry may be called after it is dropped.

Example

use ash::{vk, Entry};
let entry = unsafe { Entry::load()? };
let app_info = vk::ApplicationInfo {
    api_version: vk::make_api_version(0, 1, 0, 0),
    ..Default::default()
};
let create_info = vk::InstanceCreateInfo {
    p_application_info: &app_info,
    ..Default::default()
};
let instance = unsafe { entry.create_instance(&create_info, None)? };

pub unsafe fn load_from(path: impl AsRef<OsStr>) -> Result<Self, LoadingError>

Load Vulkan library at path

Safety

dlopening native libraries is inherently unsafe. The safety guidelines for Library::new() and Library::get() apply here.

No Vulkan functions loaded directly or indirectly from this Entry may be called after it is dropped.

pub unsafe fn from_static_fn(static_fn: StaticFn) -> Self

Load entry points based on an already-loaded vk::StaticFn

Safety

static_fn must contain valid function pointers that comply with the semantics specified by Vulkan 1.0, which must remain valid for at least the lifetime of the returned Entry.

pub fn fp_v1_0(&self) -> &EntryFnV1_0

pub fn static_fn(&self) -> &StaticFn

pub fn try_enumerate_instance_version(&self) -> VkResult<Option<u32>>

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkEnumerateInstanceVersion.html

Example

let entry = Entry::linked();
match entry.try_enumerate_instance_version()? {
    // Vulkan 1.1+
    Some(version) => {
        let major = vk::version_major(version);
        let minor = vk::version_minor(version);
        let patch = vk::version_patch(version);
    },
    // Vulkan 1.0
    None => {},
}

pub unsafe fn create_instance( &self, create_info: &InstanceCreateInfo, allocation_callbacks: Option<&AllocationCallbacks> ) -> VkResult<Instance>

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkCreateInstance.html

Safety

The resulting Instance and any function-pointer objects (e.g. Device and extensions) loaded from it may not be used after this Entry object is dropped, unless it was crated using [Entry::linked()].

Instance does not implement drop semantics and can only be destroyed via destroy_instance().

pub fn enumerate_instance_layer_properties( &self ) -> VkResult<Vec<LayerProperties>>

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkEnumerateInstanceLayerProperties.html

pub fn enumerate_instance_extension_properties( &self, layer_name: Option<&CStr> ) -> VkResult<Vec<ExtensionProperties>>

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkEnumerateInstanceExtensionProperties.html

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

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkGetInstanceProcAddr.html

impl Entry

Vulkan core 1.1

pub fn fp_v1_1(&self) -> &EntryFnV1_1

pub fn enumerate_instance_version(&self) -> VkResult<u32>

👎Deprecated: This function is unavailable and therefore panics on Vulkan 1.0, please use try_enumerate_instance_version() instead

https://www.khronos.org/registry/vulkan/specs/1.3-extensions/man/html/vkEnumerateInstanceVersion.html

Please use try_enumerate_instance_version() instead.

impl Entry

Vulkan core 1.2

pub fn fp_v1_2(&self) -> &EntryFnV1_2

impl Entry

Vulkan core 1.3

pub fn fp_v1_3(&self) -> &EntryFnV1_3

Trait Implementations

impl Clone for Entry

fn clone(&self) -> Entry

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.