aboutsummaryrefslogtreecommitdiff
path: root/pd/doc/5.reference
diff options
context:
space:
mode:
authorHans-Christoph Steiner <eighthave@users.sourceforge.net>2011-10-09 16:36:37 +0000
committerHans-Christoph Steiner <eighthave@users.sourceforge.net>2011-10-09 16:36:37 +0000
commit21c068f1916330e90f814bed461fe0821d1665ec (patch)
tree949b73696fff09a44b8d3eb01b70bae7174cbd14 /pd/doc/5.reference
parentbf8ced1efe1a032342e864edc635fa4e2676670d (diff)
checked in pd-0.43-0.src.tar.gz
svn path=/trunk/; revision=15557
Diffstat (limited to 'pd/doc/5.reference')
-rw-r--r--pd/doc/5.reference/bang-help.pd2
-rw-r--r--pd/doc/5.reference/block~-help.pd28
-rw-r--r--pd/doc/5.reference/delay-help.pd39
-rw-r--r--pd/doc/5.reference/drawpolygon-help.pd2
-rw-r--r--pd/doc/5.reference/line-help.pd51
-rw-r--r--pd/doc/5.reference/route-help.pd17
-rw-r--r--pd/doc/5.reference/spigot-help.pd1
-rw-r--r--pd/doc/5.reference/tabread-help.pd53
-rw-r--r--pd/doc/5.reference/tabread4-help.pd39
-rw-r--r--pd/doc/5.reference/tabread~-help.pd45
10 files changed, 212 insertions, 65 deletions
diff --git a/pd/doc/5.reference/bang-help.pd b/pd/doc/5.reference/bang-help.pd
index 1f522268..5a289050 100644
--- a/pd/doc/5.reference/bang-help.pd
+++ b/pd/doc/5.reference/bang-help.pd
@@ -2,7 +2,7 @@
#X obj 49 182 print;
#X text 107 183 Output is in the printout window.;
#X obj 66 15 bang;
-#X text 112 14 - SEND "BANG" MSSESSAGE;
+#X text 112 14 - SEND "BANG" MESSAGE;
#X msg 61 105 walk the cat;
#X msg 49 79 45;
#X obj 49 152 bang;
diff --git a/pd/doc/5.reference/block~-help.pd b/pd/doc/5.reference/block~-help.pd
index 4d2bdbdc..97e2207b 100644
--- a/pd/doc/5.reference/block~-help.pd
+++ b/pd/doc/5.reference/block~-help.pd
@@ -1,4 +1,4 @@
-#N canvas 21 2 607 676 12;
+#N canvas 0 0 603 672 12;
#X obj 48 10 block~;
#X text 112 11 (and switch~) - block size and on/off control for DSP
;
@@ -74,7 +74,6 @@ may be switched with impunity \, but not catch~.;
#X text 32 11 INTERACTIONS BETWEEN BLOCK~/SWITCH~ AND OTHER OBJECTS
IN PD;
#X restore 40 482 pd block-interations;
-#X text 227 483 INTERACTIONS WITH OTHER OBJECTS;
#X text 44 269 Pd's default block size is 64 samples. The inlet~ and
outlet~ objects reblock signals to adjust for differences between parent
and subpatch \, but only power-of-two adjustments are possible. So
@@ -85,4 +84,27 @@ any other block size. This is intended for later use in video processing.
#X text 45 395 Switch~ takes a "bang" message that causes one block
of DSP to be computed. This might be useful for pre-computing waveforms
or window functions \, or also for video processing.;
-#X text 337 604 updated for Pd version 0.4;
+#X text 198 484 <-- BUG!! block~/switch~ and dac~/adc~ are incompatible
+;
+#N canvas 0 0 581 315 block-interations 0;
+#X text 32 11 You can use the switch~ object to single-step dsp in
+a subpatch. This might be useful for block operations that don't want
+to be synced to the sample clock: loading a wondiw function in a table
+\, or copying one table to another:;
+#X obj 136 193 noise~;
+#X obj 136 225 tabwrite~ zzzz;
+#X obj 33 154 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1
+-1;
+#N canvas 0 0 450 300 (subpatch) 0;
+#X array zzzz 256 float 2;
+#X coords 0 1 256 -1 256 140 1;
+#X restore 300 116 graph;
+#X obj 33 228 switch~ 256;
+#X text 25 111 turn DSP on and click to;
+#X text 26 127 randomize the table at right:;
+#X connect 1 0 2 0;
+#X connect 3 0 2 0;
+#X connect 3 0 5 0;
+#X restore 40 505 pd block-interations;
+#X text 198 506 <-- wierd 'bang' feature lets you single-step DSP;
+#X text 337 604 updated for Pd version 0.43;
diff --git a/pd/doc/5.reference/delay-help.pd b/pd/doc/5.reference/delay-help.pd
index 5f90cd4b..119f2a31 100644
--- a/pd/doc/5.reference/delay-help.pd
+++ b/pd/doc/5.reference/delay-help.pd
@@ -1,30 +1,33 @@
#N canvas 3 0 513 348 12;
#X obj 66 15 delay;
-#X obj 13 229 50;
-#X msg 13 98 bang;
-#X floatatom 13 255;
-#X floatatom 116 182;
-#X obj 51 230 0;
+#X floatatom 116 182 0 0 0 0 - - -;
#X text 111 16 - CALLBACK AFTER TIME DELAY;
#X text 130 205 <-- creation argument initializes delay time;
-#X text 6 41 The delay object sends a bang to its outlet after a delay in milliseconds specified by its right inlet or its creation argument.;
+#X text 6 41 The delay object sends a bang to its outlet after a delay
+in milliseconds specified by its right inlet or its creation argument.
+;
#X obj 51 204 delay 1000;
-#X text 58 86 Click here to test the delay object by initializing the number box below to 50 and then clearing it after the specified delay.;
#X text 94 132 Click here to CANCEL delay's action;
#X msg 51 133 stop;
#X text 43 324 see also:;
#X obj 155 323 timer;
#X obj 111 323 metro;
#X msg 62 155 2000;
-#X text 102 154 Number in right inlet sets time and schedules the action.;
-#X text 316 320 updated for Pd version 0.3;
+#X text 102 154 Number in right inlet sets time and schedules the action.
+;
#X text 145 183 <-- scroll to change delay time in milliseconds;
-#X text 14 280 Note: sending a bang to a delay which is already set will reschedule its output \, cancelling the old one.;
-#X connect 1 0 3 0;
-#X connect 2 0 1 0;
-#X connect 2 0 9 0;
-#X connect 4 0 9 1;
-#X connect 5 0 3 0;
-#X connect 9 0 5 0;
-#X connect 12 0 9 0;
-#X connect 16 0 9 0;
+#X text 14 280 Note: sending a bang to a delay which is already set
+will reschedule its output \, cancelling the old one.;
+#X obj 52 231 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1
+-1;
+#X obj 34 112 bng 15 250 50 0 empty empty empty 17 7 0 10 -262144 -1
+-1;
+#X text 55 109 bang to set it;
+#X obj 224 258 del;
+#X text 115 256 Also known as:;
+#X text 317 320 updated for Pd version 0.43;
+#X connect 1 0 5 1;
+#X connect 5 0 15 0;
+#X connect 7 0 5 0;
+#X connect 11 0 5 0;
+#X connect 16 0 5 0;
diff --git a/pd/doc/5.reference/drawpolygon-help.pd b/pd/doc/5.reference/drawpolygon-help.pd
index 7b3dfd24..cfc3cd10 100644
--- a/pd/doc/5.reference/drawpolygon-help.pd
+++ b/pd/doc/5.reference/drawpolygon-help.pd
@@ -12,7 +12,7 @@ dog float weasel;
#N canvas 177 100 580 549 help-drawpolygon-template 1;
#X obj 19 24 drawpolygon 0 2 0 0 0 weasel;
#X obj 18 300 filledpolygon 900 dog 3 10 0 20 cat 30 0;
-#X text 30 322 filledpolyconn and filledcurve take the same arguments
+#X text 30 322 filledpolygon and filledcurve take the same arguments
\, except that a new first argument is added to specify interior color.
Here the interior color is red (900) \, the outline color is controlled
by the "dog" field \, and the three points describe a triangle of altitude
diff --git a/pd/doc/5.reference/line-help.pd b/pd/doc/5.reference/line-help.pd
index f5d5ad38..d56c262a 100644
--- a/pd/doc/5.reference/line-help.pd
+++ b/pd/doc/5.reference/line-help.pd
@@ -1,35 +1,44 @@
-#N canvas 31 15 669 403 12;
-#X floatatom 22 339 0 0 0 0 - - -;
-#X msg 31 205 0 1000;
-#X msg 46 227 39;
+#N canvas 372 214 597 464 12;
+#X floatatom 22 416 8 0 0 0 - - -;
+#X msg 32 219 0 1000;
+#X msg 47 241 39;
#X obj 66 15 line;
#X text 106 14 - ramp generator;
-#X msg 22 182 1 1000;
-#X text 18 36 The line object takes (target \, time) pairs and slews
+#X msg 23 196 1 1000;
+#X text 22 38 The line object takes (target \, time) pairs and slews
to the specified target over the time given \, updating its output
-at a "grain rate" given by the creation argument. If you dont' specify
+at a "grain rate" given by the creation argument. If you don't specify
a time \, line jumps immediately to the target. Note that the inlet
does not remember old values (unlike every other inlet in Pd) -- sending
a float causes a jump in the output regardless of whatever time value
was specified in some previous message. If the line object receives
a message specifying some new target before reaching the previous one
\, it takes off from its current value.;
-#X text 93 194 send a pair to ramp to a new value;
-#X text 105 224 send a single number to jump;
-#X text 46 363 see also:;
-#X obj 132 361 line~;
-#X msg 57 252 stop;
-#X text 98 251 "stop" message to stop output;
-#X obj 22 313 line 0 100;
-#X text 383 369 updated for Pd version 0.37;
-#X text 125 310 creation arguments:;
-#X text 316 310 1 initial value;
-#X text 318 330 2 time grain in milliseconds;
-#X msg 51 282 set 5;
-#X text 99 282 "set" to change value (and stop) without output;
+#X text 94 208 send a pair to ramp to a new value;
+#X text 97 243 send a single number to jump;
+#X text 106 443 see also:;
+#X obj 176 440 line~;
+#X msg 58 266 stop;
+#X text 103 268 "stop" message to stop output;
+#X obj 22 390 line 0 100;
+#X text 122 396 creation arguments:;
+#X text 271 388 1 initial value;
+#X msg 52 296 set 5;
+#X text 105 296 "set" to change value (and stop) without output;
+#X text 394 441 updated for Pd version 0.43;
+#X obj 222 440 vline~;
+#X floatatom 91 352 0 0 0 0 - - -;
+#X floatatom 91 328 0 0 0 0 - - -;
+#X text 126 328 first inlet sets next ramp time (cleared when ramp
+starts!);
+#X text 125 354 second inlet sets grain (not cleared \, acts as normal
+inlet);
+#X text 270 404 2 time grain in milliseconds (20 by default);
#X connect 1 0 13 0;
#X connect 2 0 13 0;
#X connect 5 0 13 0;
#X connect 11 0 13 0;
#X connect 13 0 0 0;
-#X connect 18 0 13 0;
+#X connect 16 0 13 0;
+#X connect 20 0 13 2;
+#X connect 21 0 13 1;
diff --git a/pd/doc/5.reference/route-help.pd b/pd/doc/5.reference/route-help.pd
index 224fb0ea..578795bc 100644
--- a/pd/doc/5.reference/route-help.pd
+++ b/pd/doc/5.reference/route-help.pd
@@ -1,4 +1,4 @@
-#N canvas 0 0 815 537 12;
+#N canvas 58 56 699 665 12;
#X obj 183 213 print x1;
#X obj 261 213 print x2;
#X obj 339 213 print x3;
@@ -45,9 +45,17 @@ of arguments plus one.;
the list contining only the number 5 \, both messages match "float"
\, and ditto for symbols. An empty list matches "bang". In Pd these
are all considered special cases of lists.;
-#X text 545 506 updated for Pd version 0.35;
#X text 97 9 - route messages according to their first element;
#X obj 43 8 route;
+#X text 482 627 updated for Pd version 0.43;
+#X obj 132 564 route 4;
+#X msg 84 539 1 2 3;
+#X floatatom 187 540 5 0 0 0 - - -;
+#X msg 132 539 4 5 6;
+#X obj 131 590 print w1;
+#X obj 200 591 print w2;
+#X text 278 549 With zero or one argument \, route sprouts an inlet
+to set the arument (which may be float or symbol).;
#X connect 4 0 0 0;
#X connect 4 1 1 0;
#X connect 4 2 2 0;
@@ -78,3 +86,8 @@ are all considered special cases of lists.;
#X connect 30 2 31 0;
#X connect 30 3 32 0;
#X connect 30 4 33 0;
+#X connect 41 0 45 0;
+#X connect 41 1 46 0;
+#X connect 42 0 41 0;
+#X connect 43 0 41 1;
+#X connect 44 0 41 0;
diff --git a/pd/doc/5.reference/spigot-help.pd b/pd/doc/5.reference/spigot-help.pd
index 10ff1569..8e6a0d19 100644
--- a/pd/doc/5.reference/spigot-help.pd
+++ b/pd/doc/5.reference/spigot-help.pd
@@ -15,7 +15,6 @@ ignored.;
#X text 349 310 updated for Pd version 0.38;
#X obj 92 244 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0 1
;
-#X text 450 267;
#X text 125 267 optional arg sets the initial state (0 by default)
;
#X connect 3 0 8 0;
diff --git a/pd/doc/5.reference/tabread-help.pd b/pd/doc/5.reference/tabread-help.pd
index fa671a21..25c9bfd9 100644
--- a/pd/doc/5.reference/tabread-help.pd
+++ b/pd/doc/5.reference/tabread-help.pd
@@ -1,21 +1,38 @@
-#N canvas 44 26 703 454 12;
-#X text 52 181 index;
+#N canvas 58 46 685 536 12;
+#X text 89 188 index;
#X obj 36 9 tabread;
-#X obj 15 244 tabread array99;
-#X floatatom 15 182 0 0 0;
-#X floatatom 15 278 0 0 0;
-#X graph graph1 0 0 10 10 362 379 612 179;
-#X array array99 10 float;
-#X pop;
-#X msg 31 56 \; readout 1 \; array99 resize 10 \; array99 bounds 0 0 10 10 \; array99 xlabel -0.5 0 1 2 3 4 5 6 7 8 9 10 \; array99 ylabel -1 0 1 2 3 4 5 6 7 8 9 10 \; array99 0 1 4 2 8 5 6 1 4 2 8;
-#X text 60 276 output = array99[index];
-#X text 141 33 click here to initialize;
-#X text 159 236 creation argument;
-#X text 155 254 gives array name;
-#X msg 25 204 set array99;
-#X text 137 204 change array name;
-#X text 422 407 updated for Pd version 0.33;
-#X text 110 8 - read numbers from a table;
+#X obj 52 251 tabread array99;
+#X floatatom 52 189 0 0 0 0 - - -;
+#X floatatom 52 285 0 0 0 0 - - -;
+#N canvas 0 0 450 300 (subpatch) 0;
+#X array array99 10 float 3;
+#A 0 9 0 8 1 7 2 6 3 5 4;
+#X coords 0 10 10 0 250 200 1 0 0;
+#X restore 398 219 graph;
+#X text 90 286 output = array99[index];
+#X text 196 243 creation argument;
+#X text 198 259 gives array name;
+#X msg 62 211 set array99;
+#X text 174 211 change array name;
+#X text 109 9 - read numbers from a table;
+#X msg 36 363 \; array99 xlabel -0.5 0 1 2 3 4 5 6 7 8 9 10 \; array99
+ylabel -1 0 1 2 3 4 5 6 7 8 9 10;
+#X text 449 486 updated for Pd version 0.43;
+#X obj 37 337 loadbang;
+#X text 8 433 see also the "array" tutorial in section 2 of the Pd
+documentation \, and these objects:;
+#X obj 9 472 tabwrite~;
+#X obj 213 472 tabwrite;
+#X obj 278 472 tabsend~;
+#X obj 343 472 tabreceive~;
+#X obj 80 472 tabplay~;
+#X obj 148 472 tabread4;
+#X text 59 45 The tabread object reads values from an array ("table")
+according to an index. The index is rounded down to the next lower
+integer. Values in the table correspond to indices starting at 0 Indices
+outside of the range are replaced by the nearest index in range (from
+0 to 9 in this example).;
#X connect 2 0 4 0;
#X connect 3 0 2 0;
-#X connect 11 0 2 0;
+#X connect 9 0 2 0;
+#X connect 14 0 12 0;
diff --git a/pd/doc/5.reference/tabread4-help.pd b/pd/doc/5.reference/tabread4-help.pd
new file mode 100644
index 00000000..fea18fb4
--- /dev/null
+++ b/pd/doc/5.reference/tabread4-help.pd
@@ -0,0 +1,39 @@
+#N canvas 61 69 685 536 12;
+#X text 89 188 index;
+#X obj 36 9 tabread;
+#X floatatom 52 189 0 0 0 0 - - -;
+#X floatatom 52 285 0 0 0 0 - - -;
+#N canvas 0 0 450 300 (subpatch) 0;
+#X array array99 10 float 3;
+#A 0 9 0 8 1 7 2 6 3 5 4;
+#X coords 0 10 10 0 250 200 1 0 0;
+#X restore 398 219 graph;
+#X text 90 286 output = array99[index];
+#X text 196 243 creation argument;
+#X text 198 259 gives array name;
+#X msg 62 211 set array99;
+#X text 174 211 change array name;
+#X text 109 9 - read numbers from a table;
+#X msg 36 363 \; array99 xlabel -0.5 0 1 2 3 4 5 6 7 8 9 10 \; array99
+ylabel -1 0 1 2 3 4 5 6 7 8 9 10;
+#X text 449 486 updated for Pd version 0.43;
+#X obj 37 337 loadbang;
+#X text 8 433 see also the "array" tutorial in section 2 of the Pd
+documentation \, and these objects:;
+#X obj 9 472 tabwrite~;
+#X obj 213 472 tabwrite;
+#X obj 278 472 tabsend~;
+#X obj 343 472 tabreceive~;
+#X obj 80 472 tabplay~;
+#X obj 52 251 tabread4 array99;
+#X obj 148 472 tabread;
+#X text 59 44 The tabread4 object reads values from an array ("table")
+according to an index \, applying four-point polynomial interpolation.
+Indices should range from 1 to (size-2) so that the 4-point interpolation
+is meaningful. You can shift-drag the number box to see the effect
+of interpolation.Indices outside of the range are replaced by the nearest
+index in range (from 1 to 8 in this example).;
+#X connect 2 0 20 0;
+#X connect 8 0 20 0;
+#X connect 13 0 11 0;
+#X connect 20 0 3 0;
diff --git a/pd/doc/5.reference/tabread~-help.pd b/pd/doc/5.reference/tabread~-help.pd
new file mode 100644
index 00000000..e27523e6
--- /dev/null
+++ b/pd/doc/5.reference/tabread~-help.pd
@@ -0,0 +1,45 @@
+#N canvas 320 156 845 474 12;
+#N canvas 0 0 450 300 (subpatch) 0;
+#X array array99 10 float 3;
+#A 0 -0.5 0.5 -0.4 0.4 -0.3 0.3 -0.2 0.2 -0.1 0.1;
+#X coords 0 1 10 -1 250 200 1;
+#X restore 562 167 graph;
+#X obj 16 362 snapshot~;
+#X obj 35 336 metro 200;
+#X obj 16 149 sig~;
+#X floatatom 16 123 6 0 10 0 - - -;
+#X obj 35 310 r readout;
+#X floatatom 16 388 0 0 0 0 - - -;
+#X msg 28 186 set array99;
+#X text 118 185 "set" message permits you to switch between arrays
+;
+#X text 144 274 creation argument initializes array name;
+#X text 11 403 see also the "array" tutorial in section 2 of the Pd
+documentation \, and these objects:;
+#X text 563 16 click here to test;
+#X obj 91 445 tabwrite~;
+#X obj 236 445 tabread;
+#X obj 359 446 tabwrite;
+#X obj 424 446 tabsend~;
+#X obj 489 446 tabreceive~;
+#X obj 162 445 tabplay~;
+#X msg 582 40 \; readout 1 \; pd dsp 1 \;;
+#X text 24 230 signal input;
+#X obj 47 21 tabread~;
+#X text 127 21 non-interpolating table lookup;
+#X text 7 58 Tabread~ looks up values out of the named array. Incoming
+values are truncated to the next lower integer \, and values out of
+bounds get the nearest (first or last) point.;
+#X text 64 117 incoming signal is index. Indices should range from
+0 to (size-1).;
+#X obj 16 274 tabread~ array99;
+#X obj 16 446 tabread4~;
+#X obj 294 445 tabread4;
+#X text 625 451 updated for Pd version 0.43;
+#X connect 1 0 6 0;
+#X connect 2 0 1 0;
+#X connect 3 0 24 0;
+#X connect 4 0 3 0;
+#X connect 5 0 2 0;
+#X connect 7 0 24 0;
+#X connect 24 0 1 0;