Immediate Mode in Doodle Canvas

.github/workflows/ci.yml

@@ -71,11 +71,11 @@ jobs:
 
       - name: Make target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main')
-        run: mkdir -p reactor/js/target image/js/target unidocs/target js/target reactor/jvm/target core/js/target examples/js/target turtle/js/target core/jvm/target jvm/target interact/js/target interact/jvm/target java2d/target examples/jvm/target turtle/jvm/target image/jvm/target svg/jvm/target svg/js/target golden/target target canvas/target project/target
+        run: mkdir -p reactor/js/target image/js/target unidocs/target js/target reactor/jvm/target core/js/target examples/js/target turtle/js/target core/jvm/target jvm/target interact/js/target interact/jvm/target java2d/target examples/jvm/target target turtle/jvm/target image/jvm/target svg/jvm/target svg/js/target golden/target canvas/target project/target
 
       - name: Compress target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main')
-        run: tar cf targets.tar reactor/js/target image/js/target unidocs/target js/target reactor/jvm/target core/js/target examples/js/target turtle/js/target core/jvm/target jvm/target interact/js/target interact/jvm/target java2d/target examples/jvm/target turtle/jvm/target image/jvm/target svg/jvm/target svg/js/target golden/target target canvas/target project/target
+        run: tar cf targets.tar reactor/js/target image/js/target unidocs/target js/target reactor/jvm/target core/js/target examples/js/target turtle/js/target core/jvm/target jvm/target interact/js/target interact/jvm/target java2d/target examples/jvm/target target turtle/jvm/target image/jvm/target svg/jvm/target svg/js/target golden/target canvas/target project/target
 
       - name: Upload target directories
         if: github.event_name != 'pull_request' && (startsWith(github.ref, 'refs/tags/v') || github.ref == 'refs/heads/main')

.scalafix.conf

@@ -1,4 +1,5 @@
 rules = [
   OrganizeImports
 ]
+OrganizeImports.removeUnused = false
 OrganizeImports.coalesceToWildcardImportThreshold = 5

build.sbt

@@ -152,9 +152,9 @@ lazy val docs =
         val dest1 = mdocOut.value
         val dest2 = (laikaSite / target).value
         val cmd1 =
-          s"npx tailwindcss -i ${src.toString}/creative-scala.css -o ${dest1.toString}/creative-scala.css"
+          s"cmd /c npx tailwindcss -i ${src.toString}/creative-scala.css -o ${dest1.toString}/creative-scala.css"
         val cmd2 =
-          s"npx tailwindcss -i ${src.toString}/creative-scala.css -o ${dest2.toString}/creative-scala.css"
+          s"cmd /c npx tailwindcss -i ${src.toString}/creative-scala.css -o ${dest2.toString}/creative-scala.css"
         cmd1 !
 
         cmd2 !

canvas/src/main/scala/doodle/canvas/algebra/CanvasAlgebra.scala

@@ -20,7 +20,7 @@ import cats.Apply
 import cats.Eval
 import cats.Functor
 import cats.Monad
-import doodle.algebra.generic.*
+import doodle.algebra.generic._
 import doodle.core.BoundingBox
 import org.scalajs.dom.CanvasRenderingContext2D
 
@@ -29,16 +29,26 @@ final case class CanvasAlgebra(
     applyDrawing: Apply[CanvasDrawing] = Apply.apply[CanvasDrawing],
     functorDrawing: Functor[CanvasDrawing] = Apply.apply[CanvasDrawing]
 ) extends Path,
+      Raster,
       Shape,
+      Immediate,
       GenericDebug[CanvasDrawing],
       GenericLayout[CanvasDrawing],
+      GenericRaster[CanvasDrawing, Immediate],
+      GenericShape[CanvasDrawing],
       GenericSize[CanvasDrawing],
       GenericStyle[CanvasDrawing],
       GenericTransform[CanvasDrawing],
       GivenApply[CanvasDrawing],
       GivenFunctor[CanvasDrawing],
       doodle.algebra.Algebra {
   type Drawing[A] = doodle.canvas.Drawing[A]
+
+  override def empty: Finalized[CanvasDrawing, Unit] =
+    Finalized.leaf(_ =>
+      (BoundingBox.empty, Renderable.unit(CanvasDrawing.unit))
+    )
+
   implicit val drawingInstance: Monad[Drawing] =
     new Monad[Drawing] {
       def pure[A](x: A): Drawing[A] =
@@ -67,5 +77,4 @@ final case class CanvasAlgebra(
         )
       }
     }
-
 }

canvas/src/main/scala/doodle/canvas/algebra/CanvasDrawing.scala

@@ -1,21 +1,8 @@
-/*
- * Copyright 2015 Creative Scala
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
 package doodle.canvas.algebra
 
+import doodle.algebra.Algebra
+import doodle.algebra.generic.*
+
 import cats.Apply
 import doodle.algebra.generic.Fill
 import doodle.algebra.generic.Fill.ColorFill
@@ -29,21 +16,26 @@ import doodle.core.OpenPath
 import doodle.core.PathElement.BezierCurveTo
 import doodle.core.PathElement.LineTo
 import doodle.core.PathElement.MoveTo
-import doodle.core.Transform
+import doodle.core.Transform 
 import doodle.core.font.Font
 import doodle.core.font.FontFamily
 import doodle.core.font.FontSize
 import doodle.core.font.FontStyle
 import doodle.core.font.FontWeight
 import org.scalajs.dom.CanvasRenderingContext2D
 
+import doodle.algebra.Algebra
+import doodle.algebra.Raster
+import doodle.algebra.Picture
+
 import scala.scalajs.js
 import scala.scalajs.js.JSConverters.*
 
 /** A canvas `Drawing` is a function that, when applied, produces a value of
   * type `A` and has the side-effect of drawing on the canvas.
   */
 opaque type CanvasDrawing[A] = Function[CanvasRenderingContext2D, A]
+
 object CanvasDrawing {
   given Apply[CanvasDrawing] with {
     def ap[A, B](ff: CanvasDrawing[A => B])(
@@ -121,6 +113,16 @@ object CanvasDrawing {
     }
   }
 
+  def raster(width: Int, height: Int)(
+    f: Immediate => Unit
+  ): CanvasDrawing[Unit] = {
+    CanvasDrawing { ctx =>
+      implicit val implicitCtx: CanvasRenderingContext2D = ctx
+      val immediate = new Immediate {}
+      f(immediate)
+    }
+  }
+
   def setFill(fill: Option[Fill]): CanvasDrawing[Unit] =
     fill.map(setFill).getOrElse(unit)
 

canvas/src/main/scala/doodle/canvas/algebra/Immediate.scala

@@ -0,0 +1,36 @@
+/*
+ * Copyright 2015 Creative Scala
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package doodle.canvas.algebra
+
+import doodle.core.Color
+import org.scalajs.dom.CanvasRenderingContext2D
+
+trait Immediate {
+  def fillColor(color: Color)(implicit ctx: CanvasRenderingContext2D): Unit = {
+    ctx.fillStyle = CanvasDrawing.colorToCSS(color)
+  }
+
+  def rectangle(x: Double, y: Double, width: Double, height: Double)(implicit ctx: CanvasRenderingContext2D): Unit = {
+    ctx.fillRect(x, y, width, height)
+  }
+}
+
+
+
+
+
+

canvas/src/main/scala/doodle/canvas/algebra/Raster.scala

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2015 Creative Scala
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package doodle.canvas.algebra
+
+import doodle.algebra.Algebra
+import doodle.algebra.generic.*
+import org.scalajs.dom.CanvasRenderingContext2D
+import doodle.core.Transform as Tx
+
+trait Raster extends GenericRaster[CanvasDrawing, Immediate] {
+  self: Algebra { type Drawing[U] = Finalized[CanvasDrawing, U] } =>
+
+  object RasterApi extends RasterApi {
+    def raster(
+        tx: Tx,
+        width: Int,
+        height: Int
+    )(f: Immediate => Unit): CanvasDrawing[Unit] = {
+      CanvasDrawing.setTransform(tx) >>
+        CanvasDrawing.raster(width, height)(f)
+    }
+
+    def unit: CanvasDrawing[Unit] = {
+      CanvasDrawing.unit
+    }
+  }
+}
+

core/js/src/main/scala/doodle/syntax/package.scala

@@ -25,6 +25,7 @@ package object syntax {
       with LayoutSyntax
       with NormalizedSyntax
       with PathSyntax
+      with RasterSyntax
       with RendererSyntax
       with ShapeSyntax
       with SizeSyntax
@@ -41,6 +42,7 @@ package object syntax {
   object layout extends LayoutSyntax
   object normalized extends NormalizedSyntax
   object path extends PathSyntax
+  object raster extends RasterSyntax
   object renderer extends RendererSyntax
   object shape extends ShapeSyntax
   object size extends SizeSyntax

core/jvm/src/main/scala/doodle/syntax/package.scala

@@ -27,6 +27,7 @@ package object syntax {
       with LayoutSyntax
       with NormalizedSyntax
       with PathSyntax
+      with RasterSyntax
       with RendererSyntax
       with ShapeSyntax
       with SizeSyntax
@@ -46,6 +47,7 @@ package object syntax {
   object layout extends LayoutSyntax
   object normalized extends NormalizedSyntax
   object path extends PathSyntax
+  object raster extends RasterSyntax
   object renderer extends RendererSyntax
   object shape extends ShapeSyntax
   object size extends SizeSyntax

core/shared/src/main/scala/doodle/algebra/Raster.scala

@@ -0,0 +1,34 @@
+/*
+ * Copyright 2015 Creative Scala
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package doodle
+package algebra
+
+trait Raster[A] extends Algebra {
+  def raster(width: Int, height: Int)(f: A => Unit): Drawing[Unit]
+}
+
+trait RasterConstructor[A] {
+  self: BaseConstructor { type Algebra <: Raster[A] } =>
+
+  def raster(width: Int, height: Int)(f: A => Unit): Picture[Unit] =
+    new Picture[Unit] {
+      def apply(implicit algebra: Algebra): algebra.Drawing[Unit] =
+        algebra.raster(width, height)(f)
+    }
+}
+
+

core/shared/src/main/scala/doodle/algebra/generic/GenericRaster.scala

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2015 Creative Scala
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package doodle
+package algebra
+package generic
+
+import cats.data.State
+import doodle.core.BoundingBox
+import doodle.core.{Transform as Tx}
+
+trait GenericRaster[G[_], A] extends Raster[A] {
+  self: Algebra { type Drawing[U] = Finalized[G, U] } =>
+
+  trait RasterApi {
+    def raster(
+        tx: Tx,
+        width: Int,
+        height: Int
+    )(f: A => Unit): G[Unit]
+    def unit: G[Unit]
+  }
+
+  def RasterApi: RasterApi
+
+  def raster(width: Int, height: Int)(f: A => Unit): Finalized[G, Unit] = {
+    Finalized.leaf { dc =>
+      val bb = BoundingBox.centered(width, height)
+      (
+        bb,
+        State.inspect(tx =>
+          RasterApi.raster(tx, width, height)(f)
+        )
+      )
+    }
+  }
+
+  def empty: Finalized[G, Unit] =
+    Finalized.leaf { _ =>
+      (BoundingBox.empty, Renderable.unit(RasterApi.unit))
+    }
+}

core/shared/src/main/scala/doodle/syntax/RasterSyntax.scala

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2015 Creative Scala
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package doodle
+package syntax
+
+import doodle.algebra.Algebra
+import doodle.algebra.Picture
+import doodle.algebra.Raster
+
+trait RasterSyntax {
+  def raster[Alg <: Algebra, R](
+      width: Int,
+      height: Int
+  )(
+      f: R => Unit
+  ): Picture[Alg & Raster[R], Unit] =
+    new Picture[Alg & Raster[R], Unit] {
+      def apply(implicit algebra: Alg & Raster[R]): algebra.Drawing[Unit] =
+        algebra.raster(width, height)(f)
+    }
+}

docs/src/pages/canvas/examples.md

@@ -12,6 +12,10 @@ The source for these examples is [in the repository](https://github.com/creative
 
 @:doodle("parametric-spiral", "CanvasParametricSpiral.draw")
 
+## Experiment
+
+@:doodle("Experiment", "Experiment.draw")
+
 
 ## Frame Background