Skip to main content

ShaderRegistry

Struct ShaderRegistry 

Source
pub struct ShaderRegistry {
    pub cache_hits: u64,
    pub compilations: u64,
    /* private fields */
}
Expand description

Central registry for shader sources and compiled variants.

Call ShaderRegistry::register to add a ShaderSource, then ShaderRegistry::get_or_compile to obtain a compiled variant, which is transparently cached in the internal VariantCache.

Fields§

§cache_hits: u64

Number of cache hits since creation.

§compilations: u64

Number of compilations triggered since creation.

Implementations§

Source§

impl ShaderRegistry

Source

pub fn new(cache_capacity: usize) -> Self

Create a new empty registry with the given cache capacity.

Source

pub fn register(&mut self, source: ShaderSource)

Register a shader source. Overwrites any existing source with the same name and clears cached variants for that name.

Source

pub fn get_or_compile( &mut self, name: &str, defines: &HashMap<String, String>, ) -> Result<&CompiledVariant, RegistryError>

Get or compile a variant.

Returns Err when the source name is unknown or when a required placeholder is not supplied in defines.

Source

pub fn shader_names(&self) -> Vec<&str>

Return all registered shader names.

Source

pub fn cached_count(&self) -> usize

Return the number of entries currently in the variant cache.

Source

pub fn invalidate(&mut self, name: &str)

Invalidate a single shader by name (clears its cached variants).

Source

pub fn invalidate_all(&mut self)

Invalidate all cached variants.

Source§

impl ShaderRegistry

Source

pub fn compile_variant( &mut self, name: &str, defines: &HashMap<String, String>, opts: &ShaderCompileOptions, ) -> Result<CompiledVariant, RegistryError>

Compile a specific shader variant with the given options.

Unlike get_or_compile this method always forces a fresh compilation (not served from the cache) and respects the max_source_bytes limit in opts.

Source§

impl ShaderRegistry

Source

pub fn apply_hot_reload(&mut self, tracker: &HotReloadTracker) -> Vec<String>

Check a HotReloadTracker and invalidate any stale shader variants.

Returns the list of shader names that were invalidated.

Source

pub fn registered_count(&self) -> usize

Return all shader names registered in this registry.

Source

pub fn source_bytes(&self, name: &str) -> usize

Return the size (in WGSL source bytes) of the named shader, or 0.

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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

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