History

starting to add skeleton for documentation comments

Matthew Wang committed 6 years ago

Commit e3e22cb1 parent 68a76693 files · +602 −120Browse files

Unified · Split

3 files
  1. TestPlugin/LEAF.jucer +2 −2
  2. leaf/Inc/leaf-filters.h +235 −116
  3. leaf/Inc/leaf-oscillators.h +365 −2
TestPlugin/LEAF.jucer+2−2
@@ -129,9 +129,9 @@ · 128 unmodified lines
129129 <MODULEPATH id="juce_audio_utils" path="../../../../JUCE/modules"/>
130130 </MODULEPATHS>
131131 </XCODE_MAC>
132− <XCODE_IPHONE targetFolder="Builds/iOS" iosScreenOrientation="portraitlandscape"
132+ <XCODE_IPHONE targetFolder="Builds/iOS" iosScreenOrientation="UIInterfaceOrientationPortrait,UIInterfaceOrientationLandscapeLeft,UIInterfaceOrientationLandscapeRight"
133133 iosDevelopmentTeamID="QY96HSP2FJ" microphonePermissionNeeded="1"
134− iosBackgroundAudio="1" iPadScreenOrientation="portraitlandscape"
134+ iosBackgroundAudio="1" iPadScreenOrientation="UIInterfaceOrientationPortrait,UIInterfaceOrientationLandscapeLeft,UIInterfaceOrientationLandscapeRight"
135135 iosDeviceFamily="1,2">
136136 <CONFIGURATIONS>
137137 <CONFIGURATION name="Debug" isDebug="1" optimisation="1" targetName="OOPS" enablePluginBinaryCopyStep="1"/>
leaf/Inc/leaf-filters.h+235−116
@@ -30,7 +30,15 @@ extern "C" { · 29 unmodified lines
3030
3131 //==============================================================================
3232
33− /* tAllpass: Schroeder allpass. Comb-filter with feedforward and feedback. */
33+ /*!
34+ @defgroup tallpass tAllpass
35+ @ingroup filters
36+ @brief Schroeder allpass. Comb-filter with feedforward and feedback.
37+ @{
38+ */
39+
40+ /*! @} */
41+
3442 typedef struct _tAllpass
3543 {
3644 tMempool mempool;
@@ -55,7 +63,15 @@ extern "C" { · 18 unmodified lines
5563
5664 //==============================================================================
5765
58− /* tOnePole: OnePole filter, reimplemented from STK (Cook and Scavone). */
66+ /*!
67+ @defgroup tonepole tOnePole
68+ @ingroup filters
69+ @brief OnePole filter, reimplemented from STK (Cook and Scavone).
70+ @{
71+ */
72+
73+ /*! @} */
74+
5975 typedef struct _tOnePole
6076 {
6177 tMempool mempool;
@@ -81,7 +97,15 @@ extern "C" { · 19 unmodified lines
8197
8298 //==============================================================================
8399
84− /* TwoPole filter, reimplemented from STK (Cook and Scavone). */
100+ /*!
101+ @defgroup ttwopole tTwoPole
102+ @ingroup filters
103+ @brief TwoPole filter, reimplemented from STK (Cook and Scavone).
104+ @{
105+ */
106+
107+ /*! @} */
108+
85109 typedef struct _tTwoPole
86110 {
87111 tMempool mempool;
@@ -92,7 +116,7 @@ extern "C" { · 4 unmodified lines
92116
93117 float radius, frequency;
94118 oBool normalize;
95−
119+
96120 float lastOut[2];
97121 } _tTwoPole;
98122
@@ -112,7 +136,15 @@ extern "C" { · 13 unmodified lines
112136
113137 //==============================================================================
114138
115− /* OneZero filter, reimplemented from STK (Cook and Scavone). */
139+ /*!
140+ @defgroup tonezero tOneZero
141+ @ingroup filters
142+ @brief OneZero filter, reimplemented from STK (Cook and Scavone).
143+ @{
144+ */
145+
146+ /*! @} */
147+
116148 typedef struct _tOneZero
117149 {
118150 tMempool mempool;
@@ -137,7 +169,15 @@ extern "C" { · 18 unmodified lines
137169
138170 //==============================================================================
139171
140− /* TwoZero filter, reimplemented from STK (Cook and Scavone). */
172+ /*!
173+ @defgroup ttwozero tTwoZero
174+ @ingroup filters
175+ @brief TwoZero filter, reimplemented from STK (Cook and Scavone).
176+ @{
177+ */
178+
179+ /*! @} */
180+
141181 typedef struct _tTwoZero
142182 {
143183 tMempool mempool;
@@ -166,7 +206,15 @@ extern "C" { · 22 unmodified lines
166206
167207 //==============================================================================
168208
169− /* PoleZero filter, reimplemented from STK (Cook and Scavone). */
209+ /*!
210+ @defgroup tpolezero tPoleZero
211+ @ingroup filters
212+ @brief PoleZero filter, reimplemented from STK (Cook and Scavone).
213+ @{
214+ */
215+
216+ /*! @} */
217+
170218 typedef struct _tPoleZero
171219 {
172220 tMempool mempool;
@@ -195,7 +243,15 @@ extern "C" { · 22 unmodified lines
195243
196244 //==============================================================================
197245
198− /* BiQuad filter, reimplemented from STK (Cook and Scavone). */
246+ /*!
247+ @defgroup tbiquad tBiQuad
248+ @ingroup filters
249+ @brief BiQuad filter, reimplemented from STK (Cook and Scavone).
250+ @{
251+ */
252+
253+ /*! @} */
254+
199255 typedef struct _tBiQuad
200256 {
201257 tMempool mempool;
@@ -230,7 +286,15 @@ extern "C" { · 28 unmodified lines
230286
231287 //==============================================================================
232288
233−/* State Variable Filter, algorithm from Andy Simper. */
289+ /*!
290+ @defgroup tsvf tSVF
291+ @ingroup filters
292+ @brief State Variable Filter, algorithm from Andy Simper.
293+ @{
294+ */
295+
296+ /*! @} */
297+
234298 typedef enum SVFType
235299 {
236300 SVFTypeHighpass = 0,
@@ -263,7 +327,15 @@ extern "C" { · 26 unmodified lines
263327 void tSVF_setFreqAndQ (tSVF* const svff, float freq, float Q);
264328 //==============================================================================
265329
266− /* Efficient State Variable Filter for 14-bit control input, [0, 4096). */
330+ /*!
331+ @defgroup tefficientsvf tEfficientSVF
332+ @ingroup filters
333+ @brief Efficient State Variable Filter for 14-bit control input, [0, 4096).
334+ @{
335+ */
336+
337+ /*! @} */
338+
267339 typedef struct _tEfficientSVF
268340 {
269341 tMempool mempool;
@@ -285,7 +357,15 @@ extern "C" { · 15 unmodified lines
285357
286358 //==============================================================================
287359
288− /* Simple Highpass filter. */
360+ /*!
361+ @defgroup thighpass tHighpass
362+ @ingroup filters
363+ @brief Simple Highpass filter.
364+ @{
365+ */
366+
367+ /*! @} */
368+
289369 typedef struct _tHighpass
290370 {
291371 tMempool mempool;
@@ -305,7 +385,15 @@ extern "C" { · 13 unmodified lines
305385
306386 //==============================================================================
307387
308− // Butterworth Filter
388+ /*!
389+ @defgroup tbutterworth tButterworth
390+ @ingroup filters
391+ @brief
392+ @{
393+ */
394+
395+ /*! @} */
396+
309397 #define NUM_SVF_BW 16
310398 typedef struct _tButterworth
311399 {
@@ -334,6 +422,15 @@ extern "C" { · 22 unmodified lines
334422
335423 //==============================================================================
336424
425+ /*!
426+ @defgroup tfir tFIR
427+ @ingroup filters
428+ @brief
429+ @{
430+ */
431+
432+ /*! @} */
433+
337434 typedef struct _tFIR
338435 {
339436 tMempool mempool;
@@ -349,125 +446,146 @@ extern "C" { · 9 unmodified lines
349446 void tFIR_free (tFIR* const);
350447
351448 float tFIR_tick (tFIR* const, float input);
352−
449+
353450
354451 //==============================================================================
355452
356−
453+ /*!
454+ @defgroup tmedianfilter tMedianFilter
455+ @ingroup filters
456+ @brief
457+ @{
458+ */
459+
460+ /*! @} */
461+
357462 typedef struct _tMedianFilter
358463 {
359464 tMempool mempool;
360− float* val;
361− int* age;
362− int m;
363− int size;
364− int middlePosition;
365− int last;
366− int pos;
465+ float* val;
466+ int* age;
467+ int m;
468+ int size;
469+ int middlePosition;
470+ int last;
471+ int pos;
367472 } _tMedianFilter;
368−
473+
369474 typedef _tMedianFilter* tMedianFilter;
370−
475+
371476 void tMedianFilter_init (tMedianFilter* const, int size);
372− void tMedianFilter_initToPool (tMedianFilter* const, int size, tMempool* const);
373− void tMedianFilter_free (tMedianFilter* const);
374−
375− float tMedianFilter_tick (tMedianFilter* const, float input);
376−
377−
378−
379−
380−
381− //Vadim Zavalishin style from VA book (from implementation in RSlib posted to kvr forum)
382−
477+ void tMedianFilter_initToPool (tMedianFilter* const, int size, tMempool* const);
478+ void tMedianFilter_free (tMedianFilter* const);
479+
480+ float tMedianFilter_tick (tMedianFilter* const, float input);
481+
482+
483+ /*!
484+ @defgroup tvzfilter tVZFilter
485+ @ingroup filters
486+ @brief
487+ @{
488+ */
489+
490+ /*! @} */
491+
492+ //Vadim Zavalishin style from VA book (from implementation in RSlib posted to kvr forum)
493+
383494 typedef enum VZFilterType
384495 {
385− Highpass = 0,
496+ Highpass = 0,
386497 Lowpass,
387498 BandpassSkirt,
388− BandpassPeak,
389− BandReject,
499+ BandpassPeak,
500+ BandReject,
390501 Bell,
391− Lowshelf,
392− Highshelf,
393− Morph,
394− Bypass,
395− Allpass
502+ Lowshelf,
503+ Highshelf,
504+ Morph,
505+ Bypass,
506+ Allpass
396507 } VZFilterType;
397−
398−
399− typedef struct _tVZFilter
400− {
401− tMempool mempool;
402−
403− VZFilterType type;
404− // state:
405− float s1, s2;
406−
407− // filter coefficients:
408− float g; // embedded integrator gain
409− float R2; // twice the damping coefficient (R2 == 2*R == 1/Q)
410− float h; // factor for feedback (== 1/(1+2*R*g+g*g))
411− float cL, cB, cH; // coefficients for low-, band-, and highpass signals
412−
413− // parameters:
414− float fc; // characteristic frequency
415− float G; // gain
416− float invG; //1/gain
417− float B; // bandwidth (in octaves)
418− float m; // morph parameter (0...1)
419−
420− float sr; //local sampling rate of filter (may be different from leaf sr if oversampled)
421− float inv_sr;
422− } _tVZFilter;
423−
424− typedef _tVZFilter* tVZFilter;
425−
426− void tVZFilter_init (tVZFilter* const, VZFilterType type, float freq, float Q);
427− void tVZFilter_initToPool (tVZFilter* const, VZFilterType type, float freq, float Q, tMempool* const);
428− void tVZFilter_free (tVZFilter* const);
429−
430− void tVZFilter_setSampleRate (tVZFilter* const, float sampleRate);
431− float tVZFilter_tick (tVZFilter* const, float input);
432− float tVZFilter_tickEfficient (tVZFilter* const vf, float in);
433− void tVZFilter_calcCoeffs (tVZFilter* const);
434− void tVZFilter_setBandwidth (tVZFilter* const, float bandWidth);
435− void tVZFilter_setFreq (tVZFilter* const, float freq);
436− void tVZFilter_setFreqAndBandwidth (tVZFilter* const vf, float freq, float bw);
437− void tVZFilter_setGain (tVZFilter* const, float gain);
438− void tVZFilter_setType (tVZFilter* const, VZFilterType type);
439− float tVZFilter_BandwidthToR (tVZFilter* const vf, float B);
440−
441−
442−
443−
444− //diode ladder filter
445− typedef struct _tDiodeFilter
446− {
447− tMempool mempool;
448− float f;
449− float r;
450− float Vt;
451− float n;
452− float gamma;
453− float zi;
454− float g0inv;
455− float g1inv;
456− float g2inv;
457− float s0, s1, s2, s3;
458− } _tDiodeFilter;
459−
460− typedef _tDiodeFilter* tDiodeFilter;
461−
462− void tDiodeFilter_init (tDiodeFilter* const, float freq, float Q);
463− void tDiodeFilter_initToPool (tDiodeFilter* const, float freq, float Q, tMempool* const);
464− void tDiodeFilter_free (tDiodeFilter* const);
465−
466− float tDiodeFilter_tick (tDiodeFilter* const, float input);
467− void tDiodeFilter_setFreq (tDiodeFilter* const vf, float cutoff);
468− void tDiodeFilter_setQ (tDiodeFilter* const vf, float resonance);
469−
470−
508+
509+
510+ typedef struct _tVZFilter
511+ {
512+ tMempool mempool;
513+
514+ VZFilterType type;
515+ // state:
516+ float s1, s2;
517+
518+ // filter coefficients:
519+ float g; // embedded integrator gain
520+ float R2; // twice the damping coefficient (R2 == 2*R == 1/Q)
521+ float h; // factor for feedback (== 1/(1+2*R*g+g*g))
522+ float cL, cB, cH; // coefficients for low-, band-, and highpass signals
523+
524+ // parameters:
525+ float fc; // characteristic frequency
526+ float G; // gain
527+ float invG; //1/gain
528+ float B; // bandwidth (in octaves)
529+ float m; // morph parameter (0...1)
530+
531+ float sr; //local sampling rate of filter (may be different from leaf sr if oversampled)
532+ float inv_sr;
533+ } _tVZFilter;
534+
535+ typedef _tVZFilter* tVZFilter;
536+
537+ void tVZFilter_init (tVZFilter* const, VZFilterType type, float freq, float Q);
538+ void tVZFilter_initToPool (tVZFilter* const, VZFilterType type, float freq, float Q, tMempool* const);
539+ void tVZFilter_free (tVZFilter* const);
540+
541+ void tVZFilter_setSampleRate (tVZFilter* const, float sampleRate);
542+ float tVZFilter_tick (tVZFilter* const, float input);
543+ float tVZFilter_tickEfficient (tVZFilter* const vf, float in);
544+ void tVZFilter_calcCoeffs (tVZFilter* const);
545+ void tVZFilter_setBandwidth (tVZFilter* const, float bandWidth);
546+ void tVZFilter_setFreq (tVZFilter* const, float freq);
547+ void tVZFilter_setFreqAndBandwidth (tVZFilter* const vf, float freq, float bw);
548+ void tVZFilter_setGain (tVZFilter* const, float gain);
549+ void tVZFilter_setType (tVZFilter* const, VZFilterType type);
550+ float tVZFilter_BandwidthToR (tVZFilter* const vf, float B);
551+
552+
553+ /*!
554+ @defgroup tdiodefilter tDiodeFilter
555+ @ingroup filters
556+ @brief
557+ @{
558+ */
559+
560+ /*! @} */
561+
562+ //diode ladder filter
563+ typedef struct _tDiodeFilter
564+ {
565+ tMempool mempool;
566+ float f;
567+ float r;
568+ float Vt;
569+ float n;
570+ float gamma;
571+ float zi;
572+ float g0inv;
573+ float g1inv;
574+ float g2inv;
575+ float s0, s1, s2, s3;
576+ } _tDiodeFilter;
577+
578+ typedef _tDiodeFilter* tDiodeFilter;
579+
580+ void tDiodeFilter_init (tDiodeFilter* const, float freq, float Q);
581+ void tDiodeFilter_initToPool (tDiodeFilter* const, float freq, float Q, tMempool* const);
582+ void tDiodeFilter_free (tDiodeFilter* const);
583+
584+ float tDiodeFilter_tick (tDiodeFilter* const, float input);
585+ void tDiodeFilter_setFreq (tDiodeFilter* const vf, float cutoff);
586+ void tDiodeFilter_setQ (tDiodeFilter* const vf, float resonance);
587+
588+
471589 #ifdef __cplusplus
472590 }
473591 #endif
@@ -476,3 +594,4 @@ extern "C" { · 2 unmodified lines
476594
477595 //==============================================================================
478596
597+
leaf/Inc/leaf-oscillators.h+365−2
@@ -303,6 +303,51 @@ extern "C" { · 302 unmodified lines
303303 void tSine_setFreq (tSine* const osc, float freq);
304304
305305 //==============================================================================
306+
307+ /*!
308+ @defgroup ttri tTri
309+ @ingroup oscillators
310+ @brief
311+ @{
312+ */
313+
314+ /*!
315+ @fn void tTri_init (tTri* const osc)
316+ @brief
317+ @param
318+ */
319+
320+ /*!
321+ @fn void tTri_initToPool (tTri* const osc, tMempool* const pool)
322+ @brief
323+ @param
324+ */
325+
326+ /*!
327+ @fn void tTri_free (tTri* const osc)
328+ @brief
329+ @param
330+ */
331+
332+ /*!
333+ @fn float tTri_tick (tTri* const osc)
334+ @brief
335+ @param
336+ */
337+
338+ /*!
339+ @fn void tTri_setFreq (tTri* const osc, float freq)
340+ @brief
341+ @param
342+ */
343+
344+ /*!
345+ @fn void tTri_setSkew (tTri* const osc, float skew)
346+ @brief
347+ @param
348+ */
349+
350+ /*! @} */
306351
307352 typedef struct _tTri
308353 {
@@ -323,10 +368,53 @@ extern "C" { · 14 unmodified lines
323368 void tTri_setFreq (tTri* const osc, float freq);
324369 void tTri_setSkew (tTri* const osc, float skew);
325370
326− /*! @} */
327−
328371 //==============================================================================
329372
373+ /*!
374+ @defgroup tpulse tPulse
375+ @ingroup oscillators
376+ @brief
377+ @{
378+ */
379+
380+ /*!
381+ @fn void tPulse_init (tPulse* const osc)
382+ @brief
383+ @param
384+ */
385+
386+ /*!
387+ @fn void tPulse_initToPool (tPulse* const osc, tMempool* const)
388+ @brief
389+ @param
390+ */
391+
392+ /*!
393+ @fn void tPulse_free (tPulse* const osc)
394+ @brief
395+ @param
396+ */
397+
398+ /*!
399+ @fn float tPulse_tick (tPulse* const osc)
400+ @brief
401+ @param
402+ */
403+
404+ /*!
405+ @fn void tPulse_setFreq (tPulse* const osc, float freq)
406+ @brief
407+ @param
408+ */
409+
410+ /*!
411+ @fn void tPulse_setWidth (tPulse* const osc, float width)
412+ @brief
413+ @param
414+ */
415+
416+ /*! @} */
417+
330418 typedef struct _tPulse
331419 {
332420 tMempool mempool;
@@ -347,6 +435,45 @@ extern "C" { · 14 unmodified lines
347435
348436 //==============================================================================
349437
438+ /*!
439+ @defgroup tsaw tSaw
440+ @ingroup oscillators
441+ @brief
442+ @{
443+ */
444+
445+ /*!
446+ @fn void tSaw_init (tSaw* const osc)
447+ @brief
448+ @param
449+ */
450+
451+ /*!
452+ @fn void tSaw_initToPool (tSaw* const osc, tMempool* const pool)
453+ @brief
454+ @param
455+ */
456+
457+ /*!
458+ @fn void tSaw_free (tSaw* const osc)
459+ @brief
460+ @param
461+ */
462+
463+ /*!
464+ @fn float tSaw_tick (tSaw* const osc)
465+ @brief
466+ @param
467+ */
468+
469+ /*!
470+ @fn void tSaw_setFreq (tSaw* const osc, float freq)
471+ @brief
472+ @param
473+ */
474+
475+ /*! @} */
476+
350477 typedef struct _tSaw
351478 {
352479 tMempool mempool;
@@ -365,6 +492,45 @@ extern "C" { · 12 unmodified lines
365492
366493 //==============================================================================
367494
495+ /*!
496+ @defgroup tphasor tPhasor
497+ @ingroup oscillators
498+ @brief
499+ @{
500+ */
501+
502+ /*!
503+ @fn void tPhasor_init (tPhasor* const osc)
504+ @brief
505+ @param
506+ */
507+
508+ /*!
509+ @fn void tPhasor_initToPool (tPhasor* const osc, tMempool* const)
510+ @brief
511+ @param
512+ */
513+
514+ /*!
515+ @fn void tPhasor_free (tPhasor* const osc)
516+ @brief
517+ @param
518+ */
519+
520+ /*!
521+ @fn float tPhasor_tick (tPhasor* const osc)
522+ @brief
523+ @param
524+ */
525+
526+ /*!
527+ @fn void tPhasor_setFreq (tPhasor* const osc, float freq)
528+ @brief
529+ @param
530+ */
531+
532+ /*! @} */
533+
368534 typedef struct _tPhasor
369535 {
370536 tMempool mempool;
@@ -384,6 +550,37 @@ extern "C" { · 13 unmodified lines
384550
385551 //==============================================================================
386552
553+ /*!
554+ @defgroup tnoise tNoise
555+ @ingroup oscillators
556+ @brief
557+ @{
558+ */
559+
560+ /*!
561+ @fn void tNoise_init (tNoise* const noise, NoiseType type)
562+ @brief
563+ @param
564+ */
565+
566+ /*!
567+ @fn void tNoise_initToPool (tNoise* const noise, NoiseType type, tMempool* const)
568+ @brief
569+ @param
570+ */
571+
572+ /*!
573+ @fn void tNoise_free (tNoise* const noise)
574+ @brief
575+ @param
576+ */
577+
578+ /*!
579+ @fn float tNoise_tick (tNoise* const noise)
580+ @brief
581+ @param
582+ */
583+
387584 /* tNoise. WhiteNoise, PinkNoise. */
388585 /*!
389586 * Noise types
@@ -395,6 +592,8 @@ extern "C" { · 5 unmodified lines
395592 NoiseTypeNil,
396593 };
397594
595+ /*! @} */
596+
398597 typedef enum NoiseType NoiseType;
399598
400599 typedef struct _tNoise
@@ -581,8 +780,66 @@ extern "C" { · 180 unmodified lines
581780
582781 //==============================================================================
583782
783+
584784 #define FILLEN 256
585785
786+ /*!
787+ @defgroup tmbpulse tMBPulse
788+ @ingroup oscillators
789+ @brief
790+ @{
791+ */
792+
793+ /*!
794+ @fn void tMBPulse_init(tMBPulse* const osc)
795+ @brief
796+ @param
797+ */
798+
799+ /*!
800+ @fn void tMBPulse_initToPool(tMBPulse* const osc, tMempool* const pool)
801+ @brief
802+ @param
803+ */
804+
805+ /*!
806+ @fn void tMBPulse_free(tMBPulse* const osc)
807+ @brief
808+ @param
809+ */
810+
811+ /*!
812+ @fn float tMBPulse_tick(tMBPulse* const osc)
813+ @brief
814+ @param
815+ */
816+
817+ /*!
818+ @fn void tMBPulse_setFreq(tMBPulse* const osc, float f)
819+ @brief
820+ @param
821+ */
822+
823+ /*!
824+ @fn void tMBPulse_setWidth(tMBPulse* const osc, float w)
825+ @brief
826+ @param
827+ */
828+
829+ /*!
830+ @fn void tMBPulse_syncIn(tMBPulse* const osc, float sync)
831+ @brief
832+ @param
833+ */
834+
835+ /*!
836+ @fn float tMBPulse_syncOut(tMBPulse* const osc)
837+ @brief
838+ @param
839+ */
840+
841+ /*! @} */
842+
586843 typedef struct _tMBPulse
587844 {
588845 tMempool mempool;
@@ -611,6 +868,62 @@ extern "C" { · 22 unmodified lines
611868 void tMBPulse_syncIn(tMBPulse* const osc, float sync);
612869 float tMBPulse_syncOut(tMBPulse* const osc);
613870
871+ /*!
872+ @defgroup tmbtriangle tMBTriangle
873+ @ingroup oscillators
874+ @brief
875+ @{
876+ */
877+
878+ /*!
879+ @fn void tMBTriangle_init(tMBTriangle* const osc)
880+ @brief
881+ @param
882+ */
883+
884+ /*!
885+ @fn void tMBTriangle_initToPool(tMBTriangle* const osc, tMempool* const pool)
886+ @brief
887+ @param
888+ */
889+
890+ /*!
891+ @fn void tMBTriangle_free(tMBTriangle* const osc)
892+ @brief
893+ @param
894+ */
895+
896+ /*!
897+ @fn float tMBTriangle_tick(tMBTriangle* const osc)
898+ @brief
899+ @param
900+ */
901+
902+ /*!
903+ @fn void tMBTriangle_setFreq(tMBTriangle* const osc, float f)
904+ @brief
905+ @param
906+ */
907+
908+ /*!
909+ @fn void tMBTriangle_setWidth(tMBTriangle* const osc, float w)
910+ @brief
911+ @param
912+ */
913+
914+ /*!
915+ @fn void tMBTriangle_syncIn(tMBTriangle* const osc, float sync)
916+ @brief
917+ @param
918+ */
919+
920+ /*!
921+ @fn float tMBTriangle_syncOut(tMBTriangle* const osc)
922+ @brief
923+ @param
924+ */
925+
926+ /*! @} */
614927
615928 typedef struct _tMBTriangle
616929 {
@@ -641,6 +954,56 @@ extern "C" { · 24 unmodified lines
641954 float tMBTriangle_syncOut(tMBTriangle* const osc);
642955
643956
957+ /*!
958+ @defgroup tmbsaw tMBSaw
959+ @ingroup oscillators
960+ @brief
961+ @{
962+ */
963+
964+ /*!
965+ @fn void tMBSaw_init(tMBSaw* const osc)
966+ @brief
967+ @param
968+ */
969+
970+ /*!
971+ @fn void tMBSaw_initToPool(tMBSaw* const osc, tMempool* const pool)
972+ @brief
973+ @param
974+ */
975+
976+ /*!
977+ @fn void tMBSaw_free(tMBSaw* const osc)
978+ @brief
979+ @param
980+ */
981+
982+ /*!
983+ @fn float tMBSaw_tick(tMBSaw* const osc)
984+ @brief
985+ @param
986+ */
987+
988+ /*!
989+ @fn void tMBSaw_setFreq(tMBSaw* const osc, float f)
990+ @brief
991+ @param
992+ */
993+
994+ /*!
995+ @fn void tMBSaw_syncIn(tMBSaw* const osc, float sync)
996+ @brief
997+ @param
998+ */
999+
1000+ /*!
1001+ @fn float tMBSaw_syncOut(tMBSaw* const osc)
1002+ @brief
1003+ @param
1004+ */
1005+
1006+ /*! @} */
6441007
6451008 typedef struct _tMBSaw
6461009 {

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t