|
|
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.5"/>
- <title>Face Engine SDK: fsdk::Image Struct 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="navtree.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="resize.js"></script>
- <script type="text/javascript" src="navtree.js"></script>
- <script type="text/javascript">
- $(document).ready(initResizable);
- $(window).load(resizeHeight);
- </script>
- <link href="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/search.js"></script>
- <script type="text/javascript">
- $(document).ready(function() { searchBox.OnSelectItem(0); });
- </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 style="height: 56px;">
- <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
- <td style="padding-left: 0.5em;">
- <div id="projectname">Face Engine SDK
-  <span id="projectnumber">5.8.0</span>
- </div>
- <div id="projectbrief">A face detection, recognition and tracking engine.</div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.5 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- </script>
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="modules.html"><span>Modules</span></a></li>
- <li><a href="namespaces.html"><span>Namespaces</span></a></li>
- <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
- <li>
- <div id="MSearchBox" class="MSearchBoxInactive">
- <span class="left">
- <img id="MSearchSelect" src="search/mag_sel.png"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- alt=""/>
- <input type="text" id="MSearchField" value="Search" accesskey="S"
- onfocus="searchBox.OnSearchFieldFocus(true)"
- onblur="searchBox.OnSearchFieldFocus(false)"
- onkeyup="searchBox.OnSearchFieldChange(event)"/>
- </span><span class="right">
- <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
- </span>
- </div>
- </li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="annotated.html"><span>Class List</span></a></li>
- <li><a href="classes.html"><span>Class Index</span></a></li>
- <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
- <li><a href="functions.html"><span>Class Members</span></a></li>
- </ul>
- </div>
- </div><!-- top -->
- <div id="side-nav" class="ui-resizable side-nav-resizable">
- <div id="nav-tree">
- <div id="nav-tree-contents">
- <div id="nav-sync" class="sync"></div>
- </div>
- </div>
- <div id="splitbar" style="-moz-user-select:none;"
- class="ui-resizable-handle">
- </div>
- </div>
- <script type="text/javascript">
- $(document).ready(function(){initNavTree('structfsdk_1_1_image.html','');});
- </script>
- <div id="doc-content">
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
-
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
-
- <div class="header">
- <div class="summary">
- <a href="#pub-types">Public Types</a> |
- <a href="#pub-methods">Public Member Functions</a> |
- <a href="#pub-static-methods">Static Public Member Functions</a> |
- <a href="#pro-methods">Protected Member Functions</a> |
- <a href="#pro-static-methods">Static Protected Member Functions</a> |
- <a href="#pro-attribs">Protected Attributes</a> |
- <a href="structfsdk_1_1_image-members.html">List of all members</a> </div>
- <div class="headertitle">
- <div class="title">fsdk::Image Struct Reference</div> </div>
- </div><!--header-->
- <div class="contents">
-
- <p><a class="el" href="structfsdk_1_1_image.html" title="Image. ">Image</a>.
- <a href="structfsdk_1_1_image.html#details">More...</a></p>
-
- <p><code>#include <<a class="el" href="_image_8h_source.html">Image.h</a>></code></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
- Public Types</h2></td></tr>
- <tr class="memitem:ad7383fff1a8c54a0b2153ea475b607b7"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#ad7383fff1a8c54a0b2153ea475b607b7">Type</a> : uint8_t { <br/>
-   <b>BMP</b>,
- <b>JPG</b>,
- <b>PNG</b>,
- <b>PPM</b>,
- <br/>
-   <b>TIFF</b>,
- <b>Unknown</b>
- <br/>
- }</td></tr>
- <tr class="memdesc:ad7383fff1a8c54a0b2153ea475b607b7"><td class="mdescLeft"> </td><td class="mdescRight">Supported image types. <br/></td></tr>
- <tr class="separator:ad7383fff1a8c54a0b2153ea475b607b7"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8a60bf4ecd1f111e034ff9a8478e62f4"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a8a60bf4ecd1f111e034ff9a8478e62f4">TargetDevice</a> { <b>CPU</b>,
- <b>GPU</b>,
- <b>NPU</b>
- }</td></tr>
- <tr class="memdesc:a8a60bf4ecd1f111e034ff9a8478e62f4"><td class="mdescLeft"> </td><td class="mdescRight">Target device that <a class="el" href="structfsdk_1_1_image.html" title="Image. ">fsdk::Image</a> algorithms will be running on. <br/></td></tr>
- <tr class="separator:a8a60bf4ecd1f111e034ff9a8478e62f4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acb272c751b60925b57a543cf19f31a5d"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#acb272c751b60925b57a543cf19f31a5d">ImageCompression</a> { <br/>
-   <a class="el" href="structfsdk_1_1_image.html#acb272c751b60925b57a543cf19f31a5dab75738e569f17ad386d0ff4cb90eabb9">ImageCompression::IC_NO_COMPRESSION</a>,
- <a class="el" href="structfsdk_1_1_image.html#acb272c751b60925b57a543cf19f31a5dae811dec1e75f575972a667e83a23bd34">ImageCompression::IC_SMALL_COMPRESSION</a>,
- <a class="el" href="structfsdk_1_1_image.html#acb272c751b60925b57a543cf19f31a5daf526f9c09cd1a065f528dc6518895615">ImageCompression::IC_MEDIUM_COMPRESSION</a>,
- <a class="el" href="structfsdk_1_1_image.html#acb272c751b60925b57a543cf19f31a5da60cdeb7647e393444a05d358810293f5">ImageCompression::IC_HARD_COMPRESSION</a>,
- <br/>
-   <a class="el" href="structfsdk_1_1_image.html#acb272c751b60925b57a543cf19f31a5daccd72f086a3257b06c12b790a683f2d6">ImageCompression::IC_BEST_COMPRESSION</a>
- <br/>
- }</td></tr>
- <tr class="memdesc:acb272c751b60925b57a543cf19f31a5d"><td class="mdescLeft"> </td><td class="mdescRight">Supported compression type is used only for jpg and png types. <a href="structfsdk_1_1_image.html#acb272c751b60925b57a543cf19f31a5d">More...</a><br/></td></tr>
- <tr class="separator:acb272c751b60925b57a543cf19f31a5d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7929a4eb6155bd9430dac56142672936"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a> : uint32_t { <br/>
-   <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936aa60852f204ed8028c1c58808b746d115">Error::Ok</a>,
- <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936a6518a24cb2d8166f5c57016e65e3f419">Error::InvalidWidth</a>,
- <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936aaff424fc1ea568827830b838a80cd934">Error::InvalidHeight</a>,
- <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936a588c80ae8885b51a5f0700894da5affe">Error::InvalidDataPtr</a>,
- <br/>
-   <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936a0a86fcdcc2094e925e3166b9710f8d82">Error::InvalidDataSize</a>,
- <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936a107a93f5ad9b48f874341eaa0141e0f9">Error::InvalidImage</a>,
- <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936a538273d971a3da3f944bfb95091df5d8">Error::InvalidArchive</a>,
- <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936a5d0744802b24f44a161d350c25d76c7b">Error::InvalidPath</a>,
- <br/>
-   <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936ac85f85f7c13ed006eed130ec183aa810">Error::InvalidType</a>,
- <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936ade236a235b4e8ffc9141676624753b2d">Error::InvalidFormat</a>,
- <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936abcdbc5068527815bd978d3cbba5e7deb">Error::InvalidBitmap</a>,
- <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936a83fe3c82514cc399b416bbb9d25ac9a9">Error::InvalidMemory</a>,
- <br/>
-   <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936aaf9d45225e9d3edf59f2fd40d4b9f157">Error::InvalidConversion</a>,
- <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936a2a7695a194a2f785215c4ed058e2bf7b">Error::InvalidResidence</a>,
- <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936a3634e01cc1296daece9832c5396808c2">Error::InvalidDevice</a>,
- <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936a70fa83b68f2d20d1c607a2864627f13d">Error::FailedToSave</a>,
- <br/>
-   <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936a023fe093cb8dbc5a80d2a2259d4c97a5">Error::FailedToLoad</a>,
- <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936ade906b82a6f70f5f75ea0a11da932a36">Error::FailedToInitialize</a>,
- <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936a014e56b039fd19b57e203c1fb371f5ce">Error::ReleasedInOtherThread</a>
- <br/>
- }</td></tr>
- <tr class="memdesc:a7929a4eb6155bd9430dac56142672936"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="structfsdk_1_1_image.html" title="Image. ">Image</a> error codes. <a href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">More...</a><br/></td></tr>
- <tr class="separator:a7929a4eb6155bd9430dac56142672936"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:abe735660a541cb213facb543b93f4e07"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> : uint32_t { <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993">MemoryResidence::MemoryCPU</a>,
- <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07af9b0ab7ae4fae4c4b922abbce4b9bebf">MemoryResidence::MemoryGPU</a>,
- <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a40657ac0e763be1c1a745957006c3555">MemoryResidence::MemoryNPU</a>,
- <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a1359bce90afb193bac4435d19c8864dd">MemoryResidence::MemoryNPU_DPP</a>
- }</td></tr>
- <tr class="memdesc:abe735660a541cb213facb543b93f4e07"><td class="mdescLeft"> </td><td class="mdescRight">Memory residence. <a href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">More...</a><br/></td></tr>
- <tr class="separator:abe735660a541cb213facb543b93f4e07"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
- Public Member Functions</h2></td></tr>
- <tr class="memitem:ad208540be1ae2fa9ca0ed192aee75182"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad208540be1ae2fa9ca0ed192aee75182"></a>
- <a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#ad208540be1ae2fa9ca0ed192aee75182">Image</a> () noexcept</td></tr>
- <tr class="memdesc:ad208540be1ae2fa9ca0ed192aee75182"><td class="mdescLeft"> </td><td class="mdescRight">Initializes an empty image. <br/></td></tr>
- <tr class="separator:ad208540be1ae2fa9ca0ed192aee75182"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a624947f81acd14120076f42860e51611"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a624947f81acd14120076f42860e51611">Image</a> (int width, int height, <a class="el" href="structfsdk_1_1_format.html">Format</a> format, <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> residence=<a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993">MemoryResidence::MemoryCPU</a>, int deviceId=0) noexcept</td></tr>
- <tr class="memdesc:a624947f81acd14120076f42860e51611"><td class="mdescLeft"> </td><td class="mdescRight">Initializes an empty image and preallocates storage buffer of given size. <a href="#a624947f81acd14120076f42860e51611">More...</a><br/></td></tr>
- <tr class="separator:a624947f81acd14120076f42860e51611"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a348af5fca41e5b170c0487a055f6ebbb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a348af5fca41e5b170c0487a055f6ebbb">Image</a> (int width, int height, <a class="el" href="structfsdk_1_1_format.html">Format</a> format, const void *data, <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> residence=<a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993">MemoryResidence::MemoryCPU</a>, int deviceId=0) noexcept</td></tr>
- <tr class="memdesc:a348af5fca41e5b170c0487a055f6ebbb"><td class="mdescLeft"> </td><td class="mdescRight">Initializes an empty image and preallocates storage buffer of given size. Fills image contents with provided data. <a href="#a348af5fca41e5b170c0487a055f6ebbb">More...</a><br/></td></tr>
- <tr class="separator:a348af5fca41e5b170c0487a055f6ebbb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac4d7421e28a9d81fed4de88dcc3fecf4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#ac4d7421e28a9d81fed4de88dcc3fecf4">Image</a> (int width, int height, <a class="el" href="structfsdk_1_1_format.html">Format</a> format, void *data, bool copy, <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> residence=<a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993">MemoryResidence::MemoryCPU</a>, int deviceId=0) noexcept</td></tr>
- <tr class="memdesc:ac4d7421e28a9d81fed4de88dcc3fecf4"><td class="mdescLeft"> </td><td class="mdescRight">Initializes an image. If copy is true, this allocates a new buffer of given size and fills image contents with provided data (copies it). If copy is false (which is default) this will just reference the provided data. <a href="#ac4d7421e28a9d81fed4de88dcc3fecf4">More...</a><br/></td></tr>
- <tr class="separator:ac4d7421e28a9d81fed4de88dcc3fecf4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a021abfa7a95a7d6a1e9f4edabf2043a2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a021abfa7a95a7d6a1e9f4edabf2043a2">Image</a> (const <a class="el" href="structfsdk_1_1_image.html">Image</a> &other) noexcept</td></tr>
- <tr class="memdesc:a021abfa7a95a7d6a1e9f4edabf2043a2"><td class="mdescLeft"> </td><td class="mdescRight">Initializes an image as a reference to an other image. <a href="#a021abfa7a95a7d6a1e9f4edabf2043a2">More...</a><br/></td></tr>
- <tr class="separator:a021abfa7a95a7d6a1e9f4edabf2043a2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aac20796ff887ec564cee62c826374384"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#aac20796ff887ec564cee62c826374384">Image</a> (<a class="el" href="structfsdk_1_1_image.html">Image</a> &&other) noexcept</td></tr>
- <tr class="memdesc:aac20796ff887ec564cee62c826374384"><td class="mdescLeft"> </td><td class="mdescRight">Initializes an image with contents of an other image. Source image is then invalidated. <a href="#aac20796ff887ec564cee62c826374384">More...</a><br/></td></tr>
- <tr class="separator:aac20796ff887ec564cee62c826374384"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6c85de74e85305f06232bdfb49331e0e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a6c85de74e85305f06232bdfb49331e0e">Image</a> (const <a class="el" href="structfsdk_1_1_sub_image.html">SubImage</a> &subImage) noexcept</td></tr>
- <tr class="memdesc:a6c85de74e85305f06232bdfb49331e0e"><td class="mdescLeft"> </td><td class="mdescRight">Initializes an image with contents of a sub image. Since sub images do not handle data life time, image contents are always copied. <a href="#a6c85de74e85305f06232bdfb49331e0e">More...</a><br/></td></tr>
- <tr class="separator:a6c85de74e85305f06232bdfb49331e0e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a1596737bcf2aea4a1c8fc336f6f1b182"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a1596737bcf2aea4a1c8fc336f6f1b182">create</a> (int width, int height, <a class="el" href="structfsdk_1_1_format.html">Format</a> format, bool cleanup=true, <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> residence=<a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993">MemoryResidence::MemoryCPU</a>, int deviceId=0) noexcept</td></tr>
- <tr class="memdesc:a1596737bcf2aea4a1c8fc336f6f1b182"><td class="mdescLeft"> </td><td class="mdescRight">Initializes an empty image and preallocates storage buffer of given size. <a href="#a1596737bcf2aea4a1c8fc336f6f1b182">More...</a><br/></td></tr>
- <tr class="separator:a1596737bcf2aea4a1c8fc336f6f1b182"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aafa5e102bd9b4ccda1f827f1a12499db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#aafa5e102bd9b4ccda1f827f1a12499db">create</a> (int width, int height, <a class="el" href="structfsdk_1_1_format.html">Format</a> format, const void *data, <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> residence=<a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993">MemoryResidence::MemoryCPU</a>, int deviceId=0) noexcept</td></tr>
- <tr class="memdesc:aafa5e102bd9b4ccda1f827f1a12499db"><td class="mdescLeft"> </td><td class="mdescRight">Initializes an empty image and preallocates storage buffer of given size. Fills image contents with provided data. <a href="#aafa5e102bd9b4ccda1f827f1a12499db">More...</a><br/></td></tr>
- <tr class="separator:aafa5e102bd9b4ccda1f827f1a12499db"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a99fd0c30cf7d2fd3c26ff6f1771a356b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a99fd0c30cf7d2fd3c26ff6f1771a356b">create</a> (int width, int height, <a class="el" href="structfsdk_1_1_format.html">Format</a> format, void *data, bool copy, <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> residence=<a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993">MemoryResidence::MemoryCPU</a>, int deviceId=0) noexcept</td></tr>
- <tr class="memdesc:a99fd0c30cf7d2fd3c26ff6f1771a356b"><td class="mdescLeft"> </td><td class="mdescRight">Initializes an image. If copy is true, this allocates a new buffer of given size and fills image contents with provided data (copies it). If copy is false (which is default) this will just reference the provided data. <a href="#a99fd0c30cf7d2fd3c26ff6f1771a356b">More...</a><br/></td></tr>
- <tr class="separator:a99fd0c30cf7d2fd3c26ff6f1771a356b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aeb3e38807e56a77419a073eea1e6d2ec"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#aeb3e38807e56a77419a073eea1e6d2ec">create</a> (const <a class="el" href="structfsdk_1_1_image.html">fsdk::Image</a> &source, <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> residence, int deviceId=0) noexcept</td></tr>
- <tr class="memdesc:aeb3e38807e56a77419a073eea1e6d2ec"><td class="mdescLeft"> </td><td class="mdescRight">Creates image with given memory residence based on other image instance. If source image has another MemoryResidence or device id, all memory will be copied to the new residence. In the other case new instance will be just a reference for the source. <a href="#aeb3e38807e56a77419a073eea1e6d2ec">More...</a><br/></td></tr>
- <tr class="separator:aeb3e38807e56a77419a073eea1e6d2ec"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae43bcd728b9b3389a5d45e20dee1205d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#ae43bcd728b9b3389a5d45e20dee1205d">set</a> (int width, int height, <a class="el" href="structfsdk_1_1_format.html">Format</a> format, const void *data, <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> residence=<a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993">MemoryResidence::MemoryCPU</a>, int deviceId=0) noexcept</td></tr>
- <tr class="memdesc:ae43bcd728b9b3389a5d45e20dee1205d"><td class="mdescLeft"> </td><td class="mdescRight">Initializes an image with provided data. If current image is not empty and it's size and format match the provided ones, no memory reallocation is performed. Otherwise image is re-created to match requirements. <a href="#ae43bcd728b9b3389a5d45e20dee1205d">More...</a><br/></td></tr>
- <tr class="separator:ae43bcd728b9b3389a5d45e20dee1205d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a85ddf384c606013f7c2aa2815eaeccf4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a85ddf384c606013f7c2aa2815eaeccf4">set</a> (int width, int height, <a class="el" href="structfsdk_1_1_format.html">Format</a> format, void *data, bool copy, <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> residence=<a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993">MemoryResidence::MemoryCPU</a>, int deviceId=0) noexcept</td></tr>
- <tr class="memdesc:a85ddf384c606013f7c2aa2815eaeccf4"><td class="mdescLeft"> </td><td class="mdescRight">Initializes an image with provided data. If copy is true and if current image is not empty and it's size and format match the provided ones, no memory reallocation is performed. Otherwise image is re-created to match requirements. If copy is false (which is default) this will just reference the provided data. <a href="#a85ddf384c606013f7c2aa2815eaeccf4">More...</a><br/></td></tr>
- <tr class="separator:a85ddf384c606013f7c2aa2815eaeccf4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:af449e5eaada6b033205fec916c758aff"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#af449e5eaada6b033205fec916c758aff">set</a> (const <a class="el" href="structfsdk_1_1_image.html">Image</a> &other) noexcept</td></tr>
- <tr class="memdesc:af449e5eaada6b033205fec916c758aff"><td class="mdescLeft"> </td><td class="mdescRight">Initializes an image as a reference to an other image. <a href="#af449e5eaada6b033205fec916c758aff">More...</a><br/></td></tr>
- <tr class="separator:af449e5eaada6b033205fec916c758aff"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a62466dd45bd37cdd3c73bdeb7b268b20"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a62466dd45bd37cdd3c73bdeb7b268b20">set</a> (const <a class="el" href="structfsdk_1_1_sub_image.html">SubImage</a> &subImage) noexcept</td></tr>
- <tr class="memdesc:a62466dd45bd37cdd3c73bdeb7b268b20"><td class="mdescLeft"> </td><td class="mdescRight">Initializes an image with contents of a sub image. Since sub images do not handle data life time, image contents are always copied. <a href="#a62466dd45bd37cdd3c73bdeb7b268b20">More...</a><br/></td></tr>
- <tr class="separator:a62466dd45bd37cdd3c73bdeb7b268b20"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae05f21724f71ad844532ec46310bd252"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_sub_image.html">SubImage</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#ae05f21724f71ad844532ec46310bd252">map</a> (int x, int y, int width, int height) const noexcept</td></tr>
- <tr class="memdesc:ae05f21724f71ad844532ec46310bd252"><td class="mdescLeft"> </td><td class="mdescRight">Map image contents to a given area. <a href="#ae05f21724f71ad844532ec46310bd252">More...</a><br/></td></tr>
- <tr class="separator:ae05f21724f71ad844532ec46310bd252"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac085efbd15cc73fea521d9067d551d61"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_sub_image.html">SubImage</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#ac085efbd15cc73fea521d9067d551d61">map</a> (const <a class="el" href="structfsdk_1_1_base_rect.html">Rect</a> &rect) const noexcept</td></tr>
- <tr class="memdesc:ac085efbd15cc73fea521d9067d551d61"><td class="mdescLeft"> </td><td class="mdescRight">Map image contents to a given area. <a href="#ac085efbd15cc73fea521d9067d551d61">More...</a><br/></td></tr>
- <tr class="separator:ac085efbd15cc73fea521d9067d551d61"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa4c32526ccd387fb89500e766ae3ce7f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_sub_image.html">SubImage</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#aa4c32526ccd387fb89500e766ae3ce7f">map</a> (const <a class="el" href="namespacefsdk.html#a77eb62991e30a65164c055b3e518defd">Size</a> &size) const noexcept</td></tr>
- <tr class="memdesc:aa4c32526ccd387fb89500e766ae3ce7f"><td class="mdescLeft"> </td><td class="mdescRight">Map image contents to a given area. <a href="#aa4c32526ccd387fb89500e766ae3ce7f">More...</a><br/></td></tr>
- <tr class="separator:aa4c32526ccd387fb89500e766ae3ce7f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5e5e5885d7e3e85d8d07b2c5a84937c5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_sub_image.html">SubImage</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a5e5e5885d7e3e85d8d07b2c5a84937c5">map</a> (const <a class="el" href="namespacefsdk.html#abc92bf6fd92f16b2d9c8e78a85838bcd">Point2i</a> &origin, const <a class="el" href="namespacefsdk.html#a77eb62991e30a65164c055b3e518defd">Size</a> &size) const noexcept</td></tr>
- <tr class="memdesc:a5e5e5885d7e3e85d8d07b2c5a84937c5"><td class="mdescLeft"> </td><td class="mdescRight">Map image contents to a given area. <a href="#a5e5e5885d7e3e85d8d07b2c5a84937c5">More...</a><br/></td></tr>
- <tr class="separator:a5e5e5885d7e3e85d8d07b2c5a84937c5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:add9bb121cb86eb35e669b6321a267926"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_image.html">Image</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#add9bb121cb86eb35e669b6321a267926">extract</a> (int x, int y, int width, int height) const noexcept</td></tr>
- <tr class="memdesc:add9bb121cb86eb35e669b6321a267926"><td class="mdescLeft"> </td><td class="mdescRight">Extract a sub image of this image. The new image will have it's own reference count. <a href="#add9bb121cb86eb35e669b6321a267926">More...</a><br/></td></tr>
- <tr class="separator:add9bb121cb86eb35e669b6321a267926"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3f9f9c61324959b028b645b0a873ae21"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_image.html">Image</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a3f9f9c61324959b028b645b0a873ae21">extract</a> (const <a class="el" href="structfsdk_1_1_base_rect.html">Rect</a> &rect) const noexcept</td></tr>
- <tr class="memdesc:a3f9f9c61324959b028b645b0a873ae21"><td class="mdescLeft"> </td><td class="mdescRight">Extract a sub image of this image. The new image will have it's own reference count. <a href="#a3f9f9c61324959b028b645b0a873ae21">More...</a><br/></td></tr>
- <tr class="separator:a3f9f9c61324959b028b645b0a873ae21"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4cd2e1c9c500087bcfb65f750cef09e4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_image.html">Image</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a4cd2e1c9c500087bcfb65f750cef09e4">extract</a> (const <a class="el" href="namespacefsdk.html#a77eb62991e30a65164c055b3e518defd">Size</a> &size) const noexcept</td></tr>
- <tr class="memdesc:a4cd2e1c9c500087bcfb65f750cef09e4"><td class="mdescLeft"> </td><td class="mdescRight">Extract a sub image of this image. The new image will have it's own reference count. <a href="#a4cd2e1c9c500087bcfb65f750cef09e4">More...</a><br/></td></tr>
- <tr class="separator:a4cd2e1c9c500087bcfb65f750cef09e4"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a01e37e8244745a1645c7f44356c98cfa"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_image.html">Image</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a01e37e8244745a1645c7f44356c98cfa">extract</a> (const <a class="el" href="namespacefsdk.html#abc92bf6fd92f16b2d9c8e78a85838bcd">Point2i</a> &origin, const <a class="el" href="namespacefsdk.html#a77eb62991e30a65164c055b3e518defd">Size</a> &size) const noexcept</td></tr>
- <tr class="memdesc:a01e37e8244745a1645c7f44356c98cfa"><td class="mdescLeft"> </td><td class="mdescRight">Extract a sub image of this image. The new image will have it's own reference count. <a href="#a01e37e8244745a1645c7f44356c98cfa">More...</a><br/></td></tr>
- <tr class="separator:a01e37e8244745a1645c7f44356c98cfa"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a523b0c28a4003c75c3907d0c93110493"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_image.html">Image</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a523b0c28a4003c75c3907d0c93110493">clone</a> () const noexcept</td></tr>
- <tr class="memdesc:a523b0c28a4003c75c3907d0c93110493"><td class="mdescLeft"> </td><td class="mdescRight">Create a copy of this image. The new image will have it's own reference count. <a href="#a523b0c28a4003c75c3907d0c93110493">More...</a><br/></td></tr>
- <tr class="separator:a523b0c28a4003c75c3907d0c93110493"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab0c8024817b8e634f5ec18f1a0f08916"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Image::Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#ab0c8024817b8e634f5ec18f1a0f08916">convert</a> (<a class="el" href="structfsdk_1_1_image.html">Image</a> &dest, int x, int y, int width, int height, <a class="el" href="structfsdk_1_1_format.html">Format</a> format, <a class="el" href="structfsdk_1_1_image.html#a8a60bf4ecd1f111e034ff9a8478e62f4">TargetDevice</a> device=TargetDevice::CPU) const noexcept</td></tr>
- <tr class="memdesc:ab0c8024817b8e634f5ec18f1a0f08916"><td class="mdescLeft"> </td><td class="mdescRight">Convert image format. <a href="#ab0c8024817b8e634f5ec18f1a0f08916">More...</a><br/></td></tr>
- <tr class="separator:ab0c8024817b8e634f5ec18f1a0f08916"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a566dd9391571379fed5e1da2ed9975c8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Image::Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a566dd9391571379fed5e1da2ed9975c8">convert</a> (<a class="el" href="structfsdk_1_1_image.html">Image</a> &dest, const <a class="el" href="namespacefsdk.html#abc92bf6fd92f16b2d9c8e78a85838bcd">Point2i</a> &origin, const <a class="el" href="namespacefsdk.html#a77eb62991e30a65164c055b3e518defd">Size</a> &size, <a class="el" href="structfsdk_1_1_format.html">Format</a> format, <a class="el" href="structfsdk_1_1_image.html#a8a60bf4ecd1f111e034ff9a8478e62f4">TargetDevice</a> device=TargetDevice::CPU) const noexcept</td></tr>
- <tr class="memdesc:a566dd9391571379fed5e1da2ed9975c8"><td class="mdescLeft"> </td><td class="mdescRight">Convert image format. <a href="#a566dd9391571379fed5e1da2ed9975c8">More...</a><br/></td></tr>
- <tr class="separator:a566dd9391571379fed5e1da2ed9975c8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3ddea03d5ee948a5c2d0aa81a4fe8027"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Image::Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a3ddea03d5ee948a5c2d0aa81a4fe8027">convert</a> (<a class="el" href="structfsdk_1_1_image.html">Image</a> &dest, const <a class="el" href="namespacefsdk.html#a77eb62991e30a65164c055b3e518defd">Size</a> &size, <a class="el" href="structfsdk_1_1_format.html">Format</a> format, <a class="el" href="structfsdk_1_1_image.html#a8a60bf4ecd1f111e034ff9a8478e62f4">TargetDevice</a> device=TargetDevice::CPU) const noexcept</td></tr>
- <tr class="memdesc:a3ddea03d5ee948a5c2d0aa81a4fe8027"><td class="mdescLeft"> </td><td class="mdescRight">Convert image format. <a href="#a3ddea03d5ee948a5c2d0aa81a4fe8027">More...</a><br/></td></tr>
- <tr class="separator:a3ddea03d5ee948a5c2d0aa81a4fe8027"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9a8a6abf162c095d6f1e62919cf4dabf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Image::Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a9a8a6abf162c095d6f1e62919cf4dabf">convert</a> (<a class="el" href="structfsdk_1_1_image.html">Image</a> &dest, const <a class="el" href="structfsdk_1_1_base_rect.html">Rect</a> &rect, <a class="el" href="structfsdk_1_1_format.html">Format</a> format, <a class="el" href="structfsdk_1_1_image.html#a8a60bf4ecd1f111e034ff9a8478e62f4">TargetDevice</a> device=TargetDevice::CPU) const noexcept</td></tr>
- <tr class="memdesc:a9a8a6abf162c095d6f1e62919cf4dabf"><td class="mdescLeft"> </td><td class="mdescRight">Convert image format. <a href="#a9a8a6abf162c095d6f1e62919cf4dabf">More...</a><br/></td></tr>
- <tr class="separator:a9a8a6abf162c095d6f1e62919cf4dabf"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a10e36f6ea8f5e293f7bd58658ecb1653"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Image::Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a10e36f6ea8f5e293f7bd58658ecb1653">convert</a> (<a class="el" href="structfsdk_1_1_image.html">Image</a> &dest, <a class="el" href="structfsdk_1_1_format.html">Format</a> format, <a class="el" href="structfsdk_1_1_image.html#a8a60bf4ecd1f111e034ff9a8478e62f4">TargetDevice</a> device=TargetDevice::CPU) const noexcept</td></tr>
- <tr class="memdesc:a10e36f6ea8f5e293f7bd58658ecb1653"><td class="mdescLeft"> </td><td class="mdescRight">Convert image format. <a href="#a10e36f6ea8f5e293f7bd58658ecb1653">More...</a><br/></td></tr>
- <tr class="separator:a10e36f6ea8f5e293f7bd58658ecb1653"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6ed2d1d79094102bed624f40f14f4acb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_image.html">Image</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a6ed2d1d79094102bed624f40f14f4acb">rescale</a> (float scale) const noexcept</td></tr>
- <tr class="memdesc:a6ed2d1d79094102bed624f40f14f4acb"><td class="mdescLeft"> </td><td class="mdescRight">Rescale image keeping proportions. <a href="#a6ed2d1d79094102bed624f40f14f4acb">More...</a><br/></td></tr>
- <tr class="separator:a6ed2d1d79094102bed624f40f14f4acb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae3bd0f9b7e1dd8871e7110d566c0eb3b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Image::Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#ae3bd0f9b7e1dd8871e7110d566c0eb3b">save</a> (const char *path, <a class="el" href="structfsdk_1_1_image.html#acb272c751b60925b57a543cf19f31a5d">fsdk::Image::ImageCompression</a> additionalFlag=<a class="el" href="structfsdk_1_1_image.html#acb272c751b60925b57a543cf19f31a5dab75738e569f17ad386d0ff4cb90eabb9">fsdk::Image::ImageCompression::IC_NO_COMPRESSION</a>) const noexcept</td></tr>
- <tr class="memdesc:ae3bd0f9b7e1dd8871e7110d566c0eb3b"><td class="mdescLeft"> </td><td class="mdescRight">Save image. <a href="#ae3bd0f9b7e1dd8871e7110d566c0eb3b">More...</a><br/></td></tr>
- <tr class="separator:ae3bd0f9b7e1dd8871e7110d566c0eb3b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9551bec72e3e4798bce2ddd116b53f6e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a9551bec72e3e4798bce2ddd116b53f6e">save</a> (const char *path, const <a class="el" href="structfsdk_1_1_format.html">Format</a> format) const noexcept</td></tr>
- <tr class="memdesc:a9551bec72e3e4798bce2ddd116b53f6e"><td class="mdescLeft"> </td><td class="mdescRight">Convert and Save image. <a href="#a9551bec72e3e4798bce2ddd116b53f6e">More...</a><br/></td></tr>
- <tr class="separator:a9551bec72e3e4798bce2ddd116b53f6e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a394ec678da307c9f6f73b673567bc9ae"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Image::Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a394ec678da307c9f6f73b673567bc9ae">saveToMemory</a> (<a class="el" href="structfsdk_1_1_image.html#ad7383fff1a8c54a0b2153ea475b607b7">Image::Type</a> type, <a class="el" href="structfsdk_1_1_i_archive.html">IArchive</a> *archive, <a class="el" href="structfsdk_1_1_image.html#acb272c751b60925b57a543cf19f31a5d">fsdk::Image::ImageCompression</a> additionalFlag=<a class="el" href="structfsdk_1_1_image.html#acb272c751b60925b57a543cf19f31a5dab75738e569f17ad386d0ff4cb90eabb9">fsdk::Image::ImageCompression::IC_NO_COMPRESSION</a>) const noexcept</td></tr>
- <tr class="memdesc:a394ec678da307c9f6f73b673567bc9ae"><td class="mdescLeft"> </td><td class="mdescRight">Save image to memory buffer. <a href="#a394ec678da307c9f6f73b673567bc9ae">More...</a><br/></td></tr>
- <tr class="separator:a394ec678da307c9f6f73b673567bc9ae"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4031cca84864d83a5361968eaec0809e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Image::Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a4031cca84864d83a5361968eaec0809e">saveToMemory</a> (<a class="el" href="structfsdk_1_1_image.html#ad7383fff1a8c54a0b2153ea475b607b7">Image::Type</a> type, <a class="el" href="structfsdk_1_1_i_archive.html">IArchive</a> *archive, const <a class="el" href="structfsdk_1_1_format.html">Format</a> format) const noexcept</td></tr>
- <tr class="memdesc:a4031cca84864d83a5361968eaec0809e"><td class="mdescLeft"> </td><td class="mdescRight">Convert and save image to memory buffer. <a href="#a4031cca84864d83a5361968eaec0809e">More...</a><br/></td></tr>
- <tr class="separator:a4031cca84864d83a5361968eaec0809e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8f17c7659871533d5eed712b3967944b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a8f17c7659871533d5eed712b3967944b">load</a> (const char *path) noexcept</td></tr>
- <tr class="memdesc:a8f17c7659871533d5eed712b3967944b"><td class="mdescLeft"> </td><td class="mdescRight">Load image from file. <a href="#a8f17c7659871533d5eed712b3967944b">More...</a><br/></td></tr>
- <tr class="separator:a8f17c7659871533d5eed712b3967944b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a50d05981de264e977f4fbd90990f084a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a50d05981de264e977f4fbd90990f084a">load</a> (const char *path, const <a class="el" href="structfsdk_1_1_format.html">Format</a> format) noexcept</td></tr>
- <tr class="memdesc:a50d05981de264e977f4fbd90990f084a"><td class="mdescLeft"> </td><td class="mdescRight">Load image from file and convert it to required format. <a href="#a50d05981de264e977f4fbd90990f084a">More...</a><br/></td></tr>
- <tr class="separator:a50d05981de264e977f4fbd90990f084a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a824376f7ac69c83fc8026cf38a235806"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a824376f7ac69c83fc8026cf38a235806">loadFromMemory</a> (const void *data, const uint32_t sizeInBytes) noexcept</td></tr>
- <tr class="memdesc:a824376f7ac69c83fc8026cf38a235806"><td class="mdescLeft"> </td><td class="mdescRight">Load image from memory. <a href="#a824376f7ac69c83fc8026cf38a235806">More...</a><br/></td></tr>
- <tr class="separator:a824376f7ac69c83fc8026cf38a235806"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a27b9eae4a7a4bf22182bb98debf8c45d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a27b9eae4a7a4bf22182bb98debf8c45d">loadFromMemory</a> (const void *data, const uint32_t sizeInBytes, const <a class="el" href="structfsdk_1_1_format.html">Format</a> format) noexcept</td></tr>
- <tr class="memdesc:a27b9eae4a7a4bf22182bb98debf8c45d"><td class="mdescLeft"> </td><td class="mdescRight">Load image from memory and convert it to required format. <a href="#a27b9eae4a7a4bf22182bb98debf8c45d">More...</a><br/></td></tr>
- <tr class="separator:a27b9eae4a7a4bf22182bb98debf8c45d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7d560518bf9a96c0fc8795edb4374a31"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a7d560518bf9a96c0fc8795edb4374a31">loadFromMemoryOfType</a> (const void *data, const uint32_t sizeInBytes, const <a class="el" href="structfsdk_1_1_image.html#ad7383fff1a8c54a0b2153ea475b607b7">Type</a> type) noexcept</td></tr>
- <tr class="memdesc:a7d560518bf9a96c0fc8795edb4374a31"><td class="mdescLeft"> </td><td class="mdescRight">Load image from memory of specific type. <a href="#a7d560518bf9a96c0fc8795edb4374a31">More...</a><br/></td></tr>
- <tr class="separator:a7d560518bf9a96c0fc8795edb4374a31"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae7015b5e7e8c21af7fb23a93a1235301"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#ae7015b5e7e8c21af7fb23a93a1235301">loadFromMemoryOfType</a> (const void *data, const uint32_t sizeInBytes, const <a class="el" href="structfsdk_1_1_image.html#ad7383fff1a8c54a0b2153ea475b607b7">Type</a> type, const <a class="el" href="structfsdk_1_1_format.html">Format</a> format) noexcept</td></tr>
- <tr class="memdesc:ae7015b5e7e8c21af7fb23a93a1235301"><td class="mdescLeft"> </td><td class="mdescRight">Load image from memory of specific type and convert it to required format. <a href="#ae7015b5e7e8c21af7fb23a93a1235301">More...</a><br/></td></tr>
- <tr class="separator:ae7015b5e7e8c21af7fb23a93a1235301"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6e64bb21715b54c2b208c370d4c6bb2d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_image.html">Image</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a6e64bb21715b54c2b208c370d4c6bb2d">operator=</a> (const <a class="el" href="structfsdk_1_1_image.html">Image</a> &other) noexcept</td></tr>
- <tr class="memdesc:a6e64bb21715b54c2b208c370d4c6bb2d"><td class="mdescLeft"> </td><td class="mdescRight">Assign other image. <a href="#a6e64bb21715b54c2b208c370d4c6bb2d">More...</a><br/></td></tr>
- <tr class="separator:a6e64bb21715b54c2b208c370d4c6bb2d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:acbc748fe0bdd194deb00b26e06a51ed9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_image.html">Image</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#acbc748fe0bdd194deb00b26e06a51ed9">operator=</a> (<a class="el" href="structfsdk_1_1_image.html">Image</a> &&other) noexcept</td></tr>
- <tr class="memdesc:acbc748fe0bdd194deb00b26e06a51ed9"><td class="mdescLeft"> </td><td class="mdescRight">Move other image. <a href="#acbc748fe0bdd194deb00b26e06a51ed9">More...</a><br/></td></tr>
- <tr class="separator:acbc748fe0bdd194deb00b26e06a51ed9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a935733a13b5a2d62758f63a0fa2580e9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a935733a13b5a2d62758f63a0fa2580e9">isNull</a> () const noexcept</td></tr>
- <tr class="separator:a935733a13b5a2d62758f63a0fa2580e9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a42bb8bc044a084b7779760c20701fa0d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a42bb8bc044a084b7779760c20701fa0d">isValid</a> () const noexcept</td></tr>
- <tr class="separator:a42bb8bc044a084b7779760c20701fa0d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a94659c183621f3be301832e3673936c6"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a94659c183621f3be301832e3673936c6">operator bool</a> () const noexcept</td></tr>
- <tr class="memdesc:a94659c183621f3be301832e3673936c6"><td class="mdescLeft"> </td><td class="mdescRight">Implicit cast to boolean; results in true if image is valid, false if not. <a href="#a94659c183621f3be301832e3673936c6">More...</a><br/></td></tr>
- <tr class="separator:a94659c183621f3be301832e3673936c6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a81b837c8ebacc00461ced25cc6299176"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a81b837c8ebacc00461ced25cc6299176">getScanLine</a> (int y) noexcept</td></tr>
- <tr class="memdesc:a81b837c8ebacc00461ced25cc6299176"><td class="mdescLeft"> </td><td class="mdescRight">Get image scanline data. <a href="#a81b837c8ebacc00461ced25cc6299176">More...</a><br/></td></tr>
- <tr class="separator:a81b837c8ebacc00461ced25cc6299176"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aaf7e663816bd542c1f80d42e29c22014"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#aaf7e663816bd542c1f80d42e29c22014">getScanLine</a> (int y) const noexcept</td></tr>
- <tr class="memdesc:aaf7e663816bd542c1f80d42e29c22014"><td class="mdescLeft"> </td><td class="mdescRight">Get image scanline data. <a href="#aaf7e663816bd542c1f80d42e29c22014">More...</a><br/></td></tr>
- <tr class="separator:aaf7e663816bd542c1f80d42e29c22014"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad7702083887209a2c4e188b500215e96"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#ad7702083887209a2c4e188b500215e96">getDataSize</a> () const noexcept</td></tr>
- <tr class="separator:ad7702083887209a2c4e188b500215e96"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a494e5a70e35f8a9965c9c655faf71694"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a494e5a70e35f8a9965c9c655faf71694">getDataSize</a> (<a class="el" href="structfsdk_1_1_sizer.html">Sizer</a> &sizer) const noexcept</td></tr>
- <tr class="memdesc:a494e5a70e35f8a9965c9c655faf71694"><td class="mdescLeft"> </td><td class="mdescRight">Get actual image size in bytes. <a href="#a494e5a70e35f8a9965c9c655faf71694">More...</a><br/></td></tr>
- <tr class="separator:a494e5a70e35f8a9965c9c655faf71694"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afb6c77133c3cbe2f5f7825286096ec46"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
- <tr class="memitem:afb6c77133c3cbe2f5f7825286096ec46"><td class="memTemplItemLeft" align="right" valign="top">T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#afb6c77133c3cbe2f5f7825286096ec46">getScanLineAs</a> (int y) noexcept</td></tr>
- <tr class="memdesc:afb6c77133c3cbe2f5f7825286096ec46"><td class="mdescLeft"> </td><td class="mdescRight">Get image scanline data. <a href="#afb6c77133c3cbe2f5f7825286096ec46">More...</a><br/></td></tr>
- <tr class="separator:afb6c77133c3cbe2f5f7825286096ec46"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adb2d3b84e0b3c81a8f1528e884fa655a"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
- <tr class="memitem:adb2d3b84e0b3c81a8f1528e884fa655a"><td class="memTemplItemLeft" align="right" valign="top">const T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#adb2d3b84e0b3c81a8f1528e884fa655a">getScanLineAs</a> (int y) const noexcept</td></tr>
- <tr class="memdesc:adb2d3b84e0b3c81a8f1528e884fa655a"><td class="mdescLeft"> </td><td class="mdescRight">Get image scanline data. <a href="#adb2d3b84e0b3c81a8f1528e884fa655a">More...</a><br/></td></tr>
- <tr class="separator:adb2d3b84e0b3c81a8f1528e884fa655a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a177197485010936725923806ed693187"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a177197485010936725923806ed693187">getData</a> () noexcept</td></tr>
- <tr class="separator:a177197485010936725923806ed693187"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adb87ac4315e08d3474b87dd1819748d5"><td class="memItemLeft" align="right" valign="top">const void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#adb87ac4315e08d3474b87dd1819748d5">getData</a> () const noexcept</td></tr>
- <tr class="separator:adb87ac4315e08d3474b87dd1819748d5"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab0f6a417fa00693acfc22af05fdaddaf"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
- <tr class="memitem:ab0f6a417fa00693acfc22af05fdaddaf"><td class="memTemplItemLeft" align="right" valign="top">T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#ab0f6a417fa00693acfc22af05fdaddaf">getDataAs</a> () noexcept</td></tr>
- <tr class="separator:ab0f6a417fa00693acfc22af05fdaddaf"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2ffa58c82ae839a8804721def179ccb6"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
- <tr class="memitem:a2ffa58c82ae839a8804721def179ccb6"><td class="memTemplItemLeft" align="right" valign="top">const T * </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a2ffa58c82ae839a8804721def179ccb6">getDataAs</a> () const noexcept</td></tr>
- <tr class="separator:a2ffa58c82ae839a8804721def179ccb6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a02d33587be44369699ff0c77bf918f7e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a02d33587be44369699ff0c77bf918f7e">getRowSize</a> () const noexcept</td></tr>
- <tr class="separator:a02d33587be44369699ff0c77bf918f7e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6cb445da4dc6f7949c992f6bdcd6787f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a6cb445da4dc6f7949c992f6bdcd6787f">getWidth</a> () const noexcept</td></tr>
- <tr class="separator:a6cb445da4dc6f7949c992f6bdcd6787f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ad5823d56f2b75a94424adef45c9d23c2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#ad5823d56f2b75a94424adef45c9d23c2">getHeight</a> () const noexcept</td></tr>
- <tr class="separator:ad5823d56f2b75a94424adef45c9d23c2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a28a2f942184d21b0e4270c30adef7916"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a28a2f942184d21b0e4270c30adef7916">getAspectRatio</a> () const noexcept</td></tr>
- <tr class="separator:a28a2f942184d21b0e4270c30adef7916"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3a096c49b65cb9b3ddc864a1fe0bbc5f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_format.html">Format</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a3a096c49b65cb9b3ddc864a1fe0bbc5f">getFormat</a> () const noexcept</td></tr>
- <tr class="separator:a3a096c49b65cb9b3ddc864a1fe0bbc5f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a7df80646fa1526cfdb4d767a84acf6a0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7df80646fa1526cfdb4d767a84acf6a0"></a>
- <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> </td><td class="memItemRight" valign="bottom"><b>getMemoryResidence</b> () const noexcept</td></tr>
- <tr class="separator:a7df80646fa1526cfdb4d767a84acf6a0"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a265dd8891566653b2bc83fc6de58f568"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a265dd8891566653b2bc83fc6de58f568"></a>
- int </td><td class="memItemRight" valign="bottom"><b>getDeviceId</b> () const noexcept</td></tr>
- <tr class="separator:a265dd8891566653b2bc83fc6de58f568"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac38de3f8f7136d3011bc49b399efcd5a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacefsdk.html#a77eb62991e30a65164c055b3e518defd">Size</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#ac38de3f8f7136d3011bc49b399efcd5a">getSize</a> () const noexcept</td></tr>
- <tr class="separator:ac38de3f8f7136d3011bc49b399efcd5a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a5841db4b37f8e3f633f9ee31e29e28b6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_base_rect.html">Rect</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a5841db4b37f8e3f633f9ee31e29e28b6">getRect</a> () const noexcept</td></tr>
- <tr class="separator:a5841db4b37f8e3f633f9ee31e29e28b6"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adf5ed625bd338c55677dee58043de494"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#adf5ed625bd338c55677dee58043de494">ownsData</a> () const noexcept</td></tr>
- <tr class="separator:adf5ed625bd338c55677dee58043de494"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a33771e3d4141977d08be1302020ff6cd"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a33771e3d4141977d08be1302020ff6cd">isSharedWith</a> (const <a class="el" href="structfsdk_1_1_image.html">Image</a> &other) const noexcept</td></tr>
- <tr class="separator:a33771e3d4141977d08be1302020ff6cd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a6cc848e22d99f4d2d8b34d240c0bba47"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a6cc848e22d99f4d2d8b34d240c0bba47">swap</a> (<a class="el" href="structfsdk_1_1_image.html">Image</a> &other) noexcept</td></tr>
- <tr class="memdesc:a6cc848e22d99f4d2d8b34d240c0bba47"><td class="mdescLeft"> </td><td class="mdescRight">Swap contents with another image. <a href="#a6cc848e22d99f4d2d8b34d240c0bba47">More...</a><br/></td></tr>
- <tr class="separator:a6cc848e22d99f4d2d8b34d240c0bba47"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aae4044994b8cebfdd3f94e13606b9b07"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae4044994b8cebfdd3f94e13606b9b07"></a>
- void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#aae4044994b8cebfdd3f94e13606b9b07">reset</a> () noexcept</td></tr>
- <tr class="memdesc:aae4044994b8cebfdd3f94e13606b9b07"><td class="mdescLeft"> </td><td class="mdescRight">Reset image contents. <br/></td></tr>
- <tr class="separator:aae4044994b8cebfdd3f94e13606b9b07"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a386e2313d25f5f3107e1a47a347e04d8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a386e2313d25f5f3107e1a47a347e04d8"></a>
- bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a386e2313d25f5f3107e1a47a347e04d8">equalWeak</a> (const <a class="el" href="structfsdk_1_1_image.html">fsdk::Image</a> &other) noexcept</td></tr>
- <tr class="memdesc:a386e2313d25f5f3107e1a47a347e04d8"><td class="mdescLeft"> </td><td class="mdescRight">Performs weak comparison of this image with other. Weak in this context means only image parameters should be equal i.e width, height, format and residence. Actual data pointer of two images might differ. <br/></td></tr>
- <tr class="separator:a386e2313d25f5f3107e1a47a347e04d8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a22f36f59a67cc867a96686dcf18b8f6d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a22f36f59a67cc867a96686dcf18b8f6d">equalStrong</a> (const <a class="el" href="structfsdk_1_1_image.html">fsdk::Image</a> &other) noexcept</td></tr>
- <tr class="memdesc:a22f36f59a67cc867a96686dcf18b8f6d"><td class="mdescLeft"> </td><td class="mdescRight">Performs strong comparison of this image with other. Beside weak comparison strong comparison also checks whether two images point to the same block of pixels. <a href="#a22f36f59a67cc867a96686dcf18b8f6d">More...</a><br/></td></tr>
- <tr class="separator:a22f36f59a67cc867a96686dcf18b8f6d"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8bce66953fc250acf5c729d5168d6310"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8bce66953fc250acf5c729d5168d6310"></a>
- <a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> void </td><td class="memItemRight" valign="bottom"><b>putPixel</b> (uint32_t x, uint32_t y) noexcept</td></tr>
- <tr class="separator:a8bce66953fc250acf5c729d5168d6310"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
- Static Public Member Functions</h2></td></tr>
- <tr class="memitem:a9f2d12403ad91ca275de2259da560d05"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a9f2d12403ad91ca275de2259da560d05">guessTypeFromMemory</a> (const void *data, const uint32_t sizeInBytes, <a class="el" href="structfsdk_1_1_image.html#ad7383fff1a8c54a0b2153ea475b607b7">Type</a> &type) noexcept</td></tr>
- <tr class="memdesc:a9f2d12403ad91ca275de2259da560d05"><td class="mdescLeft"> </td><td class="mdescRight">Guess type of image written into memory. <a href="#a9f2d12403ad91ca275de2259da560d05">More...</a><br/></td></tr>
- <tr class="separator:a9f2d12403ad91ca275de2259da560d05"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
- Protected Member Functions</h2></td></tr>
- <tr class="memitem:aadc0669fe4f2632fb259d2cba1a06738"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#aadc0669fe4f2632fb259d2cba1a06738">retain</a> () noexcept</td></tr>
- <tr class="memdesc:aadc0669fe4f2632fb259d2cba1a06738"><td class="mdescLeft"> </td><td class="mdescRight">Increase reference count. <a href="#aadc0669fe4f2632fb259d2cba1a06738">More...</a><br/></td></tr>
- <tr class="separator:aadc0669fe4f2632fb259d2cba1a06738"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a32f3e84a17a9e47a516d2f9cef50c040"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a32f3e84a17a9e47a516d2f9cef50c040">release</a> () noexcept</td></tr>
- <tr class="memdesc:a32f3e84a17a9e47a516d2f9cef50c040"><td class="mdescLeft"> </td><td class="mdescRight">Decrease reference count. <a href="#a32f3e84a17a9e47a516d2f9cef50c040">More...</a><br/></td></tr>
- <tr class="separator:a32f3e84a17a9e47a516d2f9cef50c040"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a48773dce5d77377aa6415084ff2a612f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a48773dce5d77377aa6415084ff2a612f">getRefCount</a> () const noexcept</td></tr>
- <tr class="memdesc:a48773dce5d77377aa6415084ff2a612f"><td class="mdescLeft"> </td><td class="mdescRight">Obtain reference count. <a href="#a48773dce5d77377aa6415084ff2a612f">More...</a><br/></td></tr>
- <tr class="separator:a48773dce5d77377aa6415084ff2a612f"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-methods"></a>
- Static Protected Member Functions</h2></td></tr>
- <tr class="memitem:aef4ba8f782d69628ffaffc4da6ed970f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#aef4ba8f782d69628ffaffc4da6ed970f">allocate</a> (int size) noexcept</td></tr>
- <tr class="memdesc:aef4ba8f782d69628ffaffc4da6ed970f"><td class="mdescLeft"> </td><td class="mdescRight">Allocate memory. <a href="#aef4ba8f782d69628ffaffc4da6ed970f">More...</a><br/></td></tr>
- <tr class="separator:aef4ba8f782d69628ffaffc4da6ed970f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a750cb313b381b4245a1e51e34b18ae44"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a750cb313b381b4245a1e51e34b18ae44">deallocate</a> (void *memory) noexcept</td></tr>
- <tr class="memdesc:a750cb313b381b4245a1e51e34b18ae44"><td class="mdescLeft"> </td><td class="mdescRight">Free memory. <a href="#a750cb313b381b4245a1e51e34b18ae44">More...</a><br/></td></tr>
- <tr class="separator:a750cb313b381b4245a1e51e34b18ae44"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
- Protected Attributes</h2></td></tr>
- <tr class="memitem:a378b11d6fc5fe3baa1f2e1a6fc0c7e68"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a378b11d6fc5fe3baa1f2e1a6fc0c7e68"></a>
- void * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a378b11d6fc5fe3baa1f2e1a6fc0c7e68">m_data</a></td></tr>
- <tr class="memdesc:a378b11d6fc5fe3baa1f2e1a6fc0c7e68"><td class="mdescLeft"> </td><td class="mdescRight">raw image data. <br/></td></tr>
- <tr class="separator:a378b11d6fc5fe3baa1f2e1a6fc0c7e68"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4309931e1a59c9b88469a5633df36769"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4309931e1a59c9b88469a5633df36769"></a>
- int * </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a4309931e1a59c9b88469a5633df36769">m_ref</a></td></tr>
- <tr class="memdesc:a4309931e1a59c9b88469a5633df36769"><td class="mdescLeft"> </td><td class="mdescRight">reference counter. nullptr if image does not own data. <br/></td></tr>
- <tr class="separator:a4309931e1a59c9b88469a5633df36769"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aa4dee2d753540eb26aac388ed8d94ce9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa4dee2d753540eb26aac388ed8d94ce9"></a>
- int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#aa4dee2d753540eb26aac388ed8d94ce9">m_height</a></td></tr>
- <tr class="memdesc:aa4dee2d753540eb26aac388ed8d94ce9"><td class="mdescLeft"> </td><td class="mdescRight">image height. <br/></td></tr>
- <tr class="separator:aa4dee2d753540eb26aac388ed8d94ce9"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a32c6a6ef3700e9babb0943ce4aac6155"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a32c6a6ef3700e9babb0943ce4aac6155"></a>
- int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a32c6a6ef3700e9babb0943ce4aac6155">m_width</a></td></tr>
- <tr class="memdesc:a32c6a6ef3700e9babb0943ce4aac6155"><td class="mdescLeft"> </td><td class="mdescRight">image width. <br/></td></tr>
- <tr class="separator:a32c6a6ef3700e9babb0943ce4aac6155"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8435a72e723aa1b3c818867457276c9a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8435a72e723aa1b3c818867457276c9a"></a>
- int </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#a8435a72e723aa1b3c818867457276c9a">m_deviceId</a></td></tr>
- <tr class="memdesc:a8435a72e723aa1b3c818867457276c9a"><td class="mdescLeft"> </td><td class="mdescRight">id of the device where image memory is allocated <br/></td></tr>
- <tr class="separator:a8435a72e723aa1b3c818867457276c9a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aefe4793bcc5d38d828d5ead04cb4f75e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_format.html">Format</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structfsdk_1_1_image.html#aefe4793bcc5d38d828d5ead04cb4f75e">m_format</a></td></tr>
- <tr class="memdesc:aefe4793bcc5d38d828d5ead04cb4f75e"><td class="mdescLeft"> </td><td class="mdescRight">image format ( <a href="#aefe4793bcc5d38d828d5ead04cb4f75e">More...</a><br/></td></tr>
- <tr class="separator:aefe4793bcc5d38d828d5ead04cb4f75e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a39ddccc55b57eb96c8140cd6e869aab4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a39ddccc55b57eb96c8140cd6e869aab4"></a>
- <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> </td><td class="memItemRight" valign="bottom"><b>m_residence</b></td></tr>
- <tr class="separator:a39ddccc55b57eb96c8140cd6e869aab4"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p><a class="el" href="structfsdk_1_1_image.html" title="Image. ">Image</a>. </p>
- <p><a class="el" href="structfsdk_1_1_image.html" title="Image. ">Image</a> objects embed an implicit reference counter to automatically track consumers perform assignments without unnecessary reallocations in a thread-safe manner.</p>
- <p>Every time you assign or set an other image as the source of the current image, the current image data reference count is decreased, new data pointer is referenced, and it's counter is increased. When data reference count drops to zero, the data is deallocated.</p>
- <p><a class="el" href="structfsdk_1_1_image.html" title="Image. ">Image</a> can also reference external data without an actual ownership. This way you can operate on your data buffer using methods of <a class="el" href="structfsdk_1_1_image.html" title="Image. ">Image</a> and still own it and cotrol it's life time.</p>
- <dl class="section note"><dt>Note</dt><dd>be careful when initializing <a class="el" href="structfsdk_1_1_image.html" title="Image. ">Image</a> via <a class="el" href="structfsdk_1_1_image.html#ae43bcd728b9b3389a5d45e20dee1205d" title="Initializes an image with provided data. If current image is not empty and it's size and format match...">set()</a> or <a class="el" href="structfsdk_1_1_image.html#a1596737bcf2aea4a1c8fc336f6f1b182" title="Initializes an empty image and preallocates storage buffer of given size. ">create()</a> and do NOT provide pointer to data owned by an other image, since this way the destination image will be unaware of data reference counter which will lead to undefined behavior. Always use appropriate overloads to set image data. </dd></dl>
- </div><h2 class="groupheader">Member Enumeration Documentation</h2>
- <a class="anchor" id="a7929a4eb6155bd9430dac56142672936"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">enum <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">fsdk::Image::Error</a> : uint32_t</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">strong</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p><a class="el" href="structfsdk_1_1_image.html" title="Image. ">Image</a> error codes. </p>
- <table class="fieldtable">
- <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936aa60852f204ed8028c1c58808b746d115"></a>Ok</em> </td><td class="fielddoc">
- <p>Ok. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936a6518a24cb2d8166f5c57016e65e3f419"></a>InvalidWidth</em> </td><td class="fielddoc">
- <p>Invalid width. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936aaff424fc1ea568827830b838a80cd934"></a>InvalidHeight</em> </td><td class="fielddoc">
- <p>Invalid height. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936a588c80ae8885b51a5f0700894da5affe"></a>InvalidDataPtr</em> </td><td class="fielddoc">
- <p>Bad input data pointer. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936a0a86fcdcc2094e925e3166b9710f8d82"></a>InvalidDataSize</em> </td><td class="fielddoc">
- <p>Bad input data size. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936a107a93f5ad9b48f874341eaa0141e0f9"></a>InvalidImage</em> </td><td class="fielddoc">
- <p>Invalid image. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936a538273d971a3da3f944bfb95091df5d8"></a>InvalidArchive</em> </td><td class="fielddoc">
- <p>Archive error. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936a5d0744802b24f44a161d350c25d76c7b"></a>InvalidPath</em> </td><td class="fielddoc">
- <p>Bad path for saving / loading. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936ac85f85f7c13ed006eed130ec183aa810"></a>InvalidType</em> </td><td class="fielddoc">
- <p>Unsupported type. </p>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_image.html#ad7383fff1a8c54a0b2153ea475b607b7" title="Supported image types. ">Image::Type</a> for more information. </dd></dl>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936ade236a235b4e8ffc9141676624753b2d"></a>InvalidFormat</em> </td><td class="fielddoc">
- <p>Unsupported format. </p>
- <dl class="section see"><dt>See Also</dt><dd>Image::Format for more information. </dd></dl>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936abcdbc5068527815bd978d3cbba5e7deb"></a>InvalidBitmap</em> </td><td class="fielddoc">
- <p>Bitmap error occurred. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936a83fe3c82514cc399b416bbb9d25ac9a9"></a>InvalidMemory</em> </td><td class="fielddoc">
- <p>Error at memory opening. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936aaf9d45225e9d3edf59f2fd40d4b9f157"></a>InvalidConversion</em> </td><td class="fielddoc">
- <p>Conversion not implemented. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936a2a7695a194a2f785215c4ed058e2bf7b"></a>InvalidResidence</em> </td><td class="fielddoc">
- <p>Invalid memory residence. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936a3634e01cc1296daece9832c5396808c2"></a>InvalidDevice</em> </td><td class="fielddoc">
- <p>Target Device is not supported for this system. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936a70fa83b68f2d20d1c607a2864627f13d"></a>FailedToSave</em> </td><td class="fielddoc">
- <p>Error during image saving. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936a023fe093cb8dbc5a80d2a2259d4c97a5"></a>FailedToLoad</em> </td><td class="fielddoc">
- <p>Error during image loading. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936ade906b82a6f70f5f75ea0a11da932a36"></a>FailedToInitialize</em> </td><td class="fielddoc">
- <p>Error during initialization. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="a7929a4eb6155bd9430dac56142672936a014e56b039fd19b57e203c1fb371f5ce"></a>ReleasedInOtherThread</em> </td><td class="fielddoc">
- <p>Failed to retain image: it was released in another thread. </p>
- </td></tr>
- </table>
-
- </div>
- </div>
- <a class="anchor" id="acb272c751b60925b57a543cf19f31a5d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">enum <a class="el" href="structfsdk_1_1_image.html#acb272c751b60925b57a543cf19f31a5d">fsdk::Image::ImageCompression</a></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">strong</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Supported compression type is used only for jpg and png types. </p>
- <p>JPG case: the higher level of compression corresponds to the lower quality. Compression/decompression speed are constant. PNG case: the higher level of compression corresponds to the lower compression speed. <a class="el" href="structfsdk_1_1_quality.html" title="Quality estimation structure Each estimation is given in normalized [0, 1] range. Parameter meanings:...">Quality</a> are constant. </p>
- <table class="fieldtable">
- <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="acb272c751b60925b57a543cf19f31a5dab75738e569f17ad386d0ff4cb90eabb9"></a>IC_NO_COMPRESSION</em> </td><td class="fielddoc">
- <p>no compression (only for png or jpg image) </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="acb272c751b60925b57a543cf19f31a5dae811dec1e75f575972a667e83a23bd34"></a>IC_SMALL_COMPRESSION</em> </td><td class="fielddoc">
- <p>compression with minimal (or without) quality loss (only for png or jpg image) </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="acb272c751b60925b57a543cf19f31a5daf526f9c09cd1a065f528dc6518895615"></a>IC_MEDIUM_COMPRESSION</em> </td><td class="fielddoc">
- <p>medium compression (only for png or jpg) </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="acb272c751b60925b57a543cf19f31a5da60cdeb7647e393444a05d358810293f5"></a>IC_HARD_COMPRESSION</em> </td><td class="fielddoc">
- <p>more than medium compression (only for png or jpg) </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="acb272c751b60925b57a543cf19f31a5daccd72f086a3257b06c12b790a683f2d6"></a>IC_BEST_COMPRESSION</em> </td><td class="fielddoc">
- <p>maximum compression level (only for png or jpg) </p>
- </td></tr>
- </table>
-
- </div>
- </div>
- <a class="anchor" id="abe735660a541cb213facb543b93f4e07"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">enum <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">fsdk::Image::MemoryResidence</a> : uint32_t</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">strong</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Memory residence. </p>
- <dl class="section note"><dt>Note</dt><dd>MemoryGPU residence is not supported for mobile platforms! Attempt to use such image on such platforms will cause an error. </dd></dl>
- <table class="fieldtable">
- <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993"></a>MemoryCPU</em> </td><td class="fielddoc">
- <p><a class="el" href="structfsdk_1_1_image.html" title="Image. ">Image</a> in Host device memory. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="abe735660a541cb213facb543b93f4e07af9b0ab7ae4fae4c4b922abbce4b9bebf"></a>MemoryGPU</em> </td><td class="fielddoc">
- <p><a class="el" href="structfsdk_1_1_image.html" title="Image. ">Image</a> in Cuda device memory. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="abe735660a541cb213facb543b93f4e07a40657ac0e763be1c1a745957006c3555"></a>MemoryNPU</em> </td><td class="fielddoc">
- <p><a class="el" href="structfsdk_1_1_image.html" title="Image. ">Image</a> in NPU device memory. </p>
- </td></tr>
- <tr><td class="fieldname"><em><a class="anchor" id="abe735660a541cb213facb543b93f4e07a1359bce90afb193bac4435d19c8864dd"></a>MemoryNPU_DPP</em> </td><td class="fielddoc">
- <p><a class="el" href="structfsdk_1_1_image.html" title="Image. ">Image</a> in NPU PreProcessing module memory. </p>
- </td></tr>
- </table>
-
- </div>
- </div>
- <h2 class="groupheader">Constructor & Destructor Documentation</h2>
- <a class="anchor" id="a624947f81acd14120076f42860e51611"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> fsdk::Image::Image </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>width</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>height</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> </td>
- <td class="paramname"><em>residence</em> = <code><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993">MemoryResidence::MemoryCPU</a></code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>deviceId</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Initializes an empty image and preallocates storage buffer of given size. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>image width. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>image height. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>image format. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">deviceId</td><td>index of a device where image will be allocated </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>deviceId is ignored for residence = <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a> </dd>
- <dd>
- if memory allocation fails, no exception is thrown; function call results in empty image. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a348af5fca41e5b170c0487a055f6ebbb"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> fsdk::Image::Image </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>width</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>height</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const void * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> </td>
- <td class="paramname"><em>residence</em> = <code><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993">MemoryResidence::MemoryCPU</a></code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>deviceId</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Initializes an empty image and preallocates storage buffer of given size. Fills image contents with provided data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>image width. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>image height. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>image format. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>image data. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">deviceId</td><td>index of a device where image will be allocated </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>deviceId is ignored for residence = <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a> </dd>
- <dd>
- if memory allocation fails, no exception is thrown; function call results in empty image. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ac4d7421e28a9d81fed4de88dcc3fecf4"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> fsdk::Image::Image </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>width</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>height</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>copy</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> </td>
- <td class="paramname"><em>residence</em> = <code><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993">MemoryResidence::MemoryCPU</a></code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>deviceId</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Initializes an image. If copy is true, this allocates a new buffer of given size and fills image contents with provided data (copies it). If copy is false (which is default) this will just reference the provided data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>image width. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>image height. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>image format. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>image data. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">copy</td><td>[optional] whether to copy or reference data. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">deviceId</td><td>index of a device where image will be allocated </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>deviceId is ignored for residence = <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a> </dd>
- <dd>
- if memory allocation fails, no exception is thrown; function call results in empty image. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a021abfa7a95a7d6a1e9f4edabf2043a2"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> fsdk::Image::Image </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_image.html">Image</a> & </td>
- <td class="paramname"><em>other</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Initializes an image as a reference to an other image. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>other image. </td></tr>
- </table>
- </dd>
- </dl>
-
- </div>
- </div>
- <a class="anchor" id="aac20796ff887ec564cee62c826374384"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> fsdk::Image::Image </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html">Image</a> && </td>
- <td class="paramname"><em>other</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Initializes an image with contents of an other image. Source image is then invalidated. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>other image. </td></tr>
- </table>
- </dd>
- </dl>
-
- </div>
- </div>
- <a class="anchor" id="a6c85de74e85305f06232bdfb49331e0e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> fsdk::Image::Image </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_sub_image.html">SubImage</a> & </td>
- <td class="paramname"><em>subImage</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Initializes an image with contents of a sub image. Since sub images do not handle data life time, image contents are always copied. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">subImage</td><td>sub image. </td></tr>
- </table>
- </dd>
- </dl>
-
- </div>
- </div>
- <h2 class="groupheader">Member Function Documentation</h2>
- <a class="anchor" id="aef4ba8f782d69628ffaffc4da6ed970f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static <a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> void* fsdk::Image::allocate </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>size</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Allocate memory. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>memory region size in bytes. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>Memory region pointer. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a523b0c28a4003c75c3907d0c93110493"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="structfsdk_1_1_image.html">Image</a> fsdk::Image::clone </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Create a copy of this image. The new image will have it's own reference count. </p>
- <dl class="section return"><dt>Returns</dt><dd>new image with copied data. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>empty image returned in case of an error. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ab0c8024817b8e634f5ec18f1a0f08916"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Image::Error</a>> fsdk::Image::convert </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html">Image</a> & </td>
- <td class="paramname"><em>dest</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>x</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>y</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>width</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>height</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#a8a60bf4ecd1f111e034ff9a8478e62f4">TargetDevice</a> </td>
- <td class="paramname"><em>device</em> = <code>TargetDevice::CPU</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Convert image format. </p>
- <dl class="section note"><dt>Note</dt><dd>specifying out of bounds area will result in runtime error. </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in,out]</td><td class="paramname">dest</td><td>destination image. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>horisontal coordinate of top left corner of image rect to convert. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>vertical coordinate of top left corner of image rect to convert. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>width of image rect to convert. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>height of image rect to convert. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>new format. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">device</td><td>target device to run convert on. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>dest should not be the same as this image. </dd>
- <dd>
- memory will not be reallocated if dest was already created with appropriate dimensions and format. </dd></dl>
- <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> with error code specified by <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> and <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a566dd9391571379fed5e1da2ed9975c8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Image::Error</a>> fsdk::Image::convert </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html">Image</a> & </td>
- <td class="paramname"><em>dest</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="namespacefsdk.html#abc92bf6fd92f16b2d9c8e78a85838bcd">Point2i</a> & </td>
- <td class="paramname"><em>origin</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="namespacefsdk.html#a77eb62991e30a65164c055b3e518defd">Size</a> & </td>
- <td class="paramname"><em>size</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#a8a60bf4ecd1f111e034ff9a8478e62f4">TargetDevice</a> </td>
- <td class="paramname"><em>device</em> = <code>TargetDevice::CPU</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Convert image format. </p>
- <dl class="section note"><dt>Note</dt><dd>specifying out of bounds area will result in runtime error. </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in,out]</td><td class="paramname">dest</td><td>destination image. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">origin</td><td>converted image origin. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>image size to convert. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>new format. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">device</td><td>target device to run convert on. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>dest should not be the same as this image. </dd>
- <dd>
- memory will not be reallocated if dest was already created with appropriate dimensions and format. </dd></dl>
- <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> with error code specified by <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> and <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a3ddea03d5ee948a5c2d0aa81a4fe8027"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Image::Error</a>> fsdk::Image::convert </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html">Image</a> & </td>
- <td class="paramname"><em>dest</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="namespacefsdk.html#a77eb62991e30a65164c055b3e518defd">Size</a> & </td>
- <td class="paramname"><em>size</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#a8a60bf4ecd1f111e034ff9a8478e62f4">TargetDevice</a> </td>
- <td class="paramname"><em>device</em> = <code>TargetDevice::CPU</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Convert image format. </p>
- <dl class="section note"><dt>Note</dt><dd>specifying out of bounds area will result in runtime error. </dd>
- <dd>
- new image origin is assumed at the top-left corner of the existing one. </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in,out]</td><td class="paramname">dest</td><td>destination image. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>new format. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>image area size to convert. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">device</td><td>target device to run convert on. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>dest should not be the same as this image. </dd>
- <dd>
- memory will not be reallocated if dest was already created with appropriate dimensions and format. </dd></dl>
- <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> with error code specified by <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> and <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a9a8a6abf162c095d6f1e62919cf4dabf"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Image::Error</a>> fsdk::Image::convert </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html">Image</a> & </td>
- <td class="paramname"><em>dest</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_base_rect.html">Rect</a> & </td>
- <td class="paramname"><em>rect</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#a8a60bf4ecd1f111e034ff9a8478e62f4">TargetDevice</a> </td>
- <td class="paramname"><em>device</em> = <code>TargetDevice::CPU</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Convert image format. </p>
- <dl class="section note"><dt>Note</dt><dd>specifying out of bounds area will result in runtime error. </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in,out]</td><td class="paramname">dest</td><td>destination image. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>new format. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">rect</td><td>image area rect to convert. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">device</td><td>target device to run convert on. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>dest should not be the same as this image. </dd>
- <dd>
- memory will not be reallocated if dest was already created with appropriate dimensions and format. </dd></dl>
- <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> with error code specified by <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> and <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a10e36f6ea8f5e293f7bd58658ecb1653"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Image::Error</a>> fsdk::Image::convert </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html">Image</a> & </td>
- <td class="paramname"><em>dest</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#a8a60bf4ecd1f111e034ff9a8478e62f4">TargetDevice</a> </td>
- <td class="paramname"><em>device</em> = <code>TargetDevice::CPU</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Convert image format. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in,out]</td><td class="paramname">dest</td><td>destination image. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>new format. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">device</td><td>target device to run convert on. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>dest should not be the same as this image. </dd>
- <dd>
- memory will not be reallocated if dest was already created with appropriate dimensions and format. </dd></dl>
- <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> with error code specified by <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> and <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a1596737bcf2aea4a1c8fc336f6f1b182"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a>> fsdk::Image::create </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>width</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>height</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>cleanup</em> = <code>true</code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> </td>
- <td class="paramname"><em>residence</em> = <code><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993">MemoryResidence::MemoryCPU</a></code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>deviceId</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Initializes an empty image and preallocates storage buffer of given size. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>image width. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>image height. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>image format. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">cleanup</td><td>initializes internal image memory to default value. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">residence</td><td>memory residence of a data pointer. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">deviceId</td><td>index of a device where image will be allocated </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>deviceId is ignored for residence = <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a> </dd>
- <dd>
- output image will have memory residence of the provided data pointer. </dd>
- <dd>
- if memory allocation fails, no exception is thrown; function call results in empty image. </dd></dl>
- <dl class="section return"><dt>Returns</dt><dd>true in case of success, false otherwise. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="aafa5e102bd9b4ccda1f827f1a12499db"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a>> fsdk::Image::create </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>width</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>height</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const void * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> </td>
- <td class="paramname"><em>residence</em> = <code><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993">MemoryResidence::MemoryCPU</a></code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>deviceId</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Initializes an empty image and preallocates storage buffer of given size. Fills image contents with provided data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>image width. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>image height. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>image format. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>image data. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">memory</td><td>residence of a data pointer. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">deviceId</td><td>index of a device where data pointer was allocated </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>deviceId is ignored for residence = <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a> </dd>
- <dd>
- output image will have memory residence of the provided data pointer. </dd>
- <dd>
- if memory allocation fails, no exception is thrown; function call results in empty image. </dd></dl>
- <dl class="section return"><dt>Returns</dt><dd>true in case of success, false otherwise. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a99fd0c30cf7d2fd3c26ff6f1771a356b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a>> fsdk::Image::create </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>width</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>height</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>copy</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> </td>
- <td class="paramname"><em>residence</em> = <code><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993">MemoryResidence::MemoryCPU</a></code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>deviceId</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Initializes an image. If copy is true, this allocates a new buffer of given size and fills image contents with provided data (copies it). If copy is false (which is default) this will just reference the provided data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>image width. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>image height. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>image format. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>image data. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">copy</td><td>whether to copy or reference data </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">memory</td><td>residence of a data pointer. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">deviceId</td><td>index of a device where data pointer was allocated </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>deviceId is ignored for residence = <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a> </dd>
- <dd>
- output image will have memory residence of the provided data pointer. </dd>
- <dd>
- if memory allocation fails, no exception is thrown; function call results in empty image. </dd></dl>
- <dl class="section return"><dt>Returns</dt><dd>true in case of success, false otherwise. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="aeb3e38807e56a77419a073eea1e6d2ec"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a>> fsdk::Image::create </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_image.html">fsdk::Image</a> & </td>
- <td class="paramname"><em>source</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> </td>
- <td class="paramname"><em>residence</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>deviceId</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Creates image with given memory residence based on other image instance. If source image has another MemoryResidence or device id, all memory will be copied to the new residence. In the other case new instance will be just a reference for the source. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">image</td><td>instance to create copy for </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">residence</td><td>memory residence for the target image </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">deviceId</td><td>index of a device for the target image </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>deviceId is ignored for residence = <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a> </dd></dl>
- <dl class="section return"><dt>Returns</dt><dd>true in case of success, false otherwise. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a750cb313b381b4245a1e51e34b18ae44"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static <a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> void fsdk::Image::deallocate </td>
- <td>(</td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>memory</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Free memory. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">memory</td><td>memory region pointer. </td></tr>
- </table>
- </dd>
- </dl>
-
- </div>
- </div>
- <a class="anchor" id="a22f36f59a67cc867a96686dcf18b8f6d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool fsdk::Image::equalStrong </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_image.html">fsdk::Image</a> & </td>
- <td class="paramname"><em>other</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Performs strong comparison of this image with other. Beside weak comparison strong comparison also checks whether two images point to the same block of pixels. </p>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_image.html#a386e2313d25f5f3107e1a47a347e04d8" title="Performs weak comparison of this image with other. Weak in this context means only image parameters s...">equalWeak()</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="add9bb121cb86eb35e669b6321a267926"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_image.html">Image</a> fsdk::Image::extract </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>x</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>y</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>width</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>height</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Extract a sub image of this image. The new image will have it's own reference count. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>horisontal coordinate of top left corner of image rect to extract. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>vertical coordinate of top left corner of image rect to extract. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>width of image rect to extract. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>height of image rect to extract. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>new image with copied data. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>empty image returned in case of an memory allocation error. </dd>
- <dd>
- Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a3f9f9c61324959b028b645b0a873ae21"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="structfsdk_1_1_image.html">Image</a> fsdk::Image::extract </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_base_rect.html">Rect</a> & </td>
- <td class="paramname"><em>rect</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Extract a sub image of this image. The new image will have it's own reference count. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">rect</td><td>image rect to extract. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>new image with copied data. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>empty image returned in case of an memory allocation error. </dd>
- <dd>
- Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a4cd2e1c9c500087bcfb65f750cef09e4"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="structfsdk_1_1_image.html">Image</a> fsdk::Image::extract </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacefsdk.html#a77eb62991e30a65164c055b3e518defd">Size</a> & </td>
- <td class="paramname"><em>size</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Extract a sub image of this image. The new image will have it's own reference count. </p>
- <dl class="section note"><dt>Note</dt><dd>new image origin is assumed at the top-left corner of the existing one. </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>image size to extract. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>new image with copied data. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>empty image returned in case of an memory allocation error. </dd>
- <dd>
- Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a01e37e8244745a1645c7f44356c98cfa"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="structfsdk_1_1_image.html">Image</a> fsdk::Image::extract </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacefsdk.html#abc92bf6fd92f16b2d9c8e78a85838bcd">Point2i</a> & </td>
- <td class="paramname"><em>origin</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="namespacefsdk.html#a77eb62991e30a65164c055b3e518defd">Size</a> & </td>
- <td class="paramname"><em>size</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Extract a sub image of this image. The new image will have it's own reference count. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">origin</td><td>extracted image origin. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>image size to extract. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>new image with copied data. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>empty image returned in case of an memory allocation error. </dd>
- <dd>
- Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a28a2f942184d21b0e4270c30adef7916"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">float fsdk::Image::getAspectRatio </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>image aspect ratio (width to height). </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a177197485010936725923806ed693187"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void* fsdk::Image::getData </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>pointer to raw image data. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="adb87ac4315e08d3474b87dd1819748d5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const void* fsdk::Image::getData </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>pointer to raw image data. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ab0f6a417fa00693acfc22af05fdaddaf"></a>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">T* fsdk::Image::getDataAs </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>pointer to image data cast to a given type. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a2ffa58c82ae839a8804721def179ccb6"></a>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const T* fsdk::Image::getDataAs </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>pointer to image data cast to a given type. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ad7702083887209a2c4e188b500215e96"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> int fsdk::Image::getDataSize </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>actual image size in bytes. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a494e5a70e35f8a9965c9c655faf71694"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> void fsdk::Image::getDataSize </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_sizer.html">Sizer</a> & </td>
- <td class="paramname"><em>sizer</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Get actual image size in bytes. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in,out]</td><td class="paramname">sizer</td><td>sizer to append result to. </td></tr>
- </table>
- </dd>
- </dl>
-
- </div>
- </div>
- <a class="anchor" id="a3a096c49b65cb9b3ddc864a1fe0bbc5f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="structfsdk_1_1_format.html">Format</a> fsdk::Image::getFormat </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>image format. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ad5823d56f2b75a94424adef45c9d23c2"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">int fsdk::Image::getHeight </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>image height. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a5841db4b37f8e3f633f9ee31e29e28b6"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="structfsdk_1_1_base_rect.html">Rect</a> fsdk::Image::getRect </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>image rectangle. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>resulting rectangle top left corner is lways at (0, 0). </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a48773dce5d77377aa6415084ff2a612f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> int fsdk::Image::getRefCount </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Obtain reference count. </p>
- <dl class="section return"><dt>Returns</dt><dd>Current reference count. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a02d33587be44369699ff0c77bf918f7e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">int fsdk::Image::getRowSize </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>size of image pixel row in bytes. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a81b837c8ebacc00461ced25cc6299176"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> void* fsdk::Image::getScanLine </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>y</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Get image scanline data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>scanline number. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>pointer to raw data. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="aaf7e663816bd542c1f80d42e29c22014"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> const void* fsdk::Image::getScanLine </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>y</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Get image scanline data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>scanline number. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>pointer to raw data. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="afb6c77133c3cbe2f5f7825286096ec46"></a>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">T* fsdk::Image::getScanLineAs </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>y</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Get image scanline data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>scanline number. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>pointer image data cast to a given type. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="adb2d3b84e0b3c81a8f1528e884fa655a"></a>
- <div class="memitem">
- <div class="memproto">
- <div class="memtemplate">
- template<typename T > </div>
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">const T* fsdk::Image::getScanLineAs </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>y</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Get image scanline data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>scanline number. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>pointer image data cast to a given type. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ac38de3f8f7136d3011bc49b399efcd5a"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="namespacefsdk.html#a77eb62991e30a65164c055b3e518defd">Size</a> fsdk::Image::getSize </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>image size. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a6cb445da4dc6f7949c992f6bdcd6787f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">int fsdk::Image::getWidth </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>image width. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a9f2d12403ad91ca275de2259da560d05"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">static <a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a>> fsdk::Image::guessTypeFromMemory </td>
- <td>(</td>
- <td class="paramtype">const void * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const uint32_t </td>
- <td class="paramname"><em>sizeInBytes</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#ad7383fff1a8c54a0b2153ea475b607b7">Type</a> & </td>
- <td class="paramname"><em>type</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Guess type of image written into memory. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to memory containing image. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">sizeInBytes</td><td>Count of bytes containing image pointed to by data. </td></tr>
- <tr><td class="paramdir">[out]</td><td class="paramname">type</td><td>Type of passed image. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true if success, false if some error occured. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>Unknown type of image is not an error. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a935733a13b5a2d62758f63a0fa2580e9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool fsdk::Image::isNull </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>true if image data is not allocated. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a33771e3d4141977d08be1302020ff6cd"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool fsdk::Image::isSharedWith </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_image.html">Image</a> & </td>
- <td class="paramname"><em>other</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>true if this image shares the same memory chunk for it's data as the other one. </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>other image to check againts. </td></tr>
- </table>
- </dd>
- </dl>
-
- </div>
- </div>
- <a class="anchor" id="a42bb8bc044a084b7779760c20701fa0d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool fsdk::Image::isValid </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>true if image is not null and has valid dimenstions and format. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_image.html#a935733a13b5a2d62758f63a0fa2580e9">isNull</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a8f17c7659871533d5eed712b3967944b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a>> fsdk::Image::load </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>path</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Load image from file. </p>
- <p>This function loads image contents from disk. Supported types are: bmp, png, ppm, jpeg, tiff. If image is not empty, it's content will be freed and memory will be reallocated to fit in the data from the file if:</p>
- <ul>
- <li>the file can be opened</li>
- <li>the file is of supported format <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Input file path. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> with error code specified by <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> and <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
- </li>
- </ul>
-
- </div>
- </div>
- <a class="anchor" id="a50d05981de264e977f4fbd90990f084a"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a>> fsdk::Image::load </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Load image from file and convert it to required format. </p>
- <p>This function does exact same thing as method above, and additionally converts loaded image to input format. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>Input file path. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>required image format. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> with error code specified by <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> and <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a824376f7ac69c83fc8026cf38a235806"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a>> fsdk::Image::loadFromMemory </td>
- <td>(</td>
- <td class="paramtype">const void * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const uint32_t </td>
- <td class="paramname"><em>sizeInBytes</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Load image from memory. </p>
- <p>This function loads image contents from memory. Supported types are: bmp, png, ppm, jpeg, tiff. If image is not empty, it's content will be freed and memory will be reallocated to fit in the data from the file if:</p>
- <ul>
- <li>the file can be opened</li>
- <li>the file is of supported format <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to input memory. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">sizeInBytes</td><td>Count of bytes of image pointed to by data. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> with error code specified by <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> and <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
- </li>
- </ul>
-
- </div>
- </div>
- <a class="anchor" id="a27b9eae4a7a4bf22182bb98debf8c45d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a>> fsdk::Image::loadFromMemory </td>
- <td>(</td>
- <td class="paramtype">const void * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const uint32_t </td>
- <td class="paramname"><em>sizeInBytes</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Load image from memory and convert it to required format. </p>
- <p>This function does exact same thing as method above, and additionally converts loaded image to input format. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to input memory. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">sizeInBytes</td><td>Count of bytes of image pointed to by data. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>required image format. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> with error code specified by <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> and <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a7d560518bf9a96c0fc8795edb4374a31"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a>> fsdk::Image::loadFromMemoryOfType </td>
- <td>(</td>
- <td class="paramtype">const void * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const uint32_t </td>
- <td class="paramname"><em>sizeInBytes</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_image.html#ad7383fff1a8c54a0b2153ea475b607b7">Type</a> </td>
- <td class="paramname"><em>type</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Load image from memory of specific type. </p>
- <p>This function loads specific type image contents from memory. If data points to image of another type, not the one passed, does nothing. Supported types are: bmp, png, ppm, jpeg, tiff. If image is not empty, it's content will be freed and memory will be reallocated to fit in the data from the file if:</p>
- <ul>
- <li>the file can be opened</li>
- <li>the file is of supported format <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to input memory. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">sizeInBytes</td><td>Count of bytes of image pointed to by data. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Type of image to be loaded. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> with error code specified by <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> and <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
- </li>
- </ul>
-
- </div>
- </div>
- <a class="anchor" id="ae7015b5e7e8c21af7fb23a93a1235301"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a>> fsdk::Image::loadFromMemoryOfType </td>
- <td>(</td>
- <td class="paramtype">const void * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const uint32_t </td>
- <td class="paramname"><em>sizeInBytes</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_image.html#ad7383fff1a8c54a0b2153ea475b607b7">Type</a> </td>
- <td class="paramname"><em>type</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Load image from memory of specific type and convert it to required format. </p>
- <p>This function does exact same thing as method above, and additionally converts loaded image to input format. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to input memory. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">sizeInBytes</td><td>Count of bytes of image pointed to by data. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>Type of image to be loaded. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>required image format. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> with error code specified by <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> and <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ae05f21724f71ad844532ec46310bd252"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_sub_image.html">SubImage</a> fsdk::Image::map </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>x</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>y</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>width</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>height</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Map image contents to a given area. </p>
- <dl class="section note"><dt>Note</dt><dd>specifying out of bounds area will result in runtime error. </dd>
- <dd>
- Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">x</td><td>horizontal coordinate of top left corner of image rect to map. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">y</td><td>vertical coordinate of top left corner of image rect to map. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>width of image rect to map </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>height of image rect to map </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>sub image corresponding to the given area. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ac085efbd15cc73fea521d9067d551d61"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="structfsdk_1_1_sub_image.html">SubImage</a> fsdk::Image::map </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_base_rect.html">Rect</a> & </td>
- <td class="paramname"><em>rect</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Map image contents to a given area. </p>
- <dl class="section note"><dt>Note</dt><dd>specifying out of bounds area will result in runtime error. </dd>
- <dd>
- Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">rect</td><td>image rect to extract </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>sub image corresponding to the given area. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="aa4c32526ccd387fb89500e766ae3ce7f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="structfsdk_1_1_sub_image.html">SubImage</a> fsdk::Image::map </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacefsdk.html#a77eb62991e30a65164c055b3e518defd">Size</a> & </td>
- <td class="paramname"><em>size</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Map image contents to a given area. </p>
- <dl class="section note"><dt>Note</dt><dd>specifying out of bounds area will result in runtime error. </dd>
- <dd>
- sub image origin is assumed at the top-left corner of the existing one. </dd>
- <dd>
- Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>image size to map. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>sub image corresponding to the given area. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a5e5e5885d7e3e85d8d07b2c5a84937c5"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="structfsdk_1_1_sub_image.html">SubImage</a> fsdk::Image::map </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="namespacefsdk.html#abc92bf6fd92f16b2d9c8e78a85838bcd">Point2i</a> & </td>
- <td class="paramname"><em>origin</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="namespacefsdk.html#a77eb62991e30a65164c055b3e518defd">Size</a> & </td>
- <td class="paramname"><em>size</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Map image contents to a given area. </p>
- <dl class="section note"><dt>Note</dt><dd>specifying out of bounds area will result in runtime error. </dd>
- <dd>
- Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">origin</td><td>sub image image origin. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>sub image size to extract. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>sub image corresponding to the given area. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a94659c183621f3be301832e3673936c6"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">fsdk::Image::operator bool </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Implicit cast to boolean; results in true if image is valid, false if not. </p>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_image.html#a42bb8bc044a084b7779760c20701fa0d">isValid</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a6e64bb21715b54c2b208c370d4c6bb2d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="structfsdk_1_1_image.html">Image</a>& fsdk::Image::operator= </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_image.html">Image</a> & </td>
- <td class="paramname"><em>other</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Assign other image. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>image to assign. </td></tr>
- </table>
- </dd>
- </dl>
-
- </div>
- </div>
- <a class="anchor" id="acbc748fe0bdd194deb00b26e06a51ed9"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="structfsdk_1_1_image.html">Image</a>& fsdk::Image::operator= </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html">Image</a> && </td>
- <td class="paramname"><em>other</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Move other image. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>image to move. </td></tr>
- </table>
- </dd>
- </dl>
-
- </div>
- </div>
- <a class="anchor" id="adf5ed625bd338c55677dee58043de494"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">bool fsdk::Image::ownsData </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
- <dl class="section return"><dt>Returns</dt><dd>true, if this image data was allocated by the image itself (via ctor or <a class="el" href="structfsdk_1_1_image.html#a1596737bcf2aea4a1c8fc336f6f1b182" title="Initializes an empty image and preallocates storage buffer of given size. ">create()</a>). Otherwise returns false. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a32f3e84a17a9e47a516d2f9cef50c040"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> int fsdk::Image::release </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Decrease reference count. </p>
- <dl class="section return"><dt>Returns</dt><dd>Current reference count. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a6ed2d1d79094102bed624f40f14f4acb"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_image.html">Image</a> fsdk::Image::rescale </td>
- <td>(</td>
- <td class="paramtype">float </td>
- <td class="paramname"><em>scale</em></td><td>)</td>
- <td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Rescale image keeping proportions. </p>
- <dl class="section note"><dt>Note</dt><dd>Performs bilinear interpolation. </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">scale</td><td>factor. Must be positive. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>scaled image. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="aadc0669fe4f2632fb259d2cba1a06738"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> int fsdk::Image::retain </td>
- <td>(</td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Increase reference count. </p>
- <dl class="section return"><dt>Returns</dt><dd>Current reference count. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ae3bd0f9b7e1dd8871e7110d566c0eb3b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Image::Error</a>> fsdk::Image::save </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#acb272c751b60925b57a543cf19f31a5d">fsdk::Image::ImageCompression</a> </td>
- <td class="paramname"><em>additionalFlag</em> = <code><a class="el" href="structfsdk_1_1_image.html#acb272c751b60925b57a543cf19f31a5dab75738e569f17ad386d0ff4cb90eabb9">fsdk::Image::ImageCompression::IC_NO_COMPRESSION</a></code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Save image. </p>
- <p>This function saves image contents to disk. Type is extracted from provided file extension. If it is unknown, function fails. Supported types are: bmp, png, ppm, jpeg, tiff. </p>
- <dl class="section note"><dt>Note</dt><dd>Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>output file path with proper file extension. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">additionalFlag</td><td>additional flag for saving of png or jpg image </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> with error code specified by <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> and <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a9551bec72e3e4798bce2ddd116b53f6e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a>> fsdk::Image::save </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>path</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Convert and Save image. </p>
- <p>This function converts image to required format and saves image contents to disk. Type is extracted from provided file extension. If it is unknown, function fails. Supported types are: bmp, png, ppm, jpeg, tiff. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">path</td><td>output file path with proper file extension. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>required image format. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> with error code specified by <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> and <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a394ec678da307c9f6f73b673567bc9ae"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Image::Error</a>> fsdk::Image::saveToMemory </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#ad7383fff1a8c54a0b2153ea475b607b7">Image::Type</a> </td>
- <td class="paramname"><em>type</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_i_archive.html">IArchive</a> * </td>
- <td class="paramname"><em>archive</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#acb272c751b60925b57a543cf19f31a5d">fsdk::Image::ImageCompression</a> </td>
- <td class="paramname"><em>additionalFlag</em> = <code><a class="el" href="structfsdk_1_1_image.html#acb272c751b60925b57a543cf19f31a5dab75738e569f17ad386d0ff4cb90eabb9">fsdk::Image::ImageCompression::IC_NO_COMPRESSION</a></code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Save image to memory buffer. </p>
- <p>This function saves image contents to memory buffer (<a class="el" href="structfsdk_1_1_i_archive.html" title="Archive interface. ">IArchive</a>). Passed IArchvie will call setSizeHint for resize. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname"><a class="el" href="structfsdk_1_1_image.html#ad7383fff1a8c54a0b2153ea475b607b7" title="Supported image types. ">Image::Type</a></td><td>format used to encode. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname"><a class="el" href="structfsdk_1_1_i_archive.html" title="Archive interface. ">IArchive</a></td><td>to store contents of encoded image. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">additionalFlag</td><td>additional flag for saving of png or jpg image </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> with error code specified by <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> and <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a4031cca84864d83a5361968eaec0809e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Image::Error</a>> fsdk::Image::saveToMemory </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#ad7383fff1a8c54a0b2153ea475b607b7">Image::Type</a> </td>
- <td class="paramname"><em>type</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_i_archive.html">IArchive</a> * </td>
- <td class="paramname"><em>archive</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td> const</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Convert and save image to memory buffer. </p>
- <p>This function converts image to required format and saves image contents to memory buffer (<a class="el" href="structfsdk_1_1_i_archive.html" title="Archive interface. ">IArchive</a>). Passed IArchvie will call setSizeHint for resize. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname"><a class="el" href="structfsdk_1_1_image.html#ad7383fff1a8c54a0b2153ea475b607b7" title="Supported image types. ">Image::Type</a></td><td>format used to encode. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname"><a class="el" href="structfsdk_1_1_i_archive.html" title="Archive interface. ">IArchive</a></td><td>to store contents of encoded image. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>required image format. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> with error code specified by <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> and <a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936" title="Image error codes. ">Image::Error</a>. </dd></dl>
- <dl class="section note"><dt>Note</dt><dd>Memory residence must be <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a>. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="ae43bcd728b9b3389a5d45e20dee1205d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a>> fsdk::Image::set </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>width</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>height</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const void * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> </td>
- <td class="paramname"><em>residence</em> = <code><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993">MemoryResidence::MemoryCPU</a></code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>deviceId</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Initializes an image with provided data. If current image is not empty and it's size and format match the provided ones, no memory reallocation is performed. Otherwise image is re-created to match requirements. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>image width. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>image height. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>image format. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>image data. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">memory</td><td>residence of a data pointer. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">deviceId</td><td>index of a device where data pointer was allocated </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>deviceId is ignored for residence = <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a> </dd>
- <dd>
- output image will have memory residence of the provided data pointer. </dd>
- <dd>
- if memory allocation fails, no exception is thrown; function call results in empty image. </dd></dl>
- <dl class="section return"><dt>Returns</dt><dd>true in case of success, false otherwise. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a85ddf384c606013f7c2aa2815eaeccf4"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a>> fsdk::Image::set </td>
- <td>(</td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>width</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>height</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_format.html">Format</a> </td>
- <td class="paramname"><em>format</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">void * </td>
- <td class="paramname"><em>data</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">bool </td>
- <td class="paramname"><em>copy</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07">MemoryResidence</a> </td>
- <td class="paramname"><em>residence</em> = <code><a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993">MemoryResidence::MemoryCPU</a></code>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">int </td>
- <td class="paramname"><em>deviceId</em> = <code>0</code> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Initializes an image with provided data. If copy is true and if current image is not empty and it's size and format match the provided ones, no memory reallocation is performed. Otherwise image is re-created to match requirements. If copy is false (which is default) this will just reference the provided data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">width</td><td>image width. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">height</td><td>image height. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">format</td><td>image format. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>image data. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">copy</td><td>whether to copy or reference data. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">memory</td><td>residence of a data pointer. </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">deviceId</td><td>index of a device where data pointer was allocated </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>deviceId is ignored for residence = <a class="el" href="structfsdk_1_1_image.html#abe735660a541cb213facb543b93f4e07a2795bef6531632efb72ad70348fb5993" title="Image in Host device memory. ">MemoryResidence::MemoryCPU</a> </dd>
- <dd>
- output image will have memory residence of the provided data pointer. </dd>
- <dd>
- if memory allocation fails, no exception is thrown; function call results in empty image. </dd></dl>
- <dl class="section return"><dt>Returns</dt><dd>true in case of success, false otherwise. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="af449e5eaada6b033205fec916c758aff"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a>> fsdk::Image::set </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_image.html">Image</a> & </td>
- <td class="paramname"><em>other</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Initializes an image as a reference to an other image. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">other</td><td>other image. </td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>true in case of success, false otherwise. </dd></dl>
-
- </div>
- </div>
- <a class="anchor" id="a62466dd45bd37cdd3c73bdeb7b268b20"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_def_8h.html#a5dc4c3043f171426dafe6fc800218945">FSDK_API</a> <a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="structfsdk_1_1_image.html#a7929a4eb6155bd9430dac56142672936">Error</a>> fsdk::Image::set </td>
- <td>(</td>
- <td class="paramtype">const <a class="el" href="structfsdk_1_1_sub_image.html">SubImage</a> & </td>
- <td class="paramname"><em>subImage</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Initializes an image with contents of a sub image. Since sub images do not handle data life time, image contents are always copied. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in]</td><td class="paramname">subImage</td><td>sub image. </td></tr>
- </table>
- </dd>
- </dl>
-
- </div>
- </div>
- <a class="anchor" id="a6cc848e22d99f4d2d8b34d240c0bba47"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">void fsdk::Image::swap </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="structfsdk_1_1_image.html">Image</a> & </td>
- <td class="paramname"><em>other</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>Swap contents with another image. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramdir">[in,out]</td><td class="paramname">other</td><td>image to swap with. </td></tr>
- </table>
- </dd>
- </dl>
-
- </div>
- </div>
- <h2 class="groupheader">Member Data Documentation</h2>
- <a class="anchor" id="aefe4793bcc5d38d828d5ead04cb4f75e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="structfsdk_1_1_format.html">Format</a> fsdk::Image::m_format</td>
- </tr>
- </table>
- </td>
- <td class="mlabels-right">
- <span class="mlabels"><span class="mlabel">protected</span></span> </td>
- </tr>
- </table>
- </div><div class="memdoc">
-
- <p>image format ( </p>
- <dl class="section see"><dt>See Also</dt><dd><a class="el" href="structfsdk_1_1_format.html" title="Image format. ">Format</a>). </dd></dl>
-
- </div>
- </div>
- <hr/>The documentation for this struct was generated from the following file:<ul>
- <li>include/fsdk/Types/<a class="el" href="_image_8h_source.html">Image.h</a></li>
- </ul>
- </div><!-- contents -->
- </div><!-- doc-content -->
- <!-- start footer part -->
- <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
- <ul>
- <li class="navelem"><a class="el" href="namespacefsdk.html">fsdk</a></li><li class="navelem"><a class="el" href="structfsdk_1_1_image.html">Image</a></li>
- <li class="footer">Generated on Fri Jun 17 2022 12:19:44 for Face Engine SDK by
- <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
- </ul>
- </div>
- </body>
- </html>
|
