[Gridflow-cvs] [svn] commit: r5336 - in /trunk/doc/flow_classes: #in-help.pd #out-help.pd

svn-gridflow at artengine.ca svn-gridflow at artengine.ca
Mon Apr 5 22:25:44 EDT 2010


Author: matju
Date: Mon Apr  5 22:25:44 2010
New Revision: 5336

Log:
use [doc_link] to go to [#io.$1] pages

Modified:
    trunk/doc/flow_classes/#in-help.pd
    trunk/doc/flow_classes/#out-help.pd

Modified: trunk/doc/flow_classes/#in-help.pd
==============================================================================
--- trunk/doc/flow_classes/#in-help.pd (original)
+++ trunk/doc/flow_classes/#in-help.pd Mon Apr  5 22:25:44 2010
@@ -1,13 +1,13 @@
-#N canvas 594 0 632 685 10;
+#N canvas 56 6 632 685 10;
 #X text 13 34 This object imports a grid \, usually an image \, video
 or live stream.;
 #X msg 362 126 open working.jpg;
 #X obj 354 106 bng 15 250 50 0 empty empty empty 0 -6 0 8 -24198 -1
 -1;
 #X text 55 181 <--click here;
-#X text 232 1070 "loop 0" - turns off the loop option. The video stops
+#X text 232 1110 "loop 0" - turns off the loop option. The video stops
 once it reaches the end.;
-#X text 232 1285 Displays the resulting grid when connected to [#out
+#X text 232 1325 Displays the resulting grid when connected to [#out
 window];
 #N canvas 82 93 663 454 quicktime 0;
 #X text 9 9 The following messages can be used to set parameters for
@@ -129,7 +129,7 @@
 #X connect 11 0 14 0;
 #X connect 12 0 14 0;
 #X connect 13 0 14 0;
-#X restore 293 675 pd more info about video devices;
+#X restore 293 695 pd more info about video devices;
 #X text 169 213 (and turn off the metro);
 #X text 244 195 <-- vary this;
 #X text 352 74 IMAGE FILES:;
@@ -140,40 +140,40 @@
 #X text 68 265 <-- sends a bang upon reaching;
 #X text 97 278 the end of the file;
 #X obj 17 305 #out window \, title video;
-#X text 232 1035 "loop 1" - Restarts a video each time it reaches the
+#X text 232 1075 "loop 1" - Restarts a video each time it reaches the
 end (default setting).;
 #X obj 41 248 route bang;
 #X msg 24 147 open violoncelle.mov;
 #X obj 0 0 doc_h;
-#X obj 3 761 doc_i 1;
-#X obj 3 1255 doc_o 2;
-#X obj 14 791 doc_ii 0;
-#X obj 14 1285 doc_oo 0;
-#X obj 14 1307 doc_oo 1;
+#X obj 3 801 doc_i 1;
+#X obj 3 1295 doc_o 2;
+#X obj 14 831 doc_ii 0;
+#X obj 14 1325 doc_oo 0;
+#X obj 14 1347 doc_oo 1;
 #X obj 3 332 doc_c 1..2;
 #X text 165 389 auto-open with auto-detect of the format-handler;
 #X text 207 409 auto-open with manual choice of the format-handler
 ;
-#X obj 97 1105 doc_m i0 open;
-#X obj 97 1162 doc_m i0 set;
-#X obj 97 978 doc_m i0 close;
-#X obj 97 1140 doc_m i0 rewind;
-#X obj 97 1035 doc_m i0 loop;
-#X obj 97 956 doc_m i0 float int;
-#X obj 97 1285 doc_m o0 grid;
-#X obj 97 1307 doc_m o1 bang;
-#X obj 103 1487 #out;
+#X obj 97 1145 doc_m i0 open;
+#X obj 97 1202 doc_m i0 set;
+#X obj 97 1018 doc_m i0 close;
+#X obj 97 1180 doc_m i0 rewind;
+#X obj 97 1075 doc_m i0 loop;
+#X obj 97 996 doc_m i0 float int;
+#X obj 97 1325 doc_m o0 grid;
+#X obj 97 1347 doc_m o1 bang;
+#X obj 103 1527 #out;
 #X obj 34 371 #in;
 #X obj 34 391 #in filename.suffix;
 #X obj 34 411 #in handler filename.suffix;
 #X text 66 370 nothing opened \, you have to open by yourself;
-#X text 232 1105 \$1=filename. sends it as a resource to [#in]. For
+#X text 232 1145 \$1=filename. sends it as a resource to [#in]. For
 example: "open sewing.jpg".;
-#X obj 97 791 doc_m i0 bang;
-#X obj 97 1342 doc_m o1 float int;
-#X text 232 1342 frame number of the frame currently being viewed.
+#X obj 97 831 doc_m i0 bang;
+#X obj 97 1382 doc_m o1 float int;
+#X text 232 1382 frame number of the frame currently being viewed.
 Applies to formats that have frame numbers \, i.e. video.;
-#X text 232 791 A bang reads a frame and sends it through the outlet.
+#X text 232 831 A bang reads a frame and sends it through the outlet.
 Since frames from videos and live streams are read as a series of individual
 grids \, successive bangs advance through the frames. A bang reads
 a frame and sends it through the outlet. Since frames from videos and
@@ -184,55 +184,57 @@
 are several pictures in the same file \, but if the end of file is
 reached instead \, it will rewind and send the first picture again.
 ;
-#X obj 0 1507 doc_f;
-#X text 232 978 Closes the video input device. Only necessary when
+#X obj 0 1547 doc_f;
+#X text 232 1018 Closes the video input device. Only necessary when
 you are using a live capture device.;
-#X text 232 1140 Will rewind video to the beginning.;
-#X text 232 1162 select the video frame numbered \$1 \, where 0 is
+#X text 232 1180 Will rewind video to the beginning.;
+#X text 232 1202 select the video frame numbered \$1 \, where 0 is
 the first frame. A bang must be sent to [#in] in order to display the
 frame. this only works with video file formats.;
-#X text 232 956 same as set \$1 \, bang;
-#X obj 97 1013 doc_m i0 load;
-#X text 232 1013 shortcut for open \$1 \, bang \, close;
-#X obj 97 1377 doc_m o1 not_open;
-#X text 232 1307 Signals that the requested operation cannot be performed
+#X text 232 996 same as set \$1 \, bang;
+#X obj 97 1053 doc_m i0 load;
+#X text 232 1053 shortcut for open \$1 \, bang \, close;
+#X obj 97 1417 doc_m o1 not_open;
+#X text 232 1347 Signals that the requested operation cannot be performed
 because the end of the file was reached.;
-#X text 232 1377 Signals that the requested operation cannot be performed
+#X text 232 1417 Signals that the requested operation cannot be performed
 because [#in] is in closed mode. This could mean a «close» message
 was previously sent \, or no «open» (or equivalent) was ever done
 \, or the file was not found \, or the file was read-protected \, or
 the device is locked by another object or application that opened it
 (busy) \, or any other reason.;
-#X obj 139 1487 #camera;
+#X obj 139 1527 #camera;
 #X obj 354 172 #out window \, title working;
 #X obj 356 280 #out window \, title sewing;
-#X text 237 621 to get screenshots. see also [pix_snap];
+#X text 237 641 to get screenshots. see also [pix_snap];
 #X text 246 501 picture formats;
 #X text 247 571 movie formats;
 #X text 236 461 generic file format that can encode any grid.;
-#X obj 3 1487 doc_also;
-#X obj 97 1210 doc_m i0 <any>;
-#X text 232 1210 passed to the file format handler currently open.
+#X obj 3 1527 doc_also;
+#X obj 97 1250 doc_m i0 <any>;
+#X text 232 1250 passed to the file format handler currently open.
 If none is open \, this will send a "not_open" message on outlet 1
 ;
-#X text 244 674 cameras;
+#X text 244 694 cameras;
 #X obj 237 478 doc_accolade;
 #X obj 237 548 doc_accolade;
-#X obj 236 651 doc_accolade;
+#X obj 236 671 doc_accolade;
+#X obj 114 695 doc_link #io.dc1394;
+#X text 33 750 note that [#out] supports some more modules (those that
+are only for output);
+#X text 33 439 click on a hyperlink for more info;
 #X obj 114 463 doc_link #io.grid;
-#X obj 114 675 doc_link #io.dc1394;
 #X obj 114 523 doc_link #io.png;
 #X obj 114 503 doc_link #io.jpeg;
 #X obj 114 483 doc_link #io.ppm;
 #X obj 114 553 doc_link #io.quicktimehw;
 #X obj 114 573 doc_link #io.quicktimeapple;
-#X obj 114 593 doc_link #io.quicktimempeg;
-#X obj 114 623 doc_link #io.x11;
-#X obj 114 655 doc_link #io.videodev;
-#X obj 114 695 doc_link #io.quicktimecamera;
-#X text 80 721 note that [#out] supports some more modules (those that
-are only for output);
-#X text 83 443 click on a hyperlink for more info;
+#X obj 114 643 doc_link #io.x11;
+#X obj 114 675 doc_link #io.videodev;
+#X obj 114 715 doc_link #io.quicktimecamera;
+#X obj 114 593 doc_link #io.mpeg;
+#X msg 115 619 open quicktime;
+#X text 236 617 alias for either quicktimeapple or quicktimehw;
 #X connect 1 0 7 0;
 #X connect 2 0 7 0;
 #X connect 7 0 73 0;

Modified: trunk/doc/flow_classes/#out-help.pd
==============================================================================
--- trunk/doc/flow_classes/#out-help.pd (original)
+++ trunk/doc/flow_classes/#out-help.pd Mon Apr  5 22:25:44 2010
@@ -1,36 +1,36 @@
-#N canvas 594 0 632 715 10;
+#N canvas 591 0 632 715 10;
 #X obj 15 325 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
 -1;
 #X text 10 71 Displaying a grid:;
 #X text 342 73 Saving a grid:;
-#X text 232 689 "rewind" rewinds to the beginning of a video file.
+#X text 232 958 "rewind" rewinds to the beginning of a video file.
 Will overwrite previous data.;
 #X obj 15 100 bng 15 250 50 0 empty empty empty 0 -6 0 8 -24198 -1
 -1;
 #X obj 15 221 #in;
 #X msg 65 227 open window;
 #X msg 65 252 close;
-#X text 232 597 "close" closes the file and hides the display \, must
+#X text 232 866 "close" closes the file and hides the display \, must
 be accompanied by message "open window" to reopen the display.;
-#X text 232 764 A bang notifies when a complete grid has been received.
+#X text 232 1033 A bang notifies when a complete grid has been received.
 ;
 #X text 12 32 Displays or saves an incoming grid (usually an image
 or a video).;
 #X obj 15 302 #out window \, title example;
 #X obj 127 100 bng 15 250 50 0 empty empty empty 0 -6 0 8 -24198 -1
 -1;
-#X obj 133 886 #record;
-#X text 232 654 "open filename.format" (ex: "open somefile.jpg") sets
+#X obj 133 1152 #record;
+#X text 232 923 "open filename.format" (ex: "open somefile.jpg") sets
 the filename to write to.;
 #X obj 351 96 bng 15 250 50 0 empty empty empty 0 -6 0 8 -24198 -1
 -1;
 #X obj 351 190 #in;
 #X msg 127 262 hidecursor;
 #X text 196 261 <-- linux only;
-#X text 232 632 "hidecursor" (linux only) hides the mouse cursor.;
+#X text 232 901 "hidecursor" (linux only) hides the mouse cursor.;
 #X obj 0 0 doc_h;
 #X obj 3 371 doc_c n;
-#X obj 3 886 doc_also;
+#X obj 3 1152 doc_also;
 #N canvas 140 70 570 615 More 0;
 #X text 203 143 open default display for screenshot;
 #X msg 82 197 open videodev /dev/video0;
@@ -84,15 +84,15 @@
 #X connect 24 0 15 0;
 #X connect 25 0 18 0;
 #X restore 140 334 pd More info about this object class;
-#X obj 3 488 doc_i 1;
-#X obj 14 518 doc_ii 0;
-#X obj 14 764 doc_oo 0;
-#X obj 97 518 doc_m i0 grid;
-#X obj 97 654 doc_m i0 open;
-#X obj 97 597 doc_m i0 close;
-#X obj 97 632 doc_m i0 hidecursor;
-#X obj 97 689 doc_m i0 rewind;
-#X obj 103 886 #in;
+#X obj 3 757 doc_i 1;
+#X obj 14 787 doc_ii 0;
+#X obj 14 1033 doc_oo 0;
+#X obj 97 787 doc_m i0 grid;
+#X obj 97 923 doc_m i0 open;
+#X obj 97 866 doc_m i0 close;
+#X obj 97 901 doc_m i0 hidecursor;
+#X obj 97 958 doc_m i0 rewind;
+#X obj 103 1152 #in;
 #X text 188 426 auto-open with auto-detect of the format-handler;
 #X text 226 451 auto-open with manual choice of the format-handler
 ;
@@ -100,28 +100,49 @@
 #X obj 46 407 #out;
 #X obj 46 428 #out filename.suffix;
 #X obj 46 449 #out handler filename.suffix;
-#X obj 97 553 doc_m i0 autoclose;
-#X obj 0 906 doc_f;
-#X obj 97 764 doc_m o0 bang;
+#X obj 97 822 doc_m i0 autoclose;
+#X obj 0 1172 doc_f;
+#X obj 97 1033 doc_m o0 bang;
 #X msg 15 117 load working.jpg;
 #X msg 127 117 load sewing.jpg;
 #X msg 351 113 load sewing.jpg;
-#X text 232 553 "autoclose 1": close after incoming image is finished.
+#X text 232 822 "autoclose 1": close after incoming image is finished.
 ;
-#X text 232 575 "autoclose 0": doesn't.;
-#X text 232 518 write one frame (or in the case of [#out grid] \, one
+#X text 232 844 "autoclose 0": doesn't.;
+#X text 232 787 write one frame (or in the case of [#out grid] \, one
 grid of any kind).;
 #X obj 351 266 #out;
 #X msg 365 235 open somefile.jpg \, autoclose;
-#X obj 97 789 doc_m o1 not_open;
-#X obj 3 734 doc_o 2;
-#X obj 14 789 doc_oo 1;
-#X text 232 789 Signals that the requested operation cannot be performed
+#X obj 97 1055 doc_m o1 not_open;
+#X obj 3 1003 doc_o 2;
+#X obj 14 1055 doc_oo 1;
+#X text 232 1055 Signals that the requested operation cannot be performed
 because [#in] is in closed mode. This could mean a "close" message
 was previously sent \, or no "open" (or equivalent) was ever done \,
 or the file was not found \, or the file was read-protected \, or the
 device is locked by another object or application that opened it (busy)
 \, or any other reason.;
+#X text 256 521 picture formats;
+#X text 244 481 generic file format that can encode any grid.;
+#X obj 246 499 doc_accolade;
+#X obj 124 483 doc_link #io.grid;
+#X obj 124 523 doc_link #io.jpeg;
+#X obj 124 503 doc_link #io.ppm;
+#X obj 124 563 doc_link #io.quicktimehw;
+#X text 246 562 movie formats (.mov and .avi);
+#X obj 124 593 doc_link #io.x11;
+#X obj 246 597 doc_accolade;
+#X obj 124 613 doc_link #io.quartz;
+#X obj 124 633 doc_link #io.sdl;
+#X obj 124 653 doc_link #io.aalib;
+#X text 58 707 note that [#in] supports some more modules (those that
+are only for input);
+#X text 258 621 windows;
+#X text 317 612 see also [#to_pix] with [gemwin];
+#X text 316 627 and see also [#see];
+#X msg 124 675 open window;
+#X text 243 674 alias for either quartz or x11 or sdl;
+#X text 125 543 no png (sorry);
 #X connect 4 0 42 0;
 #X connect 5 0 11 0;
 #X connect 6 0 11 0;



More information about the Gridflow-cvs mailing list