Screenshot

Cargo.toml

@@ -33,17 +33,25 @@ resolver = "2"
 
 [workspace.package]
 edition = "2024"
-version = "0.4.0-pre3"
+version = "0.4.0-pre4"
 authors = ["Johannes 'Sharlin' Dahlström <johannes.dahlstrom@gmail.com>"]
 license = "MIT OR Apache-2.0"
 repository = "https://github.com/jdahlstrom/retrofire"
 keywords = ["graphics", "gamedev", "demoscene", "retrocomputing", "rendering"]
 categories = ["graphics", "game-development", "no-std"]
 
+[workspace.lints]
+clippy.manual_range_contains = "allow"
+clippy.collapsible_if = "allow"
+
+[features]
+default = ["std"]
+std = ["retrofire-core/std", "retrofire-geom/std"]
+
 [dependencies]
-retrofire-core = { version = "0.4.0-pre3", path = "core" }
-retrofire-front = { version = "0.4.0-pre3", path = "front" }
-retrofire-geom = { version = "0.4.0-pre3", path = "geom" }
+retrofire-core = { version = "0.4.0-pre4", path = "core" }
+retrofire-front = { version = "0.4.0-pre4", path = "front" }
+retrofire-geom = { version = "0.4.0-pre4", path = "geom" }
 
 [profile.release]
 opt-level = 2

README.md

@@ -14,7 +14,8 @@
 
 *Note: This document is best viewed on an 80-column VGA terminal.*
 
-Retrofire is a software 3D rendering library
+Retrofire is a software 3D rendering library focusing on performance,
+correctness, and pedagogical value.
 
 The Retrofire project began as a shamelessly nostalgic effort to explore
 the state of graphics programming as it was in the mid-to-late 90s in
@@ -75,24 +76,24 @@ for custom allocators is planned in order to make `alloc` optional as well.
 
 ## Planned
 
-- Material support
-- Basic scene graph
-- Hierarchical transforms
-
-- Mipmapping and mipmap generation
-- More procedural generation
-- Basic animation and sequencing
-- Particle simulations
-- Support for more file types
+* Material support
+* Basic scene graph
+* Hierarchical transforms
+* Mipmapping and mipmap generation
+* More procedural generation
+* Basic animation and sequencing
+* Particle simulations
+* Support for more file types
 
 # Organization
 
 Retrofire is split into several packages:
 
-* core:  math, renderer, utilities; no-std compatible
-* geom:  geometric shapes, mesh builders, model loading
-* front: frontends for writing simple graphical applications
-* demos: binaries showcasing retrofire features
+* retrofire: a metapackage that just re-exports core, geom, and front
+* retrofire-core:  math, renderer, utilities; no-std compatible
+* retrofire-geom:  geometric shapes, mesh builders, model loading
+* retrofire-front: frontends for writing simple graphical applications
+* retrofire-demos: binaries showcasing retrofire features.
 
 # Dependencies
 
@@ -104,13 +105,25 @@ functions, the package is not fully functional unless either the `std`,
 `libm`, or `mm` feature is enabled. Activating `std` additionally enables
 APIs that do I/O.
 
-The `front` package depends on either `sdl2`, `minifb`, or `wasm-bindgen`
-and `web-sys`, depending on enabled features.
+The `retrofire-front` package depends on either `sdl2`, `minifb`, or
+`wasm-bindgen` and `web-sys`, depending on enabled features.
+
+The `retrofire-geom` package has no external dependencies. It only requires
+`alloc`; activating the optional feature `std` enables APIs that do I/O.
+
+The `retrofire-demos` package depends on `retrofire`.
+
+# Screenshots
+
+The classic Stanford bunny.
+![The classic Stanford bunny 3D model.](docs/bunny.jpg)
 
-The `geom` package has no external dependencies. It only requires `alloc`;
-activating the optional feature `std` enables APIs that do I/O.
+A first-person mouse-and-keyboard scene with many "Rust crates" strewn on a
+checkered floor.
+![Many wooden crates on a plane, each with the Rust logo](docs/crates.jpg)
 
-The `retrofire-demos` package depends on `retrofire-front`.
+Ten thousand spherical particles positioned randomly in a sphere.
+![Ten thousand spherical particles in random positions.](docs/sprites.jpg)
 
 # License
 

core/Cargo.toml

@@ -34,3 +34,6 @@ fp = []
 [dependencies]
 libm = { version = "0.2", optional = true }
 micromath = { version = "2.1", optional = true }
+
+[lints]
+workspace = true

core/README.md

@@ -12,12 +12,14 @@
 
 # Retrofire-core
 
-Core functionality of the `retrofire` project.
+Core functionality of the [`retrofire`][1] project.
 
 Includes a math library with strongly typed points, vectors, matrices,
 colors, and angles; basic geometry primitives; a software 3D renderer with
 customizable shaders; with more to come.
 
+[1]: https://crates.io/crates/retrofire
+
 ## Crate features
 
 * `std`:

core/examples/hello_tri.rs

@@ -0,0 +1,58 @@
+use retrofire_core::geom::tri;
+use retrofire_core::{prelude::*, util::*};
+
+fn main() {
+    let verts = [
+        vertex(pt3(-1.0, 1.0, 0.0), rgb(1.0, 0.0, 0.0)),
+        vertex(pt3(1.0, 1.0, 0.0), rgb(0.0, 0.8, 0.0)),
+        vertex(pt3(0.0, -1.0, 0.0), rgb(0.4, 0.4, 1.0)),
+    ];
+
+    #[cfg(feature = "fp")]
+    let shader = shader::new(
+        |v: Vertex3<Color3f>, mvp: &Mat4x4<ModelToProj>| {
+            // Transform vertex position from model to projection space
+            // Interpolate vertex colors in linear color space
+            vertex(mvp.apply(&v.pos), v.attrib.to_linear())
+        },
+        |frag: Frag<Color3f<_>>| frag.var.to_srgb().to_color4(),
+    );
+    #[cfg(not(feature = "fp"))]
+    let shader = shader::new(
+        |v: Vertex3<Color3f>, mvp: &Mat4x4<ModelToProj>| {
+            // Transform vertex position from model to projection space
+            // Interpolate vertex colors in normal sRGB color space
+            vertex(mvp.apply(&v.pos), v.attrib)
+        },
+        |frag: Frag<Color3f<_>>| frag.var.to_color4(),
+    );
+
+    let dims @ (w, h) = (640, 480);
+    let modelview = translate3(0.0, 0.0, 2.0).to();
+    let project = perspective(1.0, w as f32 / h as f32, 0.1..1000.0);
+    let viewport = viewport(pt2(0, h)..pt2(w, 0));
+
+    let mut framebuf = Buf2::<Color4>::new(dims);
+
+    render(
+        [tri(0, 1, 2)],
+        verts,
+        &shader,
+        &modelview.then(&project),
+        viewport,
+        &mut framebuf,
+        &Context::default(),
+    );
+
+    let center_pixel = framebuf[[w / 2, h / 2]];
+
+    if cfg!(feature = "fp") {
+        assert_eq!(center_pixel, rgba(150, 128, 186, 255));
+    } else {
+        assert_eq!(center_pixel, rgba(114, 102, 127, 255));
+    }
+    #[cfg(feature = "std")]
+    {
+        pnm::save_ppm("triangle.ppm", framebuf).unwrap();
+    }
+}