Skip to main content

PipelineCacheKey

Struct PipelineCacheKey 

Source
pub struct PipelineCacheKey {
    pub shader_hash: u64,
    pub entry_point: String,
    pub layout_tag: String,
}
Expand description

Unique key identifying a compiled compute pipeline.

Two pipelines are considered identical — and therefore candidates for sharing a cached wgpu::ComputePipeline — when all three fields match.

§Layout tag conventions

The layout_tag is an opaque caller-supplied string. A suggested convention is to encode the binding types in declaration order, e.g.:

Binding patternlayout_tag
read ⟶ read_write"r-w"
read ⟶ read ⟶ read_write"r-r-w"
uniform ⟶ read ⟶ read_write"u-r-w"

Any unambiguous scheme works as long as it is applied consistently within a project.

Fields§

§shader_hash: u64

FNV-1a 64-bit hash of the WGSL shader source text.

Using a hash keeps the key small; the probability of a collision for distinct shaders in a typical project is negligible (< 2⁻⁶⁰).

§entry_point: String

The @compute function name used as the pipeline entry point.

§layout_tag: String

An opaque string describing the bind-group layout structure.

Implementations§

Source§

impl PipelineCacheKey

Source

pub fn new(shader_source: &str, entry_point: &str, layout_tag: &str) -> Self

Construct a key from raw shader source, entry point, and layout tag.

The shader source is hashed with fnv1a_64; the raw text is not stored in the key.

§Examples
use oxigdal_gpu::pipeline_cache::{PipelineCacheKey, fnv1a_64};

let src = "// wgsl shader source";
let key = PipelineCacheKey::new(src, "main", "r-w");
assert_eq!(key.shader_hash, fnv1a_64(src.as_bytes()));
assert_eq!(key.entry_point, "main");
assert_eq!(key.layout_tag, "r-w");
Source

pub fn from_hash(shader_hash: u64, entry_point: &str, layout_tag: &str) -> Self

Construct a key directly from a pre-computed shader hash.

Use this when the hash has already been computed externally to avoid re-hashing the shader source.

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 Display 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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<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<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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,

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