Struct Id

pub struct Id<T: Marker>(/* private fields */);

An identifier for a wgpu object.

An Id<T> value identifies a value stored in a Global’s Hub.

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: Marker,

pub unsafe fn from_raw(raw: RawId) -> Self

Safety

The raw id must be valid for the type.

pub fn into_raw(self) -> RawId

Coerce the identifiers into its raw underlying representation.

pub fn backend(self) -> Backend

Get the backend this identifier corresponds to.

pub fn zip(index: u32, epoch: u32, backend: Backend) -> Self

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

impl Id<CommandEncoder>

pub fn into_command_buffer_id(self) -> CommandBufferId

impl Id<CommandBuffer>

pub fn into_command_encoder_id(self) -> CommandEncoderId

impl Id<Device>

pub fn into_queue_id(self) -> QueueId

Trait Implementations

impl<T> Clone for Id<T>

where T: Marker,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Id<T>

where T: Marker,

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

Formats the value using the given formatter.

impl<T> Hash for Id<T>

where T: Marker,

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

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: Marker,

fn cmp(&self, other: &Self) -> 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: Marker,

fn eq(&self, other: &Self) -> 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: Marker,

fn partial_cmp(&self, other: &Self) -> 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<T> Copy for Id<T>

where T: Marker,

impl<T> Eq for Id<T>

where T: Marker,