Struct Id

pub struct Id<T>(/* private fields */)
where
    T: 'static + WasmNotSendSync;

An identifier for a wgpu object.

An Id<T> value identifies a value stored in a Global’s Hub’s Storage. Storage implements Index and IndexMut, accepting Id values as indices.

Note on Id typing

You might assume that an Id<T> can only be used to retrieve a resource of type T, but that is not quite the case. The id types in wgpu-core’s public API (TextureId, for example) can refer to resources belonging to any backend, but the corresponding resource types (Texture<A>, for example) are always parameterized by a specific backend A.

So the T in Id<T> is usually a resource type like Texture<Empty>, where Empty is the wgpu_hal dummy back end. These empty types are never actually used, beyond just making sure you access each Storage with the right kind of identifier. The members of Hub<A> pair up each X<Empty> type with the resource type X<A>, for some specific backend A.

Implementations

impl<T> Id<T>

where T: 'static + WasmNotSendSync,

pub unsafe fn from_raw(raw: NonZero<u64>) -> Id<T>

Safety

The raw id must be valid for the type.

pub fn backend(self) -> Backend

Trait Implementations

impl<T> Clone for Id<T>

where T: 'static + WasmNotSendSync,

fn clone(&self) -> Id<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Id<T>

where T: 'static + WasmNotSendSync,

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T> From<ObjectId> for Id<T>

where T: 'static + WasmNotSendSync,

fn from(id: ObjectId) -> Id<T>

Converts to this type from the input type.

impl<T> Hash for Id<T>

where T: 'static + WasmNotSendSync,

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T> Ord for Id<T>

where T: 'static + WasmNotSendSync,

fn cmp(&self, other: &Id<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T> PartialEq for Id<T>

where T: 'static + WasmNotSendSync,

fn eq(&self, other: &Id<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> PartialOrd for Id<T>

where T: 'static + WasmNotSendSync,

fn partial_cmp(&self, other: &Id<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<A> Resource<Id<Adapter<Api>>> for Adapter<A>

where A: HalApi,

const TYPE: &'static str = "Adapter"

fn as_info(&self) -> &ResourceInfo<Id<Adapter<Api>>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<Adapter<Api>>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl<A> Resource<Id<BindGroup<Api>>> for BindGroup<A>

where A: HalApi,

const TYPE: &'static str = "BindGroup"

fn as_info(&self) -> &ResourceInfo<Id<BindGroup<Api>>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<BindGroup<Api>>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl<A> Resource<Id<BindGroupLayout<Api>>> for BindGroupLayout<A>

where A: HalApi,

const TYPE: &'static str = "BindGroupLayout"

fn as_info(&self) -> &ResourceInfo<Id<BindGroupLayout<Api>>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<BindGroupLayout<Api>>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl<A> Resource<Id<Buffer<Api>>> for Buffer<A>

where A: HalApi,

const TYPE: &'static str = "Buffer"

fn as_info(&self) -> &ResourceInfo<Id<Buffer<Api>>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<Buffer<Api>>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl<A> Resource<Id<CommandBuffer<Api>>> for CommandBuffer<A>

where A: HalApi,

const TYPE: &'static str = "CommandBuffer"

fn as_info(&self) -> &ResourceInfo<Id<CommandBuffer<Api>>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<CommandBuffer<Api>>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl<A> Resource<Id<ComputePipeline<Api>>> for ComputePipeline<A>

where A: HalApi,

const TYPE: &'static str = "ComputePipeline"

fn as_info(&self) -> &ResourceInfo<Id<ComputePipeline<Api>>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<ComputePipeline<Api>>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl<A> Resource<Id<Device<Api>>> for Device<A>

where A: HalApi,

const TYPE: &'static str = "Device"

fn as_info(&self) -> &ResourceInfo<Id<Device<Api>>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<Device<Api>>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl<A> Resource<Id<Device<Api>>> for Queue<A>

where A: HalApi,

const TYPE: &'static str = "Queue"

fn as_info(&self) -> &ResourceInfo<Id<Device<Api>>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<Device<Api>>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl<A> Resource<Id<PipelineLayout<Api>>> for PipelineLayout<A>

where A: HalApi,

const TYPE: &'static str = "PipelineLayout"

fn as_info(&self) -> &ResourceInfo<Id<PipelineLayout<Api>>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<PipelineLayout<Api>>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl<A> Resource<Id<QuerySet<Api>>> for QuerySet<A>

where A: HalApi,

const TYPE: &'static str = "QuerySet"

fn as_info(&self) -> &ResourceInfo<Id<QuerySet<Api>>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<QuerySet<Api>>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl<A> Resource<Id<RenderBundle<Api>>> for RenderBundle<A>

where A: HalApi,

const TYPE: &'static str = "RenderBundle"

fn as_info(&self) -> &ResourceInfo<Id<RenderBundle<Api>>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<RenderBundle<Api>>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl<A> Resource<Id<RenderPipeline<Api>>> for RenderPipeline<A>

where A: HalApi,

const TYPE: &'static str = "RenderPipeline"

fn as_info(&self) -> &ResourceInfo<Id<RenderPipeline<Api>>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<RenderPipeline<Api>>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl<A> Resource<Id<Sampler<Api>>> for Sampler<A>

where A: HalApi,

const TYPE: &'static str = "Sampler"

fn as_info(&self) -> &ResourceInfo<Id<Sampler<Api>>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<Sampler<Api>>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl<A> Resource<Id<ShaderModule<Api>>> for ShaderModule<A>

where A: HalApi,

const TYPE: &'static str = "ShaderModule"

fn as_info(&self) -> &ResourceInfo<Id<ShaderModule<Api>>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<ShaderModule<Api>>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl<A> Resource<Id<StagingBuffer<Api>>> for StagingBuffer<A>

where A: HalApi,

const TYPE: &'static str = "StagingBuffer"

fn as_info(&self) -> &ResourceInfo<Id<StagingBuffer<Api>>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<StagingBuffer<Api>>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl Resource<Id<Surface>> for Surface

const TYPE: &'static str = "Surface"

fn as_info(&self) -> &ResourceInfo<Id<Surface>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<Surface>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl<A> Resource<Id<Texture<Api>>> for Texture<A>

where A: HalApi,

const TYPE: &'static str = "Texture"

fn as_info(&self) -> &ResourceInfo<Id<Texture<Api>>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<Texture<Api>>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl<A> Resource<Id<TextureView<Api>>> for TextureView<A>

where A: HalApi,

const TYPE: &'static str = "TextureView"

fn as_info(&self) -> &ResourceInfo<Id<TextureView<Api>>>

fn as_info_mut(&mut self) -> &mut ResourceInfo<Id<TextureView<Api>>>

fn label(&self) -> String

fn ref_count(self: &Arc<Self>) -> usize

fn is_unique(self: &Arc<Self>) -> bool

fn is_equal(&self, other: &Self) -> bool

impl<T> TypedId for Id<T>

where T: 'static + WasmNotSendSync,

fn zip(index: u32, epoch: u32, backend: Backend) -> Id<T>

fn unzip(self) -> (u32, u32, Backend)

fn into_raw(self) -> NonZero<u64>

impl<T> Copy for Id<T>

where T: 'static + WasmNotSendSync,

impl<T> Eq for Id<T>

where T: 'static + WasmNotSendSync,