Struct wgpu::Instance [−][src]
pub struct Instance { /* fields omitted */ }
Context for all other wgpu objects. Instance of wgpu.
This is the first thing you create when using wgpu.
Its primary use is to create Adapter
s and Surface
s.
Does not have to be kept alive.
Implementations
impl Instance
[src]
pub fn new(backends: BackendBit) -> Self
[src]
Create an new instance of wgpu.
Arguments
backends
- Controls from which backends wgpu will choose during instantiation.
pub fn enumerate_adapters(
&self,
backends: BackendBit
) -> impl Iterator<Item = Adapter>
[src]
&self,
backends: BackendBit
) -> impl Iterator<Item = Adapter>
Retrieves all available Adapter
s that match the given BackendBit
.
Arguments
backends
- Backends from which to enumerate adapters.
pub fn request_adapter(
&self,
options: &RequestAdapterOptions<'_>
) -> impl Future<Output = Option<Adapter>> + Send
[src]
&self,
options: &RequestAdapterOptions<'_>
) -> impl Future<Output = Option<Adapter>> + Send
Retrieves an Adapter
which matches the given RequestAdapterOptions
.
Some options are “soft”, so treated as non-mandatory. Others are “hard”.
If no adapters are found that suffice all the “hard” options, None
is returned.
pub unsafe fn create_surface<W: HasRawWindowHandle>(
&self,
window: &W
) -> Surface
[src]
&self,
window: &W
) -> Surface
Creates a surface from a raw window handle.
Safety
- Raw Window Handle must be a valid object to create a surface upon.
pub fn poll_all(&self, force_wait: bool)
[src]
Polls all devices.
If force_wait
is true and this is not running on the web,
then this function will block until all in-flight buffers have been mapped.
Trait Implementations
Auto Trait Implementations
impl !RefUnwindSafe for Instance
impl Send for Instance
impl Sync for Instance
impl Unpin for Instance
impl !UnwindSafe for Instance
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Downcast<T> for T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.