290 lines
13 KiB
HTML
290 lines
13 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/renderer.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="#nested-classes">Data Structures</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">renderer.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="textblock"><code>#include <GLFW/glfw3.h></code><br />
|
|
</div><div class="textblock"><div class="dynheader">
|
|
Include dependency graph for renderer.h:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="renderer_8h__incl.png" border="0" usemap="#src_2renderer_8h" alt=""/></div>
|
|
<map name="src_2renderer_8h" id="src_2renderer_8h">
|
|
<area shape="rect" title=" " alt="" coords="5,5,116,32"/>
|
|
<area shape="rect" title=" " alt="" coords="5,80,116,107"/>
|
|
</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="renderer_8h__dep__incl.png" border="0" usemap="#src_2renderer_8hdep" alt=""/></div>
|
|
<map name="src_2renderer_8hdep" id="src_2renderer_8hdep">
|
|
<area shape="rect" title=" " alt="" coords="163,5,273,32"/>
|
|
<area shape="rect" href="io_8c.html" title=" " alt="" coords="5,155,73,181"/>
|
|
<area shape="rect" href="shaders_8h.html" title=" " alt="" coords="36,80,144,107"/>
|
|
<area shape="rect" href="main_8c.html" title=" " alt="" coords="137,155,227,181"/>
|
|
<area shape="rect" href="shaders_8c.html" title=" " alt="" coords="262,155,369,181"/>
|
|
<area shape="rect" href="io_8h.html" title=" " alt="" coords="219,80,289,107"/>
|
|
<area shape="rect" href="renderer_8c.html" title=" " alt="" coords="364,80,475,107"/>
|
|
</map>
|
|
</div>
|
|
</div>
|
|
<p><a href="renderer_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="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structshader__state.html">shader_state</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structrenderer__state.html">renderer_state</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:a906b1457eeeaa2d7a9655343af151f66"><td class="memItemLeft" align="right" valign="top">GLFWwindow * </td><td class="memItemRight" valign="bottom"><a class="el" href="renderer_8h.html#a906b1457eeeaa2d7a9655343af151f66">initialize_window</a> (int width, int height)</td></tr>
|
|
<tr class="memdesc:a906b1457eeeaa2d7a9655343af151f66"><td class="mdescLeft"> </td><td class="mdescRight">Initialize GLFW and OpenGL, and create a window. <a href="renderer_8h.html#a906b1457eeeaa2d7a9655343af151f66">More...</a><br /></td></tr>
|
|
<tr class="separator:a906b1457eeeaa2d7a9655343af151f66"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a934ec25611d153f2e7f357573ade2061"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="renderer_8h.html#a934ec25611d153f2e7f357573ade2061">initialize_vertices</a> ()</td></tr>
|
|
<tr class="memdesc:a934ec25611d153f2e7f357573ade2061"><td class="mdescLeft"> </td><td class="mdescRight">Initialize the vertex array. <a href="renderer_8h.html#a934ec25611d153f2e7f357573ade2061">More...</a><br /></td></tr>
|
|
<tr class="separator:a934ec25611d153f2e7f357573ade2061"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5d8bc1fbae1bbe4bd2e70c9b645875ab"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="renderer_8h.html#a5d8bc1fbae1bbe4bd2e70c9b645875ab">initialize_framebuffer</a> (unsigned int *framebuffer, unsigned int *texture_color_buffer, unsigned int texture_width, unsigned int texture_height)</td></tr>
|
|
<tr class="memdesc:a5d8bc1fbae1bbe4bd2e70c9b645875ab"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a framebuffer and the associated texture. <a href="renderer_8h.html#a5d8bc1fbae1bbe4bd2e70c9b645875ab">More...</a><br /></td></tr>
|
|
<tr class="separator:a5d8bc1fbae1bbe4bd2e70c9b645875ab"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5180f7bf2b71421af837035824a8c8ac"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="renderer_8h.html#a5180f7bf2b71421af837035824a8c8ac">framebuffer_size_callback</a> (GLFWwindow *window, int width, int height)</td></tr>
|
|
<tr class="memdesc:a5180f7bf2b71421af837035824a8c8ac"><td class="mdescLeft"> </td><td class="mdescRight">Callback to adjust the size of the viewport when the window is resized. <a href="renderer_8h.html#a5180f7bf2b71421af837035824a8c8ac">More...</a><br /></td></tr>
|
|
<tr class="separator:a5180f7bf2b71421af837035824a8c8ac"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="a5180f7bf2b71421af837035824a8c8ac"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5180f7bf2b71421af837035824a8c8ac">◆ </a></span>framebuffer_size_callback()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void framebuffer_size_callback </td>
|
|
<td>(</td>
|
|
<td class="paramtype">GLFWwindow * </td>
|
|
<td class="paramname"><em>window</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></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Callback to adjust the size of the viewport when the window is resized. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">window</td><td>The current window. </td></tr>
|
|
<tr><td class="paramname">width</td><td>The new width. </td></tr>
|
|
<tr><td class="paramname">height</td><td>The new height. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5d8bc1fbae1bbe4bd2e70c9b645875ab"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5d8bc1fbae1bbe4bd2e70c9b645875ab">◆ </a></span>initialize_framebuffer()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int initialize_framebuffer </td>
|
|
<td>(</td>
|
|
<td class="paramtype">unsigned int * </td>
|
|
<td class="paramname"><em>framebuffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int * </td>
|
|
<td class="paramname"><em>texture_color_buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned int </td>
|
|
<td class="paramname"><em>texture_width</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">unsigned 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 a framebuffer and the associated texture. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">framebuffer</td><td>The framebuffer ID to be initialized. </td></tr>
|
|
<tr><td class="paramname">texture_color_buffer</td><td>The texture ID to be initialized. </td></tr>
|
|
<tr><td class="paramname">texture_width</td><td>The width of the desired texture image. </td></tr>
|
|
<tr><td class="paramname">texture_height</td><td>The height of the desired texture image. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>0 on success, 1 on failure. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a934ec25611d153f2e7f357573ade2061"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a934ec25611d153f2e7f357573ade2061">◆ </a></span>initialize_vertices()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">unsigned int initialize_vertices </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialize the vertex array. </p>
|
|
<p>This functions defines a simple rectangle containing the whole viewport.</p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The vertex array object ID. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a906b1457eeeaa2d7a9655343af151f66"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a906b1457eeeaa2d7a9655343af151f66">◆ </a></span>initialize_window()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">GLFWwindow* initialize_window </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></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialize GLFW and OpenGL, and create a window. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">width</td><td>The width of the window to create. </td></tr>
|
|
<tr><td class="paramname">height</td><td>The height of the window to create. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A pointer to the newly created GLFW window, or <code>NULL</code> on 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>
|