frust_engine/gpu/

targets.rs

//! The per-renderer pool the engine draws its off-screen intermediates from.
//!
//! A layer, a filter input, a scratch copy — every target that is not the
//! frame's own surface is a short-lived texture that a later pass in the same
//! frame samples and nothing outlives the frame. Allocating one per frame is
//! the cost `frust_gpu::TexturePool` exists to remove, so the engine holds one
//! pool per renderer (one per surface, since a renderer is per surface) and
//! takes its intermediates from there.
//!
//! Two engine-level decisions sit on top of the substrate pool.
//!
//! - **A ceiling of [`MAX_INTERMEDIATE_DIMENSION`].** The adapter's own
//!   `max_texture_dimension_2d` can be far larger than anything worth
//!   allocating as a transient: a single 16384-square `Rgba8Unorm` intermediate
//!   is a gigabyte. [`max_texture_size`] therefore takes the smaller of the
//!   adapter's ceiling and 8192, which is the largest intermediate the engine
//!   will ask a driver for.
//! - **An over-ceiling request is a value, not an error.** A layer larger than
//!   that ceiling is answered with [`IntermediateTexture::TooLarge`] carrying
//!   the extent that was refused, so a caller sees exactly what it asked for
//!   and skips the layer rather than taking a device error mid-frame. A caller
//!   that instead splits the layer into
//!   [bands](crate::schedule::pages::page_bands) never reaches this arm: every
//!   band is sized inside the same ceiling, and all of a layer's bands share
//!   one extent, so a banded layer draws one texture out of this pool and
//!   reuses it band after band.
//!
//! Like the substrate pool this type is generic over the texture and view
//! types, so its keying, reuse and aging are exercised against a counting fake
//! with no GPU in the loop. The engine always uses the default
//! `IntermediateTargets<wgpu::Texture, wgpu::TextureView>`.
//!
//! ## The one off-screen target this module does not hand out
//!
//! [`atlas_layer_config`] describes a pass whose colour attachment is one
//! layer of the glyph/image atlas array — a target [`crate::gpu::atlas`] owns
//! outright and deliberately keeps out of the pool (its module doc gives the
//! reason: residency across frames is the atlas's whole purpose). The
//! *allocation* therefore belongs there; the *viewport* decision belongs here,
//! beside [`IntermediateTargets::descriptor`], because it is the same decision
//! this module already makes for every other target that is not the frame's own
//! surface — what extent the vertex stage maps its NDC against, and which
//! resource-texture widths the fragment stage reconstructs by shift.
//!
//! ## The filter pass's two extras
//!
//! A [filter](crate::filters) round renders between two pooled pages this
//! module hands out, and needs two things beyond them: the *filter-data*
//! texture holding the frame's parameter blocks
//! ([`filter_data_texture_descriptor`], sized by
//! [`filter_data_texture_height`]) and the bilinear [`filter_sampler`] its
//! kernels read the source page through — the engine's first and only sampler.
//! Both are described here, beside the pages they are used with;
//! [`crate::renderer::FilterResources`] owns the live resources.

use frust_gpu::{PoolStats, PooledTexture, TextureAllocator, TextureDesc, TexturePool, TierCaps};

use crate::filters::blur::GpuFilterData;

use super::config::GpuConfig;
use super::pipelines::INTERMEDIATE_FORMAT;

/// The largest intermediate the engine allocates on any adapter, whatever its
/// own `max_texture_dimension_2d` reports.
///
/// 8192 square is 256 MiB at [`INTERMEDIATE_FORMAT`] — already far past any
/// real layer — and a transient that big is a memory decision rather than a
/// capability one, which is why it is pinned here instead of taken from the
/// adapter.
pub const MAX_INTERMEDIATE_DIMENSION: u32 = 8192;

/// How many of the most recent frames' parked entries a surface resize keeps
/// (see [`IntermediateTargets::drop_parked`]).
///
/// Two: the frame that just ran and the one before it. One is not enough — a
/// resize arrives *between* frames, so the page the last frame released is
/// already a frame behind by the time the resize is handled, and a window
/// being dragged would evict it on every step. Three or more starts holding
/// pages across frames that stopped asking for them, which is what the pool's
/// own aging is for.
pub const RESIZE_KEEP_ALIVE_FRAMES: u64 = 2;

/// The usage every intermediate is created with: drawn into by a strip pass,
/// then sampled by the pass that composites it.
pub const INTERMEDIATE_USAGE: wgpu::TextureUsages = wgpu::TextureUsages::RENDER_ATTACHMENT
    .union(wgpu::TextureUsages::TEXTURE_BINDING)
    .union(wgpu::TextureUsages::COPY_SRC);

/// The label every retained page is allocated under.
pub const RETAINED_PAGE_LABEL: &str = "frust-engine retained page";

/// The descriptor a retained page of `width` x `height` is allocated with.
///
/// A retained page is the one off-screen layer target this module does not
/// hand out: it outlives the frame that rendered it, so it is the retained
/// store's own allocation (`crate::cache::retained`) rather than a pooled
/// entry the pool could age out or hand to another layer. It is otherwise a
/// layer page in every respect — rendered into by a strip pass and sampled by
/// the composite that draws it — so it takes exactly a pooled page's format
/// and usage, and the extent is the caller's, unquantized: a retained page is
/// sized once to its body and reused while the body keeps that size.
#[must_use]
pub fn retained_page_descriptor(width: u32, height: u32) -> TextureDesc {
    TextureDesc {
        width,
        height,
        format: INTERMEDIATE_FORMAT,
        usage: INTERMEDIATE_USAGE,
        label: Some(RETAINED_PAGE_LABEL.to_string()),
    }
}

/// The largest intermediate extent the engine will request on `caps`' adapter.
#[must_use]
pub fn max_texture_size(caps: &TierCaps) -> u32 {
    caps.max_texture_dimension_2d
        .min(MAX_INTERMEDIATE_DIMENSION)
}

/// The viewport uniform a strip pass whose colour attachment is one atlas
/// array layer draws with.
///
/// `page` is the layer's own extent in texels — the atlas page size, not the
/// frame's — because the vertex stage maps a strip's pixel coordinates into NDC
/// against the *attachment* it writes, and an atlas layer is neither the
/// surface's extent nor a pooled page's. Getting this wrong does not fail
/// validation: it silently scales every glyph by the ratio of the two extents.
///
/// `alphas_tex_width` is the coverage texture the replayed strips sample;
/// `encoded_paints_tex_width` is the encoded-paint texture, which an atlas pass
/// only ever binds as a stand-in — a replayed glyph outline paints solid, and a
/// solid instance carries its colour in its own payload rather than indexing a
/// record. Both must be powers of two, for
/// [`tex_width_bits`](super::config::tex_width_bits)' reason.
///
/// No strip offset and no NDC negation: an atlas page holds its glyphs at the
/// slot coordinates the allocator handed out, in the same y-down space every
/// other engine target uses.
#[must_use]
pub fn atlas_layer_config(
    page: (u32, u32),
    alphas_tex_width: u32,
    encoded_paints_tex_width: u32,
) -> GpuConfig {
    GpuConfig::new(page.0, page.1, alphas_tex_width, encoded_paints_tex_width)
}

/// Whether an atlas page of `page` texels can be a render attachment on
/// `caps`' adapter.
///
/// The atlas is not pooled, so it never passes through
/// [`IntermediateTargets::acquire`]'s own ceiling check — but a page is still a
/// texture a driver has to accept, and the budgets
/// [`crate::cache::images::AtlasBudget`] hands out are chosen without the
/// adapter in view. This is the check a caller makes once, at the point it
/// decides a page size, rather than discovering the refusal as a device error
/// on the first frame that misses a glyph.
///
/// The adapter's own `max_texture_dimension_2d` is the bound, not
/// [`MAX_INTERMEDIATE_DIMENSION`]: that ceiling is a transient-memory decision
/// about targets allocated per frame, and an atlas page is allocated once and
/// lives for the renderer.
#[must_use]
pub fn atlas_page_fits(caps: &TierCaps, page: (u32, u32)) -> bool {
    page.0 > 0
        && page.1 > 0
        && page.0 <= caps.max_texture_dimension_2d
        && page.1 <= caps.max_texture_dimension_2d
}

/// Texels per row of the filter-data texture.
///
/// Sixteen [`super::RESOURCE_TEXTURE_FORMAT`] texels is exactly 256 bytes,
/// which is `wgpu::COPY_BYTES_PER_ROW_ALIGNMENT` — the narrowest row an upload
/// may legally have, and so the cheapest whole-texture write a frame with one
/// filter can issue. A filter's parameter block is
/// [`GpuFilterData::SIZE_TEXELS`] wide and blocks are packed back to back, so a
/// block may straddle a row boundary; the fragment stage addresses one by a
/// flat texel index and reconstructs the coordinate by division, so it never
/// notices (see `load_filter_texel` in `shaders/filter.wgsl`).
pub const FILTER_DATA_TEXTURE_WIDTH: u32 = 16;

const _: () = assert!(
    FILTER_DATA_TEXTURE_WIDTH * super::TEXEL_BYTES == wgpu::COPY_BYTES_PER_ROW_ALIGNMENT,
    "a filter-data row is exactly one copy alignment unit, which is what makes a one-row upload \
     legal"
);

/// The filter-data texture's descriptor at `height` rows.
///
/// A resource texture like the alpha and encoded-paint ones: `Rgba32Uint`,
/// sampled by the fragment stage with `textureLoad` and written by a queue
/// upload, never a render attachment. Unlike those two it is
/// [`FILTER_DATA_TEXTURE_WIDTH`] texels wide rather than the adapter's resource
/// dimension — a frame's filters are counted in ones, not in thousands, and a
/// row of the adapter's width would make the smallest possible upload 64 KiB.
#[must_use]
pub fn filter_data_texture_descriptor(height: u32) -> wgpu::TextureDescriptor<'static> {
    super::resource_texture_descriptor(
        "frust-engine filter data texture",
        FILTER_DATA_TEXTURE_WIDTH,
        height,
    )
}

/// The filter-data texture height that holds `blocks` parameter blocks, or
/// `None` for a block count past [`MAX_INTERMEDIATE_DIMENSION`] rows.
///
/// The refusal is a value rather than an error for the reason every ceiling in
/// this module is: the caller skips what does not fit rather than taking a
/// device error mid-frame. It is also unreachable in practice —
/// [`MAX_INTERMEDIATE_DIMENSION`] rows hold over forty thousand filters, and a
/// frame records filters in ones.
#[must_use]
pub fn filter_data_texture_height(blocks: usize) -> Option<u32> {
    let texels = u32::try_from(blocks)
        .ok()?
        .checked_mul(GpuFilterData::SIZE_TEXELS)?;
    let height = texels
        .div_ceil(FILTER_DATA_TEXTURE_WIDTH)
        .max(super::MIN_RESOURCE_TEXTURE_HEIGHT);
    (height <= MAX_INTERMEDIATE_DIMENSION).then_some(height)
}

/// The engine's one sampler, which the blur kernels read their source page
/// through.
///
/// Bilinear, and that is the whole reason it exists: every other engine
/// pipeline reads its textures with `textureLoad` at integer coordinates, while
/// the blur kernels sample at *fractional* offsets so a decimation costs four
/// samples instead of sixteen and a convolution tap one instead of two (see
/// [`crate::filters::blur`]'s bilinear kernel).
///
/// Clamped rather than bordered on every axis: `wgpu`'s transparent-black
/// border address mode needs an adapter feature this tier never requests. The
/// address mode is not what makes a tap past the region transparent, and could
/// not be — a filter layer's region sits at its page's own *origin*, so on the
/// near side a clamp replicates the region's own edge texel instead of leaving
/// the texture at all. Every kernel therefore bounds its own taps against the
/// source region (`sample_region_bilinear` in `shaders/filters_blur.wgsl`,
/// `drop_shadow_load_checked` in `shaders/filters_drop_shadow.wgsl`), which is
/// what makes this sampler's behaviour outside that region unobservable rather
/// than merely harmless. No mip chain, because a pooled page has exactly one
/// level.
#[must_use]
pub fn filter_sampler(device: &wgpu::Device) -> wgpu::Sampler {
    device.create_sampler(&wgpu::SamplerDescriptor {
        label: Some("frust-engine filter sampler"),
        address_mode_u: wgpu::AddressMode::ClampToEdge,
        address_mode_v: wgpu::AddressMode::ClampToEdge,
        address_mode_w: wgpu::AddressMode::ClampToEdge,
        mag_filter: wgpu::FilterMode::Linear,
        min_filter: wgpu::FilterMode::Linear,
        mipmap_filter: wgpu::MipmapFilterMode::Nearest,
        ..Default::default()
    })
}

/// The result of asking for an intermediate: a pooled texture, or the extent
/// that was refused.
#[derive(Debug)]
pub enum IntermediateTexture<T = wgpu::Texture, V = wgpu::TextureView> {
    /// A texture at least the requested extent. Its allocation is quantized
    /// up, so render into `PooledTexture::requested_size`, not `size`.
    Texture(PooledTexture<T, V>),
    /// The request exceeded [`IntermediateTargets::max_texture_size`] on at
    /// least one axis and nothing was allocated.
    ///
    /// A layer too wide for one page has an answer that renders it —
    /// [`page_bands`](crate::schedule::pages::page_bands) — so reaching this
    /// arm means the extent was asked for whole rather than by band.
    TooLarge {
        /// Requested width in texels.
        width: u32,
        /// Requested height in texels.
        height: u32,
        /// The per-axis ceiling that refused it.
        max: u32,
    },
}

impl<T, V> IntermediateTexture<T, V> {
    /// The pooled texture, or `None` for a refused request.
    #[must_use]
    pub fn texture(&self) -> Option<&PooledTexture<T, V>> {
        match self {
            Self::Texture(texture) => Some(texture),
            Self::TooLarge { .. } => None,
        }
    }

    /// Whether the request was refused for exceeding the ceiling.
    #[must_use]
    pub fn is_too_large(&self) -> bool {
        matches!(self, Self::TooLarge { .. })
    }
}

/// The engine's pool of off-screen intermediates, with its own frame clock.
///
/// The clock is what the substrate pool ages entries against; it advances once
/// per [`Self::end_frame`], including frames that acquired nothing — those are
/// the frames a parked entry ages on.
#[derive(Debug)]
pub struct IntermediateTargets<T = wgpu::Texture, V = wgpu::TextureView> {
    pool: TexturePool<T, V>,
    max_texture_size: u32,
    frame: u64,
}

impl<T, V> IntermediateTargets<T, V> {
    /// A pool sized for `caps`' adapter.
    #[must_use]
    pub fn new(caps: &TierCaps) -> Self {
        Self {
            pool: TexturePool::new(caps),
            max_texture_size: max_texture_size(caps),
            frame: 0,
        }
    }

    /// The largest intermediate this pool will allocate, per axis.
    #[must_use]
    pub fn max_texture_size(&self) -> u32 {
        self.max_texture_size
    }

    /// The frame clock parked entries age against.
    #[must_use]
    pub fn frame(&self) -> u64 {
        self.frame
    }

    /// The underlying pool's counters.
    #[must_use]
    pub fn stats(&self) -> PoolStats {
        self.pool.stats()
    }

    /// The descriptor an intermediate of `width` x `height` is requested with,
    /// before the pool quantizes it.
    #[must_use]
    pub fn descriptor(width: u32, height: u32, label: &str) -> TextureDesc {
        TextureDesc {
            width,
            height,
            format: INTERMEDIATE_FORMAT,
            usage: INTERMEDIATE_USAGE,
            label: Some(label.to_string()),
        }
    }

    /// Hands out an intermediate of at least `width` x `height`, or refuses it
    /// for exceeding [`Self::max_texture_size`].
    ///
    /// The check is on the *requested* extent rather than the quantized one:
    /// the substrate pool clamps its quantization to the adapter ceiling
    /// already, so a request inside the engine's ceiling can never quantize
    /// past the adapter's.
    pub fn acquire<A>(
        &mut self,
        allocator: &A,
        width: u32,
        height: u32,
        label: &str,
    ) -> IntermediateTexture<T, V>
    where
        A: TextureAllocator<Texture = T, View = V>,
    {
        if width > self.max_texture_size || height > self.max_texture_size {
            return IntermediateTexture::TooLarge {
                width,
                height,
                max: self.max_texture_size,
            };
        }

        let desc = Self::descriptor(width, height, label);
        IntermediateTexture::Texture(self.pool.acquire(allocator, &desc, self.frame))
    }

    /// Parks an intermediate for reuse.
    pub fn release(&mut self, texture: PooledTexture<T, V>) {
        self.pool.release(texture);
    }

    /// Advances the frame clock and ages parked entries out of the pool.
    ///
    /// Call once per frame, whether or not the frame acquired anything.
    pub fn end_frame(&mut self) {
        self.frame = self.frame.saturating_add(1);
        self.pool.age(self.frame);
    }

    /// Drops the parked entries the last [`RESIZE_KEEP_ALIVE_FRAMES`] frames
    /// did not use, keeping the pool itself and its counters.
    ///
    /// This is what a surface resize calls. A page keyed on the *old* surface
    /// extent is dead weight the moment the surface changes size, and holding
    /// it for the pool's full keep-alive window is waste — so a resize
    /// collapses that window to the frames immediately behind it instead of
    /// waiting a second for the ordinary aging to reach them.
    ///
    /// It collapses the window rather than emptying the pool, and the
    /// difference is the whole point. Not every page is keyed on the surface:
    /// a fading card, a dismissing sheet, a menu at its own size all ask for
    /// the same page extent whatever the window does, and a window edge being
    /// dragged produces a resize *per frame*. Dropping everything on each of
    /// them would evict that page between every pair of frames that wants it
    /// and turn the pool back into a plain allocator for the whole drag —
    /// exactly the failure the substrate pool's aging slack exists to prevent
    /// (see `frust_gpu::pool`'s module header). Keeping what the frames right
    /// behind this resize actually used is bounded by what one frame can hold
    /// live at once and is precisely the set the next frame asks for again.
    ///
    /// Implemented by aging against a clock far enough ahead to expire
    /// everything older, without moving this pool's own clock: the frame
    /// counter still advances once per [`Self::end_frame`], so a resize does
    /// not age unrelated entries by a second every time a window edge moves.
    /// Entries still checked out are untouched — the pool does not hold those.
    pub fn drop_parked(&mut self) {
        // `TexturePool::age(f)` drops an entry when `f - last_used` exceeds the
        // keep-alive window, so a horizon this far ahead expires exactly the
        // entries last used before the retained frames.
        let horizon = self
            .frame
            .saturating_add(self.pool.max_unused_frames())
            .saturating_sub(RESIZE_KEEP_ALIVE_FRAMES.saturating_sub(1));
        self.pool.age(horizon);
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::cell::Cell;

    use frust_gpu::DownlevelProfile;

    /// A [`TextureAllocator`] with no GPU behind it: the texture and view are
    /// both the allocation's ordinal, so "how many textures did this actually
    /// allocate?" is answerable with no device.
    #[derive(Debug, Default)]
    struct FakeAllocator {
        allocations: Cell<u32>,
    }

    impl TextureAllocator for FakeAllocator {
        type Texture = u32;
        type View = u32;

        fn allocate_texture(&self, _desc: &TextureDesc) -> (u32, u32) {
            self.allocations.set(self.allocations.get() + 1);
            (self.allocations.get(), self.allocations.get())
        }
    }

    fn caps() -> TierCaps {
        TierCaps::fake(DownlevelProfile::Full)
    }

    fn targets() -> IntermediateTargets<u32, u32> {
        IntermediateTargets::new(&caps())
    }

    #[test]
    fn the_ceiling_is_the_smaller_of_the_adapter_limit_and_the_engine_cap() {
        let mut caps = caps();
        caps.max_texture_dimension_2d = 16384;
        assert_eq!(max_texture_size(&caps), MAX_INTERMEDIATE_DIMENSION);

        caps.max_texture_dimension_2d = 4096;
        assert_eq!(max_texture_size(&caps), 4096);
    }

    #[test]
    fn an_intermediate_is_a_sampled_copyable_render_attachment() {
        let desc = IntermediateTargets::<u32, u32>::descriptor(64, 32, "layer");
        assert_eq!(desc.format, INTERMEDIATE_FORMAT);
        assert!(desc.usage.contains(wgpu::TextureUsages::RENDER_ATTACHMENT));
        assert!(desc.usage.contains(wgpu::TextureUsages::TEXTURE_BINDING));
        assert_eq!(desc.sample_count(), 1);
    }

    #[test]
    fn an_atlas_layer_pass_maps_its_ndc_against_the_page_not_the_frame() {
        let config = atlas_layer_config((1024, 1024), 2048, 1);

        assert_eq!(config.width, 1024);
        assert_eq!(config.height, 1024);
        assert_eq!(config.strip_offset_x, 0);
        assert_eq!(config.strip_offset_y, 0);
        assert_eq!(config.negate_ndc, 0);
        assert_eq!(config.alphas_tex_width_bits, 11, "log2(2048)");
        assert_eq!(
            config.encoded_paints_tex_width_bits, 0,
            "a 1-texel stand-in reconstructs as `1 << 0`"
        );
    }

    #[test]
    fn a_page_past_the_adapters_own_limit_does_not_fit() {
        let mut caps = caps();
        caps.max_texture_dimension_2d = 2048;

        assert!(atlas_page_fits(&caps, (2048, 2048)));
        assert!(!atlas_page_fits(&caps, (4096, 1024)));
        assert!(!atlas_page_fits(&caps, (1024, 4096)));
        // A degenerate page is not a page: nothing can be allocated in it, and
        // a zero-extent attachment is a device error rather than an empty pass.
        assert!(!atlas_page_fits(&caps, (0, 1024)));
        assert!(!atlas_page_fits(&caps, (1024, 0)));
    }

    #[test]
    fn the_atlas_pages_ceiling_is_the_adapters_rather_than_the_transient_cap() {
        let mut caps = caps();
        caps.max_texture_dimension_2d = 16384;

        // The pool refuses this; the atlas does not, because a page is
        // allocated once for the renderer rather than per frame.
        const { assert!(MAX_INTERMEDIATE_DIMENSION < 16384) };
        assert!(atlas_page_fits(&caps, (16384, 16384)));
        assert_eq!(max_texture_size(&caps), MAX_INTERMEDIATE_DIMENSION);
    }

    #[test]
    fn the_filter_data_texture_is_one_copy_aligned_row_per_five_and_a_third_filters() {
        let desc = filter_data_texture_descriptor(1);
        assert_eq!(desc.size.width, FILTER_DATA_TEXTURE_WIDTH);
        assert_eq!(desc.size.height, 1);
        assert_eq!(desc.format, crate::gpu::RESOURCE_TEXTURE_FORMAT);
        assert!(desc.usage.contains(wgpu::TextureUsages::TEXTURE_BINDING));
        assert!(desc.usage.contains(wgpu::TextureUsages::COPY_DST));
        assert!(!desc.usage.contains(wgpu::TextureUsages::RENDER_ATTACHMENT));

        // Three texels a block into a sixteen-texel row: five whole blocks fit
        // on the first row and the sixth straddles onto the second, which the
        // flat-index addressing makes a non-event.
        assert_eq!(filter_data_texture_height(0), Some(1), "never zero-height");
        assert_eq!(filter_data_texture_height(1), Some(1));
        assert_eq!(filter_data_texture_height(5), Some(1));
        assert_eq!(filter_data_texture_height(6), Some(2));
        assert_eq!(filter_data_texture_height(11), Some(3));
    }

    #[test]
    fn a_filter_count_past_the_transient_ceiling_is_a_value_rather_than_a_device_error() {
        let per_row = (FILTER_DATA_TEXTURE_WIDTH / GpuFilterData::SIZE_TEXELS) as usize;
        let at_ceiling = per_row * MAX_INTERMEDIATE_DIMENSION as usize;

        assert!(filter_data_texture_height(at_ceiling).is_some());
        assert_eq!(filter_data_texture_height(usize::MAX), None);
        assert_eq!(
            filter_data_texture_height(at_ceiling * 2),
            None,
            "a block count no texture could hold is refused rather than clamped onto one"
        );
    }

    #[test]
    fn an_oversized_request_is_refused_without_allocating() {
        let allocator = FakeAllocator::default();
        let mut targets = targets();
        let max = targets.max_texture_size();

        let refused = targets.acquire(&allocator, max + 1, 16, "huge layer");
        assert!(refused.is_too_large());
        assert!(refused.texture().is_none());
        assert!(matches!(
            refused,
            IntermediateTexture::TooLarge { width, height, max: ceiling }
                if width == max + 1 && height == 16 && ceiling == max
        ));
        assert_eq!(allocator.allocations.get(), 0);
        assert_eq!(targets.stats().created, 0);

        // The other axis is checked the same way.
        assert!(
            targets
                .acquire(&allocator, 16, max + 1, "huge layer")
                .is_too_large()
        );
        assert_eq!(allocator.allocations.get(), 0);
    }

    #[test]
    fn a_released_intermediate_is_reused_rather_than_reallocated() {
        let allocator = FakeAllocator::default();
        let mut targets = targets();

        let first = targets.acquire(&allocator, 300, 200, "layer");
        let pooled = match first {
            IntermediateTexture::Texture(texture) => texture,
            IntermediateTexture::TooLarge { .. } => unreachable!("300x200 is inside the ceiling"),
        };
        // Quantized up to the pool's 256-px keys, with the request preserved.
        assert_eq!(pooled.requested_size(), (300, 200));
        assert_eq!(pooled.size(), (512, 256));
        targets.release(pooled);

        let second = targets.acquire(&allocator, 300, 200, "layer");
        assert!(second.texture().is_some());
        assert_eq!(allocator.allocations.get(), 1, "the second acquire reuses");
        assert_eq!(targets.stats().reused, 1);
    }

    #[test]
    fn a_parked_entry_ages_out_after_the_keep_alive_window() {
        let allocator = FakeAllocator::default();
        let mut targets = targets();

        let pooled = targets
            .acquire(&allocator, 256, 256, "layer")
            .texture()
            .is_some();
        assert!(pooled);
        let entry = match targets.acquire(&allocator, 256, 256, "layer") {
            IntermediateTexture::Texture(texture) => texture,
            IntermediateTexture::TooLarge { .. } => unreachable!("256x256 is inside the ceiling"),
        };
        targets.release(entry);
        assert_eq!(targets.stats().free, 1);

        // Frames that acquire nothing are the frames entries age on.
        for _ in 0..60 {
            targets.end_frame();
        }
        assert_eq!(
            targets.stats().free,
            1,
            "still inside the keep-alive window"
        );

        targets.end_frame();
        assert_eq!(targets.stats().free, 0);
        assert_eq!(targets.stats().evicted, 1);
        assert_eq!(targets.frame(), 61);
    }

    #[test]
    fn a_resize_drops_the_parked_entries_the_recent_frames_did_not_use() {
        let allocator = FakeAllocator::default();
        let mut targets = targets();

        // Three pages parked on this frame, then a few frames of nothing —
        // the shape of a surface whose layers went away well before the drag
        // started.
        for size in [256_u32, 512, 768] {
            match targets.acquire(&allocator, size, size, "layer") {
                IntermediateTexture::Texture(texture) => targets.release(texture),
                IntermediateTexture::TooLarge { .. } => unreachable!("inside the ceiling"),
            }
        }
        assert_eq!(targets.stats().free, 3);
        assert_eq!(targets.stats().keys, 3);
        for _ in 0..RESIZE_KEEP_ALIVE_FRAMES {
            targets.end_frame();
        }

        targets.drop_parked();

        assert_eq!(targets.stats().free, 0);
        assert_eq!(targets.stats().keys, 0);
        assert_eq!(targets.stats().evicted, 3);
        // Well inside the pool's own keep-alive window, so ordinary aging
        // would not have reached them yet — the resize is what dropped them.
        assert!(targets.frame() < targets.pool.max_unused_frames());
        // The pool itself survives: a fresh acquire still works, and the
        // lifetime counters are not reset by the eviction.
        assert_eq!(targets.stats().created, 3);
        assert!(
            targets
                .acquire(&allocator, 256, 256, "layer")
                .texture()
                .is_some()
        );
        assert_eq!(targets.stats().created, 4);
    }

    #[test]
    fn a_resize_storm_reuses_the_page_a_fixed_size_layer_keeps_asking_for() {
        let allocator = FakeAllocator::default();
        let mut targets = targets();

        // One layer at one size under a surface being resized every frame:
        // resize, render, end frame, over and over. Its page never changes
        // extent, so the pool must hand back the same texture every time
        // rather than allocating one per resize (E13).
        for _ in 0..200 {
            targets.drop_parked();
            match targets.acquire(&allocator, 640, 480, "layer") {
                IntermediateTexture::Texture(texture) => targets.release(texture),
                IntermediateTexture::TooLarge { .. } => unreachable!("inside the ceiling"),
            }
            targets.end_frame();
        }

        assert_eq!(
            targets.stats().created,
            1,
            "a resize per frame must not turn the pool back into a plain allocator"
        );
        assert_eq!(targets.stats().reused, 199);
        assert_eq!(targets.stats().evicted, 0);
        assert_eq!(allocator.allocations.get(), 1);
    }

    #[test]
    fn a_resize_does_not_age_the_pool_by_a_second_every_time_a_window_edge_moves() {
        let allocator = FakeAllocator::default();
        let mut targets = targets();

        // A page parked on this frame, then a drag's worth of resizes with no
        // frames between them: the clock is the frame counter's to advance, so
        // none of these may age anything out on their own.
        match targets.acquire(&allocator, 256, 256, "layer") {
            IntermediateTexture::Texture(texture) => targets.release(texture),
            IntermediateTexture::TooLarge { .. } => unreachable!("inside the ceiling"),
        }
        for _ in 0..100 {
            targets.drop_parked();
        }

        assert_eq!(targets.frame(), 0, "a resize is not a frame");
        assert_eq!(targets.stats().free, 1);
        assert_eq!(targets.stats().evicted, 0);
    }

    #[test]
    fn a_checked_out_intermediate_survives_a_drop_of_the_parked_entries() {
        let allocator = FakeAllocator::default();
        let mut targets = targets();

        let held = match targets.acquire(&allocator, 256, 256, "layer") {
            IntermediateTexture::Texture(texture) => texture,
            IntermediateTexture::TooLarge { .. } => unreachable!("inside the ceiling"),
        };
        targets.drop_parked();
        assert_eq!(targets.stats().evicted, 0, "nothing was parked to evict");
        assert_eq!(targets.stats().in_use, 1);

        // It returns to the pool as usual afterwards.
        targets.release(held);
        assert_eq!(targets.stats().free, 1);
    }
}