104 lines
4.5 KiB
HTML
104 lines
4.5 KiB
HTML
<!-- HTML header for doxygen 1.9.8-->
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
||
<head>
|
||
<title>SDi toolsBox</title>
|
||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
||
<meta name="generator" content="Doxygen 1.9.8"/>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||
<script type="text/javascript" src="jquery.js"></script>
|
||
<script type="text/javascript" src="dynsections.js"></script>
|
||
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||
<link href="custom_doxygen.css" rel="stylesheet" type="text/css"/>
|
||
</head>
|
||
<body>
|
||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||
<div id="titlearea">
|
||
<table cellspacing="0" cellpadding="0">
|
||
<tbody>
|
||
<tr id="projectrow">
|
||
<td id="projectalign">
|
||
<div id="projectname">sdi_toolBox
|
||
</div>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
</div>
|
||
<!-- end header part -->
|
||
<!-- Generated by Doxygen 1.9.8 -->
|
||
<script type="text/javascript" src="menudata.js"></script>
|
||
<script type="text/javascript" src="menu.js"></script>
|
||
<script type="text/javascript">
|
||
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
||
$(function() {
|
||
initMenu('',false,false,'search.php','Search');
|
||
});
|
||
/* @license-end */
|
||
</script>
|
||
<div id="main-nav"></div>
|
||
</div><!-- top -->
|
||
<div><div class="header">
|
||
<div class="headertitle"><div class="title">SDi toolsBox </div></div>
|
||
</div><!--header-->
|
||
<div class="contents">
|
||
<div class="textblock"><p><a class="anchor" id="md_docs__pages_2mainpage"></a> </p><h1>Welcome</h1>
|
||
<p>Welcome to the official <b>SDi toolsBox</b> documentation. Here you will find a detailed view of all the classes, functions and external tools. <br />
|
||
</p>
|
||
<hr />
|
||
<h1>Installation</h1>
|
||
<p>Installing the toolbox is done by copying the build toolBox directory to the project repository, ideally to the solution directory: </p><div class="fragment"><div class="line">|-- project_directory/</div>
|
||
<div class="line">| |-- sdi_toolBox_x.x.x/</div>
|
||
<div class="line">| |-- src/</div>
|
||
<div class="line">| | |-- project.vcxproj</div>
|
||
<div class="line">| | |-- ...</div>
|
||
<div class="line">| |-- project_solution.sln</div>
|
||
</div><!-- fragment --><p>Next, save this path in the development project settings. Example with Visual Studio:</p>
|
||
<p><img src="include_directories.png" alt="" class="inline"/></p>
|
||
<p>Finally, to use the available tools, it will be necessary to include the header files in this way:</p>
|
||
<div class="fragment"><div class="line"><span class="preprocessor">#include <sdi_toolsBox/xxxxx.h></span></div>
|
||
<div class="line"><span class="preprocessor">#include <sdi_toolsBox_legacy/xxxxx.h></span></div>
|
||
<div class="line"><span class="preprocessor">#include <sdi_toolsBox_experimental/xxxxx.h></span></div>
|
||
</div><!-- fragment --><hr />
|
||
<h1>License</h1>
|
||
<pre>
|
||
The zlib License
|
||
|
||
Copyright (c) 2026 SD-Innovation S.A.S.
|
||
|
||
This software is provided ‘as-is’, without any express or implied
|
||
warranty. In no event will the authors be held liable for any damages
|
||
arising from the use of this software.
|
||
|
||
Permission is granted to anyone to use this software for any purpose,
|
||
including commercial applications, and to alter it and redistribute it
|
||
freely, subject to the following restrictions:
|
||
|
||
1. The origin of this software must not be misrepresented; you must not
|
||
claim that you wrote the original software. If you use this software
|
||
in a product, an acknowledgment in the product documentation would be
|
||
appreciated but is not required.
|
||
|
||
2. Altered source versions must be plainly marked as such, and must not be
|
||
misrepresented as being the original software.
|
||
|
||
3. This notice may not be removed or altered from any source
|
||
distribution.
|
||
</pre> </div></div><!-- PageDoc -->
|
||
</div><!-- contents -->
|
||
<!-- HTML footer for doxygen 1.9.8-->
|
||
<!-- start footer part -->
|
||
<hr class="footer"/><address class="footer">
|
||
<small>
|
||
SDi toolsBox is licensed under the terms and conditions of the <a href="https://opensource.org/licenses/zlib-license.php" target="_blank">zlib/png license</a>
|
||
<br />
|
||
Copyright (c) 2026 - SD-Innovation S.A.S. - FRANCE | ver: 2.x.x - build: 2026-04-28
|
||
<br />
|
||
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen" /></a> 1.9.8
|
||
</small>
|
||
</address>
|
||
</body>
|
||
</html>
|