-
Notifications
You must be signed in to change notification settings - Fork 0
/
search.html
575 lines (535 loc) · 19.4 KB
/
search.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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Search — OpenXR Tutorial documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css">
<link rel="stylesheet" href="_static/css/theme.css" type="text/css">
<link rel="stylesheet" href="_static/copybutton.css" type="text/css">
<link rel="shortcut icon" href="_static/favicon.ico">
<link rel="canonical" href="https://openxr-tutorial.simul.co/search.html" >
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/clipboard.min.js"></script>
<script src="_static/copybutton.js"></script>
<script src="https://unpkg.com/[email protected]/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad:true});</script>
<script src="_static/js/theme.js"></script>
<script src="_static/searchtools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" >
<link rel="search" title="Search" href="#" >
<script src="_static/js/js.cookie.min.js"></script>
<script >
var currentPlatform="all";
var currentAPI="all";
function setPlatform(pl)
{
currentPlatform=pl;
if(navigator.cookieEnabled)
Cookies.set('platform', pl, { expires: 365,sameSite: "strict"});
}
function setGraphicsAPI(a)
{
currentAPI=a;
if(navigator.cookieEnabled)
Cookies.set('graphicsapi', a, { expires: 365,sameSite: "strict"});
}
function getPlatform()
{
if(currentPlatform=="all"&&navigator.cookieEnabled)
{
currentPlatform=Cookies.get("platform");
if (typeof currentPlatform == 'undefined')
{
currentPlatform = "windows"; // Default if cookies are enabled.
// console.log("getPlatform() defaulted to: "+currentPlatform);
}
//else
// console.log("getPlatform() from cookie: "+currentPlatform);
}
//console.log("getPlatform() returned: "+currentPlatform);
return currentPlatform;
}
function getGraphicsAPI()
{
if(currentAPI=="all"&&navigator.cookieEnabled)
{
currentAPI=Cookies.get("graphicsapi");
if (typeof currentAPI == 'undefined')
{
currentAPI = "vulkan"; // Default if cookies are enabled.
//console.log("getGraphicsAPI() defaulted to: "+currentAPI);
}
//else
// console.log("getGraphicsAPI() from cookie: "+currentAPI);
}
//console.log("getGraphicsAPI() returned: "+currentAPI);
return currentAPI;
}
//https://stackoverflow.com/questions/8562613/how-to-add-url-parameter-to-the-current-url
function addUrlParameter(addr,name, value)
{
//console.log("add url parameter to : "+addr)
url=new URL(addr);
url.searchParams.set(name,value);
return url.toString();
}
function getUrlParameter(name)
{
const urlParams = new URLSearchParams(window.location.search);
return urlParams.get(name);
}
function getUrlParameterWithCheck(name, checkValues, defaultValue)
{
const urlParameter = getUrlParameter(name);
ok = false;
for (i = 0; i < checkValues.length; i++)
{
ok |= (urlParameter == checkValues[i]);
}
return ok ? urlParameter : defaultValue;
}
function updatePlatformFromURL()
{
var platform = getUrlParameterWithCheck('platform', ['windows', 'linux', 'android'], getPlatform());
if (typeof platform == 'undefined')
{
platform = "linux"; // Set default here.
}
setPlatform(platform);
updatePlatform();
}
function updatePlatformFromTab()
{
var platform = getPlatform();
if (typeof platform == 'undefined')
{
platform = "linux"; // Set default here.
}
setPlatform(platform);
updatePlatform();
}
function updatePlatform()
{
var platform = getPlatform();
//console.log('updatePlatform() = ' + platform);
$(".linux").hide();
$(".android").hide();
$(".windows").hide();
if (platform == "windows"||platform == "all")
{
$(".windows").show();
$(".selectd3d11").removeAttr("disabled");
$(".selectd3d12").removeAttr("disabled");
$(".selectopengles").attr("disabled", true);
$(".selectvulkan").removeAttr("disabled");
$(".selectopengl").removeAttr("disabled");
}
if (platform == "linux"||platform == "all")
{
$(".linux").show();
$(".selectd3d11").attr("disabled", true);
$(".selectd3d12").attr("disabled", true);
$(".selectopengles").attr("disabled", true);
$(".selectvulkan").removeAttr("disabled");
$(".selectopengl").removeAttr("disabled");
}
if (platform == "android"||platform == "all")
{
//console.log("platform " + platform + ".");
$(".android").show();
$(".selectd3d11").attr("disabled", true);
$(".selectd3d12").attr("disabled", true);
$(".selectopengles").removeAttr("disabled");
$(".selectvulkan").removeAttr("disabled");
$(".selectopengl").attr("disabled", true);
}
var oldelements = document.querySelectorAll(".selected-platform");
while (oldelements.length > 0)
{
var el=oldelements.item(0);
el.classList.remove('selected-platform');
////console.log("Removing selected-platform from "+el.id);
oldelements = document.querySelectorAll(".selected-platform");
}
var element = document.getElementById('select' + platform);
if(element)
{
element.classList.add('selected-platform');
////console.log("Adding selected-platform to "+element.id);
}
var element2 = document.getElementById('select' + platform + "-inline");
if(element2)
{
element2.classList.add('selected-platform');
////console.log("Adding selected-platform to "+element2.id);
}
if(limitAPIChoice())
updateGraphicsAPI();
window.updatePlatform=updatePlatform;
}
function limitAPIChoice()
{
var platform = getPlatform();
var graphicsApi = getGraphicsAPI();
////console.log("limitAPIChoice(), platform = " + platform+", graphicsApi = "+graphicsApi);
window.limitAPIChoice=limitAPIChoice;
var newApi=graphicsApi;
if (platform == "windows")
{
if (graphicsApi == "opengles"||graphicsApi==undefined)
newApi="d3d11";
}
if (platform == "linux")
{
if (graphicsApi == "opengles"||graphicsApi=="d3d11"||graphicsApi=="d3d12"||graphicsApi==undefined)
newApi="vulkan";
}
if (platform == "android"||graphicsApi==undefined)
{
if (graphicsApi != "opengles"&&graphicsApi!="vulkan")
newApi="vulkan";
}
////console.log("newApi = "+newApi);
if (newApi != graphicsApi)
{
////console.log("setting graphicsapi = "+newApi);
setGraphicsAPI(newApi);
graphicsApi=newApi;
return true;
}
return false;
}
function makeLinksOpenInNewWindow()
{
////console.log("makeLinksOpenInNewWindow ");
var download_hrefs = document.getElementsByClassName('reference download internal');
[].forEach.call(download_hrefs, function(el) {
el.setAttribute('target', "_blank");
////console.log("Adding target blank to "+el.id);
});
link_hrefs = document.getElementsByClassName('reference external');
[].forEach.call(link_hrefs, function(el) {
// ONLY if it's really an external link, i.e. it contains "http:" or "https:"
if(el.getAttribute('href').includes("://")) {
//console.log(el.getAttribute('href')+" includes ://");
el.setAttribute('target', "_blank");
}
else {
}
////console.log("Adding target blank to "+el.id);
});
window.makeLinksOpenInNewWindow=makeLinksOpenInNewWindow;
}
function initDropdownLinks()
{
//console.log("initDropdownLinks ");
var platform_api_links = document.getElementsByClassName('dropdown-platform-api');
//let pattern = new RegExp("\/[windows|linux|android]\/[d3d11|d3d12|vulkan|opengl|opengles]\/","gm");
let pattern = new RegExp("(windows|linux|android)\/(d3d11|d3d12|vulkan|opengles|opengl)","gm");
let root_pattern = new RegExp("(.*)\/([a-z0-9A-Z_]+\.html)","gm");
[].forEach.call(platform_api_links, function(el) {
href=window.location.href;
//console.log("initDropdownLinks href "+href);
platform_api=el.id.replace('-','/');
//console.log("platform_api "+platform_api);
if(href.match(pattern)==null)
{
if(href.match(root_pattern)==null)
{
href=href+"/"+platform_api;
}
else
{
href=href.replace(root_pattern,"$1/"+platform_api+"/$2");
}
//console.log("1-> href "+href);
}
else
{
href=href.replace(pattern, platform_api);
//console.log("2-> href "+href);
}
el.href=href;
////console.log("Adding target blank to "+el.id);
});
window.initDropdownLinks=initDropdownLinks;
}
function addIconsToToctree()
{
var toctreeheadings = document.getElementsByClassName('toctree-l1');
var i = 0;
const heading_ids = ["toc_introduction", "toc_setup", "toc_graphics","toc_interactions","toc_extensions","toc_nextsteps"];
const heading_anchors = ["introduction", "openxr-setup", "graphics","interactions","extensions","nextsteps"];
[].forEach.call(toctreeheadings, function(el) {
if(i<6) {
el.id =heading_ids[i];
el.classList.add('toctree-sidepanel');
el.children[0].href=el.children[0].href.replace('#','')+"#"+heading_anchors[i];
}
i++;
});
}
function updatedToctreeURLs()
{
var toctreeheadings = document.getElementsByClassName('toctree-l1');
[].forEach.call(toctreeheadings, function(el) {
var baseURI = el.children[0].baseURI;
var baseURIAddPath = baseURI + "android/vulkan/";
let pattern = new RegExp("(windows|linux|android)\/(d3d11|d3d12|vulkan|opengles|opengl)", "gm");
let href=el.children[0].href;
if (href.match(pattern) == null)
{
console.log("Replacing href " + href);
href = href.replace(baseURI, baseURIAddPath);
console.log("with " + href);
el.children[0].href= href;
}
});
}
function copyLinkToThisPage()
{
var graphicsapi =getGraphicsAPI();
var platform =getPlatform();
var url =window.location.href;
//url =addUrlParameter(url,"platform",platform);
//url =addUrlParameter(url,"graphicsapi",graphicsapi);
navigator.clipboard.writeText(url);
var dlg = document.getElementById("copied-link-dialog");
document.getElementById("copied-link-text").innerHTML = "Copied:<br>" + url + "<br>to the clipboard.";
dlg.style.visibility = 'visible';
var sharepagetooltip = document.getElementById('share-page-tooltiptext');
//sharepagetooltip.style.opacity = 0;
setTimeout(() =>
{
const dlg = document.getElementById("copied-link-dialog");
dlg.style.visibility = 'hidden';
}, 2500);
// Alert the copied text
//alert("Copied the link: " + url+" to the clipboard.");
}
function updateGraphicsAPIFromURL()
{
var graphicsApi = getUrlParameterWithCheck('graphicsapi', ['d3d11', 'd3d12', 'opengl', 'opengles', 'vulkan'], getGraphicsAPI());
setGraphicsAPI(graphicsApi);
updateGraphicsAPI();
}
function updateGraphicsAPIFromTab()
{
var graphicsApi = getGraphicsAPI();
if (typeof graphicsApi == 'undefined')
{
graphicsApi = "vulkan"; // Set default here.
}
setGraphicsAPI(graphicsApi);
updateGraphicsAPI();
}
function updateGraphicsAPI()
{
var graphicsApi = getGraphicsAPI();
//console.log('updateGraphicsAPI() = ' + graphicsApi);
// first, hide all the api's
$(".d3d11").hide();
$(".d3d12").hide();
$(".opengl").hide();
$(".opengles").hide();
$(".vulkan").hide();
// Now, show the wanted api's. In this way, divs with more than one will be shown, even if they have one that is hidden.
if (graphicsApi == "d3d11"||graphicsApi == "all") {
$(".d3d11").show();
}
if (graphicsApi == "d3d12"||graphicsApi == "all") {
$(".d3d12").show();
}
if (graphicsApi == "opengl"||graphicsApi == "all") {
$(".opengl").show();
}
if (graphicsApi == "opengles"||graphicsApi == "all") {
$(".opengles").show();
}
if (graphicsApi == "vulkan"||graphicsApi == "all") {
$(".vulkan").show();
}
var oldelements = document.querySelectorAll(".selected-graphics-api");
////console.log("selected-platform on "+oldelements.length+" elements.");
while (oldelements.length > 0)
{
var el=oldelements.item(0);
el.classList.remove('selected-graphics-api');
////console.log("Removing selected-graphics-api from "+el.id);
oldelements = document.querySelectorAll(".selected-graphics-api");
}
var element = document.getElementById('select' + graphicsApi);
if(element)
{
element.classList.add('selected-graphics-api');
}
var element2 = document.getElementById('select' + graphicsApi +"-inline");
if (element2)
{
element2.classList.add('selected-graphics-api');
}
window.updateGraphicsAPI=updateGraphicsAPI;
}
</script>
<script>
var graphicsApi = getGraphicsAPI();
if (graphicsApi==undefined)
{
setGraphicsAPI(a);
graphicsApi='vulkan';
}
</script>
<style>
@import url('https://fonts.googleapis.com/css2?family=Poppins&display=swap');
@import url('https://fonts.cdnfonts.com/css/menlo');
</style>
</head>
<body class="wy-body-for-nav" onpageshow="updatePlatformFromURL(); updateGraphicsAPIFromURL();initDropdownLinks()" onload="makeLinksOpenInNewWindow(); addIconsToToctree(); updatedToctreeURLs();">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="" >
<img src="_static/OpenXR_170px_Feb17.png" class="logo" alt="The OpenXR logo" >
<span class="sidebartitle">
Tutorial
</span>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="android/vulkan/search.html" method="get">
<label class="search-label" for="q">Search the tutorial</label>
<input type="text" name="q" id="q" placeholder="Search..." aria-label="Search docs">
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li id="toc_introduction" class="toctree-l1 toctree-sidepanel"><a class="reference internal" href=".//android/vulkan/1-introduction.html">1 Introduction</a></li>
<li id="toc_setup" class="toctree-l1 toctree-sidepanel"><a class="reference internal" href=".//android/vulkan/2-setup.html">2 OpenXR Setup</a></li>
<li id="toc_graphics" class="toctree-l1 toctree-sidepanel"><a class="reference internal" href=".//android/vulkan/3-graphics.html">3 Graphics</a></li>
<li id="toc_interactions" class="toctree-l1 toctree-sidepanel"><a class="reference internal" href=".//android/vulkan/4-actions.html">4 Interactions</a></li>
<li id="toc_extensions" class="toctree-l1 toctree-sidepanel"><a class="reference internal" href=".//android/vulkan/5-extensions.html">5 Extensions</a></li>
<li id="toc_nextsteps" class="toctree-l1 toctree-sidepanel"><a class="reference internal" href=".//android/vulkan/6-next-steps.html">6 Next Steps</a></li>
</ul>
</div>
</div>
</nav>
<div data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">OpenXR Tutorial</a>
</nav>
<div class="sticky-breadcrumb-ribbon" role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Search</li>
<li class="wy-breadcrumbs-aside">
<div class="platform-api-dropdown">
<span>Android/Vulkan</span>
<div class="platform-api-dropdown-content">
<ul>
<li><a class="dropdown-platform-api" id="android-opengles" href="#">Android OpenGL ES</a></li>
<li><a class="dropdown-platform-api" id="android-vulkan" href="#">Android Vulkan</a></li>
<li><a class="dropdown-platform-api" id="linux-opengl" href="#">Linux OpenGL</a></li>
<li><a class="dropdown-platform-api" id="linux-vulkan" href="#">Linux Vulkan</a></li>
<li><a class="dropdown-platform-api" id="windows-d3d11" href="#">Windows D3D11</a></li>
<li><a class="dropdown-platform-api" id="windows-d3d12" href="#">Windows D3D12</a></li>
<li><a class="dropdown-platform-api" id="windows-opengl" href="#">Windows OpenGL</a></li>
<li><a class="dropdown-platform-api" id="windows-vulkan" href="#">Windows Vulkan</a></li>
</ul>
</div>
</div>
<script>
function choosePlatform(platformName)
{
setPlatform(platformName);
updatePlatformFromTab();
};
</script>
<script>
function chooseGraphicsAPI(graphicsApiName)
{
setGraphicsAPI(graphicsApiName);
updateGraphicsAPIFromTab();
limitAPIChoice();
};
</script>
</li>
</ul>
</div>
<div class="wy-nav-content">
<div class="rst-content">
<div class="share-page-container">
<button class="share-this-page" id='share-this-page' onclick="copyLinkToThisPage()">
<img class="api-tab-img" src="_static/css/icons/share_FILL0_wght400_GRAD0_opsz24.svg" alt="Copy link to this page" />
</button>
<div id="copied-link-dialog">
<p id="copied-link-text"></p>
</div>
<div id="share-page-tooltiptext">Copy link to this page</div>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<noscript>
<div id="fallback" class="admonition warning">
<p class="last">
Please activate JavaScript to enable the search functionality.
</p>
</div>
</noscript>
<div id="search-results">
</div>
</div>
</div>
<footer>
<hr>
<div role="contentinfo">
<div class="legal-notice">
<h3>Legal Notice</h3>
<p>
</p>
<p>
© 2023, The Khronos Group. <a href="https://creativecommons.org/licenses/by/4.0/deed.en">Creative Commons International 4.0 BY Attribution</a>. Code is licensed as <a href="https://www.apache.org/licenses/LICENSE-2.0">Apache 2.0</a>.
</p>
<p>
"OpenXR" and the OpenXR logo are trademarks owned by The Khronos Group Inc. and are registered as a trademark in China, the European Union, Japan and the United Kingdom. Vulkan and the Vulkan logo are registered trademarks of the Khronos Group Inc.
</p>
<p>
OpenGL® and the oval logo are trademarks or registered trademarks of Hewlett Packard Enterprise in the United States and/or other countries worldwide. OpenGL is a registered trademark and the OpenGL ES logo is a trademark of Hewlett Packard Enterprise used by permission by Khronos.
</p>
<p>
Microsoft DirectX, Microsoft DirectX11, and Microsoft DirectX12 are trademarks owned by Microsoft.
</p>
<p>
The OpenXR Tutorial is owned and operated by The Khronos Group Inc. Khronos <a href="https://www.khronos.org/legal/" rel="nofollow">Legal Notices</a>, <a href="https://www.khronos.org/legal/privacy" rel="nofollow">Privacy Policy</a>, and <a href="https://www.khronos.org/about/code-of-conduct" rel="nofollow">Code of Conduct</a> apply.
</p>
<p></p>
</div>
</div>
</footer>
</div>
</div>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<script>
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
<script id="searchindexloader"></script>
</body>
</html>