<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Mercator: Mercator::ShaderFactories Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</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>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</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 class="navpath"><b>Mercator</b>::<a class="el" href="classMercator_1_1ShaderFactories.html">ShaderFactories</a>
</div>
</div>
<div class="contents">
<h1>Mercator::ShaderFactories Class Reference</h1><!-- doxytag: class="Mercator::ShaderFactories" -->Class which manages all the shader factories available.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="ShaderFactory_8h_source.html">ShaderFactory.h</a>></code>
<p>
<p>
<a href="classMercator_1_1ShaderFactories-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classMercator_1_1Shader.html">Shader</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1ShaderFactories.html#163aecf52bd58f214aa599e85b4de2b6">newShader</a> (const std::string &type, const <a class="el" href="classMercator_1_1Shader.html#1e99426c6c90afbb8c54114bb692b861">Shader::Parameters</a> &) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a shader of the specified type. <a href="#163aecf52bd58f214aa599e85b4de2b6"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classMercator_1_1ShaderFactories.html">ShaderFactories</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1ShaderFactories.html#8811a1c1c728555f112f23dc6650e36e">instance</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a singleton instance if required. <a href="#8811a1c1c728555f112f23dc6650e36e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="47079fa10f33753ebebaf80d20d7067f"></a><!-- doxytag: member="Mercator::ShaderFactories::del" ref="47079fa10f33753ebebaf80d20d7067f" args="()" -->
static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1ShaderFactories.html#47079fa10f33753ebebaf80d20d7067f">del</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete the instance. <br></td></tr>
<tr><td colspan="2"><br><h2>Private Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b8394922a6766e9ac987503e4b771056"></a><!-- doxytag: member="Mercator::ShaderFactories::FactoryMap" ref="b8394922a6766e9ac987503e4b771056" args="" -->
typedef std::map< std::string, <br class="typebreak">
<a class="el" href="classMercator_1_1iShaderFactory.html">iShaderFactory</a> * > </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1ShaderFactories.html#b8394922a6766e9ac987503e4b771056">FactoryMap</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">STL map of shader factory pointers. <br></td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="246a8ec29e4d9e8f4f8ed21b04d50135"></a><!-- doxytag: member="Mercator::ShaderFactories::m_factories" ref="246a8ec29e4d9e8f4f8ed21b04d50135" args="" -->
<a class="el" href="classMercator_1_1ShaderFactories.html#b8394922a6766e9ac987503e4b771056">FactoryMap</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1ShaderFactories.html#246a8ec29e4d9e8f4f8ed21b04d50135">m_factories</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Map of shader factory pointers keyed on type string. <br></td></tr>
<tr><td colspan="2"><br><h2>Static Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="856a6676b6831534ba583eb132b2cbae"></a><!-- doxytag: member="Mercator::ShaderFactories::m_instance" ref="856a6676b6831534ba583eb132b2cbae" args="" -->
static <a class="el" href="classMercator_1_1ShaderFactories.html">ShaderFactories</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classMercator_1_1ShaderFactories.html#856a6676b6831534ba583eb132b2cbae">m_instance</a> = 0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Pointer to the singleton instance of <a class="el" href="classMercator_1_1ShaderFactories.html" title="Class which manages all the shader factories available.">ShaderFactories</a>. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class which manages all the shader factories available.
<p>
Requests for new shaders of a given type are passed here, and shader objects are returned. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8811a1c1c728555f112f23dc6650e36e"></a><!-- doxytag: member="Mercator::ShaderFactories::instance" ref="8811a1c1c728555f112f23dc6650e36e" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classMercator_1_1ShaderFactories.html">ShaderFactories</a> & Mercator::ShaderFactories::instance </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct a singleton instance if required.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a reference to the instance. </dd></dl>
<p>References <a class="el" href="ShaderFactory_8h_source.html#l00048">m_instance</a>.</p>
</div>
</div><p>
<a class="anchor" name="163aecf52bd58f214aa599e85b4de2b6"></a><!-- doxytag: member="Mercator::ShaderFactories::newShader" ref="163aecf52bd58f214aa599e85b4de2b6" args="(const std::string &type, const Shader::Parameters &) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classMercator_1_1Shader.html">Shader</a> * Mercator::ShaderFactories::newShader </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"> <em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="classMercator_1_1Shader.html#1e99426c6c90afbb8c54114bb692b861">Shader::Parameters</a> & </td>
<td class="paramname"> <em>params</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a shader of the specified type.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>type</em> </td><td>a string giving the type of shader. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params</em> </td><td>a map of the parameters for the shader </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a pointer to the new shader object </dd></dl>
<p>References <a class="el" href="ShaderFactory_8h_source.html#l00045">m_factories</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="ShaderFactory_8h_source.html">ShaderFactory.h</a><li>ShaderFactory.cpp</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated for Mercator by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address>
</body>
</html>
