geodesic-wallpaper 1.6.1

//! Trace geodesics (the straightest possible paths) across curved 3D surfaces;
//! the engine behind the `geodesic-wallpaper` animated Windows wallpaper.
//!
//! ![geodesic-wallpaper rendering a torus, a torus knot and two presets](https://gitlab.com/mattbusel/geodesic-wallpaper/-/raw/master/assets/hero.gif)
//!
//! Most people want the app, not the library: download it from the
//! [latest release](https://github.com/Mattbusel/geodesic-wallpaper/releases/latest)
//! or run `cargo install geodesic-wallpaper` on Windows.
//!
//! The library needs no window and no GPU for the maths: surfaces, the RK4
//! integrator, trails, the expression parsers and the GIF / APNG / PNG
//! writers all run headless. Only [`renderer`] uses wgpu.
//!
//! # Example: follow one geodesic on a torus
//!
//! ```
//! use geodesic_wallpaper::geodesic::Geodesic;
//! use geodesic_wallpaper::surface::{torus::Torus, Surface};
//!
//! let torus = Torus::new(2.0, 0.7);
//! // Start at (u, v) = (0, 0) heading in direction (1, 0.3); live 300 steps.
//! let mut g = Geodesic::new(0.0, 0.0, 1.0, 0.3, 300, 0);
//! for _ in 0..100 {
//!     g.step(&torus, 0.016); // one RK4 step of the geodesic equation
//! }
//! let p = torus.position(g.u, g.v); // back to a 3D point
//! assert!(p.length() > 1.0 && p.length() < 3.0);
//! ```
//!
//! # Main types
//!
//! - [`surface::Surface`]: the trait every surface implements (metric,
//!   Christoffel symbols, embedding). Implementations live in [`surface`],
//!   for example [`surface::torus::Torus`] and [`surface::pseudosphere::Pseudosphere`].
//! - [`geodesic::Geodesic`]: one particle integrated with RK4 along the surface.
//! - [`trail::TrailBuffer`]: the fading ring buffer drawn behind each geodesic.
//! - [`config::Config`]: everything `config.toml` can set.
//! - [`renderer::Renderer`]: the wgpu renderer (window or offscreen).
//! - [`recorder::GifWriter`], [`recorder::ApngWriter`],
//!   [`recorder::FfmpegWriter`]: stream frames to a GIF, a full-colour
//!   animated PNG, or an MP4 through an installed ffmpeg.
//! - [`surface::user_defined::UserDefinedSurface`] and
//!   [`surface::procedural::parse_expression`]: surfaces from a formula
//!   typed by a user; bad input is an error, never a panic.
//! - [`hot_reload::watch_config`]: debounced `config.toml` reloading.
//!
//! # Examples
//!
//! In the repository: `cargo run --example follow_geodesic`,
//! `cargo run --example custom_surface` and
//! `cargo run --example trails_to_gif` (draws trails on the CPU and writes a
//! GIF and an APNG).
//!
//! # Cargo features
//!
//! | Feature | Default | Adds |
//! | --- | --- | --- |
//! | `lua` | off | [`lua_surface`]: a surface metric written in Lua 5.4 (compiled in, needs a C compiler) |
//! | `palette` | off | `From` conversions between [`colorspace`] types and the `palette` crate |
//!
//! Many other modules (tilings, fractals, reaction-diffusion and so on) are
//! library-only experiments that the wallpaper binary does not use yet.

// Many of the generative-art modules below are library-only experiments that
// the wallpaper binary does not call. Keep CI's `clippy -D warnings` gate
// meaningful for the core while tolerating their style lints.
#![warn(missing_docs)]
#![allow(
    dead_code,
    unused_imports,
    unused_variables,
    unused_mut,
    unused_parens,
    unused_comparisons,
    clippy::absurd_extreme_comparisons,
    clippy::approx_constant,
    clippy::cast_abs_to_unsigned,
    clippy::collapsible_else_if,
    clippy::collapsible_if,
    clippy::const_is_empty,
    clippy::excessive_precision,
    clippy::flat_map_identity,
    clippy::items_after_test_module,
    clippy::let_and_return,
    clippy::manual_div_ceil,
    clippy::manual_memcpy,
    clippy::manual_range_contains,
    clippy::needless_range_loop,
    clippy::nonminimal_bool,
    clippy::overly_complex_bool_expr,
    clippy::ptr_arg,
    clippy::should_implement_trait,
    clippy::too_many_arguments,
    clippy::type_complexity,
    clippy::unnecessary_cast,
    clippy::unnecessary_map_or,
    clippy::useless_vec
)]

pub mod animation;
pub mod animation_engine;
pub mod audio_reactive;
pub mod cellular_automata;
pub mod cellular_automata_2d;
pub mod cellular_noise;
pub mod color_theory;
pub mod colorspace;
pub mod composer;
pub mod config;
pub mod dithering;
pub mod error;
pub mod escher;
pub mod events;
pub mod export;
pub mod field;
pub mod finance_driver;
pub mod flow;
pub mod flow_field;
pub mod flow_field_render;
pub mod fractal;
pub mod fractal_geometry;
pub mod fractal_tree;
pub mod gallery;
pub mod generative_art;
pub mod geodesic;
pub mod gradient;
pub mod hot_reload;
pub mod hyperbolic_tiling;
pub mod interactive;
pub mod interference;
pub mod islamic_patterns;
pub mod iso_surface;
pub mod kaleidoscope;
pub mod l_system;
pub mod lissajous;
pub mod lod;
#[cfg(feature = "lua")]
pub mod lua_surface;
pub mod mandelbrot;
pub mod mesh;
pub mod metamorphosis;
pub mod morph;
pub mod mosaic;
pub mod multi_monitor;
pub mod noise;
pub mod noise_field;
pub mod origami;
pub mod palette;
pub mod parameter_tuner;
pub mod particle_system;
pub mod particles;
pub mod pathfinding_art;
pub mod penrose;
pub mod preview;
pub mod projection;
pub mod projection_art;
pub mod quilts;
pub mod reaction_diffusion;
pub mod reaction_diffusion_v2;
pub mod recorder;
pub mod renderer;
pub mod scene_presets;
pub mod spirograph;
pub mod stereographic;
pub mod strange_attractor;
pub mod surface;
pub mod symmetry;
pub mod symmetry_art;
pub mod terrain;
pub mod texture_synthesizer;
pub mod tiling;
pub mod timelapse;
pub mod topology_art;
pub mod torus_mapping;
pub mod trail;
pub mod tray;
pub mod typography;
pub mod voronoi;
pub mod voronoi_art;
pub mod wallpaper;
pub mod wave_function_collapse;
pub mod wave_interference;