You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: child-scripts.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -30,7 +30,7 @@ In the interest of performance, it is best to declare any child scripts used in
30
30
31
31
### [`script::run(A)`](../api/script.md#run) and `script::run(A) -> R`
32
32
33
-
`script` objects represent child scripts. They are executed with the `run()` function. Depending on whether the child script returns a value or not, `run()` should either be called as an [expression](https://en.wikipedia.org/wiki/Expression_(computer_science)) or as a [statement](https://en.wikipedia.org/wiki/Statement_(computer_science)).
33
+
`script` objects represent child scripts. They are executed with the `run()` function. Depending on whether the child script returns a value or not, `run()` should either be called as an [expression](https://en.wikipedia.org/wiki/Expression_(computer_science)) or as a [statement](https://en.wikipedia.org/wiki/Statement_(computer_science)).
Copy file name to clipboardExpand all lines: color-scripts.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
**Note:**
8
8
9
-
They may be written to produce [side effects](https://en.wikipedia.org/wiki/Side_effect_(computer_science)), though this will adversely impact performance.
9
+
They may be written to produce [side effects](https://en.wikipedia.org/wiki/Side_effect_(computer_science)), though this will adversely impact performance.
10
10
11
11
## Contract
12
12
@@ -55,10 +55,10 @@ This script takes the input color `c` and returns a shade of grey with the same
55
55
56
56
This script does not utilize any functions from the scripting API.
57
57
58
-
However, it makes use of the `rgba(int r, int g, int b, int alpha) -> color` function from the *DeltaScript* base language [standard library](https://github.com/jbunke/deltascript). <!-- TODO - GitHub link to SL and to specific function -->
58
+
However, it makes use of the `rgba(int r, int g, int b, int alpha) -> color` function from the *DeltaScript* base language [standard library](https://github.com/jbunke/deltascript/blob/master/docs/functions-sl.md#rgba).
Copy file name to clipboardExpand all lines: color.md
+7-7
Original file line number
Diff line number
Diff line change
@@ -5,12 +5,12 @@
5
5
This article is meant to (1) provide an overview of the digital color theory concepts that one should understand in order to best use *Stipple Effect*, and (2) explain and illustrate some of *Stipple Effect*'s color-related jargon and conventions.
A **color model** is a mathematical model used to represent colors as a combination of numbers. Each of these numbers is associated with a particular attribute or quantity.
The **RGB** color model is an additive color model with the components **red** (R), **green** (G), and **blue** (B). These components are referred to as color channels.
16
16
@@ -24,9 +24,9 @@ The **RGBA** color model is an extension of RGB that adds a fourth channel: **al
**Hex codes** are six- or eight-digit alphanumeric codes following a leading `#` that represent digital colors in the RGB color model. Since the maximum value an RGB color channel can have is 255, a base-16 numbering system is the numbering system with the lowest [radix](https://en.wikipedia.org/wiki/Radix) that can represent all possible RGB channel values in two digits.
29
+
**Hex codes** are six- or eight-digit alphanumeric codes following a leading `#` that represent digital colors in the RGB color model. Since the maximum value an RGB color channel can have is 255, a base-16 numbering system is the numbering system with the lowest [radix](https://en.wikipedia.org/wiki/Radix) that can represent all possible RGB channel values in two digits.
30
30
31
31
Hexadecimal (base-16) numbering uses the digits 0 to F, where A follows 9. Thus, the digit A = 10, B = 11, and so on. Alphabetical digits can be represented in uppercase or lowercase.

58
58
59
-
The HSV model as implemented in *Stipple Effect* is best visualized as a cone. It is also often described as a cylinder. [**Hue**](https://en.wikipedia.org/wiki/Hue) is the angular property. [**Saturation**](https://en.wikipedia.org/wiki/Colorfulness) the radial dimension. That is to say that the saturation of a particular color in the model can be described as the ratio of its distance from the center of the cone to the radius of the cone at that particular height level. [**Value**](https://en.wikipedia.org/wiki/Lightness), alternatively **lightness** or **brightness**, is the height level of the color in the cone.
59
+
The HSV model as implemented in *Stipple Effect* is best visualized as a cone. It is also often described as a cylinder. [**Hue**](https://en.wikipedia.org/wiki/Hue) is the angular property. [**Saturation**](https://en.wikipedia.org/wiki/Colorfulness) the radial dimension. That is to say that the saturation of a particular color in the model can be described as the ratio of its distance from the center of the cone to the radius of the cone at that particular height level. [**Value**](https://en.wikipedia.org/wiki/Lightness), alternatively **lightness** or **brightness**, is the height level of the color in the cone.
60
60
61
-
Value is somewhat ambiguously defined in HS(V/L/B) color models. *Stipple Effect* defines value as the normalized single highest RGB color channel value. Thus, pure white ([`#ffffff`](https://en.wikipedia.org/wiki/White)) and pure blue ([`#0000ff`](https://en.wikipedia.org/wiki/Blue)) have the same value (1.0), despite white being a lighter color than blue.
61
+
Value is somewhat ambiguously defined in HS(V/L/B) color models. *Stipple Effect* defines value as the normalized single highest RGB color channel value. Thus, pure white ([`#ffffff`](https://en.wikipedia.org/wiki/White)) and pure blue ([`#0000ff`](https://en.wikipedia.org/wiki/Blue)) have the same value (1.0), despite white being a lighter color than blue.
62
62
63
63
Any color can be mapped from the RGB model to the HSV model, and vice versa. *Stipple Effect* has various [color samplers](./interface.md#samplers) that can be swapped out to visualize colors using different models.
Copy file name to clipboardExpand all lines: fonts.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
[`< Overview`](./README.md)
4
4
5
-
*Stipple Effect* uses the underlying [*Delta Time*](https://github.com/jbunke/delta-time) library to load and display fonts. Thus, the program's native system fonts, as well as user-defined fonts uploaded for use by the [text tool](./text-tool.md) at runtime, must comply with Delta Time's **font standard**.
5
+
*Stipple Effect* uses the underlying [*Delta Time*](https://github.com/jbunke/delta-time) library to load and display fonts. Thus, the program's native system fonts, as well as user-defined fonts uploaded for use by the [text tool](./text-tool.md) at runtime, must comply with Delta Time's **font standard**.
6
6
7
7
## Font files
8
8
@@ -15,17 +15,17 @@
15
15
16
16
### Parsed pixel colors
17
17
18
-
***Red** (`#ff0000`) - parsed as part of the [glyph](https://en.wikipedia.org/wiki/Glyph) associated with its bounding box
18
+
***Red** (`#ff0000`) - parsed as part of the [glyph](https://en.wikipedia.org/wiki/Glyph) associated with its bounding box
19
19
***Green** (`#00ff00`) - parsed as left- or right pixel boundary of the glyph associated with its bounding box *at that particular pixel height*
Copy file name to clipboardExpand all lines: interface.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -164,9 +164,9 @@ _**Normal Map**_
164
164
165
165
Normal mapping is a technique most often used to simulate lighting. A "normal map" is a type of asset that is used in conjuction with a standard texture to represent the **surface normals** of the object represented by the texture. These surface normals can then be used to simulate lighting based on a light source.
166
166
167
-
The normal map sampler in *Stipple Effect* can be [quantized](https://en.wikipedia.org/wiki/Color_quantization) for a limited set of directions or faces, which may be more pertinent to a pixel art context.
167
+
The normal map sampler in *Stipple Effect* can be [quantized](https://en.wikipedia.org/wiki/Color_quantization) for a limited set of directions or faces, which may be more pertinent to a pixel art context.
168
168
169
-
Read more about normal maps [here](https://en.wikipedia.org/wiki/Normal_mapping).
169
+
Read more about normal maps [here](https://en.wikipedia.org/wiki/Normal_mapping).
Copy file name to clipboardExpand all lines: pixel-grid.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -39,7 +39,7 @@ Toggle the pixel grid on or off. The pixel grid icon is located in the lower seg
39
39
40
40
**Shortcut:** <kbd>Ctrl</kbd> + <kbd>B</kbd>
41
41
42
-
If the [project](./project.md) has a [selection](./selection.md), the program attempts to set the dimensions of the pixel grid and checkerboard rectangles to the bounds of the smallest [axis-aligned bounding box](https://en.wikipedia.org/wiki/Minimum_bounding_box#Axis-aligned_minimum_bounding_box) that captures all the pixels in the selection. If the project does **not** have a selection, the program attempts to set the dimensions of the rectangles to the dimensions of the project canvas.
42
+
If the [project](./project.md) has a [selection](./selection.md), the program attempts to set the dimensions of the pixel grid and checkerboard rectangles to the bounds of the smallest [axis-aligned bounding box](https://en.wikipedia.org/wiki/Minimum_bounding_box#Axis-aligned_minimum_bounding_box) that captures all the pixels in the selection. If the project does **not** have a selection, the program attempts to set the dimensions of the rectangles to the dimensions of the project canvas.
Copy file name to clipboardExpand all lines: preview-scripts.md
+13-17
Original file line number
Diff line number
Diff line change
@@ -8,13 +8,13 @@ The script is executed every time that the user edits the project. An edit to th
8
8
9
9
**Note:**
10
10
11
-
Preview script transformations merely affect the preview. **These transformations are not applied to the project itself.** However, the results of preview script transformations can be [converted into full-fledged projects](./preview-window.md#converting-preview-script-transformations-into-projects).
11
+
Preview script transformations merely affect the preview. **These transformations are not applied to the project itself.** However, the results of preview script transformations can be [converted into full-fledged projects](./preview-window.md#converting-previews-into-projects).
12
12
13
13
## Contract
14
14
15
15
*How preview scripts must be structured to be accepted by the program*
16
16
17
-
Preview scripts can have a few possible [type signatures](https://en.wikipedia.org/wiki/Type_signature):
17
+
Preview scripts can have a few possible [type signatures](https://en.wikipedia.org/wiki/Type_signature):
18
18
19
19
* They must take a single parameter<sup>1, 2</sup>. This can either be an `image` or an array of images `image[]`.
20
20
* They must return either an `image` or an array of images `image[]`. The return type is not correlated with the parameter type.
@@ -152,13 +152,11 @@ This script utilizes the following API function:
This script utilizes the following functions from the *DeltaScript*base language [standard library](https://github.com/jbunke/deltascript): <!-- TODO - GitHub link to SL -->
155
+
This script utilizes the following functions from the *DeltaScript*[standard library](https://github.com/jbunke/deltascript/blob/master/docs/std-lib.md):
156
156
157
-
<!-- TODO - links to specific functions in the SL -->
*[`new_image_of(int width, int height) -> image`](https://github.com/jbunke/deltascript/blob/master/docs/functions-sl.md#new_image_of)
159
+
*[`image::draw(image overlay, int x, int y)`](https://github.com/jbunke/deltascript/blob/master/docs/image-sl.md#draw)
162
160
163
161
## Example 2
164
162
@@ -210,19 +208,17 @@ If `orig` is wider than it is tall, the copies are stacked vertically. If not, t
210
208
211
209
This script does not utilize any functions from the scripting API.
212
210
213
-
However, it makes use of the following functions from the *DeltaScript* base language [standard library](https://github.com/jbunke/deltascript): <!-- TODO - GitHub link to SL -->
214
-
215
-
<!-- TODO - links to specific functions in the SL -->
211
+
However, it makes use of the following functions from the *DeltaScript*[standard library](https://github.com/jbunke/deltascript/blob/master/docs/std-lib.md):
216
212
217
-
*`new_image_of(int width, int height) -> image`
218
-
*`rgba(int r, int g, int b, int alpha) -> color`
219
-
*`image::dot(color c, int x, int y)`
220
-
*`image::draw(image overlay, int x, int y)`
221
-
*`image::pixel(int x, int y) -> color`
213
+
*[`new_image_of(int width, int height) -> image`](https://github.com/jbunke/deltascript/blob/master/docs/functions-sl.md#new_image_of)
214
+
*[`rgba(int r, int g, int b, int alpha) -> color`](https://github.com/jbunke/deltascript/blob/master/docs/functions-sl.md#rgba)
215
+
*[`image::dot(color c, int x, int y)`](https://github.com/jbunke/deltascript/blob/master/docs/image-sl.md#dot)
216
+
*[`image::draw(image overlay, int x, int y)`](https://github.com/jbunke/deltascript/blob/master/docs/image-sl.md#draw)
217
+
*[`image::pixel(int x, int y) -> color`](https://github.com/jbunke/deltascript/blob/master/docs/image-sl.md#pixel)
A *Stipple Effect* session consists of one or multiple **projects**. Projects are sometimes referred to – especially in the [source code](https://github.com/stipple-effect/stipple-effect) – as **contexts**.
9
+
A *Stipple Effect* session consists of one or multiple **projects**. Projects are sometimes referred to – especially in the [source code](https://github.com/stipple-effect/stipple-effect) – as **contexts**.
10
10
11
11
The projects that are currently loaded in the program are arranged in the [projects panel](./interface.md#projects).
Copy file name to clipboardExpand all lines: save.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Saving a project to any other file type than STIP is considered an **export**. S
18
18
19
19
**Single PNG:**
20
20
21
-
For exporting a static project as a [PNG image](https://en.wikipedia.org/wiki/PNG). PNG images preserve transparency.
21
+
For exporting a static project as a [PNG image](https://en.wikipedia.org/wiki/PNG). PNG images preserve transparency.
22
22
23
23
**Sprite sheet:**
24
24
@@ -30,11 +30,11 @@ Exports an animation as a series of separate image files. Files have a shared na
30
30
31
31
**Animated GIF:**
32
32
33
-
Exports an animation as an [animated GIF image](https://en.wikipedia.org/wiki/GIF#Animated_GIF).
33
+
Exports an animation as an [animated GIF image](https://en.wikipedia.org/wiki/GIF#Animated_GIF).
34
34
35
35
**MP4 Video:**
36
36
37
-
Exports an animation as an [MP4 video](https://en.wikipedia.org/wiki/MP4_file_format). This is a [lossy compression](https://en.wikipedia.org/wiki/Lossy_compression) export.
37
+
Exports an animation as an [MP4 video](https://en.wikipedia.org/wiki/MP4_file_format). This is a [lossy compression](https://en.wikipedia.org/wiki/Lossy_compression) export.
0 commit comments