-
Notifications
You must be signed in to change notification settings - Fork 6
Expand file tree
/
Copy pathreference.html
More file actions
1570 lines (1465 loc) · 54.8 KB
/
reference.html
File metadata and controls
1570 lines (1465 loc) · 54.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Object Reference — plugdata</title>
<meta name="description" content="Searchable reference documentation for every Pure Data object included with plugdata — ELSE, Cyclone, Gem, heavylib, pdlua, plugdata and vanilla." />
<link rel="icon" href="assets/plugdata-logo.png" type="image/png" />
<meta property="og:title" content="Object Reference — plugdata" />
<meta property="og:description" content="Searchable reference documentation for every Pure Data object included with plugdata." />
<meta property="og:type" content="website" />
<link rel="preconnect" href="https://fonts.googleapis.com" />
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@300;400;500;600;700&family=JetBrains+Mono:wght@400;500;600&display=swap" rel="stylesheet" />
<link rel="stylesheet" href="styles.css" />
<!-- Reference page specific styles (extending styles.css) -->
<style>
/* ===== Search + toolbar ===== */
.ref-toolbar {
position: sticky;
top: 3.5rem;
z-index: 20;
background: hsl(var(--background) / 0.9);
backdrop-filter: blur(8px);
-webkit-backdrop-filter: blur(8px);
border-bottom: 1px solid hsl(var(--border));
padding: 1rem 0;
}
.ref-search {
position: relative;
display: flex;
align-items: center;
}
.ref-search svg.icon-search {
position: absolute;
left: 1rem;
width: 1rem;
height: 1rem;
color: hsl(var(--muted-foreground));
pointer-events: none;
}
.ref-search input {
flex: 1;
width: 100%;
height: 2.75rem;
padding: 0 2.75rem 0 2.75rem;
border: 1px solid hsl(var(--border));
border-radius: 9999px;
background: hsl(var(--card));
color: hsl(var(--foreground));
font: inherit;
font-size: 0.9375rem;
outline: none;
transition: border-color 0.15s, box-shadow 0.15s;
}
.ref-search input:focus {
border-color: hsl(var(--primary));
box-shadow: 0 0 0 3px hsl(var(--primary) / 0.12);
}
.ref-search .clear {
position: absolute;
right: 0.5rem;
width: 1.75rem;
height: 1.75rem;
border-radius: 9999px;
display: inline-flex;
align-items: center;
justify-content: center;
color: hsl(var(--muted-foreground));
}
.ref-search .clear:hover {
background: hsl(var(--secondary));
color: hsl(var(--foreground));
}
.ref-search .kbd {
position: absolute;
right: 1rem;
font-family: var(--font-mono);
font-size: 11px;
color: hsl(var(--muted-foreground));
background: hsl(var(--secondary));
border: 1px solid hsl(var(--border));
padding: 1px 6px;
border-radius: 4px;
pointer-events: none;
}
.ref-filters {
margin-top: 0.75rem;
display: flex;
gap: 0.375rem;
flex-wrap: wrap;
align-items: center;
}
.ref-chip {
display: inline-flex;
align-items: center;
gap: 0.375rem;
height: 2rem;
padding: 0 0.875rem;
border: 1px solid hsl(var(--border));
border-radius: 9999px;
background: hsl(var(--card));
color: hsl(var(--muted-foreground));
font-size: 0.8125rem;
font-weight: 500;
cursor: pointer;
transition: background 0.15s, color 0.15s, border-color 0.15s;
white-space: nowrap;
}
.ref-chip:hover {
color: hsl(var(--foreground));
border-color: hsl(var(--foreground) / 0.25);
}
.ref-chip.active {
background: hsl(var(--foreground));
color: hsl(var(--background));
border-color: hsl(var(--foreground));
}
.ref-chip .count {
font-family: var(--font-mono);
font-size: 11px;
opacity: 0.7;
}
.ref-status {
margin-top: 0.75rem;
font-size: 0.8125rem;
color: hsl(var(--muted-foreground));
font-family: var(--font-mono);
}
/* ===== Filters toggle + panel ===== */
.ref-filters .filters-toggle {
gap: 0.375rem;
}
.ref-filters .filters-toggle .chev {
width: 11px;
height: 11px;
transition: transform 0.15s;
}
.ref-filters .filters-toggle[aria-expanded="true"] .chev {
transform: rotate(180deg);
}
.ref-filters .filters-toggle.has-active {
color: hsl(var(--foreground));
border-color: hsl(var(--foreground) / 0.35);
background: hsl(var(--secondary));
}
.ref-filters .filters-toggle.has-active .count {
background: hsl(var(--foreground));
color: hsl(var(--background));
padding: 0 5px;
border-radius: 9999px;
opacity: 1;
min-width: 16px;
text-align: center;
}
.ref-filter-panel {
margin-top: 0.75rem;
padding: 1rem 1.125rem 1.125rem;
background: hsl(var(--card));
border: 1px solid hsl(var(--border));
border-radius: 0.625rem;
display: flex;
flex-direction: column;
gap: 1.125rem;
box-shadow: var(--shadow-soft);
}
.ref-fp-section {
display: flex;
flex-direction: column;
gap: 0.5rem;
}
.ref-fp-label {
display: flex;
align-items: baseline;
gap: 0.5rem;
font-size: 11px;
font-weight: 500;
text-transform: uppercase;
letter-spacing: 0.14em;
color: hsl(var(--muted-foreground));
}
.ref-fp-label .ref-loading {
text-transform: none;
letter-spacing: 0;
font-size: 11px;
}
.ref-fp-chips {
display: flex;
flex-wrap: wrap;
gap: 0.375rem;
align-items: center;
}
.ref-fp-hint {
font-size: 0.8125rem;
color: hsl(var(--muted-foreground));
font-family: var(--font-mono);
padding: 0.25rem 0;
}
.ref-fp-actions {
display: flex;
gap: 0.5rem;
padding-top: 0.5rem;
border-top: 1px solid hsl(var(--border));
}
.ref-fp-clear {
font-size: 0.8125rem;
color: hsl(var(--muted-foreground));
padding: 0.25rem 0.625rem;
border-radius: 0.25rem;
font-family: inherit;
transition: background 0.12s, color 0.12s;
}
.ref-fp-clear:hover {
color: hsl(var(--foreground));
background: hsl(var(--secondary));
}
.ref-chip .swatch {
display: inline-block;
width: 8px;
height: 8px;
border-radius: 2px;
margin-right: 0.125rem;
}
/* ===== Object list ===== */
.ref-main {
padding: 2rem 0 5rem;
}
.ref-list {
display: grid;
grid-template-columns: 1fr;
gap: 1px;
background: hsl(var(--border));
border: 1px solid hsl(var(--border));
border-radius: 0.75rem;
overflow: hidden;
}
@media (min-width: 640px) {
.ref-list { grid-template-columns: repeat(2, 1fr); }
}
@media (min-width: 1024px) {
.ref-list { grid-template-columns: repeat(3, 1fr); }
}
.ref-card {
background: hsl(var(--card));
padding: 1.125rem 1.25rem;
cursor: pointer;
display: flex;
flex-direction: column;
gap: 0.375rem;
transition: background 0.12s;
text-align: left;
width: 100%;
border: 0;
font-family: inherit;
min-height: 5rem;
}
.ref-card:hover {
background: hsl(var(--secondary) / 0.6);
}
.ref-card .row {
display: flex;
align-items: center;
justify-content: space-between;
gap: 0.75rem;
}
.ref-card .name {
font-family: var(--font-mono);
font-size: 0.9375rem;
font-weight: 600;
color: hsl(var(--foreground));
letter-spacing: -0.01em;
word-break: break-all;
}
.ref-card .origin {
font-family: var(--font-mono);
font-size: 10px;
text-transform: uppercase;
letter-spacing: 0.08em;
color: hsl(var(--muted-foreground));
padding: 2px 6px;
border: 1px solid hsl(var(--border));
border-radius: 3px;
flex-shrink: 0;
}
.ref-card .desc {
font-size: 0.8125rem;
color: hsl(var(--muted-foreground));
line-height: 1.5;
display: -webkit-box;
-webkit-line-clamp: 2;
-webkit-box-orient: vertical;
overflow: hidden;
}
.ref-card .desc:empty {
display: none;
}
.ref-empty {
padding: 4rem 1rem;
text-align: center;
color: hsl(var(--muted-foreground));
}
.ref-empty h3 {
font-size: 1.125rem;
color: hsl(var(--foreground));
margin-bottom: 0.5rem;
}
.ref-empty p {
font-size: 0.9375rem;
max-width: 28rem;
margin: 0 auto;
}
.ref-loading {
display: inline-flex;
align-items: center;
gap: 0.5rem;
font-family: var(--font-mono);
font-size: 0.75rem;
color: hsl(var(--muted-foreground));
}
.ref-spinner {
width: 12px;
height: 12px;
border: 1.5px solid hsl(var(--border));
border-top-color: hsl(var(--foreground));
border-radius: 50%;
animation: spin 0.8s linear infinite;
}
@keyframes spin { to { transform: rotate(360deg); } }
/* ===== Detail view ===== */
.ref-detail {
padding: 3rem 0 5rem;
}
.ref-detail .back {
display: inline-flex;
align-items: center;
gap: 0.375rem;
font-size: 0.875rem;
color: hsl(var(--muted-foreground));
padding: 0.375rem 0.625rem;
margin-left: -0.625rem;
border-radius: 0.375rem;
margin-bottom: 2rem;
transition: background 0.12s, color 0.12s;
}
.ref-detail .back:hover {
background: hsl(var(--secondary));
color: hsl(var(--foreground));
}
.ref-detail .meta {
display: flex;
align-items: center;
gap: 0.5rem;
flex-wrap: wrap;
margin-bottom: 1rem;
}
.ref-detail h1 {
font-family: var(--font-mono);
font-size: clamp(2rem, 4vw + 1rem, 3rem);
font-weight: 600;
letter-spacing: -0.02em;
line-height: 1;
word-break: break-all;
margin-bottom: 0.75rem;
}
.ref-detail h1 .brackets {
color: hsl(var(--muted-foreground) / 0.45);
font-weight: 400;
}
.ref-detail .tagline {
font-size: 1.125rem;
color: hsl(var(--muted-foreground));
max-width: 40rem;
line-height: 1.5;
}
.ref-detail .aliases {
margin-top: 0.75rem;
font-size: 0.875rem;
color: hsl(var(--muted-foreground));
}
.ref-detail .aliases code {
font-family: var(--font-mono);
background: hsl(var(--secondary));
border: 1px solid hsl(var(--border));
padding: 1px 6px;
border-radius: 3px;
font-size: 0.8125rem;
margin: 0 0.125rem;
color: hsl(var(--foreground));
}
.ref-object-viz {
margin: 2.5rem 0;
padding: 2rem;
border: 1px solid hsl(var(--border));
background: hsl(var(--card));
border-radius: 0.75rem;
background-image: radial-gradient(hsl(var(--grid-dot)) 1px, transparent 1px);
background-size: 22px 22px;
background-position: -1px -1px;
display: flex;
align-items: center;
justify-content: center;
min-height: 11rem;
}
.ref-sections {
display: grid;
grid-template-columns: 1fr;
gap: 2.5rem;
margin-top: 3rem;
}
@media (min-width: 900px) {
.ref-sections { grid-template-columns: 2fr 3fr; gap: 3rem; }
.ref-sections .full { grid-column: 1 / -1; }
}
.ref-sec {
min-width: 0;
}
.ref-sec h2 {
font-size: 0.75rem;
font-weight: 500;
text-transform: uppercase;
letter-spacing: 0.14em;
color: hsl(var(--muted-foreground));
margin-bottom: 1rem;
padding-bottom: 0.75rem;
border-bottom: 1px solid hsl(var(--border));
}
.ref-sec .body {
font-size: 0.9375rem;
line-height: 1.7;
color: hsl(var(--foreground));
white-space: pre-wrap;
}
.ref-sec .body code, .ref-sec .body .obj-link {
font-family: var(--font-mono);
background: hsl(var(--secondary));
border: 1px solid hsl(var(--border));
padding: 1px 5px;
border-radius: 3px;
font-size: 0.875em;
color: hsl(var(--foreground));
white-space: nowrap;
}
.ref-sec .body .obj-link {
cursor: pointer;
transition: background 0.12s, border-color 0.12s, color 0.12s;
}
.ref-sec .body .obj-link:hover {
background: hsl(var(--primary-soft));
border-color: hsl(var(--primary) / 0.4);
color: hsl(var(--primary));
}
.ref-table {
width: 100%;
border-collapse: collapse;
font-size: 0.875rem;
}
.ref-table th, .ref-table td {
text-align: left;
padding: 0.75rem 0.875rem;
border-bottom: 1px solid hsl(var(--border));
vertical-align: top;
}
.ref-table th {
font-size: 11px;
font-weight: 500;
text-transform: uppercase;
letter-spacing: 0.1em;
color: hsl(var(--muted-foreground));
background: hsl(var(--secondary) / 0.5);
}
.ref-table tr:last-child td { border-bottom: 0; }
.ref-table td code, .ref-table .mono {
font-family: var(--font-mono);
font-size: 0.8125rem;
color: hsl(var(--primary));
}
.ref-table-wrap {
border: 1px solid hsl(var(--border));
border-radius: 0.5rem;
overflow: hidden;
background: hsl(var(--card));
}
.ref-io {
display: flex;
flex-direction: column;
gap: 1rem;
}
.ref-io-port {
border: 1px solid hsl(var(--border));
border-radius: 0.5rem;
padding: 0.875rem 1rem;
background: hsl(var(--card));
}
.ref-io-port .title {
display: flex;
align-items: center;
gap: 0.5rem;
margin-bottom: 0.625rem;
font-family: var(--font-mono);
font-size: 0.75rem;
color: hsl(var(--muted-foreground));
text-transform: uppercase;
letter-spacing: 0.08em;
}
.ref-io-port .title .num {
display: inline-flex;
align-items: center;
justify-content: center;
width: 1.25rem;
height: 1.25rem;
background: hsl(var(--foreground));
color: hsl(var(--background));
border-radius: 3px;
font-weight: 600;
font-size: 10px;
}
.ref-io-port ul {
display: flex;
flex-direction: column;
gap: 0.5rem;
}
.ref-io-port li {
display: grid;
grid-template-columns: auto 1fr;
gap: 0.75rem;
align-items: baseline;
font-size: 0.875rem;
line-height: 1.6;
}
.ref-io-port li .msg-type {
font-family: var(--font-mono);
font-size: 0.8125rem;
color: hsl(var(--primary));
background: hsl(var(--primary-soft));
padding: 1px 6px;
border-radius: 3px;
white-space: nowrap;
}
.ref-footer {
margin-top: 4rem;
padding-top: 2rem;
border-top: 1px solid hsl(var(--border));
display: flex;
gap: 0.75rem;
flex-wrap: wrap;
}
/* Origin color accents */
.origin-ELSE { color: hsl(22 92% 54%); border-color: hsl(22 92% 54% / 0.3); background: hsl(22 92% 96%); }
.origin-cyclone { color: hsl(212 90% 48%); border-color: hsl(212 90% 48% / 0.3); background: hsl(212 90% 96%); }
.origin-vanilla { color: hsl(160 60% 35%); border-color: hsl(160 60% 35% / 0.3); background: hsl(160 60% 95%); }
.origin-Gem { color: hsl(280 60% 50%); border-color: hsl(280 60% 50% / 0.3); background: hsl(280 60% 96%); }
.origin-heavylib { color: hsl(340 70% 50%); border-color: hsl(340 70% 50% / 0.3); background: hsl(340 70% 96%); }
.origin-pdlua { color: hsl(200 70% 45%); border-color: hsl(200 70% 45% / 0.3); background: hsl(200 70% 96%); }
.origin-plugdata { color: hsl(48 80% 40%); border-color: hsl(48 80% 40% / 0.3); background: hsl(48 80% 96%); }
/* hidden state */
[hidden] { display: none !important; }
/* Reduce page-hero bottom for this page */
.page-hero.compact .inner { padding: 3rem 0 1.5rem; }
</style>
</head>
<body>
<!-- ===== Header ===== -->
<header class="site-header">
<div class="container">
<div class="bar">
<a href="index.html" class="brand">
<img src="assets/plugdata-logo.png" alt="" />
<span>plugdata</span>
</a>
<nav class="nav" aria-label="Primary">
<a href="index.html">Home</a>
<a href="about.html">About</a>
<a href="download.html">Download</a>
<a href="documentation.html">Documentation</a>
<a href="support.html">Support</a>
<a href="store.html">Store</a>
</nav>
<div class="icon-links">
<a class="icon-btn" href="https://github.com/plugdata-team/plugdata" target="_blank" rel="noreferrer" aria-label="GitHub">
<svg width="16" height="16" viewBox="0 0 16 16" fill="currentColor">
<path fill-rule="evenodd" clip-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8C0 11.54 2.29 14.53 5.47 15.59C5.87 15.66 6.02 15.42 6.02 15.21C6.02 15.02 6.01 14.39 6.01 13.72C4 14.09 3.48 13.23 3.32 12.78C3.23 12.55 2.84 11.84 2.5 11.65C2.22 11.5 1.82 11.13 2.49 11.12C3.12 11.11 3.57 11.7 3.72 11.94C4.44 13.15 5.59 12.81 6.05 12.6C6.12 12.08 6.33 11.73 6.56 11.53C4.78 11.33 2.92 10.64 2.92 7.58C2.92 6.71 3.23 5.99 3.74 5.43C3.66 5.23 3.38 4.41 3.82 3.31C3.82 3.31 4.49 3.1 6.02 4.13C6.66 3.95 7.34 3.86 8.02 3.86C8.7 3.86 9.38 3.95 10.02 4.13C11.55 3.09 12.22 3.31 12.22 3.31C12.66 4.41 12.38 5.23 12.3 5.43C12.81 5.99 13.12 6.7 13.12 7.58C13.12 10.65 11.25 11.33 9.47 11.53C9.76 11.78 10.01 12.26 10.01 13.01C10.01 14.08 10 14.94 10 15.21C10 15.42 10.15 15.67 10.55 15.59C13.71 14.53 16 11.53 16 8C16 3.58 12.42 0 8 0Z"/>
</svg>
</a>
<a class="icon-btn" href="https://discord.gg/eT2RxdF9Nq" target="_blank" rel="noreferrer" aria-label="Discord">
<svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor"><path d="M19.27 5.33A18 18 0 0 0 14.9 4l-.2.42a16.6 16.6 0 0 0-4.9 0L9.6 4a18 18 0 0 0-4.37 1.33C2.5 9.32 1.76 13.2 2.13 17a18.5 18.5 0 0 0 5.6 2.83l.45-.62a13 13 0 0 1-2.13-1.03l.52-.41a13 13 0 0 0 11.16 0l.52.41c-.66.4-1.38.74-2.13 1.03l.45.62A18.5 18.5 0 0 0 21.87 17c.46-4.55-.74-8.4-2.6-11.67zM9.34 14.6a1.78 1.78 0 0 1-1.66-1.86 1.7 1.7 0 1 1 3.32 0c0 1.03-.74 1.86-1.66 1.86zm5.32 0a1.78 1.78 0 0 1-1.66-1.86 1.7 1.7 0 1 1 3.32 0c0 1.03-.74 1.86-1.66 1.86z"/></svg>
</a>
</div>
<button class="icon-btn menu-toggle" data-menu-toggle aria-label="Menu">
<svg width="20" height="20" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="1.8"><path d="M4 7h16M4 12h16M4 17h16"/></svg>
</button>
</div>
<nav class="mobile-nav" data-mobile-nav aria-label="Mobile">
<a href="index.html">Home</a>
<a href="about.html">About</a>
<a href="download.html">Download</a>
<a href="documentation.html">Documentation</a>
<a href="reference.html" class="active">Reference</a>
<a href="support.html">Support</a>
<a href="store.html">Store</a>
<div class="row">
<a class="btn btn-outline sm" href="https://github.com/plugdata-team/plugdata" target="_blank" rel="noreferrer">GitHub</a>
<a class="btn btn-outline sm" href="https://discord.gg/eT2RxdF9Nq" target="_blank" rel="noreferrer">Discord</a>
</div>
</nav>
</div>
</header>
<main>
<!-- ===== LIST VIEW ===== -->
<div id="list-view">
<!-- Sticky toolbar: search + filters -->
<div class="ref-toolbar">
<div class="container">
<label class="ref-search">
<svg class="icon-search" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><circle cx="11" cy="11" r="8"/><path d="m21 21-4.3-4.3"/></svg>
<input id="search-input" type="search" placeholder="Search objects — try "osc", "filter", "reverb"…" autocomplete="off" spellcheck="false" />
<button class="clear" id="search-clear" type="button" aria-label="Clear search" hidden>
<svg width="14" height="14" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><path d="M18 6 6 18M6 6l12 12"/></svg>
</button>
<span class="kbd" id="search-kbd">/</span>
</label>
<div class="ref-filters" id="filters">
<!-- populated by JS -->
</div>
<div class="ref-filter-panel" id="filter-panel" hidden>
<!-- populated by JS when open -->
</div>
<div class="ref-status" id="status">Loading catalogue…</div>
</div>
</div>
<!-- Main list -->
<section class="ref-main">
<div class="container">
<div id="list" class="ref-list" aria-live="polite"></div>
<div id="empty" class="ref-empty" hidden>
<h3>No objects match your search</h3>
<p>Try a shorter query, remove a filter, or check the spelling. Object names in Pd often use <code style="font-family:var(--font-mono);font-size:0.875em;">~</code> for audio-rate versions.</p>
</div>
</div>
</section>
</div>
<!-- ===== DETAIL VIEW ===== -->
<div id="detail-view" hidden>
<section class="ref-detail">
<div class="container">
<a class="back" href="#" id="back-link">
<svg width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2"><path d="M19 12H5M12 19l-7-7 7-7"/></svg>
Back to all objects
</a>
<div id="detail-content">
<!-- populated by JS -->
</div>
</div>
</section>
</div>
</main>
<!-- ===== Footer ===== -->
<footer class="site-footer">
<div class="container">
<div class="top">
<div>
<a href="index.html" class="brand"><img src="assets/plugdata-logo.png" alt="" width="28" height="28" /><span>plugdata</span></a>
<p class="blurb">A free, open-source visual programming environment for audio.</p>
</div>
<div>
<h4>Project</h4>
<ul>
<li><a href="about.html">About</a></li>
<li><a href="documentation.html">Documentation</a></li>
<li><a href="reference.html">Reference</a></li>
<li><a href="support.html">Support</a></li>
</ul>
</div>
<div>
<h4>Get plugdata</h4>
<ul>
<li><a href="download.html">Download</a></li>
<li><a href="store.html">Store</a></li>
<li><a href="https://github.com/plugdata-team/plugdata/releases" target="_blank" rel="noreferrer">Releases</a></li>
</ul>
</div>
<div>
<h4>Community</h4>
<ul>
<li><a href="https://github.com/plugdata-team/plugdata" target="_blank" rel="noreferrer">GitHub</a></li>
<li><a href="https://discord.gg/eT2RxdF9Nq" target="_blank" rel="noreferrer">Discord</a></li>
<li><a href="https://github.com/sponsors/timothyschoen" target="_blank" rel="noreferrer">Sponsor</a></li>
</ul>
</div>
</div>
<div class="bottom">
<p class="copy">© <span data-year>2025</span> plugdata. Released under the GPL-3.0 license. Based on Pure Data by Miller Puckette.</p>
<div class="socials">
<a href="https://github.com/plugdata-team/plugdata" target="_blank" rel="noreferrer" aria-label="GitHub">
<svg width="16" height="16" viewBox="0 0 16 16" fill="currentColor"><path fill-rule="evenodd" clip-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8C0 11.54 2.29 14.53 5.47 15.59C5.87 15.66 6.02 15.42 6.02 15.21C6.02 15.02 6.01 14.39 6.01 13.72C4 14.09 3.48 13.23 3.32 12.78C3.23 12.55 2.84 11.84 2.5 11.65C2.22 11.5 1.82 11.13 2.49 11.12C3.12 11.11 3.57 11.7 3.72 11.94C4.44 13.15 5.59 12.81 6.05 12.6C6.12 12.08 6.33 11.73 6.56 11.53C4.78 11.33 2.92 10.64 2.92 7.58C2.92 6.71 3.23 5.99 3.74 5.43C3.66 5.23 3.38 4.41 3.82 3.31C3.82 3.31 4.49 3.1 6.02 4.13C6.66 3.95 7.34 3.86 8.02 3.86C8.7 3.86 9.38 3.95 10.02 4.13C11.55 3.09 12.22 3.31 12.22 3.31C12.66 4.41 12.38 5.23 12.3 5.43C12.81 5.99 13.12 6.7 13.12 7.58C13.12 10.65 11.25 11.33 9.47 11.53C9.76 11.78 10.01 12.26 10.01 13.01C10.01 14.08 10 14.94 10 15.21C10 15.42 10.15 15.67 10.55 15.59C13.71 14.53 16 11.53 16 8C16 3.58 12.42 0 8 0Z"/></svg>
</a>
<a href="https://discord.gg/eT2RxdF9Nq" target="_blank" rel="noreferrer" aria-label="Discord">
<svg width="20" height="20" viewBox="0 0 24 24" fill="currentColor"><path d="M19.27 5.33A18 18 0 0 0 14.9 4l-.2.42a16.6 16.6 0 0 0-4.9 0L9.6 4a18 18 0 0 0-4.37 1.33C2.5 9.32 1.76 13.2 2.13 17a18.5 18.5 0 0 0 5.6 2.83l.45-.62a13 13 0 0 1-2.13-1.03l.52-.41a13 13 0 0 0 11.16 0l.52.41c-.66.4-1.38.74-2.13 1.03l.45.62A18.5 18.5 0 0 0 21.87 17c.46-4.55-.74-8.4-2.6-11.67zM9.34 14.6a1.78 1.78 0 0 1-1.66-1.86 1.7 1.7 0 1 1 3.32 0c0 1.03-.74 1.86-1.66 1.86zm5.32 0a1.78 1.78 0 0 1-1.66-1.86 1.7 1.7 0 1 1 3.32 0c0 1.03-.74 1.86-1.66 1.86z"/></svg>
</a>
</div>
</div>
</div>
</footer>
<!-- ====== Reference logic ====== -->
<script>
(function() {
'use strict';
// ---------- Config ----------
const REPO = 'plugdata-team/plugdata';
const BRANCH = 'develop';
const DOC_PREFIX = 'Resources/Documentation/';
const TREES_URL = `https://api.github.com/repos/${REPO}/git/trees/${BRANCH}?recursive=1`;
const RAW_BASE = `https://raw.githubusercontent.com/${REPO}/${BRANCH}/`;
const EDIT_BASE = `https://github.com/${REPO}/blob/${BRANCH}/`;
const CACHE_KEY_INDEX = 'plugdata:ref-index:v1';
const INDEX_TTL = 30 * 60 * 1000; // 30 min
// Pre-built bundle (committed by the GitHub Action). When present, the
// page hydrates in one fetch instead of ~1,150 lazy ones, and search can
// hit body content from the very first keystroke. If the bundle 404s
// (forks, dev, before first deploy) we fall back to the live trees API.
const BUNDLE_URL = 'assets/reference-data.json';
// ---------- State ----------
/** @type {{ name: string, origin: string, path: string, data?: any, titles?: string[], displayName?: string }[]} */
let items = [];
const byKey = new Map(); // key = origin+'/'+name -> item
let activeFilter = 'all'; // 'all' or origin
let searchQuery = '';
let filterCounts = {};
// Filter panel state
let signalFilter = 'all'; // 'all' | 'signal' | 'data'
const categoryFilters = new Set(); // active category names
const knownCategories = new Set(); // categories seen across loaded items
let filtersOpen = false;
// ---------- DOM ----------
const listEl = document.getElementById('list');
const emptyEl = document.getElementById('empty');
const statusEl = document.getElementById('status');
const filtersEl = document.getElementById('filters');
const filterPanelEl = document.getElementById('filter-panel');
const searchInput = document.getElementById('search-input');
const searchClear = document.getElementById('search-clear');
const searchKbd = document.getElementById('search-kbd');
const listView = document.getElementById('list-view');
const detailView = document.getElementById('detail-view');
const detailContent = document.getElementById('detail-content');
const backLink = document.getElementById('back-link');
const yearEl = document.querySelector('[data-year]');
if (yearEl) yearEl.textContent = new Date().getFullYear();
// ---------- Mobile menu wiring (mirrors main site) ----------
const menuBtn = document.querySelector('[data-menu-toggle]');
const mobileNav = document.querySelector('[data-mobile-nav]');
if (menuBtn && mobileNav) {
menuBtn.addEventListener('click', () => {
const open = mobileNav.classList.toggle('open');
mobileNav.style.display = open ? 'flex' : 'none';
});
}
// ---------- Helpers ----------
function itemKey(item) { return item.origin + '/' + item.name; }
function encodeKey(k) { return encodeURIComponent(k); }
function parseHash() {
const h = location.hash.replace(/^#/, '');
if (!h) return null;
try { return decodeURIComponent(h); } catch { return h; }
}
function esc(s) {
return String(s == null ? '' : s).replace(/[&<>"']/g, c =>
({ '&': '&', '<': '<', '>': '>', '"': '"', "'": ''' }[c])
);
}
// Linkify [object] references inside body text. Must run on escaped text only.
function linkifyRefs(escapedHtml) {
// Match [name] where name contains typical Pd object chars.
return escapedHtml.replace(/\[([A-Za-z0-9_][A-Za-z0-9_.~\/\-]*)\]/g, (full, name) => {
// Try to find this name in our index (any origin). Prefer exact match.
const candidates = items.filter(it => it.name === name);
if (!candidates.length) return full; // leave as plain text
const target = candidates[0];
const key = itemKey(target);
return `[<a class="obj-link" href="#${encodeKey(key)}" data-obj-link="${esc(key)}">${esc(name)}</a>]`;
});
}
// ---------- sessionStorage cache ----------
function readCache(key) {
try {
const raw = sessionStorage.getItem(key);
if (!raw) return null;
return JSON.parse(raw);
} catch { return null; }
}
function writeCache(key, value) {
try { sessionStorage.setItem(key, JSON.stringify(value)); } catch { /* quota */ }
}
// ---------- Fetch catalogue ----------
// Try the pre-built bundle first. Returns a fully-hydrated items array
// (data already attached) or null on miss. Cheap to call: a single HTTP
// request, validated against the cache via If-None-Match.
async function tryLoadBundle() {
try {
statusEl.innerHTML = '<span class="ref-loading"><span class="ref-spinner"></span>Loading reference bundle…</span>';
const res = await fetch(BUNDLE_URL, { cache: 'no-cache' });
if (!res.ok) return null;
const bundle = await res.json();
if (!bundle || !bundle.objects || typeof bundle.objects !== 'object') return null;
const result = [];
for (const [key, data] of Object.entries(bundle.objects)) {
const slash = key.indexOf('/');
if (slash < 0) continue;
const origin = key.slice(0, slash);
const name = key.slice(slash + 1);
const item = { name, origin, path: 'Resources/Documentation/' + key + '.json' };
applyItemData(item, data);
result.push(item);
}
result.sort((a, b) => a.name.toLowerCase().localeCompare(b.name.toLowerCase()));
return result;
} catch {
return null;
}
}
async function loadIndex() {
// Try cache first
const cached = readCache(CACHE_KEY_INDEX);
if (cached && (Date.now() - cached.fetchedAt < INDEX_TTL) && Array.isArray(cached.items)) {
return cached.items;
}
statusEl.innerHTML = '<span class="ref-loading"><span class="ref-spinner"></span>Fetching catalogue from GitHub…</span>';
const res = await fetch(TREES_URL, { headers: { Accept: 'application/vnd.github+json' } });
if (!res.ok) {
throw new Error(`GitHub tree API returned ${res.status}. You may be rate-limited — try again in an hour.`);
}
const json = await res.json();
if (!json.tree) throw new Error('Unexpected API response (no tree).');
const result = [];
for (const node of json.tree) {
if (node.type !== 'blob') continue;
if (!node.path.startsWith(DOC_PREFIX)) continue;
if (!node.path.endsWith('.json')) continue;
const rel = node.path.slice(DOC_PREFIX.length); // e.g. ELSE/add.json
const slash = rel.indexOf('/');
if (slash < 0) continue;
const origin = rel.slice(0, slash);
const filename = rel.slice(slash + 1);
const name = filename.replace(/\.json$/, '');
result.push({ name, origin, path: node.path });
}
// Sort: by name (case-insensitive), stable
result.sort((a, b) => a.name.toLowerCase().localeCompare(b.name.toLowerCase()));
writeCache(CACHE_KEY_INDEX, { fetchedAt: Date.now(), items: result });
return result;
}
async function fetchJSON(path) {
const url = RAW_BASE + path;
const res = await fetch(url);
if (!res.ok) throw new Error(`Failed to fetch ${path}: ${res.status}`);
return res.json();
}
// ---------- Item data ----------
// Apply a parsed JSON to an item: capture titles, display name, and
// contribute its categories to the panel's known set.
function applyItemData(item, data) {
item.data = data;
if (Array.isArray(data.title) && data.title.length) {
item.titles = data.title.slice();
item.displayName = data.title[0];
} else {
item.titles = [item.name];
item.displayName = item.name;
}
if (Array.isArray(data.categories)) {
for (const c of data.categories) {
if (typeof c === 'string' && c.trim()) knownCategories.add(c.trim());
}
}
}
// Fallback path only: when the pre-built bundle is unavailable we have to
// pull every JSON individually from raw.githubusercontent.com. Done in
// parallel with bounded concurrency, with progress in the status line.
async function loadAllJsonsEagerly(items) {
const concurrency = 8;
let cursor = 0;
let done = 0;
const tick = () => {
statusEl.innerHTML = `<span class="ref-loading"><span class="ref-spinner"></span>Loading documentation… ${done.toLocaleString()} / ${items.length.toLocaleString()}</span>`;
};
tick();
await Promise.all(Array.from({ length: concurrency }, async () => {
while (cursor < items.length) {
const item = items[cursor++];
try {
const data = await fetchJSON(item.path);
applyItemData(item, data);
} catch {
item.data = { __error: true };
}
done++;
if (done % 25 === 0 || done === items.length) tick();
}
}));
}
// ---------- Filter helpers ----------
// With the bundle loaded, every item already has data, so we can read
// signal-rate from the actual port definitions. The `~` heuristic is kept
// as a safety net for the rare case where data is missing or errored.
function isSignalObject(item) {
const d = item.data;
if (d && !d.__error && (Array.isArray(d.inlets) || Array.isArray(d.outlets))) {
const portIsSignal = (p) => p && Array.isArray(p.messages) &&
p.messages.some(m => m && typeof m.type === 'string' && m.type.toLowerCase().includes('signal'));
const inlets = Array.isArray(d.inlets) ? d.inlets : [];
const outlets = Array.isArray(d.outlets) ? d.outlets : [];
return inlets.some(portIsSignal) || outlets.some(portIsSignal);
}
return /~/.test(item.name);
}
function categoriesOf(item) {
return (item.data && Array.isArray(item.data.categories)) ? item.data.categories : [];
}
// ---------- Rendering: filters ----------
function renderFilters() {
const origins = Array.from(new Set(items.map(i => i.origin))).sort();
filterCounts = { all: items.length };
for (const o of origins) filterCounts[o] = items.filter(i => i.origin === o).length;
const chips = [
{ id: 'all', label: 'All' },
...origins.map(o => ({ id: o, label: o }))
];
// Count of active "extra" filters (signal/data + categories), for the badge
const extraCount = (signalFilter !== 'all' ? 1 : 0) + categoryFilters.size;
const toggleClasses = ['ref-chip', 'filters-toggle']
.concat(extraCount > 0 ? ['has-active'] : [])
.join(' ');
filtersEl.innerHTML = chips.map(c =>
`<button class="ref-chip ${activeFilter === c.id ? 'active' : ''}" data-filter="${esc(c.id)}">
${esc(c.label)}
<span class="count">${filterCounts[c.id]}</span>
</button>`
).join('') + `
<button type="button" class="${toggleClasses}" data-toggle-filters aria-expanded="${filtersOpen}">
<svg width="12" height="12" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<polygon points="22 3 2 3 10 12.46 10 19 14 21 14 12.46 22 3"/>
</svg>
Filters
${extraCount > 0 ? `<span class="count">${extraCount}</span>` : ''}
<svg class="chev" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round">
<polyline points="6 9 12 15 18 9"/>
</svg>
</button>
`;
}