|
| 1 | +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 | +<html xmlns="http://www.w3.org/1999/xhtml"> |
| 3 | +<head> |
| 4 | +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| 5 | +<meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| 6 | +<meta name="generator" content="Doxygen 1.8.11"/> |
| 7 | +<title>libsxbp: sxbp/render_backends/backend_pbm.h File Reference</title> |
| 8 | +<link href="tabs.css" rel="stylesheet" type="text/css"/> |
| 9 | +<script type="text/javascript" src="jquery.js"></script> |
| 10 | +<script type="text/javascript" src="dynsections.js"></script> |
| 11 | +<link href="search/search.css" rel="stylesheet" type="text/css"/> |
| 12 | +<script type="text/javascript" src="search/searchdata.js"></script> |
| 13 | +<script type="text/javascript" src="search/search.js"></script> |
| 14 | +<script type="text/javascript"> |
| 15 | + $(document).ready(function() { init_search(); }); |
| 16 | +</script> |
| 17 | +<link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| 18 | +</head> |
| 19 | +<body> |
| 20 | +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| 21 | +<div id="titlearea"> |
| 22 | +<table cellspacing="0" cellpadding="0"> |
| 23 | + <tbody> |
| 24 | + <tr style="height: 56px;"> |
| 25 | + <td id="projectalign" style="padding-left: 0.5em;"> |
| 26 | + <div id="projectname">libsxbp |
| 27 | +  <span id="projectnumber">v0.25</span> |
| 28 | + </div> |
| 29 | + <div id="projectbrief">Experimental generation of 2D spiralling lines based on input binary data.</div> |
| 30 | + </td> |
| 31 | + </tr> |
| 32 | + </tbody> |
| 33 | +</table> |
| 34 | +</div> |
| 35 | +<!-- end header part --> |
| 36 | +<!-- Generated by Doxygen 1.8.11 --> |
| 37 | +<script type="text/javascript"> |
| 38 | +var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| 39 | +</script> |
| 40 | + <div id="navrow1" class="tabs"> |
| 41 | + <ul class="tablist"> |
| 42 | + <li><a href="index.html"><span>Main Page</span></a></li> |
| 43 | + <li><a href="pages.html"><span>Related Pages</span></a></li> |
| 44 | + <li><a href="annotated.html"><span>Data Structures</span></a></li> |
| 45 | + <li class="current"><a href="files.html"><span>Files</span></a></li> |
| 46 | + <li> |
| 47 | + <div id="MSearchBox" class="MSearchBoxInactive"> |
| 48 | + <span class="left"> |
| 49 | + <img id="MSearchSelect" src="search/mag_sel.png" |
| 50 | + onmouseover="return searchBox.OnSearchSelectShow()" |
| 51 | + onmouseout="return searchBox.OnSearchSelectHide()" |
| 52 | + alt=""/> |
| 53 | + <input type="text" id="MSearchField" value="Search" accesskey="S" |
| 54 | + onfocus="searchBox.OnSearchFieldFocus(true)" |
| 55 | + onblur="searchBox.OnSearchFieldFocus(false)" |
| 56 | + onkeyup="searchBox.OnSearchFieldChange(event)"/> |
| 57 | + </span><span class="right"> |
| 58 | + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> |
| 59 | + </span> |
| 60 | + </div> |
| 61 | + </li> |
| 62 | + </ul> |
| 63 | + </div> |
| 64 | + <div id="navrow2" class="tabs2"> |
| 65 | + <ul class="tablist"> |
| 66 | + <li><a href="files.html"><span>File List</span></a></li> |
| 67 | + <li><a href="globals.html"><span>Globals</span></a></li> |
| 68 | + </ul> |
| 69 | + </div> |
| 70 | +<!-- window showing the filter options --> |
| 71 | +<div id="MSearchSelectWindow" |
| 72 | + onmouseover="return searchBox.OnSearchSelectShow()" |
| 73 | + onmouseout="return searchBox.OnSearchSelectHide()" |
| 74 | + onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| 75 | +</div> |
| 76 | + |
| 77 | +<!-- iframe showing the search results (closed by default) --> |
| 78 | +<div id="MSearchResultsWindow"> |
| 79 | +<iframe src="javascript:void(0)" frameborder="0" |
| 80 | + name="MSearchResults" id="MSearchResults"> |
| 81 | +</iframe> |
| 82 | +</div> |
| 83 | + |
| 84 | +<div id="nav-path" class="navpath"> |
| 85 | + <ul> |
| 86 | +<li class="navelem"><a class="el" href="dir_c99b4bd6479b6378cc5576b72b3ab7c8.html">sxbp</a></li><li class="navelem"><a class="el" href="dir_d88c95693a1d3683493b3e03165f8682.html">render_backends</a></li> </ul> |
| 87 | +</div> |
| 88 | +</div><!-- top --> |
| 89 | +<div class="header"> |
| 90 | + <div class="summary"> |
| 91 | +<a href="#func-members">Functions</a> </div> |
| 92 | + <div class="headertitle"> |
| 93 | +<div class="title">backend_pbm.h File Reference</div> </div> |
| 94 | +</div><!--header--> |
| 95 | +<div class="contents"> |
| 96 | + |
| 97 | +<p>This compilation unit provides functionality to render a bitmap struct to a PBM image (binary version, stored in a buffer). |
| 98 | +<a href="#details">More...</a></p> |
| 99 | +<div class="textblock"><code>#include "<a class="el" href="saxbospiral_8h_source.html">../saxbospiral.h</a>"</code><br /> |
| 100 | +<code>#include "<a class="el" href="render_8h_source.html">../render.h</a>"</code><br /> |
| 101 | +</div><div class="textblock"><div class="dynheader"> |
| 102 | +Include dependency graph for backend_pbm.h:</div> |
| 103 | +<div class="dyncontent"> |
| 104 | +<div class="center"><img src="backend__pbm_8h__incl.png" border="0" usemap="#sxbp_2render__backends_2backend__pbm_8h" alt=""/></div> |
| 105 | +<map name="sxbp_2render__backends_2backend__pbm_8h" id="sxbp_2render__backends_2backend__pbm_8h"> |
| 106 | +<area shape="rect" id="node2" href="saxbospiral_8h.html" title="This compilation unit provides most of the data types used by the library, as well as defining some l..." alt="" coords="27,169,138,196"/> |
| 107 | +<area shape="rect" id="node6" href="render_8h.html" title="This compilation unit provides functions for rendering a spiral to a bitmap. " alt="" coords="131,95,213,121"/> |
| 108 | +</map> |
| 109 | +</div> |
| 110 | +</div> |
| 111 | +<p><a href="backend__pbm_8h_source.html">Go to the source code of this file.</a></p> |
| 112 | +<table class="memberdecls"> |
| 113 | +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> |
| 114 | +Functions</h2></td></tr> |
| 115 | +<tr class="memitem:a5d36e5bbb54b1d681b8d1cf8beb3c96d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="saxbospiral_8h.html#aaf3547c499b3c2c5909819d6790533e7">sxbp_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="backend__pbm_8h.html#a5d36e5bbb54b1d681b8d1cf8beb3c96d">sxbp_render_backend_pbm</a> (<a class="el" href="structsxbp__bitmap__t.html">sxbp_bitmap_t</a> bitmap, <a class="el" href="structsxbp__buffer__t.html">sxbp_buffer_t</a> *buffer)</td></tr> |
| 116 | +<tr class="memdesc:a5d36e5bbb54b1d681b8d1cf8beb3c96d"><td class="mdescLeft"> </td><td class="mdescRight">Renders a bitmap image to a PBM image. <a href="#a5d36e5bbb54b1d681b8d1cf8beb3c96d">More...</a><br /></td></tr> |
| 117 | +<tr class="separator:a5d36e5bbb54b1d681b8d1cf8beb3c96d"><td class="memSeparator" colspan="2"> </td></tr> |
| 118 | +</table> |
| 119 | +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| 120 | +<div class="textblock"><p>This compilation unit provides functionality to render a bitmap struct to a PBM image (binary version, stored in a buffer). </p> |
| 121 | +<dl class="section remark"><dt>Remarks</dt><dd>Reference materials used for the PBM format are located at <a href="http://netpbm.sourceforge.net/doc/pbm.html">http://netpbm.sourceforge.net/doc/pbm.html</a></dd></dl> |
| 122 | +<dl class="section author"><dt>Author</dt><dd>Joshua Saxby <joshua.a.saxby+TNOPLuc8vM==.com </dd></dl> |
| 123 | +<dl class="section date"><dt>Date</dt><dd>2016, 2017</dd></dl> |
| 124 | +<dl class="section copyright"><dt>Copyright</dt><dd>Copyright (C) Joshua Saxby 2016</dd> |
| 125 | +<dd> |
| 126 | +This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at <a href="http://mozilla.org/MPL/2.0/">http://mozilla.org/MPL/2.0/</a>. </dd></dl> |
| 127 | +</div><h2 class="groupheader">Function Documentation</h2> |
| 128 | +<a class="anchor" id="a5d36e5bbb54b1d681b8d1cf8beb3c96d"></a> |
| 129 | +<div class="memitem"> |
| 130 | +<div class="memproto"> |
| 131 | + <table class="memname"> |
| 132 | + <tr> |
| 133 | + <td class="memname"><a class="el" href="saxbospiral_8h.html#aaf3547c499b3c2c5909819d6790533e7">sxbp_status_t</a> sxbp_render_backend_pbm </td> |
| 134 | + <td>(</td> |
| 135 | + <td class="paramtype"><a class="el" href="structsxbp__bitmap__t.html">sxbp_bitmap_t</a> </td> |
| 136 | + <td class="paramname"><em>bitmap</em>, </td> |
| 137 | + </tr> |
| 138 | + <tr> |
| 139 | + <td class="paramkey"></td> |
| 140 | + <td></td> |
| 141 | + <td class="paramtype"><a class="el" href="structsxbp__buffer__t.html">sxbp_buffer_t</a> * </td> |
| 142 | + <td class="paramname"><em>buffer</em> </td> |
| 143 | + </tr> |
| 144 | + <tr> |
| 145 | + <td></td> |
| 146 | + <td>)</td> |
| 147 | + <td></td><td></td> |
| 148 | + </tr> |
| 149 | + </table> |
| 150 | +</div><div class="memdoc"> |
| 151 | + |
| 152 | +<p>Renders a bitmap image to a PBM image. </p> |
| 153 | +<dl class="params"><dt>Parameters</dt><dd> |
| 154 | + <table class="params"> |
| 155 | + <tr><td class="paramname">bitmap</td><td>Bitmap containing the image to render. </td></tr> |
| 156 | + <tr><td class="paramname">buffer</td><td>[out] Buffer to write out the PBM image data to. </td></tr> |
| 157 | + </table> |
| 158 | + </dd> |
| 159 | +</dl> |
| 160 | +<dl class="section return"><dt>Returns</dt><dd>SXBP_OPERATION_OK on success. </dd> |
| 161 | +<dd> |
| 162 | +SXBP_MALLOC_REFUSED on memory allocation failure.</dd></dl> |
| 163 | +<dl class="section note"><dt>Note</dt><dd>Asserts:<ul> |
| 164 | +<li>That bitmap.pixels is not NULL</li> |
| 165 | +<li>That buffer->bytes is NULL </li> |
| 166 | +</ul> |
| 167 | +</dd></dl> |
| 168 | + |
| 169 | +</div> |
| 170 | +</div> |
| 171 | +</div><!-- contents --> |
| 172 | +<!-- start footer part --> |
| 173 | +<hr class="footer"/><address class="footer"><small> |
| 174 | +Generated by  <a href="http://www.doxygen.org/index.html"> |
| 175 | +<img class="footer" src="doxygen.png" alt="doxygen"/> |
| 176 | +</a> 1.8.11 |
| 177 | +</small></address> |
| 178 | +</body> |
| 179 | +</html> |
0 commit comments