248 lines
12 KiB
HTML
248 lines
12 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<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.17"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>ShaderTool: src/shaders.h File Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">ShaderTool
|
|
 <span id="projectnumber">0.1</span>
|
|
</div>
|
|
<div id="projectbrief">Live tool for developing OpenGL shaders interactively</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">shaders.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include "<a class="el" href="renderer_8h_source.html">renderer.h</a>"</code><br />
|
|
</div><div class="textblock"><div class="dynheader">
|
|
Include dependency graph for shaders.h:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="shaders_8h__incl.png" border="0" usemap="#src_2shaders_8h" alt=""/></div>
|
|
<map name="src_2shaders_8h" id="src_2shaders_8h">
|
|
<area shape="rect" title=" " alt="" coords="7,5,115,32"/>
|
|
<area shape="rect" href="renderer_8h.html" title=" " alt="" coords="17,80,105,107"/>
|
|
<area shape="rect" title=" " alt="" coords="5,155,116,181"/>
|
|
</map>
|
|
</div>
|
|
</div><div class="textblock"><div class="dynheader">
|
|
This graph shows which files directly or indirectly include this file:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="shaders_8h__dep__incl.png" border="0" usemap="#src_2shaders_8hdep" alt=""/></div>
|
|
<map name="src_2shaders_8hdep" id="src_2shaders_8hdep">
|
|
<area shape="rect" title=" " alt="" coords="88,5,196,32"/>
|
|
<area shape="rect" href="io_8c.html" title=" " alt="" coords="5,80,73,107"/>
|
|
<area shape="rect" href="main_8c.html" title=" " alt="" coords="97,80,187,107"/>
|
|
<area shape="rect" href="shaders_8c.html" title=" " alt="" coords="211,80,318,107"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
<p><a href="shaders_8h_source.html">Go to the source code of this file.</a></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a58c13f6719bcad0be93367257facb2d8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="shaders_8h.html#a58c13f6719bcad0be93367257facb2d8">initialize_shaders</a> (struct <a class="el" href="structrenderer__state.html">renderer_state</a> *state, const char *shader_file, const char *buffer_file, int window_width, int window_height)</td></tr>
|
|
<tr class="memdesc:a58c13f6719bcad0be93367257facb2d8"><td class="mdescLeft"> </td><td class="mdescRight">Initialize shaders, compile them, and create the required texture for the buffer shader. <a href="shaders_8h.html#a58c13f6719bcad0be93367257facb2d8">More...</a><br /></td></tr>
|
|
<tr class="separator:a58c13f6719bcad0be93367257facb2d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a199bc15d3bf9a2b6948bfbf44e90652c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="shaders_8h.html#a199bc15d3bf9a2b6948bfbf44e90652c">compile_shaders</a> (unsigned int *shader_program, const char *const fragment_shader_file)</td></tr>
|
|
<tr class="memdesc:a199bc15d3bf9a2b6948bfbf44e90652c"><td class="mdescLeft"> </td><td class="mdescRight">Compile shaders from source files. <a href="shaders_8h.html#a199bc15d3bf9a2b6948bfbf44e90652c">More...</a><br /></td></tr>
|
|
<tr class="separator:a199bc15d3bf9a2b6948bfbf44e90652c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abf2fc422517537eba9784a4cb7ecab69"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="shaders_8h.html#abf2fc422517537eba9784a4cb7ecab69">read_file</a> (const char *const filename)</td></tr>
|
|
<tr class="memdesc:abf2fc422517537eba9784a4cb7ecab69"><td class="mdescLeft"> </td><td class="mdescRight">Reads a file in a heap-allocated buffer. <a href="shaders_8h.html#abf2fc422517537eba9784a4cb7ecab69">More...</a><br /></td></tr>
|
|
<tr class="separator:abf2fc422517537eba9784a4cb7ecab69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a199bc15d3bf9a2b6948bfbf44e90652c"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a199bc15d3bf9a2b6948bfbf44e90652c">◆ </a></span>compile_shaders()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int compile_shaders </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned int * </td>
|
|
<td class="paramname"><em>shader_program</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char *const </td>
|
|
<td class="paramname"><em>fragment_shader_file</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Compile shaders from source files. </p>
|
|
<p>This function reads the source files of the vertex and fragment shaders, compiles them, and links them together in a shader program.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">shader_program</td><td>Pointer to the ID of the shader program where the shaders will be stored. </td></tr>
|
|
<tr><td class="paramname">fragment_shader_file</td><td>File name of the fragment shader. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 on error. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a58c13f6719bcad0be93367257facb2d8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a58c13f6719bcad0be93367257facb2d8">◆ </a></span>initialize_shaders()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int initialize_shaders </td>
|
|
<td>(</td>
|
|
<td class="paramtype">struct <a class="el" href="structrenderer__state.html">renderer_state</a> * </td>
|
|
<td class="paramname"><em>state</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>shader_file</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>buffer_file</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>texture_width</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">int </td>
|
|
<td class="paramname"><em>texture_height</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialize shaders, compile them, and create the required texture for the buffer shader. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">state</td><td>The target renderer state. </td></tr>
|
|
<tr><td class="paramname">shader_file</td><td>The file name of the screen shader. </td></tr>
|
|
<tr><td class="paramname">buffer_file</td><td>The file name of the buffer shader, or NULL if no buffer shader. </td></tr>
|
|
<tr><td class="paramname">texture_width</td><td>The width of the texture for the buffer shader. </td></tr>
|
|
<tr><td class="paramname">texture_height</td><td>The height of the texture for the buffer shader. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 on error. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abf2fc422517537eba9784a4cb7ecab69"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abf2fc422517537eba9784a4cb7ecab69">◆ </a></span>read_file()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">char* read_file </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const char *const </td>
|
|
<td class="paramname"><em>filename</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reads a file in a heap-allocated buffer. </p>
|
|
<p>This function computes the length of the file, allocate a buffer of the correct size, and reads the file in the buffer. Returns <code>NULL</code> on error.</p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">filename</td><td>The file to read. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A buffer containing the contents of the file, or <code>NULL</code> if there was an error. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|