aboutsummaryrefslogtreecommitdiff
path: root/pd/doc
diff options
context:
space:
mode:
Diffstat (limited to 'pd/doc')
-rw-r--r--pd/doc/5.reference/get-help.pd65
-rw-r--r--pd/doc/5.reference/samphold~-help.pd72
-rw-r--r--pd/doc/5.reference/set-help.pd92
3 files changed, 131 insertions, 98 deletions
diff --git a/pd/doc/5.reference/get-help.pd b/pd/doc/5.reference/get-help.pd
index 6784a6ce..3b2f235a 100644
--- a/pd/doc/5.reference/get-help.pd
+++ b/pd/doc/5.reference/get-help.pd
@@ -1,46 +1,51 @@
-#N struct help-get-template1 float x float y;
-#N canvas 293 5 629 429 12;
-#X text 13 325 see also:;
-#X obj 143 370 template;
-#X obj 84 345 set;
-#X obj 116 345 append;
-#X obj 175 345 getsize;
-#X obj 243 345 setsize;
-#X obj 311 345 element;
-#X obj 16 370 sublist;
-#X obj 84 370 scalar;
+#N struct help-get-template1 float x float y symbol s;
+#N canvas 489 102 633 413 12;
+#X text 22 324 see also:;
+#X obj 93 344 set;
+#X obj 125 344 append;
+#X obj 184 344 getsize;
+#X obj 252 344 setsize;
+#X obj 320 344 element;
+#X obj 25 369 sublist;
#X msg 60 130 next;
-#N canvas 164 72 425 146 help-get-template1 0;
+#N canvas 292 338 631 204 help-get-template1 0;
#X obj 41 87 filledpolygon 9 0 1 0 0 20 0 20 30 0 30;
-#X obj 60 21 template float x float y;
+#X obj 60 21 struct help-get-template1 float x float y symbol s;
#X restore 376 234 pd help-get-template1;
#N canvas 0 0 276 156 help-get-data 1;
-#X scalar help-get-template1 46 23 \;;
-#X scalar help-get-template1 106 73 \;;
+#X scalar help-get-template1 46 23 dog \;;
+#X scalar help-get-template1 106 73 cat \;;
#X restore 376 212 pd help-get-data;
#X obj 21 10 get;
#X text 86 10 -- get values from a scalar;
#X msg 45 102 traverse pd-help-get-data \, next;
-#X floatatom 45 214 5 0 0;
-#X floatatom 222 210 5 0 0;
+#X floatatom 45 211 5 0 0 0 - - -;
+#X floatatom 168 211 5 0 0 0 - - -;
#X obj 45 157 pointer;
#X text 337 101 output first scalar in list;
#X text 103 129 output next item;
-#X text 21 277 If you have data whose template varies (from a heterogeneous
+#X text 24 267 If you have data whose template varies (from a heterogeneous
list \, for example) you can use "pointer" to select according to template
before sending to "get".;
-#X obj 45 185 get help-get-template1 x y;
#X text 31 37 "Get" \, when sent a pointer to a scalar \, retrieves
fields from it by name. The fields can be float or symbol. In the future
this will also allow access to sublists of scalars.;
-#X text 293 167 First argument selects template.;
-#X text 294 182 Remaining args are names of fields.;
-#X text 41 233 x output;
-#X text 220 232 y output;
-#X obj 16 345 pointer;
-#X text 373 399 updated for Pd version 0.35;
-#X connect 9 0 17 0;
-#X connect 14 0 17 0;
-#X connect 17 0 21 0;
-#X connect 21 0 15 0;
-#X connect 21 1 16 0;
+#X text 307 167 First argument selects template.;
+#X text 308 182 Remaining args are names of fields.;
+#X text 41 227 x output;
+#X text 166 228 y output;
+#X obj 25 344 pointer;
+#X obj 93 369 struct;
+#X text 377 377 updated for Pd version 0.39;
+#X obj 45 185 get help-get-template1 x y s;
+#X text 252 229 s output;
+#X symbolatom 256 211 6 0 0 0 - - -;
+#X obj 118 158 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
+-1;
+#X connect 7 0 15 0;
+#X connect 12 0 15 0;
+#X connect 15 0 27 0;
+#X connect 15 1 30 0;
+#X connect 27 0 13 0;
+#X connect 27 1 14 0;
+#X connect 27 2 29 0;
diff --git a/pd/doc/5.reference/samphold~-help.pd b/pd/doc/5.reference/samphold~-help.pd
index 1a58bd02..4ad542cf 100644
--- a/pd/doc/5.reference/samphold~-help.pd
+++ b/pd/doc/5.reference/samphold~-help.pd
@@ -1,34 +1,46 @@
-#N canvas 121 54 554 287 10;
-#X obj 32 238 snapshot~;
-#X floatatom 32 257;
-#X obj 41 219 metro 100;
-#X obj 41 197 r start;
-#X msg 387 21 \; pd dsp 1 \; start bang;
-#X text 392 270 updated for version 0.29;
-#X text 454 30 Click to start;
-#X text 447 78 Click to stop;
-#X msg 388 65 \; pd dsp 0 \; start 0;
+#N canvas 430 114 568 497 12;
+#X obj 24 451 snapshot~;
+#X floatatom 24 476 5 0 0 0 - - -;
+#X obj 33 425 metro 100;
#X obj 19 7 samphold~;
#X text 96 6 - sample and hold unit;
-#X obj 32 170 samphold~;
-#X text 10 26 The samphold~ object samples its left input whenever its right input decreases in value (as a phasor~ does each period \, for example.) Both inputs are audio signals.;
-#X obj 67 129 sig~;
-#X obj 101 148 sig~;
-#X floatatom 67 109;
-#X floatatom 101 127;
-#X msg 32 66 set 34;
-#X msg 38 87 reset;
-#X text 81 65 set output to a number;
-#X text 81 86 force the next sample;
-#X text 97 109 sample signal;
-#X text 135 127 control signal;
+#X obj 24 376 samphold~;
+#X text 14 32 The samphold~ object samples its left input whenever
+its right input decreases in value (as a phasor~ does each period \,
+for example.) Both inputs are audio signals.;
+#X obj 59 340 sig~;
+#X obj 116 376 sig~;
+#X floatatom 59 315 3 0 0 0 - - -;
+#X floatatom 116 355 3 0 0 0 - - -;
+#X msg 24 212 set 34;
+#X msg 37 281 reset;
+#X text 89 210 set output to a number;
+#X text 97 315 sample signal;
+#X text 159 353 control signal;
+#X msg 32 244 reset 10;
+#X text 111 242 reset previous value;
+#X text 100 292 to force the next sample;
+#X obj 33 403 loadbang;
+#X text 320 472 updated for version 0.39;
+#X text 111 256 for control inlet;
+#X text 99 278 reset to default 1e+20;
+#X text 14 82 The "set" message sets the output value (which continues
+to be updated as normal afterward.) The "reset" message causes samphold~
+to act as if the specified value were the most recent value of the
+control input. Use this \, for example \, if you reset the incoming
+phasor but don't want the jump reflected in the output. Plain "reset"
+is equivalent to "reset infinity" which forces the next input to be
+sampled.;
+#X msg 122 422 \; pd dsp 1;
#X connect 0 0 1 0;
#X connect 2 0 0 0;
-#X connect 3 0 2 0;
-#X connect 11 0 0 0;
-#X connect 13 0 11 0;
-#X connect 14 0 11 1;
-#X connect 15 0 13 0;
-#X connect 16 0 14 0;
-#X connect 17 0 11 0;
-#X connect 18 0 11 0;
+#X connect 5 0 0 0;
+#X connect 7 0 5 0;
+#X connect 8 0 5 1;
+#X connect 9 0 7 0;
+#X connect 10 0 8 0;
+#X connect 11 0 5 0;
+#X connect 12 0 5 0;
+#X connect 16 0 5 0;
+#X connect 19 0 2 0;
+#X connect 19 0 24 0;
diff --git a/pd/doc/5.reference/set-help.pd b/pd/doc/5.reference/set-help.pd
index 227b29b4..d9750558 100644
--- a/pd/doc/5.reference/set-help.pd
+++ b/pd/doc/5.reference/set-help.pd
@@ -1,45 +1,61 @@
-#N struct help-set-template1 float x float y;
-#N canvas 300 3 583 365 12;
-#X text 19 263 see also:;
-#X obj 137 308 template;
-#X obj 112 284 append;
-#X obj 170 284 getsize;
-#X obj 237 284 setsize;
-#X obj 215 308 element;
-#X obj 11 308 sublist;
-#X obj 78 308 scalar;
-#X msg 210 155 next;
-#X obj 21 10 get;
-#X floatatom 19 173 5 0 0;
-#X floatatom 108 181 5 0 0;
-#X obj 196 180 pointer;
-#X text 273 113 output first scalar in list;
-#X text 256 155 output next item;
-#X text 262 204 First argument selects template.;
-#X text 263 219 Remaining args are names of fields.;
-#X obj 11 283 pointer;
-#X msg 196 131 traverse pd-help-set-data \, next;
+#N struct help-set-template1 float x float y symbol s;
+#N canvas 355 10 598 568 12;
+#X text 34 478 see also:;
+#X obj 127 499 append;
+#X obj 185 499 getsize;
+#X obj 252 499 setsize;
+#X obj 153 523 element;
+#X obj 26 523 sublist;
+#X msg 211 174 next;
+#X floatatom 20 192 5 0 0 0 - - -;
+#X floatatom 109 200 5 0 0 0 - - -;
+#X obj 197 199 pointer;
+#X text 274 132 output first scalar in list;
+#X text 257 174 output next item;
+#X text 263 223 First argument selects template.;
+#X text 264 238 Remaining args are names of fields.;
+#X obj 26 498 pointer;
+#X msg 197 150 traverse pd-help-set-data \, next;
#N canvas 0 0 276 122 help-set-data 1;
-#X scalar help-set-template1 39 23 \;;
-#X scalar help-set-template1 99 73 \;;
-#X restore 377 244 pd help-set-data;
-#N canvas 164 72 425 146 help-set-template1 0;
+#X scalar help-set-template1 39 23 dog \;;
+#X scalar help-set-template1 99 73 cat \;;
+#X restore 389 461 pd help-set-data;
+#N canvas 41 424 514 219 help-set-template1 0;
#X obj 41 87 filledpolygon 9 0 1 0 0 20 0 20 30 0 30;
-#X obj 60 21 template float x float y;
-#X restore 377 266 pd help-set-template1;
+#X obj 39 34 struct help-set-template1 float x float y symbol s;
+#X obj 46 133 drawsymbol s 0 -15 0 s=;
+#X restore 389 483 pd help-set-template1;
#X text 86 10 -- set values in a scalar;
-#X obj 19 204 set help-set-template1 x y;
-#X text 18 155 x value;
-#X text 106 162 y value;
-#X obj 79 283 get;
-#X text 19 32 "Set" takes a pointer to a scalar in its rightmost inlet
+#X obj 20 223 set help-set-template1 x y;
+#X text 19 174 x value;
+#X text 107 181 y value;
+#X obj 94 498 get;
+#X text 14 34 "Set" takes a pointer to a scalar in its rightmost inlet
\; the remaining inlets set numeric values of fields. Only the leftmost
inlet is "hot". You can't "set" arrays or sublists. Instead \, you
can get pointers into them using "element" and "sublist" (probably
not working yet) and set individual items.;
-#X text 336 342 updated for Pd version 0.35;
-#X connect 8 0 12 0;
-#X connect 10 0 22 0;
-#X connect 11 0 22 1;
-#X connect 12 0 22 2;
-#X connect 18 0 12 0;
+#X text 333 530 updated for Pd version 0.39;
+#X obj 94 523 struct;
+#X obj 21 10 set;
+#X msg 257 389 next;
+#X obj 243 414 pointer;
+#X msg 243 365 traverse pd-help-set-data \, next;
+#X obj 21 444 set -symbol help-set-template1 s;
+#X symbolatom 21 423 10 0 0 0 - - -;
+#X msg 21 370 symbol monkey;
+#X msg 29 396 symbol fish;
+#X text 25 300 To set fields whose values are symbols \, give the set
+object the "-symbol" argument. (Unfortunately \, you can't mix symbols
+and numbers in the same "set" object.);
+#X connect 6 0 9 0;
+#X connect 7 0 19 0;
+#X connect 8 0 19 1;
+#X connect 9 0 19 2;
+#X connect 15 0 9 0;
+#X connect 27 0 28 0;
+#X connect 28 0 30 1;
+#X connect 29 0 28 0;
+#X connect 31 0 30 0;
+#X connect 32 0 31 0;
+#X connect 33 0 31 0;