Struct RenderInstance 

pub struct RenderInstance(/* private fields */);

The GPU instance is used to initialize the RenderQueue and RenderDevice.

Implementations

impl RenderInstance

pub fn new(t: Instance) -> RenderInstance

Constructs a new instance of WgpuWrapper which will wrap the specified value.

pub fn into_inner(self) -> Instance

Unwraps the value.

Methods from Deref<Target = Instance>

pub fn wgsl_language_features(&self) -> WgslLanguageFeatures

Returns the set of WGSL language extensions supported by this instance.

pub fn enumerate_adapters( &self, backends: Backends, ) -> impl Future<Output = Vec<Adapter>>

Retrieves all available Adapters that match the given Backends.

Arguments

• backends - Backends from which to enumerate adapters.

pub fn request_adapter( &self, options: &RequestAdapterOptions<&Surface<'_>>, ) -> impl Future<Output = Result<Adapter, RequestAdapterError>> + WasmNotSend

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 satisfy all the “hard” options, an error is returned.

When targeting WebGL2, a compatible_surface must be specified; using RequestAdapterOptions::default() will not succeed.

pub fn create_surface<'window>( &self, target: impl Into<SurfaceTarget<'window>>, ) -> Result<Surface<'window>, CreateSurfaceError>

Creates a new surface targeting a given window/canvas/surface/etc..

Internally, this creates surfaces for all backends that are enabled for this instance.

See SurfaceTarget for what targets are supported. See Instance::create_surface_unsafe() for surface creation with unsafe target variants.

Most commonly used are window handles (or provider of windows handles) which can be passed directly as they’re automatically converted to SurfaceTarget.

pub unsafe fn create_surface_unsafe<'window>( &self, target: SurfaceTargetUnsafe, ) -> Result<Surface<'window>, CreateSurfaceError>

Creates a new surface targeting a given window/canvas/surface/etc. using an unsafe target.

Internally, this creates surfaces for all backends that are enabled for this instance.

See SurfaceTargetUnsafe for what targets are supported. See Instance::create_surface for surface creation with safe target variants.

Safety

• See respective SurfaceTargetUnsafe variants for safety requirements.

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) -> Option<GlobalReport>

Generates memory report.

Returns None if the feature is not supported by the backend which happens only when WebGPU is pre-selected by the instance creation.

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

where A: Api,

Get the wgpu_hal instance from this Instance.

Find the Api struct corresponding to the active backend in wgpu_hal::api, and pass that struct to the to the A type parameter.

Returns a guard that dereferences to the type of the hal backend which implements A::Instance.

Types

• hal::api::Vulkan uses hal::vulkan::Instance
• hal::api::Metal uses hal::metal::Instance
• hal::api::Dx12 uses hal::dx12::Instance
• hal::api::Gles uses hal::gles::Instance

Errors

This method will return None if:

• The instance is not from the backend specified by A.
• The instance is from the webgpu or custom backend.

Safety

• The returned resource must not be destroyed unless the guard is the last reference to it and it is not in use by the GPU. The guard and handle may be dropped at any time however.
• All the safety requirements of wgpu-hal must be upheld.

pub unsafe fn create_adapter_from_hal<A>( &self, hal_adapter: ExposedAdapter<A>, ) -> Adapter

where A: Api,

Converts a wgpu-hal hal::ExposedAdapter to a wgpu Adapter.

Types

The type of hal_adapter.adapter depends on the backend:

• hal::api::Vulkan uses hal::vulkan::Adapter
• hal::api::Metal uses hal::metal::Adapter
• hal::api::Dx12 uses hal::dx12::Adapter
• hal::api::Gles uses hal::gles::Adapter

Safety

hal_adapter must be created from this instance internal handle.

Trait Implementations

impl Clone for RenderInstance

fn clone(&self) -> RenderInstance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for RenderInstance

where RenderInstance: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<RenderInstance>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

const HAS_SUMMARY_TICK: bool = false

Set this constant to true if the component should track a summary tick.

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 RenderInstance

where RenderInstance: Send + Sync + 'static,

impl Send for RenderInstance

impl Sync for RenderInstance