<!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.4"/>
<title>ClanLib: provider_type_register.h Source File</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="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 style="padding-left: 0.5em;">
<div id="projectname">ClanLib
 <span id="projectnumber">2.3.7</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_14852d208b69b5a1926f5d908b4903da.html">Sources</a></li><li class="navelem"><a class="el" href="dir_66cde9167ab84f7398e86467706d8b82.html">API</a></li><li class="navelem"><a class="el" href="dir_c037c6c42af909c40afab7a0ead9b463.html">Display</a></li><li class="navelem"><a class="el" href="dir_54228bedd7c8b32df95fb85ef7dada33.html">ImageProviders</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">provider_type_register.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="provider__type__register_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">** ClanLib SDK</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">** Copyright (c) 1997-2011 The ClanLib Team</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">**</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">** This software is provided 'as-is', without any express or implied</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">** warranty. In no event will the authors be held liable for any damages</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">** arising from the use of this software.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">**</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">** Permission is granted to anyone to use this software for any purpose,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">** including commercial applications, and to alter it and redistribute it</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">** freely, subject to the following restrictions:</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">**</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">** 1. The origin of this software must not be misrepresented; you must not</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">** claim that you wrote the original software. If you use this software</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">** in a product, an acknowledgment in the product documentation would be</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">** appreciated but is not required.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">** 2. Altered source versions must be plainly marked as such, and must not be</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">** misrepresented as being the original software.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">** 3. This notice may not be removed or altered from any source distribution.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">**</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">** Note: Some of the libraries ClanLib may link to may have additional</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">** requirements or restrictions.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">**</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">** File Author(s):</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">**</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">** Magnus Norddahl</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">** (if your name is missing here, please add it)</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#include "../api_display.h"</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include "../../Core/IOData/virtual_directory.h"</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include "<a class="code" href="provider__type_8h.html">provider_type.h</a>"</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">template</span><<span class="keyword">class</span> Prov<span class="keywordtype">id</span>erClass></div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="code" href="classCL__ProviderType__Register.html"> 43</a></span> <span class="keyword">class </span><a class="code" href="classCL__ProviderType__Register.html" title="Class template to register a provider type. ">CL_ProviderType_Register</a> : <span class="keyword">public</span> <a class="code" href="classCL__ImageProviderType.html" title="Provider type. ">CL_ImageProviderType</a></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> {</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="classCL__ProviderType__Register.html#ab208fc85273869569a3bc9bd4a24327c"> 50</a></span>  <a class="code" href="classCL__ProviderType__Register.html#ab208fc85273869569a3bc9bd4a24327c" title="Registers provider type in the CL_ProviderFactory. ">CL_ProviderType_Register</a>(<span class="keyword">const</span> <a class="code" href="classCL__String8.html" title="String container template. ">CL_String</a> &type) : <a class="code" href="classCL__ImageProviderType.html" title="Provider type. ">CL_ImageProviderType</a>(type)</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  {</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  }</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00060"></a><span class="lineno"><a class="code" href="classCL__ProviderType__Register.html#a7da984a95d7a8ce3aa8a28cb640c47cf"> 60</a></span>  <span class="keyword">virtual</span> <a class="code" href="classCL__PixelBuffer.html" title="Pixel data container. ">CL_PixelBuffer</a> <a class="code" href="classCL__ProviderType__Register.html#a7da984a95d7a8ce3aa8a28cb640c47cf" title="Called to load an image with this provider type. ">load</a>(</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">const</span> <a class="code" href="classCL__String8.html" title="String container template. ">CL_String</a> &filename,</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">const</span> <a class="code" href="classCL__VirtualDirectory.html" title="Virtual File System (VFS) directory. ">CL_VirtualDirectory</a> &directory)</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  {</div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordflow">return</span> ProviderClass::load(filename, directory);</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  }</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div>
<div class="line"><a name="l00067"></a><span class="lineno"><a class="code" href="classCL__ProviderType__Register.html#a461118b0c0549d3c72bb9fbe3ec35887"> 67</a></span>  <span class="keyword">virtual</span> <a class="code" href="classCL__PixelBuffer.html" title="Pixel data container. ">CL_PixelBuffer</a> <a class="code" href="classCL__ProviderType__Register.html#a461118b0c0549d3c72bb9fbe3ec35887">load</a>(</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="classCL__IODevice.html" title="I/O Device interface. ">CL_IODevice</a> &file)</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  {</div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordflow">return</span> ProviderClass::load(file);</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  }</div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"><a class="code" href="classCL__ProviderType__Register.html#af9f2e03bd65d1996ac91e4f4fb2fbccf"> 73</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCL__ProviderType__Register.html#af9f2e03bd65d1996ac91e4f4fb2fbccf" title="Called to save a given PixelBuffer to a file. ">save</a>(</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <a class="code" href="classCL__PixelBuffer.html" title="Pixel data container. ">CL_PixelBuffer</a> buffer,</div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keyword">const</span> <a class="code" href="classCL__String8.html" title="String container template. ">CL_String</a> &filename,</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <a class="code" href="classCL__VirtualDirectory.html" title="Virtual File System (VFS) directory. ">CL_VirtualDirectory</a> &directory)</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  {</div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  ProviderClass::save(buffer, filename, directory);</div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  }</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a name="l00081"></a><span class="lineno"><a class="code" href="classCL__ProviderType__Register.html#ad4f3952adf72cbd570935222fe4c40a1"> 81</a></span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classCL__ProviderType__Register.html#ad4f3952adf72cbd570935222fe4c40a1">save</a>(</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <a class="code" href="classCL__PixelBuffer.html" title="Pixel data container. ">CL_PixelBuffer</a> buffer,</div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <a class="code" href="classCL__IODevice.html" title="I/O Device interface. ">CL_IODevice</a> &file)</div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  {</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  ProviderClass::save(buffer, file);</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  }</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> };</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 14 2013 13:05:46 for ClanLib by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>
