elias/strudel-docker
1
0
Fork 0
mirror of https://github.com/eliasstepanik/strudel-docker.git synced 2026-01-24 20:18:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: euclid + euclidLegato

Browse Source
This commit is contained in:
Felix Roos 2022-09-25 22:09:39 +02:00
parent b64cf197f2
commit 69ce7c78a4
2 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
packages/core/euclid.mjs
View File

@ -25,14 +25,19 @@ const euclid = (pulses, steps, rotation = 0) => {
* describe a large number of rhythms used in the most important music world traditions. * describe a large number of rhythms used in the most important music world traditions.
* *
* @memberof Pattern * @memberof Pattern
* @name euclid
* @param {number} pulses the number of onsets / beats * @param {number} pulses the number of onsets / beats
* @param {number} steps the number of steps to fill * @param {number} steps the number of steps to fill
* @param {number} rotation (optional) offset in steps * @param {number} rotation (optional) offset in steps
* @returns Pattern * @returns Pattern
* @example // The Cuban tresillo pattern. * @example
* "c3".euclid(3,8) * // The Cuban tresillo pattern.
* n("c3").euclid(3,8).out()
*/
/**
* @example // A thirteenth century Persian rhythm called Khafif-e-ramal. * @example // A thirteenth century Persian rhythm called Khafif-e-ramal.
* "c3".euclid(2,5) * n("c3").euclid(2,5)
* @example // The archetypal pattern of the Cumbia from Colombia, as well as a Calypso rhythm from Trinidad. * @example // The archetypal pattern of the Cumbia from Colombia, as well as a Calypso rhythm from Trinidad.
* "c3".euclid(3,4) * "c3".euclid(3,4)
* @example // Another thirteenth century Persian rhythm by the name of Khafif-e-ramal, as well as a Rumanian folk-dance rhythm. * @example // Another thirteenth century Persian rhythm by the name of Khafif-e-ramal, as well as a Rumanian folk-dance rhythm.
@ -79,7 +84,11 @@ Pattern.prototype.euclid = function (pulses, steps, rotation = 0) {
}; };
/** /**
* Similar to {@link Pattern#euclid}, but each pulse is held until the next pulse, so there will be no gaps. * Similar to `.euclid`, but each pulse is held until the next pulse, so there will be no gaps.
* @name euclidLegato
* @memberof Pattern
* @example
* n("g2").decay(.1).sustain(.3).euclidLegato(3,8).out()
*/ */
Pattern.prototype.euclidLegato = function (pulses, steps, rotation = 0) { Pattern.prototype.euclidLegato = function (pulses, steps, rotation = 0) {
const bin_pat = euclid(pulses, steps, rotation); const bin_pat = euclid(pulses, steps, rotation);

8
tutorial/tutorial.mdx
View File

@ -502,11 +502,15 @@ The following functions modify a pattern temporal structure in some way.
{{ 'Pattern.late' | jsdoc }} {{ 'Pattern.late' | jsdoc }}
{{ 'Pattern.rev' | jsdoc }} {{ 'Pattern.legato' | jsdoc }}
{{ 'Pattern.struct' | jsdoc }} {{ 'Pattern.struct' | jsdoc }}
{{ 'Pattern.legato' | jsdoc }} {{ 'Pattern.euclid' | jsdoc }}
{{ 'Pattern.euclidLegato' | jsdoc }}
{{ 'Pattern.rev' | jsdoc }}
{{ 'Pattern.iter' | jsdoc }} {{ 'Pattern.iter' | jsdoc }}