blob: 34e842deb6287a3f17af05b0f9d36ab35109a261 [file] [log] [blame]
<!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>
<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"/>
<title>iceberg-cpp: iceberg/util/endian.h File Reference</title>
<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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="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">iceberg-cpp
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_f51fe74ea6bc2b1b900619895eaa63be.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_7a408d6a2d81183c3eacfe2576f2a2aa.html">util</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#concepts">Concepts</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">endian.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Endianness conversion utilities.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;bit&gt;</code><br />
<code>#include &lt;concepts&gt;</code><br />
<code>#include &lt;cstdint&gt;</code><br />
</div>
<p><a href="endian_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="concepts" name="concepts"></a>
Concepts</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">concept &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="concepticeberg_1_1EndianConvertible.html">iceberg::EndianConvertible</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Concept for values that can be converted to/from another endian format. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a75138160d348d482441451885e7903ed" id="r_a75138160d348d482441451885e7903ed"><td class="memTemplParams" colspan="2"><a id="a75138160d348d482441451885e7903ed" name="a75138160d348d482441451885e7903ed"></a>
template&lt;EndianConvertible T&gt; </td></tr>
<tr class="memitem:a75138160d348d482441451885e7903ed"><td class="memTemplItemLeft" align="right" valign="top">constexpr T&#160;</td><td class="memTemplItemRight" valign="bottom"><b>iceberg::ByteSwap</b> (T value)</td></tr>
<tr class="memdesc:a75138160d348d482441451885e7903ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Byte-swap a value. For floating-point types, only support 32-bit and 64-bit floats. <br /></td></tr>
<tr class="separator:a75138160d348d482441451885e7903ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a213342dba249a0224ead295465dbbfd0" id="r_a213342dba249a0224ead295465dbbfd0"><td class="memTemplParams" colspan="2"><a id="a213342dba249a0224ead295465dbbfd0" name="a213342dba249a0224ead295465dbbfd0"></a>
template&lt;EndianConvertible T&gt; </td></tr>
<tr class="memitem:a213342dba249a0224ead295465dbbfd0"><td class="memTemplItemLeft" align="right" valign="top">constexpr T&#160;</td><td class="memTemplItemRight" valign="bottom"><b>iceberg::ToLittleEndian</b> (T value)</td></tr>
<tr class="memdesc:a213342dba249a0224ead295465dbbfd0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a value to little-endian format. <br /></td></tr>
<tr class="separator:a213342dba249a0224ead295465dbbfd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3c625e7e9cbdc285af7559f3f20098ff" id="r_a3c625e7e9cbdc285af7559f3f20098ff"><td class="memTemplParams" colspan="2"><a id="a3c625e7e9cbdc285af7559f3f20098ff" name="a3c625e7e9cbdc285af7559f3f20098ff"></a>
template&lt;EndianConvertible T&gt; </td></tr>
<tr class="memitem:a3c625e7e9cbdc285af7559f3f20098ff"><td class="memTemplItemLeft" align="right" valign="top">constexpr T&#160;</td><td class="memTemplItemRight" valign="bottom"><b>iceberg::FromLittleEndian</b> (T value)</td></tr>
<tr class="memdesc:a3c625e7e9cbdc285af7559f3f20098ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a value from little-endian format. <br /></td></tr>
<tr class="separator:a3c625e7e9cbdc285af7559f3f20098ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa051ea16b5c1c3d2c4b5c04db46ffa43" id="r_aa051ea16b5c1c3d2c4b5c04db46ffa43"><td class="memTemplParams" colspan="2"><a id="aa051ea16b5c1c3d2c4b5c04db46ffa43" name="aa051ea16b5c1c3d2c4b5c04db46ffa43"></a>
template&lt;EndianConvertible T&gt; </td></tr>
<tr class="memitem:aa051ea16b5c1c3d2c4b5c04db46ffa43"><td class="memTemplItemLeft" align="right" valign="top">constexpr T&#160;</td><td class="memTemplItemRight" valign="bottom"><b>iceberg::ToBigEndian</b> (T value)</td></tr>
<tr class="memdesc:aa051ea16b5c1c3d2c4b5c04db46ffa43"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a value to big-endian format. <br /></td></tr>
<tr class="separator:aa051ea16b5c1c3d2c4b5c04db46ffa43"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad32cff8f6ada2e4ab2e0701f0a043f28" id="r_ad32cff8f6ada2e4ab2e0701f0a043f28"><td class="memTemplParams" colspan="2"><a id="ad32cff8f6ada2e4ab2e0701f0a043f28" name="ad32cff8f6ada2e4ab2e0701f0a043f28"></a>
template&lt;EndianConvertible T&gt; </td></tr>
<tr class="memitem:ad32cff8f6ada2e4ab2e0701f0a043f28"><td class="memTemplItemLeft" align="right" valign="top">constexpr T&#160;</td><td class="memTemplItemRight" valign="bottom"><b>iceberg::FromBigEndian</b> (T value)</td></tr>
<tr class="memdesc:ad32cff8f6ada2e4ab2e0701f0a043f28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Convert a value from big-endian format. <br /></td></tr>
<tr class="separator:ad32cff8f6ada2e4ab2e0701f0a043f28"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Endianness conversion utilities. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>