HelpSource/Classes/WrapIndex.schelp

   1 class:: WrapIndex
   2 summary:: Index into a table with a signal.
   3 related:: Classes/Index, Classes/Shaper
   4 categories::  UGens>Buffer
   5
   6
   7 Description::
   8
   9 The input signal value is truncated to an integer value and used as an
  10 index into the table. Out-of-range index values are wrapped cyclically to
  11 the valid range.
  12
  13
  14 classmethods::
  15
  16 method::ar, kr
  17
  18 argument::bufnum
  19
  20 Index of the buffer.
  21
  22
  23 argument::in
  24
  25 The input signal.
  26
  27
  28 argument::mul
  29
  30 Output will be multiplied by this value.
  31
  32
  33 argument::add
  34
  35 This value will be added to the output.
  36
  37
  38 Examples::
  39
  40 code::
  41
  42 (
  43 // indexing into a table
  44 s = Server.local;
  45 t = [ 200, 300, 400, 500, 600, 800 ];
  46 b = Buffer(s,t.size,1);
  47
  48 // alloc and set the values
  49 s.listSendMsg( b.allocMsg( b.setnMsg(0, t) ).postln );
  50
  51 SynthDef("help-Index",{ arg out=0,i_bufnum=0;
  52         Out.ar(0,
  53                 SinOsc.ar(
  54                         WrapIndex.kr(
  55                                 i_bufnum,
  56                                 MouseX.kr(0, t.size * 3)
  57                         ),
  58                         0,
  59                         0.5
  60                 )
  61         )
  62 }).play(s,[\i_bufnum,b.bufnum]);
  63
  64 )
  65
  66 ::
  67