molgfx-render 0.1.0

use super::*;
use crate::testing::MockDevice;
use molgfx_core::{AtomSelection, ClipPlane, ClipSet, RepresentationKind, Scene, SurfaceKind};
use molgfx_gpu::SurfaceError;
use molgfx_math::{BoundingSphere, Camera, Vec3};
pub(super) fn camera() -> Camera {
    Camera::framing(
        &BoundingSphere {
            center: Vec3::ZERO,
            radius: 10.0,
        },
        1.0,
    )
}
pub(super) fn engine() -> Engine<MockDevice> {
    match Engine::new(&EngineConfig::default(), None) {
        Ok(engine) => engine,
        Err(e) => panic!("mock engine opens: {e}"),
    }
}

#[test]
fn engine_creation_keeps_every_registered_layout_within_the_portable_storage_limit() {
    for mode in [RenderMode::Realtime, RenderMode::Cinematic] {
        for profile in [
            RenderProfile::inspection(),
            RenderProfile::illustrative(),
            RenderProfile::cinematic(),
        ] {
            let config = EngineConfig {
                mode,
                profile,
                ..EngineConfig::default()
            };
            let engine = Engine::<MockDevice>::new(&config, None)
                .unwrap_or_else(|error| panic!("portable mock engine opens: {error}"));
            let layouts = engine
                .device
                .log
                .bind_group_layouts
                .lock()
                .unwrap_or_else(std::sync::PoisonError::into_inner);
            assert!(!layouts.is_empty());
            for (label, counts) in layouts.iter() {
                assert!(
                    counts.iter().all(|count| *count <= 8),
                    "{label} uses vertex/fragment/compute storage counts {counts:?}"
                );
            }
        }
    }
}
pub(crate) fn structure() -> molframe::Structure {
    let cif = "\
data_test
loop_
_atom_site.group_PDB
_atom_site.id
_atom_site.type_symbol
_atom_site.label_atom_id
_atom_site.label_alt_id
_atom_site.label_comp_id
_atom_site.label_asym_id
_atom_site.label_entity_id
_atom_site.label_seq_id
_atom_site.Cartn_x
_atom_site.Cartn_y
_atom_site.Cartn_z
_atom_site.occupancy
_atom_site.B_iso_or_equiv
_atom_site.auth_seq_id
_atom_site.auth_asym_id
_atom_site.pdbx_PDB_model_num
ATOM 1 N N  . GLY A 1 1 0.0 0.0 0.0 1.00 10.0 1 A 1
ATOM 2 C CA . GLY A 1 1 1.5 0.0 0.0 1.00 10.0 1 A 1
ATOM 3 O O  . GLY A 1 1 3.0 1.0 0.0 1.00 10.0 1 A 1
loop_
_struct_conn.id
_struct_conn.conn_type_id
_struct_conn.ptnr1_label_asym_id
_struct_conn.ptnr1_label_seq_id
_struct_conn.ptnr1_label_comp_id
_struct_conn.ptnr1_label_atom_id
_struct_conn.ptnr2_label_asym_id
_struct_conn.ptnr2_label_seq_id
_struct_conn.ptnr2_label_comp_id
_struct_conn.ptnr2_label_atom_id
_struct_conn.pdbx_value_order
1 covale A 1 GLY N A 1 GLY CA SING
";
    match molframe::read_bytes(
        cif.as_bytes().to_vec(),
        Some("render-test.cif"),
        &molframe::ReadOptions::new(),
    ) {
        Ok((structure, _)) => structure,
        Err(diagnostics) => panic!("fixture parses: {diagnostics:?}"),
    }
}
pub(super) fn represented_scene(structure_count: usize, representation_count: usize) -> Scene {
    let source = structure();
    let mut scene = Scene::new();
    for _ in 0..structure_count {
        if let Err(error) = scene.add_structure(&source) {
            panic!("fixture structure places: {error}");
        }
    }
    let selection = scene.add_selection(AtomSelection::Sparse(vec![0, 2]));
    for order in (0..representation_count).rev() {
        let Ok(handle) = scene.represent(selection, RepresentationKind::Spacefill) else {
            panic!("spacefill applies")
        };
        let Some(representation) = scene.representation_mut(handle) else {
            panic!("representation resolves")
        };
        representation.order = u16::try_from(order).unwrap_or(u16::MAX);
    }
    scene
}
#[test]
fn a_healthy_frame_presents_with_exactly_one_submission() {
    let mut engine = engine();
    let scene = Scene::new();
    let outcome = match engine.render(&scene, &camera()) {
        Ok(outcome) => outcome,
        Err(e) => panic!("frame renders: {e}"),
    };
    assert_eq!(outcome.status, FrameStatus::Presented);
    let Ok(submits) = engine.device.log.submits.lock() else {
        panic!("log lock")
    };
    let submits = *submits;
    assert_eq!(submits, 1, "one queue submission per frame");
}
#[test]
fn a_lost_surface_skips_the_frame_and_reconfigures_instead_of_panicking() {
    let mut engine = engine();
    if let Some(surface) = &mut engine.surface {
        surface.script = vec![Err(SurfaceError::Lost)];
    }
    let scene = Scene::new();
    let outcome = match engine.render(&scene, &camera()) {
        Ok(outcome) => outcome,
        Err(e) => panic!("surface loss is recoverable: {e}"),
    };
    assert_eq!(outcome.status, FrameStatus::Skipped);
    // The next frame recovers.
    let outcome = match engine.render(&scene, &camera()) {
        Ok(outcome) => outcome,
        Err(e) => panic!("recovery frame renders: {e}"),
    };
    assert_eq!(outcome.status, FrameStatus::Presented);
}
#[test]
fn an_outdated_surface_is_reconfigured_before_the_next_acquire() {
    let mut engine = engine();
    let configures_before = match &engine.surface {
        Some(surface) => surface.configures,
        None => panic!("mock opens with a surface"),
    };
    if let Some(surface) = &mut engine.surface {
        surface.script = vec![Err(SurfaceError::Outdated)];
    }
    let scene = Scene::new();
    let Ok(FrameReport {
        status: FrameStatus::Skipped,
        ..
    }) = engine.render(&scene, &camera())
    else {
        panic!("an outdated surface skips the frame")
    };
    let configures_after = match &engine.surface {
        Some(surface) => surface.configures,
        None => panic!("surface persists"),
    };
    assert!(configures_after > configures_before);
}
#[test]
fn frame_recording_issues_no_direct_scene_draws() {
    let mut engine = engine();
    let scene = Scene::new();
    let Ok(_) = engine.render(&scene, &camera()) else {
        panic!("frame renders")
    };
    let Ok(draws) = engine.device.log.draws.lock() else {
        panic!("log lock")
    };
    let draws = draws.clone();
    assert!(
        draws.iter().all(|(vertices, _)| vertices.end <= 3),
        "direct draws are fullscreen triangles only"
    );
}
#[test]
fn every_structure_representation_pair_has_one_indirect_draw() {
    let mut engine = engine();
    let scene = represented_scene(2, 2);
    if let Err(error) = engine.render(&scene, &camera()) {
        panic!("frame renders: {error}")
    }
    let first = match engine.device.log.indirect_draws.lock() {
        Ok(draws) => draws.clone(),
        Err(error) => panic!("log lock: {error}"),
    };
    assert_eq!(first.len(), 8);
    if let Err(error) = engine.render(&scene, &camera()) {
        panic!("second frame renders: {error}")
    }
    let Ok(draws) = engine.device.log.indirect_draws.lock() else {
        panic!("log lock")
    };
    assert_eq!(
        &draws[first.len()..],
        first.as_slice(),
        "draw ordering is stable"
    );
}
#[test]
fn opaque_and_translucent_representations_are_routed_to_disjoint_draws() {
    let mut scene = represented_scene(1, 2);
    let Some((transparent, _)) = scene.representations().next() else {
        panic!("fixture has a representation")
    };
    let Some(representation) = scene.representation_mut(transparent) else {
        panic!("representation resolves")
    };
    representation.material.opacity = 0.4;

    let mut engine = engine();
    if let Err(error) = engine.render(&scene, &camera()) {
        panic!("frame renders: {error}")
    }
    assert!(engine.scene_gpu.has_translucency());
    assert_eq!(engine.scene_gpu.atom_draws(false).count(), 1);
    assert_eq!(engine.scene_gpu.atom_draws(true).count(), 1);
}

#[test]
fn points_use_their_own_opaque_and_translucent_routes() {
    let source = structure();
    let mut scene = match Scene::from_structure(&source) {
        Ok(scene) => scene,
        Err(error) => panic!("fixture scene builds: {error}"),
    };
    let selection = scene.add_selection(AtomSelection::All);
    let handle = match scene.represent(selection, RepresentationKind::Points) {
        Ok(handle) => handle,
        Err(error) => panic!("points apply: {error}"),
    };
    let mut engine = engine();
    if let Err(error) = engine.render(&scene, &camera()) {
        panic!("opaque points render: {error}")
    }
    assert_eq!(engine.scene_gpu.point_draws(false).count(), 1);
    assert_eq!(engine.scene_gpu.atom_draws(false).count(), 0);
    let Some(representation) = scene.representation_mut(handle) else {
        panic!("points resolve")
    };
    representation.material.opacity = 0.4;
    if let Err(error) = engine.render(&scene, &camera()) {
        panic!("transparent points render: {error}")
    }
    assert_eq!(engine.scene_gpu.point_draws(false).count(), 0);
    assert_eq!(engine.scene_gpu.point_draws(true).count(), 1);
}

#[test]
fn an_unchanged_scene_uploads_only_the_frame_uniforms() {
    let mut engine = engine();
    let scene = represented_scene(1, 1);
    if let Err(error) = engine.render(&scene, &camera()) {
        panic!("first frame renders: {error}")
    }
    let before = match engine.device.log.writes.lock() {
        Ok(writes) => writes.len(),
        Err(error) => panic!("log lock: {error}"),
    };
    if let Err(error) = engine.render(&scene, &camera()) {
        panic!("second frame renders: {error}")
    }
    let Ok(writes) = engine.device.log.writes.lock() else {
        panic!("log lock")
    };
    assert_eq!(writes.len() - before, 1, "only group 0 changes");
    assert_eq!(
        writes[before].2,
        std::mem::size_of::<crate::scene_gpu::FrameUniforms>()
    );
}

#[test]
fn changing_a_clip_plane_updates_only_representation_state() {
    let source = structure();
    let coordinate_pointer = source.coordinates().as_ptr() as usize;
    let mut scene = match Scene::from_structure(&source) {
        Ok(scene) => scene,
        Err(error) => panic!("fixture scene builds: {error}"),
    };
    let selection = scene.add_selection(AtomSelection::All);
    let representation = match scene.represent(selection, RepresentationKind::Surface) {
        Ok(handle) => handle,
        Err(error) => panic!("surface applies: {error}"),
    };
    let mut engine = engine();
    if let Err(error) = engine.render(&scene, &camera()) {
        panic!("initial frame renders: {error}")
    }
    let before = match engine.device.log.writes.lock() {
        Ok(writes) => writes.len(),
        Err(error) => panic!("log lock: {error}"),
    };
    let plane = match ClipPlane::from_point_normal(Vec3::ZERO, Vec3::X) {
        Ok(plane) => plane,
        Err(error) => panic!("clip plane validates: {error}"),
    };
    let clipping = match ClipSet::new(&[plane]) {
        Ok(clipping) => clipping,
        Err(error) => panic!("clip set validates: {error}"),
    };
    let Some(representation) = scene.representation_mut(representation) else {
        panic!("surface resolves")
    };
    representation.clipping = clipping;
    if let Err(error) = engine.render(&scene, &camera()) {
        panic!("clipped frame renders: {error}")
    }
    let Ok(writes) = engine.device.log.writes.lock() else {
        panic!("log lock")
    };
    let changed = &writes[before..];
    // Frame, representation and colour blocks: all fixed size, none of them the
    // coordinate column.
    assert_eq!(changed.len(), 3, "only fixed-size uniforms change");
    assert!(
        changed.iter().all(|write| write.3 != coordinate_pointer),
        "clipping never re-uploads borrowed coordinates"
    );
}

#[test]
fn solvent_excluded_field_generates_once_and_not_on_an_unchanged_frame() {
    let source = structure();
    let mut scene = match Scene::from_structure(&source) {
        Ok(scene) => scene,
        Err(error) => panic!("fixture scene builds: {error}"),
    };
    let selection = scene.add_selection(AtomSelection::All);
    let handle = match scene.represent(selection, RepresentationKind::Surface) {
        Ok(handle) => handle,
        Err(error) => panic!("surface applies: {error}"),
    };
    let Some(representation) = scene.representation_mut(handle) else {
        panic!("surface resolves")
    };
    representation.params.surface_kind = SurfaceKind::SolventExcluded;

    let mut engine = engine();
    if let Err(error) = engine.render(&scene, &camera()) {
        panic!("first frame renders: {error}")
    }
    let before = match engine.device.log.dispatches.lock() {
        Ok(dispatches) => dispatches.clone(),
        Err(error) => panic!("log lock: {error}"),
    };
    assert_eq!(
        before.len(),
        3,
        "SES generates its field, erosion and continuous normals once"
    );
    assert!(before[0].0 > 1, "the field contains many workgroups");
    assert!(
        before.windows(2).all(|pair| pair[0] == pair[1]),
        "all three stages cover the same grid"
    );
    if let Err(error) = engine.render(&scene, &camera()) {
        panic!("unchanged frame renders: {error}")
    }
    let Ok(dispatches) = engine.device.log.dispatches.lock() else {
        panic!("log lock")
    };
    assert_eq!(dispatches.as_slice(), before.as_slice());
}

#[test]
fn gaussian_surface_generates_one_persistent_field_dispatch() {
    let source = structure();
    let mut scene = match Scene::from_structure(&source) {
        Ok(scene) => scene,
        Err(error) => panic!("fixture scene builds: {error}"),
    };
    let selection = scene.add_selection(AtomSelection::All);
    let handle = match scene.represent(selection, RepresentationKind::Surface) {
        Ok(handle) => handle,
        Err(error) => panic!("surface applies: {error}"),
    };
    let Some(representation) = scene.representation_mut(handle) else {
        panic!("surface resolves")
    };
    representation.params.surface_kind = SurfaceKind::Gaussian;
    representation.params.gaussian_sigma = 0.8;
    representation.params.isolevel = 0.45;

    let mut engine = engine();
    if let Err(error) = engine.render(&scene, &camera()) {
        panic!("first Gaussian frame renders: {error}")
    }
    let before = match engine.device.log.dispatches.lock() {
        Ok(dispatches) => dispatches.clone(),
        Err(error) => panic!("log lock: {error}"),
    };
    assert_eq!(
        before.len(),
        2,
        "Gaussian surfaces generate one scalar field and its normals"
    );
    assert!(
        before[0].0 > 1,
        "the Gaussian field contains many workgroups"
    );
    assert_eq!(before[0], before[1], "both stages cover the same grid");
    if let Err(error) = engine.render(&scene, &camera()) {
        panic!("unchanged Gaussian frame renders: {error}")
    }
    let Ok(dispatches) = engine.device.log.dispatches.lock() else {
        panic!("log lock")
    };
    assert_eq!(dispatches.as_slice(), before.as_slice());
}

#[test]
fn off_screen_rendering_returns_tightly_packed_rgba_without_a_window_pass() {
    let mut engine = engine();
    let image = match engine.render_image(
        &Scene::new(),
        &camera(),
        ImageConfig {
            width: 3,
            height: 2,
        },
    ) {
        Ok(image) => image,
        Err(error) => panic!("image renders: {error}"),
    };
    assert_eq!((image.width, image.height), (3, 2));
    assert_eq!(image.pixels.len(), 3 * 2 * 4);
}

#[test]
fn zero_sized_off_screen_images_are_typed_errors() {
    let mut engine = engine();
    let Err(error) = engine.render_image(
        &Scene::new(),
        &camera(),
        ImageConfig {
            width: 0,
            height: 2,
        },
    ) else {
        panic!("zero width is invalid")
    };
    assert_eq!(error.code(), "MOLGFX-E0072");
}

#[test]
fn profiling_without_timestamp_queries_is_a_typed_capability_error() {
    let mut engine = engine();
    let Err(error) = engine.profile_frame(
        &Scene::new(),
        &camera(),
        ImageConfig {
            width: 64,
            height: 64,
        },
    ) else {
        panic!("mock deliberately exposes no timestamp queries")
    };
    assert_eq!(error.code(), "MOLGFX-E0010");
}