Struct wgpu_hal::vulkan::Instance

source ·
pub struct Instance {
    shared: Arc<InstanceShared>,
}

Fields§

§shared: Arc<InstanceShared>

Implementations§

source§

impl Instance

source§

impl Instance

source

pub fn shared_instance(&self) -> &InstanceShared

source

pub fn desired_extensions( entry: &Entry, _instance_api_version: u32, flags: InstanceFlags ) -> Result<Vec<&'static CStr>, InstanceError>

Return the instance extension names wgpu would like to enable.

Return a vector of the names of instance extensions actually available on entry that wgpu would like to enable.

The instance_api_version argument should be the instance’s Vulkan API version, as obtained from vkEnumerateInstanceVersion. This is the same space of values as the VK_API_VERSION constants.

Note that wgpu can function without many of these extensions (for example, VK_KHR_wayland_surface is certainly not going to be available everywhere), but if one of these extensions is available at all, wgpu assumes that it has been enabled.

source

pub unsafe fn from_raw( entry: Entry, raw_instance: Instance, instance_api_version: u32, android_sdk_version: u32, debug_utils_user_data: Option<DebugUtilsMessengerUserData>, extensions: Vec<&'static CStr>, flags: InstanceFlags, has_nv_optimus: bool, drop_guard: Option<DropGuard> ) -> Result<Self, InstanceError>

Safety
  • raw_instance must be created from entry
  • raw_instance must be created respecting instance_api_version, extensions and flags
  • extensions must be a superset of desired_extensions() and must be created from the same entry, `instance_api_version`` and flags.
  • android_sdk_version is ignored and can be 0 for all platforms besides Android

If debug_utils_user_data is Some, then the validation layer is available, so create a vk::DebugUtilsMessengerEXT.

source

fn create_surface_from_xlib( &self, dpy: *mut Display, window: Window ) -> Result<Surface, InstanceError>

source

fn create_surface_from_xcb( &self, connection: *mut xcb_connection_t, window: xcb_window_t ) -> Result<Surface, InstanceError>

source

fn create_surface_from_wayland( &self, display: *mut c_void, surface: *mut c_void ) -> Result<Surface, InstanceError>

source

fn create_surface_android( &self, window: *const c_void ) -> Result<Surface, InstanceError>

source

fn create_surface_from_hwnd( &self, hinstance: *mut c_void, hwnd: *mut c_void ) -> Result<Surface, InstanceError>

source

fn create_surface_from_vk_surface_khr(&self, surface: SurfaceKHR) -> Surface

Trait Implementations§

source§

impl Instance<Api> for Instance

source§

unsafe fn init(desc: &InstanceDescriptor<'_>) -> Result<Self, InstanceError>

source§

unsafe fn create_surface( &self, display_handle: RawDisplayHandle, window_handle: RawWindowHandle ) -> Result<Surface, InstanceError>

source§

unsafe fn destroy_surface(&self, surface: Surface)

source§

unsafe fn enumerate_adapters(&self) -> Vec<ExposedAdapter<Api>>

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WasmNotSend for Twhere T: Send,

source§

impl<T> WasmNotSync for Twhere T: Sync,