feat(example): add WASM example

Author: tversteeg

.github/renovate.json

@@ -0,0 +1,8 @@
+{
+	"$schema": "https://docs.renovatebot.com/renovate-schema.json",
+	"extends": [
+		"config:base",
+		":automergeAll",
+		":automergeBranch"
+	]
+}

.github/workflows/rust.yml

@@ -10,118 +10,112 @@ on:
       - "**.md"
 
 jobs:
-  # Run the `rustfmt` code formatter
   rustfmt:
-    name: Rustfmt [Formatter]
+    name: Formatter check
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
+
       - uses: actions-rs/toolchain@v1
         with:
           profile: minimal
           toolchain: stable
           components: rustfmt
           override: true
+
       - run: rustup component add rustfmt
       - uses: actions-rs/cargo@v1
         with:
           command: fmt
           args: --all -- --check
 
-  # Run the `clippy` linting tool
-  clippy:
-    name: Clippy [Linter]
-    runs-on: ubuntu-latest
+  # Run compile check on Linux, macOS, and Windows
+  # On both Rust stable and Rust nightly
+  compile:
+    name: Compile
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ubuntu-latest, macOS-latest, windows-latest]
+        toolchain: [stable, nightly]
     steps:
-      - uses: actions/checkout@v1
-      - uses: actions-rs/toolchain@v1
-        with:
-          profile: minimal
-          toolchain: stable
-          components: clippy
-          override: true
-      - uses: actions-rs/clippy-check@v1
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          args: --all-targets --all-features -- -D clippy::all
+      # Checkout the branch being tested
+      - uses: actions/checkout@v3
 
-  # Run a security audit on dependencies
-  cargo_audit:
-    name: Cargo Audit [Security]
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions-rs/toolchain@v1
+      # Install rust stable
+      - uses: dtolnay/rust-toolchain@master
         with:
-          toolchain: stable
-          override: true
-      - run: cargo install --force cargo-audit
-      - run: cargo generate-lockfile
-      - uses: actions-rs/cargo@v1
-        with:
-          command: audit
+          toolchain: ${{ matrix.toolchain }}
 
-  # Ensure that the project could be successfully compiled
-  cargo_check:
-    name: Compile
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v1
-      - uses: actions-rs/toolchain@v1
+      # Cache the built dependencies
+      - uses: Swatinem/[email protected]
         with:
-          profile: minimal
-          toolchain: stable
-          override: true
-      - uses: actions-rs/cargo@v1
-        with:
-          command: check
-          args: --all
+          save-if: ${{ github.event_name == 'push' }}
+
+      # Install cargo-hack
+      - uses: taiki-e/install-action@cargo-hack
+
+      # Compile all feature combinations on the target platform
+      - name: Compile
+        run: cargo hack --feature-powerset check
 
-  # Run tests on Linux, macOS, and Windows
+  # Run tests on Linux
   # On both Rust stable and Rust nightly
   test:
-    name: Test Suite
-    needs: [cargo_check]
-    runs-on: ${{ matrix.os }}
+    name: Test
+    runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-latest, macOS-latest, windows-latest]
-        rust: [stable, nightly]
+        toolchain: [stable, nightly]
     steps:
       # Checkout the branch being tested
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
 
-      # Install all the required dependencies for testing
-      - uses: actions-rs/toolchain@v1
+      # Install rust stable
+      - uses: dtolnay/rust-toolchain@master
         with:
-          profile: minimal
-          toolchain: stable
-          override: true
+          toolchain: ${{ matrix.toolchain }}
 
-      # Install Node.js at a fixed version
-      - uses: actions/setup-node@v1
+      # Cache the built dependencies
+      - uses: Swatinem/[email protected]
         with:
-          node-version: "12.0"
+          save-if: ${{ github.event_name == 'push' }}
 
-      # Install Ruby at a fixed version
-      - uses: actions/setup-ruby@v1
-        with:
-          ruby-version: "2.6"
+      # Install cargo-hack
+      - uses: taiki-e/install-action@cargo-hack
 
-      # Install Python at a fixed version
-      - uses: actions/setup-python@v1
-        with:
-          python-version: "3.7"
+      # Run the ignored tests that expect the above setup
+      - name: Run all tests
+        run: cargo hack --feature-powerset test
 
-      # Install dotnet at a fixed version
-      - uses: actions/setup-dotnet@v1
+  wasm:
+    name: WASM examples
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      # Install rust stable
+      - uses: dtolnay/rust-toolchain@master
         with:
-          dotnet-version: "2.2.402"
+          toolchain: stable
+          targets: wasm32-unknown-unknown
 
-      # Run the ignored tests that expect the above setup
-      - name: Run all tests
-        uses: actions-rs/cargo@v1
+      # Cache the built dependencies
+      - uses: Swatinem/[email protected]
         with:
-          command: test
-          args: -- -Z unstable-options --include-ignored
+          save-if: ${{ github.event_name == 'push' }}
+
+      # Build the WASM examples
+      - name: Build example
+        run: cargo run --package run-wasm -- --release --build-only --example window
+
+      # Deploy to GitHub pages
+      - name: Deploy to GitHub Pages
+        uses: s0/git-publish-subdir-action@master
+        env:
+          REPO: self
+          BRANCH: gh-pages
+          FOLDER: target/wasm-examples
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Cargo.toml

@@ -37,6 +37,10 @@ web-sys = { version = "0.3.61", features = ["CanvasRenderingContext2d", "Documen
 wasm-bindgen = "0.2.84"
 console_log = { version = "1.0.0", features = ["wasm-bindgen", "color"] }
 
+[[example]]
+name = "window"
+required-features = ["blit"]
+
 [[bench]]
 name = "rotsprite"
 harness = false
@@ -48,3 +52,6 @@ harness = false
 [[bench]]
 name = "rotate"
 harness = false
+
+[workspace]
+members = ["run-wasm"]

README.md

@@ -9,7 +9,6 @@ Rust implementation/library of the RotSprite algorithm.
 
 Works with many types of pixel buffers.
 
-## Example
 
 ![Large](docs/example-large.png?raw=true)
 ![Small](docs/example-small.png?raw=true)
@@ -18,12 +17,20 @@ Works with many types of pixel buffers.
 |-|-|-|
 | Source Image | Rotated 30° using RotSprite | Rotated 30° using naive rotation |
 
-### Run the example
+## Example
+
+## Demos
+
+### [WASM Demo](https://tversteeg.nl/rotsprite/window/)
+
+Web: https://tversteeg.nl/rotsprite/window
+
+Uses the `["blit"]` feature flag.
 
-On Linux you need the `xorg-dev` package as required by minifb. `sudo apt install xorg-dev`
+#### Local
 
-```sh
-cargo run --example minifb
+```console
+cargo run --example window
 ```
 
 ## Credits

benches/rotsprite.rs

@@ -1,6 +1,6 @@
-use blit::*;
+use blit::BlitExt;
 use criterion::{criterion_group, criterion_main, Criterion};
-use image::*;
+use image::GenericImageView;
 use rotsprite::rotsprite;
 
 fn load_image(path: &str) -> (usize, Vec<u32>) {
@@ -10,14 +10,9 @@ fn load_image(path: &str) -> (usize, Vec<u32>) {
     let size = img.dimensions();
     // Create a new buffer for this image that can be passed to the rotate function
     let mut img_buf: Vec<u32> = vec![0xFF_FF_FF; (size.0 * size.1) as usize];
-    img.as_rgba8()
-        .expect("Could not convert image to RGBA8 array")
-        .blit(
-            &mut img_buf,
-            size.0 as usize,
-            (0, 0),
-            blit::Color::from_u32(0xFF_00_FF),
-        );
+    img.into_rgba8()
+        .to_blit_buffer_with_mask_color(0xFF_00_FF)
+        .blit(&mut img_buf, size.0 as usize, (0, 0));
 
     (size.0 as usize, img_buf)
 }

examples/simple.rs

@@ -1,4 +1,4 @@
-use image::{GenericImageView, Rgba, RgbaImage};
+use image::{Rgba, RgbaImage};
 use rotsprite::rotsprite;
 
 fn main() {

examples/window.rs

@@ -1,15 +1,13 @@
-use blit::{BlitBuffer, BlitExt};
-use image::GenericImageView;
+use blit::BlitExt;
 use rotsprite::Rotsprite;
 use softbuffer::GraphicsContext;
+use web_time::SystemTime;
 use winit::{
     event::{Event, WindowEvent},
     event_loop::{ControlFlow, EventLoop},
     window::WindowBuilder,
 };
 
-use std::time::Duration;
-
 const BACKGROUND_COLOR: u32 = 0xFF_CC_FF;
 const MASK_COLOR: u32 = 0xFF_FF_FF;
 
@@ -45,22 +43,30 @@ fn main() {
                 let width = window.inner_size().width as usize;
                 let height = window.inner_size().height as usize;
 
-                // Clear the buffer first
-                buffer.fill(BACKGROUND_COLOR);
+                // Redraw the rotation every 5 steps
+                if rotation % 15.0 == 0.0 {
+                    // Clear the buffer first
+                    buffer.fill(BACKGROUND_COLOR);
 
-                // Redraw the whole buffer if it resized
-                if buffer.len() != width * height {
-                    log::info!("Buffer resized to {width}x{height}, redrawing");
+                    // Redraw the whole buffer if it resized
+                    if buffer.len() != width * height {
+                        log::info!("Buffer resized to {width}x{height}, redrawing");
 
-                    // Resize the buffer with empty values
-                    buffer.resize(width * height, BACKGROUND_COLOR);
-                }
+                        // Resize the buffer with empty values
+                        buffer.resize(width * height, BACKGROUND_COLOR);
+                    }
+
+                    let now = SystemTime::now();
 
-                // Rotate the sprite
-                let rotated_blit_buffer = img.rotsprite((rotation / 15.0).round() * 15.0).unwrap();
+                    // Rotate the sprite
+                    let rotated_blit_buffer =
+                        img.rotsprite((rotation / 15.0).round() * 15.0).unwrap();
 
-                // Draw the rotated sprite
-                rotated_blit_buffer.blit(&mut buffer, width, (0, 0));
+                    log::info!("Rotated sprite in {}ms", now.elapsed().unwrap().as_millis());
+
+                    // Draw the rotated sprite
+                    rotated_blit_buffer.blit(&mut buffer, width, (0, 0));
+                }
 
                 rotation += 0.5;