-
Notifications
You must be signed in to change notification settings - Fork 0
/
faq.html
804 lines (574 loc) · 35.9 KB
/
faq.html
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
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>FAQ — VisPy</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/vendor/fontawesome/6.5.2/css/all.min.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/style.css?v=7002c910" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
<script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
<script src="_static/documentation_options.js?v=b0548238"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'faq';</script>
<link rel="icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Roadmap" href="roadmap.html" />
<link rel="prev" title="Resources" href="resources.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<input type="checkbox"
class="sidebar-toggle"
id="pst-primary-sidebar-checkbox"/>
<label class="overlay overlay-primary" for="pst-primary-sidebar-checkbox"></label>
<input type="checkbox"
class="sidebar-toggle"
id="pst-secondary-sidebar-checkbox"/>
<label class="overlay overlay-secondary" for="pst-secondary-sidebar-checkbox"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class="col-lg-3 navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="index.html">
<img src="_static/vispy-teaser-short.png" class="logo__image only-light" alt="VisPy - Home"/>
<script>document.write(`<img src="_static/vispy-teaser-short.png" class="logo__image only-dark" alt="VisPy - Home"/>`);</script>
</a></div>
</div>
<div class="col-lg-9 navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="installation.html">
Installation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="getting_started/index.html">
Getting Started
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="overview.html">
Documentation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="gallery/index.html">
Gallery
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="api/modules.html">
API
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="news.html">
News
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://github.com/vispy/vispy/blob/main/CODE_OF_CONDUCT.md">
Code of Conduct
</a>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<script>
document.write(`
<button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
`);
</script>
</div>
<div class="navbar-item">
<script>
document.write(`
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
</button>
`);
</script></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/vispy/vispy" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://twitter.com/vispyproject" title="Twitter" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-twitter fa-lg" aria-hidden="true"></i>
<span class="sr-only">Twitter</span></a>
</li>
</ul></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<script>
document.write(`
<button class="btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
<span class="search-button__default-text">Search</span>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
</button>
`);
</script>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="installation.html">
Installation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="getting_started/index.html">
Getting Started
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="overview.html">
Documentation
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="gallery/index.html">
Gallery
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="api/modules.html">
API
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="news.html">
News
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://github.com/vispy/vispy/blob/main/CODE_OF_CONDUCT.md">
Code of Conduct
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<script>
document.write(`
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
</button>
`);
</script></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/vispy/vispy" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
<li class="nav-item">
<a href="https://twitter.com/vispyproject" title="Twitter" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-twitter fa-lg" aria-hidden="true"></i>
<span class="sr-only">Twitter</span></a>
</li>
</ul></div>
</div>
</div>
<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">
<nav class="bd-docs-nav bd-links"
aria-label="Section Navigation">
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
<div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="community.html">Community</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="org/ANTITRUST.html">Antitrust Policy</a></li>
<li class="toctree-l2"><a class="reference internal" href="org/CHARTER.html">Charter for the VisPy Organization</a></li>
<li class="toctree-l2"><a class="reference internal" href="org/STEERING-COMMITTEE.html">Steering Committee</a></li>
<li class="toctree-l2"><a class="reference internal" href="org/TRADEMARKS.html">Trademarks</a></li>
<li class="toctree-l2"><a class="reference internal" href="governance/GOVERNANCE.html">Governance Policy</a></li>
<li class="toctree-l2"><a class="reference internal" href="governance/MAINTAINERS.html">Maintainers</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="resources.html">Resources</a></li>
<li class="toctree-l1 current active"><a class="current reference internal" href="#">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="roadmap.html">Roadmap</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="dev_guide/index.html">Developer’s Guide</a><details><summary><span class="toctree-toggle" role="presentation"><i class="fa-solid fa-chevron-down"></i></span></summary><ul>
<li class="toctree-l2"><a class="reference internal" href="dev_guide/contributor_guide.html">Contributor’s Guide</a></li>
<li class="toctree-l2"><a class="reference internal" href="dev_guide/writing_examples.html">Writing Examples</a></li>
</ul>
</details></li>
<li class="toctree-l1"><a class="reference internal" href="thirdparty.html">Third Party Projects</a></li>
</ul>
</div>
</nav></div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item"><a href="overview.html" class="nav-link">Overview</a></li>
<li class="breadcrumb-item active" aria-current="page">FAQ</li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<section id="faq">
<h1>FAQ<a class="headerlink" href="#faq" title="Link to this heading">#</a></h1>
<p>VisPy is a big project with a lot of features and sometimes a couple ways to
do things. It sits on top of the very complex OpenGL library. We’ve tried to
document what we could in an organized and easy to find manner, but some
topics don’t quite fit. This set of Frequently Asked Questions is where you’ll
find the answer to some of these miscellaneous questions.</p>
<section id="why-is-my-visualization-slower-when-i-add-more-visual-objects">
<h2>Why is my visualization slower when I add more Visual objects?<a class="headerlink" href="#why-is-my-visualization-slower-when-i-add-more-visual-objects" title="Link to this heading">#</a></h2>
<p>Each Visual object in VisPy is an OpenGL Program consisting of at least a
vertex shader and a fragment shader (see <a class="reference internal" href="getting_started/modern-gl.html"><span class="doc">Modern OpenGL</span></a>).
In general, except for some very specific cases, OpenGL Programs can only
be executed one at a time by a single OpenGL context. This means that in
your VisPy visualization each Visual object you tell VisPy to draw will
extend how long each update (draw) takes. When frames per second (FPS) or
responsiveness are a concern, this means each Visual you add reduces the
performance of your visualization.</p>
<p>While VisPy is constantly striving to improve performance, there are things
that you can do in the mean time (depending on your particular case). The
most important change that you can make is to lower the number of Visual
objects you have. For a lot of Visuals it is possible to combine them into
one by putting a little extra work into the data you provide them. For example,
instead of creating 10 separate LineVisuals, create 1 LineVisual that draws
10 lines. While this is a simple example, the same concept applies to other
types of Visuals in VisPy and more complex use cases. As a last resort for
the most complex cases, a custom Visual (custom shader code) may be necessary.
Before writing a custom Visual, check with VisPy maintainers by asking a
question on gitter or creating a question as a GitHub issue.</p>
</section>
<section id="is-vispy-multi-threaded-or-thread-safe">
<h2>Is VisPy multi-threaded or thread-safe?<a class="headerlink" href="#is-vispy-multi-threaded-or-thread-safe" title="Link to this heading">#</a></h2>
<p>VisPy does not have any special multi-thread or multi-process handling except
for the funcionality provided by the GUI framework backends that it uses. For
example, PyQt5/PySide2 provide QThread objects for running code in another
thread. These libraries also provide ways of transferring data safely or
communicating between threads; mainly signals and slots. However, there is a
limit to what operations can be performed outside the main thread.</p>
<p>The main or GUI thread for most GUI frameworks is the <strong>only</strong> thread that can
perform drawing operations or operations that will trigger drawing. This
includes OpenGL functions. This means
that calling <code class="docutils literal notranslate"><span class="pre">self.update()</span></code> on a VisPy <code class="docutils literal notranslate"><span class="pre">Canvas</span></code> or <code class="docutils literal notranslate"><span class="pre">Visual</span></code> object must
ultimately be done in the main thread. Data that will be drawn can be created
or updated in a secondary thread, but the main/GUI thread must still be the
one to do the redraw. Since many Visual objects automatically call
<code class="docutils literal notranslate"><span class="pre">self.update()</span></code> for property or data modifications this can be difficult to
do in the most performant way. Updates or requests for changes to better support
thread-safe data updates are welcome.</p>
</section>
<section id="how-to-render-headless-off-screen-with-vispy">
<h2>How to render headless/off-screen with VisPy?<a class="headerlink" href="#how-to-render-headless-off-screen-with-vispy" title="Link to this heading">#</a></h2>
<p>There are two strategies to render without windows with VisPy:</p>
<ol class="arabic simple">
<li><p>Use Xvfb that simulates an X server in memory without displaying windows.
This can be used with any VisPy backend.</p></li>
<li><p>Use a backend that directly renders into memory buffers, e.g. OSMesa or EGL
(<a class="reference external" href="https://stackoverflow.com/a/55758789">further info</a>).</p></li>
</ol>
<p>Then, in your VisPy script, use</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">image</span> <span class="o">=</span> <span class="n">canvas</span><span class="o">.</span><span class="n">render</span><span class="p">()</span>
<span class="kn">import</span> <span class="nn">imageio</span>
<span class="n">imageio</span><span class="o">.</span><span class="n">imwrite</span><span class="p">(</span><span class="s2">"rendered.png"</span><span class="p">,</span> <span class="n">image</span><span class="p">)</span>
</pre></div>
</div>
<p>to save the rendered scene to an image file.</p>
<section id="xvfb">
<h3>Xvfb<a class="headerlink" href="#xvfb" title="Link to this heading">#</a></h3>
<p>Wrap the command to launch your script with <code class="docutils literal notranslate"><span class="pre">xfvb-run</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">xvfb</span><span class="o">-</span><span class="n">run</span> <span class="o">-</span><span class="n">a</span> <span class="n">python</span> <span class="n">my_script</span><span class="o">.</span><span class="n">py</span>
</pre></div>
</div>
<p><a class="reference external" href="https://www.x.org/releases/X11R7.6/doc/man/man1/Xvfb.1.xhtml">https://www.x.org/releases/X11R7.6/doc/man/man1/Xvfb.1.xhtml</a></p>
</section>
<section id="osmesa">
<h3>OSMesa<a class="headerlink" href="#osmesa" title="Link to this heading">#</a></h3>
<p>Using the OSMesa (Off-Screen Mesa) backend:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">vispy</span>
<span class="n">vispy</span><span class="o">.</span><span class="n">use</span><span class="p">(</span><span class="s2">"osmesa"</span><span class="p">)</span>
</pre></div>
</div>
<p>VisPy tries to detect the OSMesa shared library, but, if needed, it can be set
explicitly with</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">OSMESA_LIBRARY</span><span class="o">=/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">libOSMesa</span><span class="o">.</span><span class="n">so</span>
</pre></div>
</div>
<p><a class="reference external" href="https://mesa-docs.readthedocs.io/en/latest/osmesa.html">https://mesa-docs.readthedocs.io/en/latest/osmesa.html</a></p>
</section>
<section id="egl">
<h3>EGL<a class="headerlink" href="#egl" title="Link to this heading">#</a></h3>
<p>Using the EGL backend:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">vispy</span>
<span class="n">vispy</span><span class="o">.</span><span class="n">use</span><span class="p">(</span><span class="s2">"egl"</span><span class="p">)</span>
</pre></div>
</div>
<p>VisPy tries to detect the EGL shared library, but, if needed, it can be set
explicitly with</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># Choose one, or adapt to your system.</span>
<span class="n">export</span> <span class="n">EGL_LIBRARY</span><span class="o">=/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">libEGL</span><span class="o">.</span><span class="n">so</span>
<span class="n">export</span> <span class="n">EGL_LIBRARY</span><span class="o">=/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">libEGL_mesa</span><span class="o">.</span><span class="n">so</span>
<span class="n">export</span> <span class="n">EGL_LIBRARY</span><span class="o">=/</span><span class="n">usr</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">libEGL_nvidia</span><span class="o">.</span><span class="n">so</span>
</pre></div>
</div>
<p><a class="reference external" href="https://en.wikipedia.org/wiki/EGL_(API">https://en.wikipedia.org/wiki/EGL_(API</a>)</p>
</section>
</section>
<section id="how-to-achieve-transparency-with-2d-objects">
<h2>How to achieve transparency with 2D objects?<a class="headerlink" href="#how-to-achieve-transparency-with-2d-objects" title="Link to this heading">#</a></h2>
<p>With objects that lie in a 2D plane, e.g. images, it is possible to get a
translucent effect (i.e. partial transparency, a see-through effect) by
positioning them at different depth levels in the viewing direction and by
drawing the visuals from furthest to closest with the appropriate blending
mode.</p>
<p>Here are the key steps to achieve this with two
<a class="reference internal" href="api/vispy.scene.visuals.html#vispy.scene.visuals.Image" title="vispy.scene.visuals.Image"><code class="xref py py-class docutils literal notranslate"><span class="pre">Image</span></code></a> visual nodes in a
<a class="reference internal" href="api/vispy.scene.canvas.html#vispy.scene.canvas.SceneCanvas" title="vispy.scene.canvas.SceneCanvas"><code class="xref py py-class docutils literal notranslate"><span class="pre">SceneCanvas</span></code></a>:</p>
<ol class="arabic">
<li><p>Set the opacity value in the alpha channel of the images:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="c1"># A white image with integer values between 0 and 255.</span>
<span class="n">image_data1</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ones</span><span class="p">((</span><span class="mi">200</span><span class="p">,</span> <span class="mi">300</span><span class="p">,</span> <span class="mi">4</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="s1">'uint8'</span><span class="p">)</span>
<span class="c1"># Half translucent.</span>
<span class="n">image_data1</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="mi">3</span><span class="p">]</span> <span class="o">=</span> <span class="mi">128</span>
<span class="c1"># A blue image with float values between 0 and 1.</span>
<span class="n">image_data2</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">zeros</span><span class="p">((</span><span class="mi">200</span><span class="p">,</span> <span class="mi">300</span><span class="p">,</span> <span class="mi">4</span><span class="p">),</span> <span class="n">dtype</span><span class="o">=</span><span class="s1">'np.float32'</span><span class="p">)</span>
<span class="n">image_data2</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="mi">2</span><span class="p">]</span> <span class="o">=</span> <span class="mf">1.0</span> <span class="c1"># Blue.</span>
<span class="c1"># A bit more translucent.</span>
<span class="n">image_data2</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="mi">3</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.25</span>
<span class="n">visual1</span> <span class="o">=</span> <span class="n">Image</span><span class="p">(</span><span class="n">image_data1</span><span class="p">)</span>
<span class="n">visual2</span> <span class="o">=</span> <span class="n">Image</span><span class="p">(</span><span class="n">image_data2</span><span class="p">)</span>
</pre></div>
</div>
</li>
<li><p>Position the visuals at different depth levels (z-levels) in the viewing
direction:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">vispy.visuals</span> <span class="kn">import</span> <span class="n">transforms</span>
<span class="n">visual1</span><span class="o">.</span><span class="n">transform</span> <span class="o">=</span> <span class="n">transforms</span><span class="o">.</span><span class="n">STTransform</span><span class="p">(</span><span class="n">translate</span><span class="o">=</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">))</span>
<span class="n">visual2</span><span class="o">.</span><span class="n">transform</span> <span class="o">=</span> <span class="n">transforms</span><span class="o">.</span><span class="n">STTransform</span><span class="p">(</span><span class="n">translate</span><span class="o">=</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">2</span><span class="p">))</span>
</pre></div>
</div>
<p>A higher <code class="docutils literal notranslate"><span class="pre">z</span></code> value means further back, assuming the viewing direction is
the <code class="docutils literal notranslate"><span class="pre">+z</span></code> axis, e.g. the default for a
<a class="reference internal" href="api/vispy.scene.cameras.html#vispy.scene.cameras.PanZoomCamera" title="vispy.scene.cameras.PanZoomCamera"><code class="xref py py-class docutils literal notranslate"><span class="pre">PanZoomCamera</span></code></a>.</p>
</li>
<li><p>Draw the visuals from back to front by setting the draw
<a class="reference internal" href="api/vispy.scene.node.html#vispy.scene.node.Node.order" title="vispy.scene.node.Node.order"><code class="xref py py-obj docutils literal notranslate"><span class="pre">order</span></code></a> of the nodes manually:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">visual2</span><span class="o">.</span><span class="n">order</span> <span class="o">=</span> <span class="mi">1</span> <span class="c1"># Furthest, drawn first.</span>
<span class="n">visual1</span><span class="o">.</span><span class="n">order</span> <span class="o">=</span> <span class="mi">2</span> <span class="c1"># Closest, drawn second.</span>
</pre></div>
</div>
</li>
</ol>
<p>This requires depth testing and blending enabled. An appropriate blending
function is, for example, <code class="docutils literal notranslate"><span class="pre">(GL_SRC_ALPHA,</span> <span class="pre">GL_ONE_MINUS_SRC_ALPHA)</span></code>
with <a class="reference external" href="https://docs.gl/es2/glBlendFunc">glBlendFunc</a> in OpenGL.
This is the default on the <a class="reference internal" href="api/vispy.scene.visuals.html#vispy.scene.visuals.Image" title="vispy.scene.visuals.Image"><code class="xref py py-class docutils literal notranslate"><span class="pre">Image</span></code></a> visual node, but
otherwise it can be set with</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">visual1</span><span class="o">.</span><span class="n">set_gl_state</span><span class="p">(</span><span class="s1">'translucent'</span><span class="p">)</span>
</pre></div>
</div>
<p>which is a shortcut for</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">visual1</span><span class="o">.</span><span class="n">set_gl_state</span><span class="p">(</span><span class="n">depth_test</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">cull_face</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">blend</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
<span class="n">blend_func</span><span class="o">=</span><span class="p">(</span><span class="s1">'src_alpha'</span><span class="p">,</span> <span class="s1">'one_minus_src_alpha'</span><span class="p">))</span>
</pre></div>
</div>
</section>
<section id="how-do-i-cite-vispy">
<h2>How do I cite VisPy?<a class="headerlink" href="#how-do-i-cite-vispy" title="Link to this heading">#</a></h2>
<p>See the VisPy repository for citation information:
<a class="github reference external" href="https://github.com/vispy/vispy/blob/main/CITATION.rst">vispy/vispy</a></p>
</section>
</section>
</article>
<footer class="prev-next-footer d-print-none">
<div class="prev-next-area">
<a class="left-prev"
href="resources.html"
title="previous page">
<i class="fa-solid fa-angle-left"></i>
<div class="prev-next-info">
<p class="prev-next-subtitle">previous</p>
<p class="prev-next-title">Resources</p>
</div>
</a>
<a class="right-next"
href="roadmap.html"
title="next page">
<div class="prev-next-info">
<p class="prev-next-subtitle">next</p>
<p class="prev-next-title">Roadmap</p>
</div>
<i class="fa-solid fa-angle-right"></i>
</a>
</div>
</footer>
</div>
<div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
<div class="sidebar-secondary-item">
<div
id="pst-page-navigation-heading-2"
class="page-toc tocsection onthispage">
<i class="fa-solid fa-list"></i> On this page
</div>
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
<ul class="visible nav section-nav flex-column">
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#why-is-my-visualization-slower-when-i-add-more-visual-objects">Why is my visualization slower when I add more Visual objects?</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#is-vispy-multi-threaded-or-thread-safe">Is VisPy multi-threaded or thread-safe?</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#how-to-render-headless-off-screen-with-vispy">How to render headless/off-screen with VisPy?</a><ul class="nav section-nav flex-column">
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#xvfb">Xvfb</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#osmesa">OSMesa</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#egl">EGL</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#how-to-achieve-transparency-with-2d-objects">How to achieve transparency with 2D objects?</a></li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#how-do-i-cite-vispy">How do I cite VisPy?</a></li>
</ul>
</nav></div>
<div class="sidebar-secondary-item">
<div class="tocsection editthispage">
<a href="
https://github.com/vispy/vispy/edit/main/doc/faq.rst">
<i class="fa-solid fa-pencil"></i>
Edit
</a>
</div>
</div>
<div class="sidebar-secondary-item">
<div class="tocsection sourcelink">
<a href="_sources/faq.rst.txt">
<i class="fa-solid fa-file-lines"></i> Show Source
</a>
</div>
</div>
</div></div>
</div>
<footer class="bd-footer-content">
</footer>
</main>
</div>
</div>
<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b"></script>
<script src="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b"></script>
<footer class="bd-footer">
<div class="bd-footer__inner bd-page-width">
<div class="footer-items__start">
<div class="footer-item">
<p class="copyright">
© Copyright 2013-2024, VisPy developers.
<br/>
</p>
</div>
<div class="footer-item">
<p class="sphinx-version">
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.
<br/>
</p>
</div>
</div>
<div class="footer-items__end">
<div class="footer-item">
<p class="theme-version">
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.15.4.
</p></div>
</div>
</div>
</footer>
</body>
</html>