Struct wgpu::core::hub::Hub

pub struct Hub<A>
where
    A: HalApi,
{

    pub adapters: Registry<Id<Adapter<Api>>, Adapter<A>>,
    pub devices: Registry<Id<Device<Api>>, Device<A>>,
    pub queues: Registry<Id<Device<Api>>, Queue<A>>,
    pub pipeline_layouts: Registry<Id<PipelineLayout<Api>>, PipelineLayout<A>>,
    pub shader_modules: Registry<Id<ShaderModule<Api>>, ShaderModule<A>>,
    pub bind_group_layouts: Registry<Id<BindGroupLayout<Api>>, BindGroupLayout<A>>,
    pub bind_groups: Registry<Id<BindGroup<Api>>, BindGroup<A>>,
    pub command_buffers: Registry<Id<CommandBuffer<Api>>, CommandBuffer<A>>,
    pub render_bundles: Registry<Id<RenderBundle<Api>>, RenderBundle<A>>,
    pub render_pipelines: Registry<Id<RenderPipeline<Api>>, RenderPipeline<A>>,
    pub compute_pipelines: Registry<Id<ComputePipeline<Api>>, ComputePipeline<A>>,
    pub query_sets: Registry<Id<QuerySet<Api>>, QuerySet<A>>,
    pub buffers: Registry<Id<Buffer<Api>>, Buffer<A>>,
    pub staging_buffers: Registry<Id<StagingBuffer<Api>>, StagingBuffer<A>>,
    pub textures: Registry<Id<Texture<Api>>, Texture<A>>,
    pub texture_views: Registry<Id<TextureView<Api>>, TextureView<A>>,
    pub samplers: Registry<Id<Sampler<Api>>, Sampler<A>>,
}

All the resources for a particular backend in a crate::global::Global.

To obtain global’s Hub for some HalApi backend type A, call A::hub(global).

Locking

Each field in Hub is a Registry holding all the values of a particular type of resource, all protected by a single RwLock. So for example, to access any Buffer, you must acquire a read lock on the Hubs entire buffers registry. The lock guard gives you access to the Registry’s Storage, which you can then index with the buffer’s id. (Yes, this design causes contention; see [#2272].)

But most wgpu operations require access to several different kinds of resource, so you often need to hold locks on several different fields of your Hub simultaneously.

Inside the Registry there are Arc<T> where T is a Resource Lock of Registry happens only when accessing to get the specific resource

Fields

adapters: Registry<Id<Adapter<Api>>, Adapter<A>>

devices: Registry<Id<Device<Api>>, Device<A>>

queues: Registry<Id<Device<Api>>, Queue<A>>

pipeline_layouts: Registry<Id<PipelineLayout<Api>>, PipelineLayout<A>>

shader_modules: Registry<Id<ShaderModule<Api>>, ShaderModule<A>>

bind_group_layouts: Registry<Id<BindGroupLayout<Api>>, BindGroupLayout<A>>

bind_groups: Registry<Id<BindGroup<Api>>, BindGroup<A>>

command_buffers: Registry<Id<CommandBuffer<Api>>, CommandBuffer<A>>

render_bundles: Registry<Id<RenderBundle<Api>>, RenderBundle<A>>

render_pipelines: Registry<Id<RenderPipeline<Api>>, RenderPipeline<A>>

compute_pipelines: Registry<Id<ComputePipeline<Api>>, ComputePipeline<A>>

query_sets: Registry<Id<QuerySet<Api>>, QuerySet<A>>

buffers: Registry<Id<Buffer<Api>>, Buffer<A>>

staging_buffers: Registry<Id<StagingBuffer<Api>>, StagingBuffer<A>>

textures: Registry<Id<Texture<Api>>, Texture<A>>

texture_views: Registry<Id<TextureView<Api>>, TextureView<A>>

samplers: Registry<Id<Sampler<Api>>, Sampler<A>>

Implementations

impl<A> Hub<A>

where A: HalApi,

pub fn generate_report(&self) -> HubReport