eessppeelllloo/hydra
1
0
Fork 0
mirror of https://github.com/hydra-synth/hydra.git synced 2026-06-16 04:26:10 +02:00
Code Issues Packages Projects Releases Wiki Activity

test doc structure

Browse Source
This commit is contained in:
Jack Armitage
2019-03-20 10:52:23 +00:00
parent bcd818e769
commit 671e82677f
4 changed files with 59 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/funcs.md
+12 -11
View File
@@ -55,25 +55,25 @@ Functions for manipulating audio signals.
`.setBins( bins )`
* `bins` :: integer (default x)
* `bins` :: integer (default `x`)
### setCutoff
`.setCutoff( frequency )`
* `frequency` :: float (default x)
* `frequency` :: float (default `x`)
### setScale
`.setScale( amount )`
* `amount` :: float (default x)
* `amount` :: float (default `x`)
### setSmooth
`.setSmooth( amount )`
* `amount` :: float (default x)
* `amount` :: float (default `x`)
### show
@@ -96,7 +96,7 @@ Functions for manipulating color.
`.contrast( amount )`
* `amount` :: float (default 1.6)
* `amount` :: float (default `1.6`)
Larger `amount` value makes higher contrast.
@@ -114,7 +114,7 @@ Colorize texture.
`.colorama( amount )`
* `amount` :: float (default 0.005)
* `amount` :: float (default `0.005`)
Shift HSV values.
@@ -122,7 +122,7 @@ Shift HSV values.
`.invert( amount )`
* `amount` :: float (default 1.0)
* `amount` :: float (default `1.0`)
Invert color.
@@ -130,12 +130,13 @@ Invert color.
`.luma( threshold, tolerance )`
* `threshold` :: float (default 0.5)
* `tolerance` :: float (default 0.1)
* `threshold` :: float (default `0.5`)
* `tolerance` :: float (default `0.1`)
### thresh
`.thresh( threshold, tolerance )`
* `threshold` :: float (default 0.5)
* `tolerance` :: float (default 0.04)
* `threshold` :: float (default `0.5`)
* `tolerance` :: float (default `0.04`)
docs/funcs_audio.md
+4 -4
View File
@@ -17,25 +17,25 @@ Functions for manipulating audio signals.
`.setBins( bins )`
* `bins` :: integer (default x)
* `bins` :: integer (default `x`)
### setCutoff
`.setCutoff( frequency )`
* `frequency` :: float (default x)
* `frequency` :: float (default `x`)
### setScale
`.setScale( amount )`
* `amount` :: float (default x)
* `amount` :: float (default `x`)
### setSmooth
`.setSmooth( amount )`
* `amount` :: float (default x)
* `amount` :: float (default `x`)
### show
docs/funcs_color.md
+7 -7
View File
@@ -13,7 +13,7 @@ Functions for manipulating color.
`.contrast( amount )`
* `amount` :: float (default 1.6)
* `amount` :: float (default `1.6`)
Larger `amount` value makes higher contrast.
@@ -31,7 +31,7 @@ Colorize texture.
`.colorama( amount )`
* `amount` :: float (default 0.005)
* `amount` :: float (default `0.005`)
Shift HSV values.
@@ -39,7 +39,7 @@ Shift HSV values.
`.invert( amount )`
* `amount` :: float (default 1.0)
* `amount` :: float (default `1.0`)
Invert color.
@@ -47,12 +47,12 @@ Invert color.
`.luma( threshold, tolerance )`
* `threshold` :: float (default 0.5)
* `tolerance` :: float (default 0.1)
* `threshold` :: float (default `0.5`)
* `tolerance` :: float (default `0.1`)
### thresh
`.thresh( threshold, tolerance )`
* `threshold` :: float (default 0.5)
* `tolerance` :: float (default 0.04)
* `threshold` :: float (default `0.5`)
* `tolerance` :: float (default `0.04`)
docs/funcs_geometry.md
+36 -18
View File
@@ -2,43 +2,61 @@
Functions for manipulating geometry.
- [.kaleid( `nSides`)](#.kaleid( `nSides`))
- [.rotate( `angle`, `speed` )](#.rotate( `angle`, `speed` ))
- [.scale( `size`, `xMult`, `yMult` )](#.scale( `size`, `xMult`, `yMult` ))
- [.pixelate( `x`, `y` )](#.pixelate( `x`, `y` ))
- [.scrollX( `scrollX`, `speed` )](#.scrollX( `scrollX`, `speed` ))
- [.scrollY( `scrollY`, `speed` )](#.scrollY( `scrollY`, `speed` ))
- [kaleid](#kaleid)
- [pixelate](#pixelate)
- [rotate](#rotate)
- [scale](#scale)
- [scrollX](#scrollX)
- [scrollY](#scrollY)
---
### .kaleid( `nSides`)
* nSides :: float (default 4.0)
### kaleid
`.kaleid( nSides )`
* `nSides` :: float (default `4.0`)
Kaleidoscope effect with `nSides` repetition.
### .rotate( `angle`, `speed` )
* angle :: float (default 10.0)
* speed :: float (default 0.0)
### pixelate
`.pixelate( x, y )`
* `pixelX` :: float (default `20.0`)
* `pixelY` :: float (default `20.0`)
Pixelate texture with `pixelX` segments and `pixelY` segments.
### rotate
`.rotate( angle, speed )`
* `angle` :: float (default `10.0`)
* `speed` :: float (default `0.0`)
Rotate texture.
### .scale( `size`, `xMult`, `yMult` )
### scale
`.scale( `size`, `xMult`, `yMult` )`
* size :: float
* xMult :: float (default 1.0)
* yMult :: float (default 1.0)
Scale texture.
### .pixelate( `x`, `y` )
* pixelX :: float (default 20.0)
* pixelY :: float (default 20.0)
### scrollX
Pixelate texture with `pixelX` segments and `pixelY` segments.
`.scrollX( `scrollX`, `speed` )`
### .scrollX( `scrollX`, `speed` )
* scrollX :: float (default 0.5)
* speed :: float (default 0.0)
### .scrollY( `scrollY`, `speed` )
### scrollY
`.scrollY( `scrollY`, `speed` )`
* scrollY :: float (default 0.5)
* speed :: float (default 0.0)