Difference between revisions of "ChucK/Manual"

From CSWiki
Jump to: navigation, search
(* Missing documentation.)
(* Missing documentation.)
Line 5: Line 5:
 
* On the forum Spencer noted;  
 
* On the forum Spencer noted;  
 
''All ugens have a .op parameter, which specifies how they deal with multiple inputs. the default is for the ugen to just add multiple inputs, but specifying 3 for .op will cause the ugen to multiply its inputs together. Since this happens "below the hood" so to speak its a lot better CPU-wise than multiplying in ChucK, with the added benefit of being updated every sample.''
 
''All ugens have a .op parameter, which specifies how they deal with multiple inputs. the default is for the ugen to just add multiple inputs, but specifying 3 for .op will cause the ugen to multiply its inputs together. Since this happens "below the hood" so to speak its a lot better CPU-wise than multiplying in ChucK, with the added benefit of being updated every sample.''
The manual only lists -1, 0 and 1 as options with he full range being being explained at the "Gain" entry.
+
The manual only lists -1, 0 and 1 as options with he full range being being explained at the "Gain" ugen entry.
 +
* The "this" keyword, similar to "me" except with regard to class-instances seems to be undocumented. [http://electro-music.com/forum/viewtopic.php?t=16079 Spencer explains here].
  
 
== * Outdated info. ==
 
== * Outdated info. ==

Revision as of 15:13, 14 February 2007

(add your own requests and contributions!)

* Missing documentation.

  • New interfaces to the Hid device.
  • On the forum Spencer noted;

All ugens have a .op parameter, which specifies how they deal with multiple inputs. the default is for the ugen to just add multiple inputs, but specifying 3 for .op will cause the ugen to multiply its inputs together. Since this happens "below the hood" so to speak its a lot better CPU-wise than multiplying in ChucK, with the added benefit of being updated every sample. The manual only lists -1, 0 and 1 as options with he full range being being explained at the "Gain" ugen entry.

  • The "this" keyword, similar to "me" except with regard to class-instances seems to be undocumented. Spencer explains here.

* Outdated info.

  • From mailing list, original text by Tazumi and Spencer, dec8;

> i have got a question about sending strings with the osc class.. > ist this possible? > The manual says that the osc object has 2 member functions > (addInt / addFloat).. > so is there a way to send (or revieve) other data types?

It seems the manual is out of date in this regard, it is in fact possible to send strings in ChucK's OSC implementation. Just use an "s" for the type specifier and addString to supply the string. getString will retrieve the string on the listener end.

* Suggested clarifications

  • Could somebody please go into what the word "new" means in ChucK, exactly? It's currently mentioned in the manual exactly once (in that sense). It creates a new instance of a object and it's somehow syntactically similar to "!" and that's about it as far as the manual is concerned.
  • The section on getting MIDI input is reportedly hard to understand.
  • "one window ChucK" doesn't work like that on Windows, only on Linux and OSX because the Windows comand line refuses to give you your prompt back. The manual currently implies (on page 18 according to the file's numbering) that this will work on all systems which confuses new Win-based users. Why new users (including me a while ago) flock to a paragraph labeled as optional for hardcore veterans might be a good subject for a thesis on documation writing... "One window ChucK is only for the hardest of hardcore and not possible on a Windows comand line." might do the trick though maybe Cygwin offers a solution?
  • The bottom of page 35 talks about indexing arrays "int-based" (as opossed to the asociative way). Maybe a different wording would be more fortunate, considdering that "int" is also a type of array itself?