Struct bevy::render::renderer::RenderInstance

pub struct RenderInstance(pub Instance);

The GPU instance is used to initialize the RenderQueue and RenderDevice, as well as to create WindowSurfaces.

Tuple Fields

0: Instance

Methods from Deref<Target = Instance>

pub unsafe fn as_hal<A>(&self) -> Option<&<A as Api>::Instance>where A: HalApi,

Return a reference to a specific backend instance, if available.

If this Instance has a wgpu-hal Instance for backend A, return a reference to it. Otherwise, return None.

Safety

• The raw instance handle returned must not be manually destroyed.

pub fn enumerate_adapters( &self, backends: Backends ) -> impl Iterator<Item = Adapter>

Retrieves all available [Adapter]s that match the given Backends.

Arguments

• backends - Backends from which to enumerate adapters.

pub fn request_adapter( &self, options: &RequestAdapterOptions<&Surface> ) -> 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_adapter_from_hal<A>( &self, hal_adapter: ExposedAdapter<A> ) -> Adapterwhere A: HalApi,

Converts a wgpu-hal ExposedAdapter to a wgpu [Adapter].

Safety

hal_adapter must be created from this instance internal handle.

pub unsafe fn create_surface<W>( &self, window: &W ) -> Result<Surface, CreateSurfaceError>where W: HasRawWindowHandle + HasRawDisplayHandle,

Creates a surface from a raw window handle.

If the specified display and window handle are not supported by any of the backends, then the surface will not be supported by any adapters.

Safety

• raw_window_handle must be a valid object to create a surface upon.
• raw_window_handle must remain valid until after the returned [Surface] is dropped.

Errors

• On WebGL2: Will return an error if the browser does not support WebGL2, or declines to provide GPU access (such as due to a resource shortage).

Panics

• On macOS/Metal: will panic if not called on the main thread.
• On web: will panic if the raw_window_handle does not properly refer to a canvas element.

pub unsafe fn create_surface_from_visual(&self, visual: *mut c_void) -> Surface

Creates a surface from IDCompositionVisual.

Safety

• visual must be a valid IDCompositionVisual to create a surface upon.

pub unsafe fn create_surface_from_surface_handle( &self, surface_handle: *mut c_void ) -> Surface

Creates a surface from SurfaceHandle.

Safety

• surface_handle must be a valid SurfaceHandle to create a surface upon.

pub fn poll_all(&self, force_wait: bool) -> bool

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 and all submitted commands have finished execution.

Return true if all devices’ queues are empty, or false if there are queue submissions still in flight. (Note that, unless access to all Queues associated with this [Instance] is coordinated somehow, this information could be out of date by the time the caller receives it. Queues can be shared between threads, and other threads could submit new work at any time.)

On the web, this is a no-op. Devices are automatically polled.

pub fn generate_report(&self) -> GlobalReport

Generates memory report.

Trait Implementations

impl Deref for RenderInstance

type Target = Instance

The resulting type after dereferencing.

fn deref(&self) -> &<RenderInstance as Deref>::Target

Dereferences the value.

impl DerefMut for RenderInstance

fn deref_mut(&mut self) -> &mut <RenderInstance as Deref>::Target

Mutably dereferences the value.

impl Resource for RenderInstancewhere RenderInstance: Send + Sync + 'static,