mirror of
https://github.com/storytold/photocraft.git
synced 2026-11-21 01:18:43 +00:00
Merge pull request #11148 from vangel76/perf/paint-procedural-texture-cache
perf(paint): cache procedural brush textures between strokes
This commit is contained in:
3 files changed
+168
-6
No files matched your search
@@ -25,6 +25,7 @@ pub mod dynamics;
|
||||
mod mip_cache;
|
||||
pub mod mixer;
|
||||
pub mod outline;
|
||||
mod pattern_cache;
|
||||
pub mod presets;
|
||||
pub mod procedural;
|
||||
pub mod render;
|
||||
|
||||
@@ -0,0 +1,161 @@
|
||||
//! A small process-wide cache for procedural brush textures.
|
||||
//!
|
||||
//! A stroke (and every symmetry mirror of it) used to regenerate its procedural texture in
|
||||
//! [`crate::BrushContext::new`], although the image is a pure function of the style, size, seed and
|
||||
//! level adjustments. The cache is bounded in entries and bytes and evicts the least recently used
|
||||
//! entry first. Sampled-tip mip pyramids are not handled here (see PR #9617).
|
||||
//!
|
||||
//! The key holds every input of the generator plus the level adjustments (brightness, contrast,
|
||||
//! invert) that are baked into the cached image, so a hit is always the image a rebuild would give.
|
||||
|
||||
use std::sync::{Arc, Mutex, PoisonError};
|
||||
|
||||
use crate::brush::{PatternStyle, Texture};
|
||||
use crate::tile::PatternImage;
|
||||
|
||||
const PATTERN_MAX_ENTRIES: usize = 4;
|
||||
const PATTERN_MAX_BYTES: usize = 16 << 20;
|
||||
|
||||
#[derive(PartialEq)]
|
||||
struct PatternKey {
|
||||
style: PatternStyle,
|
||||
size: u32,
|
||||
seed: u32,
|
||||
brightness: u32,
|
||||
contrast: u32,
|
||||
invert: bool,
|
||||
}
|
||||
|
||||
struct PatternEntry {
|
||||
key: PatternKey,
|
||||
image: Arc<PatternImage>,
|
||||
}
|
||||
|
||||
/// The entries, least recently used first.
|
||||
struct PatternCache(Vec<PatternEntry>);
|
||||
|
||||
impl PatternCache {
|
||||
const fn new() -> Self {
|
||||
Self(Vec::new())
|
||||
}
|
||||
|
||||
/// The image cached for `key`, which is then the most recently used entry.
|
||||
fn get(&mut self, key: &PatternKey) -> Option<Arc<PatternImage>> {
|
||||
let i = self.0.iter().position(|e| e.key == *key)?;
|
||||
let e = self.0.remove(i);
|
||||
let image = Arc::clone(&e.image);
|
||||
self.0.push(e);
|
||||
Some(image)
|
||||
}
|
||||
|
||||
/// Caches `image` for `key` (unless it is too big) and evicts the oldest entries past the limits.
|
||||
fn insert(&mut self, key: PatternKey, image: &Arc<PatternImage>) {
|
||||
if image.data.len() * 4 > PATTERN_MAX_BYTES / 2 {
|
||||
return;
|
||||
}
|
||||
// Another thread may have built the same key meanwhile: keep its image, but it was just asked for.
|
||||
match self.0.iter().position(|e| e.key == key) {
|
||||
Some(i) => {
|
||||
let e = self.0.remove(i);
|
||||
self.0.push(e);
|
||||
}
|
||||
None => self.0.push(PatternEntry { key, image: Arc::clone(image) }),
|
||||
}
|
||||
let bytes = |e: &PatternEntry| e.image.data.len() * 4;
|
||||
while self.0.len() > PATTERN_MAX_ENTRIES || self.0.iter().map(bytes).sum::<usize>() > PATTERN_MAX_BYTES {
|
||||
self.0.remove(0);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static PATTERNS: Mutex<PatternCache> = Mutex::new(PatternCache::new());
|
||||
|
||||
/// The key of `(style, size, seed)` with `t`'s levels. Brightness and contrast are keyed on the values
|
||||
/// [`Texture::level`] uses (clamped, non-finite as 0, `-0.0` as `0.0`), so equal levels share an entry.
|
||||
fn pattern_key(style: PatternStyle, size: u32, seed: u32, t: &Texture) -> PatternKey {
|
||||
let level_bits = |v: f32| (if v.is_finite() { v.clamp(-1.0, 1.0) + 0.0 } else { 0.0 }).to_bits();
|
||||
PatternKey { style, size: size.clamp(8, 1024), seed, brightness: level_bits(t.brightness), contrast: level_bits(t.contrast), invert: t.invert }
|
||||
}
|
||||
|
||||
/// The procedural pattern `(style, size, seed)` with `t`'s levels applied, from the cache when it
|
||||
/// was built recently.
|
||||
pub fn procedural_pattern(style: PatternStyle, size: u32, seed: u32, t: &Texture) -> Arc<PatternImage> {
|
||||
let key = pattern_key(style, size, seed, t);
|
||||
if let Some(image) = PATTERNS.lock().unwrap_or_else(PoisonError::into_inner).get(&key) {
|
||||
return image;
|
||||
}
|
||||
let mut img = crate::procedural::pattern(style, size, seed);
|
||||
for v in &mut img.data {
|
||||
*v = t.level(*v);
|
||||
}
|
||||
let image = Arc::new(img);
|
||||
PATTERNS.lock().unwrap_or_else(PoisonError::into_inner).insert(key, &image);
|
||||
image
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn pattern_cache_keys_on_every_input() {
|
||||
let base = Texture::default();
|
||||
let a = procedural_pattern(PatternStyle::Noise, 64, 3, &base);
|
||||
assert!(Arc::ptr_eq(&a, &procedural_pattern(PatternStyle::Noise, 64, 3, &base)));
|
||||
let mut fresh = crate::procedural::pattern(PatternStyle::Noise, 64, 3);
|
||||
fresh.data.iter_mut().for_each(|v| *v = base.level(*v));
|
||||
assert_eq!(a.data, fresh.data);
|
||||
let variants = [
|
||||
(PatternStyle::Canvas, 64, 3, base.clone()),
|
||||
(PatternStyle::Noise, 32, 3, base.clone()),
|
||||
(PatternStyle::Noise, 64, 4, base.clone()),
|
||||
(PatternStyle::Noise, 64, 3, Texture { invert: true, ..base.clone() }),
|
||||
(PatternStyle::Noise, 64, 3, Texture { brightness: 0.5, ..base.clone() }),
|
||||
(PatternStyle::Noise, 64, 3, Texture { contrast: 0.5, ..base.clone() }),
|
||||
];
|
||||
for (style, size, seed, texture) in variants {
|
||||
// Look the base up again so it is the newest entry and still cached when the variant is
|
||||
// asked for; a key that ignored the changed input would then hand back the base image.
|
||||
procedural_pattern(PatternStyle::Noise, 64, 3, &base);
|
||||
let other = procedural_pattern(style, size, seed, &texture);
|
||||
assert!(!Arc::ptr_eq(&a, &other) && other.data != a.data, "{style:?} {size} {seed}");
|
||||
}
|
||||
}
|
||||
|
||||
/// The cache holds a few entries: the oldest one goes first. Runs on a cache this test owns, so
|
||||
/// no other test can evict or refresh an entry.
|
||||
#[test]
|
||||
fn pattern_cache_evicts_the_oldest_entry_past_its_limit() {
|
||||
let base = Texture::default();
|
||||
let mut cache = PatternCache::new();
|
||||
let key = |seed| pattern_key(PatternStyle::Noise, 16, seed, &base);
|
||||
let image = |seed| Arc::new(crate::procedural::pattern(PatternStyle::Noise, 16, seed));
|
||||
let first = image(0);
|
||||
cache.insert(key(0), &first);
|
||||
assert!(Arc::ptr_eq(&first, &cache.get(&key(0)).unwrap()));
|
||||
for seed in 1..=PATTERN_MAX_ENTRIES as u32 {
|
||||
cache.insert(key(seed), &image(seed));
|
||||
}
|
||||
assert!(cache.get(&key(0)).is_none());
|
||||
assert!(cache.get(&key(1)).is_some());
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn pattern_cache_shares_an_entry_between_equal_levels() {
|
||||
let tex = |brightness, contrast| Texture { brightness, contrast, ..Texture::default() };
|
||||
let pairs = [
|
||||
(tex(2.0, 0.0), tex(1.0, 0.0)),
|
||||
(tex(-7.5, 0.0), tex(-1.0, 0.0)),
|
||||
(tex(0.0, 3.0), tex(0.0, 1.0)),
|
||||
(tex(f32::NAN, 0.0), tex(0.0, 0.0)),
|
||||
(tex(0.0, f32::INFINITY), tex(0.0, 0.0)),
|
||||
(tex(-0.0, -0.0), tex(0.0, 0.0)),
|
||||
];
|
||||
for (a, b) in pairs {
|
||||
assert!(pattern_key(PatternStyle::Noise, 64, 5, &a) == pattern_key(PatternStyle::Noise, 64, 5, &b));
|
||||
let (ia, ib) = (procedural_pattern(PatternStyle::Noise, 64, 5, &a), procedural_pattern(PatternStyle::Noise, 64, 5, &b));
|
||||
assert_eq!(ia.data, ib.data);
|
||||
}
|
||||
assert!(pattern_key(PatternStyle::Noise, 64, 5, &tex(0.5, 0.0)) != pattern_key(PatternStyle::Noise, 64, 5, &tex(1.0, 0.0)));
|
||||
}
|
||||
}
|
||||
@@ -214,12 +214,12 @@ fn prepare_pattern(b: &BrushSettings) -> Option<Arc<PatternImage>> {
|
||||
if !t.enabled {
|
||||
return None;
|
||||
}
|
||||
let mut img = match &t.pattern {
|
||||
Pattern::Procedural { style, size, seed } => crate::procedural::pattern(*style, *size, *seed),
|
||||
p => match p.bitmap() {
|
||||
Some(g) if g.is_valid() => PatternImage { width: g.width as usize, height: g.height as usize, data: g.to_f32() },
|
||||
_ => return None,
|
||||
},
|
||||
if let Pattern::Procedural { style, size, seed } = &t.pattern {
|
||||
return Some(crate::pattern_cache::procedural_pattern(*style, *size, *seed, t));
|
||||
}
|
||||
let mut img = match t.pattern.bitmap() {
|
||||
Some(g) if g.is_valid() => PatternImage { width: g.width as usize, height: g.height as usize, data: g.to_f32() },
|
||||
_ => return None,
|
||||
};
|
||||
for v in &mut img.data {
|
||||
*v = t.level(*v);
|
||||
|
||||
Reference in new issue
Block a user