-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpluginrenderer.html
More file actions
242 lines (217 loc) · 16.7 KB
/
Copy pathpluginrenderer.html
File metadata and controls
242 lines (217 loc) · 16.7 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
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" ><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" >
<title>The TrueSkyPluginRender Library — Simul 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="shortcut icon" href="../_static/favicon.ico">
<!--[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/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" >
<link rel="search" title="Search" href="../search.html" >
<link rel="next" title="Rendering Techniques in trueSKY" href="rendering.html" >
<link rel="prev" title="Native Development with the trueSKY SDK" href="nativesdk.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="" >
<span class="sidebartitle">
trueSKY 4.3
</span>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<label class="search-label" for="q">Search the documentation</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 class="current">
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation and Setup</a></li>
<li class="toctree-l1"><a class="reference internal" href="../tutorialsindex.html">Tutorials</a></li>
<li class="toctree-l1"><a class="reference internal" href="../unreal.html">trueSKY for Unreal Engine</a></li>
<li class="toctree-l1"><a class="reference internal" href="../unity.html">trueSKY for Unity</a></li>
<li class="toctree-l1"><a class="reference internal" href="../skysequencer.html">Sky Sequencer</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../programming.html">Programming with the trueSKY SDK</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="nativesdk.html">Native Development with the trueSKY SDK</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">The TrueSkyPluginRender Library</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#deployment">Deployment</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rendering.html">Rendering Techniques in trueSKY</a></li>
<li class="toctree-l2"><a class="reference internal" href="profiling.html">Performance</a></li>
<li class="toctree-l2"><a class="reference internal" href="debugging.html">Debugging</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../faq.html">Frequently Asked Questions</a></li>
<li class="toctree-l1"><a class="reference internal" href="../legalindex.html">trueSKY Licences</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Reference:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../API/apiindex.html">API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../Reference/referenceindex.html">Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../changelist.html">Changelist</a></li>
</ul>
</div>
</div>
</nav>
<div data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<h2 class="wy-nav-top">Navigation</h2><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">Simul</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div 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"><a href="../programming.html">Programming with the trueSKY SDK</a></li>
<li class="breadcrumb-item active">The TrueSkyPluginRender Library</li>
<li class="wy-breadcrumbs-aside">
<div class="truesky-version-switch">
<button id="version-switch-button">Switch Version</button>
</div>
<script>
const switchButton = document.getElementById('version-switch-button');
// current URL
const currentURL = window.location.href;
const isVersion4_3 = currentURL.includes('/4.3');
const isVersion4_4 = currentURL.includes('/4.4');
if (isVersion4_3) {
switchButton.textContent = 'Switch to 4.4';
switchButton.addEventListener('click', () => {
window.location.href = '/4.4';
});
} else if (isVersion4_4) {
switchButton.textContent = 'Switch to 4.3';
switchButton.addEventListener('click', () => {
window.location.href = '/4.3';
});
} else {
switchButton.textContent = 'Switch to 4.3';
switchButton.addEventListener('click', () => {
window.location.href = '/4.3';
});
}
</script>
</li>
</ul>
<hr>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="the-trueskypluginrender-library">
<h1>The TrueSkyPluginRender Library<a class="headerlink" href="#the-trueskypluginrender-library" title="Permalink to this heading">¶</a></h1>
<p>The library TrueSkyPlugRender provides a dynamically-bound dll interface to integrate trueSKY into an external renderer.</p>
<p>Usage is as follows:</p>
<ul class="simple">
<li><p>Initialize by dynamically loading the appropriate TrueSkyPluginRender dll for the platform.</p></li>
<li><p>Bind the exported interface functions.</p></li>
<li><p>Initialize trueSKY.</p></li>
</ul>
<p>Then, for each rendered view, for each frame that is rendered, insert trueSKY in the pipeline, after the depth buffer has been generated, but before any translucent rendering.</p>
<p>For example, in a Win32 environment, you might load the dll with:</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="n">HMODULE</span><span class="w"> </span><span class="n">dllHandle</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">LoadLibrary</span><span class="p">(</span><span class="sa">L</span><span class="s">"TrueSkyPluginRender_MT.dll"</span><span class="p">);</span>
</pre></div>
</div>
<p>Then, the interface functions are initialized, e.g.</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="c1">//! Graphics API list</span>
<span class="k">enum</span><span class="w"> </span><span class="nc">GraphicsDeviceType</span>
<span class="p">{</span>
<span class="w"> </span><span class="n">GraphicsDeviceUnknown</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">-1</span><span class="p">,</span>
<span class="w"> </span><span class="n">GraphicsDeviceD3D11</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">2</span>
<span class="p">};</span>
<span class="c1">//! Event types</span>
<span class="k">enum</span><span class="w"> </span><span class="nc">GraphicsEventType</span>
<span class="p">{</span>
<span class="w"> </span><span class="n">GraphicsEventInitialize</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
<span class="w"> </span><span class="n">GraphicsEventShutdown</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
<span class="w"> </span><span class="n">GraphicsEventBeforeReset</span><span class="o">=</span><span class="w"> </span><span class="mi">2</span><span class="p">,</span>
<span class="w"> </span><span class="n">GraphicsEventAfterReset</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">3</span>
<span class="p">};</span>
<span class="k">typedef</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="n">FStaticInitInterface</span><span class="p">)(</span><span class="w"> </span><span class="p">);</span>
<span class="k">typedef</span><span class="w"> </span><span class="kt">void</span><span class="w"> </span><span class="p">(</span><span class="o">*</span><span class="n">FStaticSetGraphicsDevice</span><span class="p">)</span>
<span class="w"> </span><span class="p">(</span><span class="kt">void</span><span class="o">*</span><span class="w"> </span><span class="n">device</span><span class="p">,</span><span class="w"> </span><span class="n">GraphicsDeviceType</span><span class="w"> </span><span class="n">deviceType</span><span class="p">,</span><span class="n">GraphicsEventType</span><span class="w"> </span><span class="n">eventType</span><span class="p">);</span>
<span class="k">typedef</span><span class="w"> </span><span class="kt">int</span><span class="p">(</span><span class="o">*</span><span class="n">FStaticRenderFrame2</span><span class="p">)(</span><span class="n">RenderFrameStruct</span><span class="o">*</span><span class="w"> </span><span class="n">frameStruct</span><span class="p">);</span>
<span class="n">FStaticInitInterface</span><span class="w"> </span><span class="n">StaticInitInterface</span><span class="o">=</span><span class="k">nullptr</span><span class="p">;</span>
<span class="n">FStaticSetGraphicsDevice</span><span class="w"> </span><span class="n">StaticSetGraphicsDevice</span><span class="o">=</span><span class="k">nullptr</span><span class="p">;</span>
<span class="n">FStaticRenderFrame2</span><span class="w"> </span><span class="n">StaticRenderFrame2</span><span class="o">=</span><span class="k">nullptr</span><span class="p">;</span>
<span class="n">StaticInitInterface</span><span class="w"> </span><span class="o">=</span><span class="p">(</span><span class="n">FStaticInitInterface</span><span class="p">)</span><span class="n">GetProcAddress</span><span class="p">(</span><span class="n">dllHandle</span><span class="p">,</span><span class="w"> </span><span class="s">"StaticInitInterface"</span><span class="w"> </span><span class="p">);</span>
<span class="n">StaticSetGraphicsDevice</span><span class="w"> </span><span class="o">=</span><span class="p">(</span><span class="n">FStaticSetGraphicsDevice</span><span class="p">)</span><span class="n">GetProcAddress</span><span class="p">(</span><span class="n">dllHandle</span><span class="p">,</span><span class="w"> </span><span class="s">"StaticSetGraphicsDevice"</span><span class="w"> </span><span class="p">);</span>
</pre></div>
</div>
<p>It’s advisable to check that the function pointers obtained are non-zero. If all the required pointers are present, the dll can be used. We start by calling</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="kt">void</span><span class="o">*</span><span class="w"> </span><span class="n">currentDevice</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="n">current</span><span class="w"> </span><span class="n">D3D11</span><span class="w"> </span><span class="n">device</span><span class="w"> </span><span class="n">pointer</span><span class="p">);</span>
<span class="n">StaticSetGraphicsDevice</span><span class="p">(</span><span class="n">currentDevice</span><span class="p">,</span><span class="w"> </span><span class="n">CurrentApiType</span><span class="p">,</span><span class="w"> </span><span class="n">GraphicsEventInitialize</span><span class="p">);</span>
<span class="n">StaticInitInterface</span><span class="p">();</span>
</pre></div>
</div>
<p>Now trueSKY is ready to render.</p>
<div class="highlight-cpp notranslate"><div class="highlight"><pre><span></span><span class="n">FrameStruct</span><span class="w"> </span><span class="n">frameStruct</span><span class="p">;</span>
<span class="p">(</span><span class="n">initialize</span><span class="w"> </span><span class="n">frameStruct</span><span class="p">...)</span>
<span class="n">StaticRenderFrame2</span><span class="p">(</span><span class="o">&</span><span class="n">frameStruct</span><span class="p">);</span>
</pre></div>
</div>
<p>A reference to the relevant functions can be found <a class="reference internal" href="../Reference/plugin.html"><span class="doc">here.</span></a></p>
<section id="deployment">
<h2>Deployment<a class="headerlink" href="#deployment" title="Permalink to this heading">¶</a></h2>
<p>Building TrueSkyPluginRenderer has a post-build script called CopyToTargetDir. Based on the built platform and config, this tries to deploy both the built dll and shaders to where they need to go.
This is specified by the file truesky_setup.json, which goes in the current user’s home folder. For example:</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span>{
<span class="w"> </span>"unreal_branches":[
<span class="w"> </span>{"ue_dir":"D:/UnrealEngine/4.25","simul":["C:/Simul/5.0/Simul","C:/Simul/4.3/Simul","C:/Simul/4.2a/Simul","C:/Simul/4.1b/Simul"],"projects":["Test425","SimulTest"]}
<span class="w"> </span>]
<span class="w"> </span>,"unity_branches":[{"unity_dir":"C:/Simul/Unity/2019","simul":["C:/Simul/4.4/Simul","C:/Simul/4.3/Simul","C:/Simul/4.1b/Simul"],"unity_version":"2019","ps4_projects":["C:/Simul/Unity/2019/PS4"]}]
<span class="w"> </span>,"simul_branches":[{"simul":"C:/Simul/4.1b/Simul","platforms":[{"platform":"Spectrum","dll_destination":"E:\\Code\\Exo<span class="w"> </span>One\\Exo_MasterPlayer_DebugsOn_XSXa\\Loose\\Data\\Plugins","shader_destination":"E:/Code/Exo<span class="w"> </span>One/Exo_MasterPlayer_DebugsOn_XSXa/Loose/D3D12"}]}]
<span class="w"> </span>,"target_ps4":"O:/192.168.3.5"
<span class="w"> </span>,"target_ps5":"O:/192.168.3.36"
<span class="w"> </span>,"target_xboxone":"\\\\192.168.3.13"
<span class="w"> </span>,"xboxone_ue4":{"Test420":"Test420_1.0.0.0_neutral__a78hwt03br9rj"}
}
</pre></div>
</div>
<p>The members “unreal_branches”, and “unity_branches” are specifically to deploy to an Unreal or Unity engine setup.
The member “simul_branches” is more generic, and will deploy to the specified dll and shader destination for each platform.</p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="nativesdk.html" class="btn btn-neutral float-left" title="Native Development with the trueSKY SDK" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="rendering.html" class="btn btn-neutral float-right" title="Rendering Techniques in trueSKY" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr>
<div role="contentinfo">
<p>© Copyright 2007-2023, Simul Software Ltd.</p>
</div>
</footer>
</div>
</div>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<div class="overlay" style="display: none;">
<img class="fullsize" alt="fullscreen image overlay" src="data:,">
</div>
</body>
</html>