Skip to main content

PipelineCacheKey

Struct PipelineCacheKey 

Source
pub struct PipelineCacheKey {
    pub version: u32,
    pub shader_hash: [u8; 32],
    pub bind_group_layout_hash: [u8; 32],
    pub push_constant_size: u32,
    pub workgroup_size: [u32; 3],
    pub feature_flags: PipelineFeatureFlags,
    pub backend_id: BackendId,
    /* private fields */
}
Expand description

Versioned pipeline-cache key shared by every backend.

Replaces the pre-0.6 pattern of using a raw blake3 hash as the key. A raw hash is not robust: two pipelines that should miss (different bind-group layout, different push-constant size, different workgroup-size selection) hashed identically because the hash covered the shader source only. Silent cache hits against a non-equivalent pipeline are a correctness hazard (wrong bind-group layout binds undefined data; wrong workgroup-size launches beyond guarantees).

#[non_exhaustive] is enforced at the type level via the private __phantom field: external callers construct keys through PipelineCacheKey::new and cannot match exhaustively, so additive key fields do not break downstream matches.

Fields§

§version: u32

Key format version. Bumped to invalidate every cache entry without an API break.

§shader_hash: [u8; 32]

blake3 hash of the canonical backend pipeline-source bytes.

§bind_group_layout_hash: [u8; 32]

Structural hash of the bind-group layout descriptors. Not the backend handle; the bytes that describe slot count, types, visibility, and access modes per bind group.

§push_constant_size: u32

Push-constant range in bytes. Included so a pipeline compiled for 16 B push constants never reuses against a layout that expects 32 B.

§workgroup_size: [u32; 3]

Workgroup-size [x, y, z] the pipeline was specialized for.

§feature_flags: PipelineFeatureFlags

Feature-flag bits the pipeline assumes at dispatch time.

§backend_id: BackendId

Backend identity. Prevents pipelines from different backends from colliding when they happen to produce identical shader hashes.

Implementations§

Source§

impl PipelineCacheKey

Source

pub fn new( shader_hash: [u8; 32], bind_group_layout_hash: [u8; 32], push_constant_size: u32, workgroup_size: [u32; 3], feature_flags: PipelineFeatureFlags, backend_id: BackendId, ) -> Self

Construct a key at the current version.

Trait Implementations§

Source§

impl Clone for PipelineCacheKey

Source§

fn clone(&self) -> PipelineCacheKey

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PipelineCacheKey

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for PipelineCacheKey

Source§

impl Hash for PipelineCacheKey

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for PipelineCacheKey

Source§

fn eq(&self, other: &PipelineCacheKey) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for PipelineCacheKey

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more