release 1.0.0

Author: tsulej

CHANGELOG.md

@@ -1,7 +1,9 @@
 # Change Log
 All notable changes to this project will be documented in this file. This change log follows the conventions of [keepachangelog.com](http://keepachangelog.com/).
 
-## 0.1.0-SNAPSHOT
+## 1.0.0-RC1 (0.1.0-SNAPSHOT)
+
+Please note - breaking changes!
 
 ### Added
 
@@ -15,6 +17,7 @@ All notable changes to this project will be documented in this file. This change
 - color gradients
 - color tweaking functions
 - font-ascent
+- thi.ng rgba interoperability
 
 ### Changed
 
@@ -33,6 +36,7 @@ All notable changes to this project will be documented in this file. This change
 - paletton-palette -> paletton
 - signal processing refactored, api changed
 - overlays refactored
+- glitch scripts refectored, api changed
 
 Prefix `make-` is reserved when function is created.
 

README.md

@@ -15,23 +15,16 @@ Clojure2D is a library supporting generative coding or glitching. It's based on
 
 ## WARNING
 
-Refactoring in progress -> towards 0.1.0, check Changelog.
+Version `1.0.0` is after big refactoring and contains plenty of breaking changes.
 
 ## Documentation
 
-[Codox - In progress!](https://clojure2d.github.io/clojure2d/docs/codox/)
+[Documentation with examples](https://clojure2d.github.io/clojure2d/docs/codox/)
 
 ## Motivation
 
 This project is the answer to personal needs to optimize my own workflow for generative or glitch creations. I've been producing a lot of Processing code and started to suffer from limitations of working in 'write sketch and run' mode. Too much copy&paste between sketches, zillions of folders, zillions of processed images. And one day I fell in love with FP. This code is the answer.
 
-### What's wrong with Processing?
-
-* not reusable code - you have to copy your common parts between sketches
-* display and canvas coupling
-* weak or no support for parallelism
-* more minor...
-
 ### Is it replacement for...
 
 ... quil, thi.ng, clisk, possibly other?
@@ -44,30 +37,31 @@ No, rather no. The closest is quil, which is really great library (both Clojure
 In points:
 
 * Almost decoupled display and canvas (decoupled drawing and refreshing) - you can have as many windows as you want, you can have as many canvases as you want. Display repaints selected canvas automaticaly in separate thread. This way you can operate on canvas in your pace.
-* Processing way is still possible (you can attach draw() function to your Display). However main benefit here: draw function keeps context between invocations, this way you can avoid global state (atoms etc.) and write more functional way. The same is for events, each Window has assigned state which is passed through event calls.
+* Processing way is still possible (you can attach draw() function to your Display). However main benefit here: draw function keeps state between invocations, this way you can avoid global state (atoms etc.) and write more functional way. The same is for events, each Window has assigned state which is passed through event calls.
 * Easy live coding possible (Emacs/Cider/REPL)
 * FastMath as main math library
-* Main focus on higher level generative/glitch concepts (like sonification support, vector field functions, colorspace operations, things like pixelsorting, slitscan etc. See my Processing sketches, link below)
-
-Check out examples and results folders
+* Main focus on higher level generative/glitch concepts (like sonification support, vector field functions, colorspace operations, things like slitscan etc. See my Processing sketches, link below)
 
 ### What's odd?
 
 It's kind of personal library which supports my (probably not optimal, not convenient for others) way of creating stuff.
 There are still plenty of bugs and not idiomatic code. It may be slower than Processing. Eats a lot of memory (Pixels code is generally immutable). Still not stable API and architecture.
-No tests (yet)
 
 ## Installation
 
 Add following line as a dependency to your `project.clj`
 
+Development version (release soon):
+
 ```clojure
-[clojure2d "0.0.7-SNAPSHOT"]
+[clojure2d "1.0.0-RC1"]
 ```
 
+_Release will be done after review of all [examples](https://github.com/Clojure2D/clojure2d-examples)_
+
 ## Usage
 
-Since still no tutorials are available, check out prepared examples. All namespaces are described below.
+Since still no tutorials are available, see [documentation](https://clojure2d.github.io/clojure2d/docs/codox/). All namespaces are described below:
 
 ### clojure2d.core [docs](https://clojure2d.github.io/clojure2d/docs/codox/clojure2d.core.html)
 
@@ -76,7 +70,6 @@ This is main namespace with functions in three groups:
 * image file oparations (load/save); jpg, png and bmp
 * canvas operations (wrapper for Java2D BufferedImage and Graphics2D)
 * window and event operations (JFrame wrapper)
-* global state (one per window)
 * session handling (logger + unique, sequential filename generator)
 
 ### clojure2d.pixels [docs](https://clojure2d.github.io/clojure2d/docs/codox/clojure2d.pixels.html)
@@ -87,24 +80,24 @@ Defines also:
 * pixel filters (blur, erode, dilate, median, threshold, posterize, tint)
 * composing Pixels
 * higher order functions which operate on Pixels parallelly (filter-channels, blend-channels)
-* accumulation bins (smooth rendering canvas)
+* log density renderer
 
 ### clojure2d.color [docs](https://clojure2d.github.io/clojure2d/docs/codox/clojure2d.color.html)
 
-* colorspace converters
+* color space converters
 * collection of blending basic functions (like add, subtract, divide, difference, etc.)
-* palette generation / color reducing filter
+* huge collection of palettes and gradients
 
 ### clojure2d.extra
 
 This is namespace for common generative/glitch specific libraries:
 
-* signal - signal processing, wave generators, effects and filters (sonification enabler) [docs](https://clojure2d.github.io/clojure2d/docs/codox/clojure2d.extra.signal.html)
-* overlays - 3 overlays (noise, spots and rgb scanlines) to finish your images [docs](https://clojure2d.github.io/clojure2d/docs/codox/clojure2d.extra.overlays.html)
-* segmentation - segment Pixels into rectangles [docs](https://clojure2d.github.io/clojure2d/docs/codox/clojure2d.extra.segmentation.html)
-* variations - vector field functions / variations taken from fractal flames world [docs](https://clojure2d.github.io/clojure2d/docs/codox/clojure2d.extra.variations.html)
-* glitch - glitching filters
-* raymarching - simple ray marching 3d scene renderer
+* signal - signal processing, wave generators, effects and filters (for sonification process) [docs](https://clojure2d.github.io/clojure2d/docs/codox/clojure2d.extra.signal.html)
+* overlays - postprocessing filters (like rgb/crt scanlines, etc.) [docs](https://clojure2d.github.io/clojure2d/docs/codox/clojure2d.extra.overlays.html)
+* segmentation - image segmentation [docs](https://clojure2d.github.io/clojure2d/docs/codox/clojure2d.extra.segmentation.html)
+* glitch - glitching filters [docs](https://clojure2d.github.io/clojure2d/docs/codox/clojure2d.extra.glitch.html)
+* utils - visualize objects: palette, gradient, image, vector/scalar field... [docs](https://clojure2d.github.io/clojure2d/docs/codox/clojure2d.extra.glitch.html)
+* raymarching - simple ray marching 3d scene renderer (abandoned)
 
 ### generateme/fastmath
 
@@ -116,33 +109,6 @@ All math functions are in [fastmath](https://github.com/generateme/fastmath) rep
 
 [EXAMPLES](https://github.com/Clojure2D/clojure2d-examples)
 
-## TODO
-
-### High priority
-
-* ~~Marginalia docs + github.io page - in progress~~
-* Cleaning, optimizations - still in progress (more profiling, boxed math removal)
-* ~~Parallel color operations on Pixels~~
-* ~~Color namespace cleaning~~
-* ~~Colorspace converters~~
-* More in extra ns:
-  - SDF objects
-  - variations
-  - glitch filters in extra namespace (moved from Processing)
-  - analog filters (for sonification part)
-* More canvas drawing functions (PShape implementation - partially done)
-* ~~Session handling (saving results in session, logging actions) - done, not tested~~
-* Sanity tests
-* Tutorials
-
-### Low priority or ideas
-
-* Cheat sheet
-* ~~More window events~~
-* Deeper joise bindings
-* Wavelets bindings
-* Tests... (in progress)
-
 ## Community
 
 [Clojurians](https://clojurians.slack.com/archives/clojure2d)

docs/codox/clojure2d.color.html

@@ -1,6 +1,6 @@
 <!DOCTYPE html PUBLIC ""
     "">
-<html><head><meta charset="UTF-8" /><title>clojure2d.extra.overlays documentation</title><script type="text/javascript" async="" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js?config=TeX-MML-AM_CHTML"></script><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="highlight/solarized-light.css" /><script type="text/javascript" src="highlight/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a> with <a href="https://github.com/xsc/codox-theme-rdash">RDash UI</a> theme</h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Clojure2d</span> <span class="project-version">0.1.0-SNAPSHOT</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>clojure2d</span></div></div></li><li class="depth-2 branch"><a href="clojure2d.color.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>color</span></div></a></li><li class="depth-2 branch"><a href="clojure2d.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>extra</span></div></div></li><li class="depth-3 branch"><a href="clojure2d.extra.glitch.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>glitch</span></div></a></li><li class="depth-3 branch current"><a href="clojure2d.extra.overlays.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>overlays</span></div></a></li><li class="depth-3 branch"><a href="clojure2d.extra.raymarching.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>raymarching</span></div></a></li><li class="depth-3 branch"><a href="clojure2d.extra.segmentation.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>segmentation</span></div></a></li><li class="depth-3 branch"><a href="clojure2d.extra.signal.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>signal</span></div></a></li><li class="depth-3"><a href="clojure2d.extra.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li><li class="depth-2"><a href="clojure2d.pixels.html"><div class="inner"><span class="tree" style="top: -207px;"><span class="top" style="height: 216px;"></span><span class="bottom"></span></span><span>pixels</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="clojure2d.extra.overlays.html#var-noise-overlay"><div class="inner"><span>noise-overlay</span></div></a></li><li class="depth-1"><a href="clojure2d.extra.overlays.html#var-render-crt-scanlines"><div class="inner"><span>render-crt-scanlines</span></div></a></li><li class="depth-1"><a href="clojure2d.extra.overlays.html#var-render-noise"><div class="inner"><span>render-noise</span></div></a></li><li class="depth-1"><a href="clojure2d.extra.overlays.html#var-render-rgb-scanlines"><div class="inner"><span>render-rgb-scanlines</span></div></a></li><li class="depth-1"><a href="clojure2d.extra.overlays.html#var-render-spots"><div class="inner"><span>render-spots</span></div></a></li><li class="depth-1"><a href="clojure2d.extra.overlays.html#var-spots-overlay"><div class="inner"><span>spots-overlay</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">clojure2d.extra.overlays</h1><div class="doc"><div class="markdown"></div><div class="markdown"><h4>Categories</h4><ul></ul><p>Other vars: <a href="clojure2d.extra.overlays.html#var-noise-overlay">noise-overlay</a> <a href="clojure2d.extra.overlays.html#var-render-crt-scanlines">render-crt-scanlines</a> <a href="clojure2d.extra.overlays.html#var-render-noise">render-noise</a> <a href="clojure2d.extra.overlays.html#var-render-rgb-scanlines">render-rgb-scanlines</a> <a href="clojure2d.extra.overlays.html#var-render-spots">render-spots</a> <a href="clojure2d.extra.overlays.html#var-spots-overlay">spots-overlay</a></p></div><div class="markdown"><h4>Code snippets</h4><div><blockquote><p>Save overlays</p></blockquote><pre><code>(defn save-result
+<html><head><meta charset="UTF-8" /><title>clojure2d.extra.overlays documentation</title><script type="text/javascript" async="" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/MathJax.js?config=TeX-MML-AM_CHTML"></script><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="highlight/solarized-light.css" /><script type="text/javascript" src="highlight/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a> with <a href="https://github.com/xsc/codox-theme-rdash">RDash UI</a> theme</h2><h1><a href="index.html"><span class="project-title"><span class="project-name">Clojure2d</span> <span class="project-version">1.0.0-RC1</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 "><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>clojure2d</span></div></div></li><li class="depth-2 branch"><a href="clojure2d.color.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>color</span></div></a></li><li class="depth-2 branch"><a href="clojure2d.core.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>core</span></div></a></li><li class="depth-2"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>extra</span></div></div></li><li class="depth-3 branch"><a href="clojure2d.extra.glitch.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>glitch</span></div></a></li><li class="depth-3 branch current"><a href="clojure2d.extra.overlays.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>overlays</span></div></a></li><li class="depth-3 branch"><a href="clojure2d.extra.raymarching.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>raymarching</span></div></a></li><li class="depth-3 branch"><a href="clojure2d.extra.segmentation.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>segmentation</span></div></a></li><li class="depth-3 branch"><a href="clojure2d.extra.signal.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>signal</span></div></a></li><li class="depth-3"><a href="clojure2d.extra.utils.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>utils</span></div></a></li><li class="depth-2"><a href="clojure2d.pixels.html"><div class="inner"><span class="tree" style="top: -207px;"><span class="top" style="height: 216px;"></span><span class="bottom"></span></span><span>pixels</span></div></a></li></ul></div><div class="sidebar secondary"><h3><a href="#top"><span class="inner">Public Vars</span></a></h3><ul><li class="depth-1"><a href="clojure2d.extra.overlays.html#var-noise-overlay"><div class="inner"><span>noise-overlay</span></div></a></li><li class="depth-1"><a href="clojure2d.extra.overlays.html#var-render-crt-scanlines"><div class="inner"><span>render-crt-scanlines</span></div></a></li><li class="depth-1"><a href="clojure2d.extra.overlays.html#var-render-noise"><div class="inner"><span>render-noise</span></div></a></li><li class="depth-1"><a href="clojure2d.extra.overlays.html#var-render-rgb-scanlines"><div class="inner"><span>render-rgb-scanlines</span></div></a></li><li class="depth-1"><a href="clojure2d.extra.overlays.html#var-render-spots"><div class="inner"><span>render-spots</span></div></a></li><li class="depth-1"><a href="clojure2d.extra.overlays.html#var-spots-overlay"><div class="inner"><span>spots-overlay</span></div></a></li></ul></div><div class="namespace-docs" id="content"><h1 class="anchor" id="top">clojure2d.extra.overlays</h1><div class="doc"><div class="markdown"></div><div class="markdown"><h4>Categories</h4><ul></ul><p>Other vars: <a href="clojure2d.extra.overlays.html#var-noise-overlay">noise-overlay</a> <a href="clojure2d.extra.overlays.html#var-render-crt-scanlines">render-crt-scanlines</a> <a href="clojure2d.extra.overlays.html#var-render-noise">render-noise</a> <a href="clojure2d.extra.overlays.html#var-render-rgb-scanlines">render-rgb-scanlines</a> <a href="clojure2d.extra.overlays.html#var-render-spots">render-spots</a> <a href="clojure2d.extra.overlays.html#var-spots-overlay">spots-overlay</a></p></div><div class="markdown"><h4>Code snippets</h4><div><blockquote><p>Save overlays</p></blockquote><pre><code>(defn save-result
   [f params &amp; opts]
   (let [n (str "images/overlays/" (first opts) ".jpg")
         c (canvas 600 800)