-
Notifications
You must be signed in to change notification settings - Fork 1
/
clientrenderer.html
187 lines (186 loc) · 7.21 KB
/
clientrenderer.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
<!DOCTYPE html>
<html class="writer-html5" lang="en">
<head>
<meta name="generator" content=
"HTML Tidy for HTML5 for Windows version 5.8.0">
<meta charset="utf-8">
<meta name="viewport" content=
"width=device-width, initial-scale=1.0">
<title>Client Renderer Library — TeleportVR documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type=
"text/css">
<link rel="stylesheet" href="_static/pygments.css" type="text/css">
<link rel="stylesheet" href="_static/pygments.css" type="text/css">
<link rel="stylesheet" href="_static/css/theme.css" type=
"text/css"><!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" id="documentation_options"
data-url_root="./" src="_static/documentation_options.js"></script>
<script data-url_root="./" id="documentation_options" src=
"_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html">
<link rel="search" title="Search" href="search.html">
<link rel="next" title="Unity Plugin" href="unity.html">
<link rel="prev" title="The TeleportClient library" href=
"teleportclient.html">
</head>
<body class="wy-body-for-nav">
<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=
"icon icon-home">TeleportVR</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html"
method="get" name="rtd-search-form"><input type="text" name="q"
placeholder="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="main navigation">
<p class="caption" role="heading"><span class=
"caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href=
"introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href=
"protocol.html">The Teleport VR Protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href=
"libavstream.html">LibAVStream</a></li>
<li class="toctree-l1"><a class="reference internal" href=
"teleportclient.html">The TeleportClient library</a></li>
<li class="toctree-l1 current"><a class=
"current reference internal" href="#">Client Renderer Library</a>
<ul>
<li class="toctree-l2"><a class="reference internal" href=
"#introduction">Introduction</a></li>
<li class="toctree-l2"><a class="reference internal" href=
"#classes">Classes</a></li>
<li class="toctree-l2"><a class="reference internal" href=
"#structs">Structs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href=
"unity.html">Unity Plugin</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation"><a href=
"index.html">TeleportVR</a></nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a> »</li>
<li>Client Renderer Library</li>
<li class="wy-breadcrumbs-aside"><a href=
"_sources/clientrenderer.rst.txt" rel="nofollow">View page
source</a></li>
</ul>
<hr></div>
<div role="main" class="document" itemscope="itemscope" itemtype=
"http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="client-renderer-library">
<h1>Client Renderer Library<a class="headerlink" href=
"#client-renderer-library" title=
"Permalink to this headline">¶</a></h1>
<div class="section" id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title=
"Permalink to this headline">¶</a></h2>
<p>LibAVStream is a helper library for streaming video and geometry
data between a server and client. A user of this library constructs
an avs::Pipeline instance, and configures the pipeline with
avs::PipelineNode subclass instances. Nodes can receive data from
other nodes, process it, and pass the processed data on to other
nodes.</p>
<p>A pipeline operates on a single thread, while queues allow
threads to exchange data. For example, the server’s Network
pipeline connects several avs::Queue instances to a single
avs::NetworkSink. For example, the video encoding pipeline links an
avs::Surface that receives raw video frames, to an avs::Encoder,
and finally to a queue. On another thread, the same queue in the
network pipeline passes the data to the avs::NetworkSink.</p>
</div>
<div class="section" id="classes">
<h2>Classes<a class="headerlink" href="#classes" title=
"Permalink to this headline">¶</a></h2>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>doxygenclass: Cannot find class “scr::GeometryCache” in doxygen
xml output for project “TeleportVR” from directory:
G:/Jarvis/workspace/Teleport/Teleport/build_docs/docs/doxygen/xml</p>
</div>
<dl class="field-list simple">
<dt class="field-odd">members</dt>
<dd class="field-odd"></dd>
</dl>
</div>
<div class="section" id="structs">
<h2>Structs<a class="headerlink" href="#structs" title=
"Permalink to this headline">¶</a></h2>
<dl class="cpp struct">
<dt class="sig sig-object cpp" id="_CPPv4N3scr13GeometryCacheE">
<span id="_CPPv3N3scr13GeometryCacheE"></span><span id=
"_CPPv2N3scr13GeometryCacheE"></span><span id=
"scr::GeometryCache"></span><span class="target" id=
"structscr_1_1_geometry_cache"></span><span class="k"><span class=
"pre">struct</span></span> <span class=
"sig-name descname"><span class="n"><span class=
"pre">GeometryCache</span></span></span><a class="headerlink" href=
"#_CPPv4N3scr13GeometryCacheE" title=
"Permalink to this definition">¶</a><br></dt>
<dd>
<p>A container for geometry sent from servers and cached locally.
There is one instance of <a class="reference internal" href=
"#structscr_1_1_geometry_cache"><span class=
"std std-ref">GeometryCache</span></a> for each connected server,
and a local <a class="reference internal" href=
"#structscr_1_1_geometry_cache"><span class=
"std std-ref">GeometryCache</span></a> for the client’s own
objects.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">members</dt>
<dd class="field-odd"></dd>
</dl>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label=
"footer navigation"><a href="unity.html" class=
"btn btn-neutral float-right" title="Unity Plugin" accesskey="n"
rel="next">Next</a> <a href="teleportclient.html" class=
"btn btn-neutral float-left" title="The TeleportClient library"
accesskey="p" rel="prev">Previous</a></div>
<hr>
<div role="contentinfo">
<p>© Copyright 2021, Simul Software Ltd.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the
Docs</a>.</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>