Rtch/Unuk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
903156c1e2
Unuk/Docs/html/class_win32_window.html
Rtch90 903156c1e2 -- [Add] Adding doxygen documentation to the docs Directory. 
-- I am too lazy to write my own documentation right now, this is what doxygen was designed for right?
2011-11-02 22:53:34 +00:00

414 lines
18 KiB
HTML
Raw Blame History

<!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"/>
<title>Unuk: Win32Window Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Unuk&#160;<span id="projectnumber">1.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;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>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('class_win32_window.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">Win32Window Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="Win32Window" -->
<p><code>#include &lt;<a class="el" href="_win32_window_8h_source.html">Win32Window.h</a>&gt;</code></p>
<p><a href="class_win32_window-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_win32_window.html#aa35dcf493ad1afa40a834b99ee251042">Win32Window</a> (HINSTANCE hInstance)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_win32_window.html#aaf37e216644b98bf2744dde43f7dfeb6">~Win32Window</a> (void)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_win32_window.html#a1399e25540a585c07cc9f8d0dedfabe9">Create</a> (int <a class="el" href="wglext_8h.html#ae6531b1788ca42a9ae8155b0c52e7630">width</a>, int <a class="el" href="wglext_8h.html#ab2e63df950c3789599e1e43f477bc9e3">height</a>, int bpp, bool fullscreen)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_win32_window.html#a6545dfce322862ad6318eb6102d59e06">Destroy</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_win32_window.html#afbd2f2d46befc3b775883c82d564210c">ProcessEvents</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_win32_window.html#a53340f72e172303a30fc72161be4ac0a">AttachGame</a> (<a class="el" href="class_game.html">Game</a> *game)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_win32_window.html#a881cc5d8e73332434b7596512c66b2ef">IsRunning</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_win32_window.html#a094c5c158c31c9d1d59f8727def85141">SwapBuffers</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">LRESULT CALLBACK&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_win32_window.html#ac17fafc962cee047adbdc883e4056544">WndProc</a> (HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_win32_window.html#a5324132bf36ee37d8a3c6c064196b6f6">GetElapsedSeconds</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static LRESULT CALLBACK&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_win32_window.html#a122b796d5a3953827f20f27fe921f449">StaticWndProc</a> (HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock">
<p>Definition at line <a class="el" href="_win32_window_8h_source.html#l00008">8</a> of file <a class="el" href="_win32_window_8h_source.html">Win32Window.h</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa35dcf493ad1afa40a834b99ee251042"></a><!-- doxytag: member="Win32Window::Win32Window" ref="aa35dcf493ad1afa40a834b99ee251042" args="(HINSTANCE hInstance)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Win32Window::Win32Window </td>
<td>(</td>
<td class="paramtype">HINSTANCE&#160;</td>
<td class="paramname"><em>hInstance</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_win32_window_8cpp_source.html#l00012">12</a> of file <a class="el" href="_win32_window_8cpp_source.html">Win32Window.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aaf37e216644b98bf2744dde43f7dfeb6"></a><!-- doxytag: member="Win32Window::~Win32Window" ref="aaf37e216644b98bf2744dde43f7dfeb6" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Win32Window::~Win32Window </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_win32_window_8cpp_source.html#l00019">19</a> of file <a class="el" href="_win32_window_8cpp_source.html">Win32Window.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a53340f72e172303a30fc72161be4ac0a"></a><!-- doxytag: member="Win32Window::AttachGame" ref="a53340f72e172303a30fc72161be4ac0a" args="(Game *game)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Win32Window::AttachGame </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_game.html">Game</a> *&#160;</td>
<td class="paramname"><em>game</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_win32_window_8cpp_source.html#l00114">114</a> of file <a class="el" href="_win32_window_8cpp_source.html">Win32Window.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1399e25540a585c07cc9f8d0dedfabe9"></a><!-- doxytag: member="Win32Window::Create" ref="a1399e25540a585c07cc9f8d0dedfabe9" args="(int width, int height, int bpp, bool fullscreen)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Win32Window::Create </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>width</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>height</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>bpp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>fullscreen</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_win32_window_8cpp_source.html#l00023">23</a> of file <a class="el" href="_win32_window_8cpp_source.html">Win32Window.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a6545dfce322862ad6318eb6102d59e06"></a><!-- doxytag: member="Win32Window::Destroy" ref="a6545dfce322862ad6318eb6102d59e06" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Win32Window::Destroy </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_win32_window_8cpp_source.html#l00106">106</a> of file <a class="el" href="_win32_window_8cpp_source.html">Win32Window.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5324132bf36ee37d8a3c6c064196b6f6"></a><!-- doxytag: member="Win32Window::GetElapsedSeconds" ref="a5324132bf36ee37d8a3c6c064196b6f6" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">float Win32Window::GetElapsedSeconds </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a881cc5d8e73332434b7596512c66b2ef"></a><!-- doxytag: member="Win32Window::IsRunning" ref="a881cc5d8e73332434b7596512c66b2ef" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Win32Window::IsRunning </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_win32_window_8cpp_source.html#l00118">118</a> of file <a class="el" href="_win32_window_8cpp_source.html">Win32Window.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="afbd2f2d46befc3b775883c82d564210c"></a><!-- doxytag: member="Win32Window::ProcessEvents" ref="afbd2f2d46befc3b775883c82d564210c" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Win32Window::ProcessEvents </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<a class="anchor" id="a122b796d5a3953827f20f27fe921f449"></a><!-- doxytag: member="Win32Window::StaticWndProc" ref="a122b796d5a3953827f20f27fe921f449" args="(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LRESULT CALLBACK Win32Window::StaticWndProc </td>
<td>(</td>
<td class="paramtype">HWND&#160;</td>
<td class="paramname"><em>hWnd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">UINT&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">WPARAM&#160;</td>
<td class="paramname"><em>wParam</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">LPARAM&#160;</td>
<td class="paramname"><em>lParam</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_win32_window_8cpp_source.html#l00225">225</a> of file <a class="el" href="_win32_window_8cpp_source.html">Win32Window.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a094c5c158c31c9d1d59f8727def85141"></a><!-- doxytag: member="Win32Window::SwapBuffers" ref="a094c5c158c31c9d1d59f8727def85141" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Win32Window::SwapBuffers </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_win32_window_8h_source.html#l00022">22</a> of file <a class="el" href="_win32_window_8h_source.html">Win32Window.h</a>.</p>
</div>
</div>
<a class="anchor" id="ac17fafc962cee047adbdc883e4056544"></a><!-- doxytag: member="Win32Window::WndProc" ref="ac17fafc962cee047adbdc883e4056544" args="(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LRESULT Win32Window::WndProc </td>
<td>(</td>
<td class="paramtype">HWND&#160;</td>
<td class="paramname"><em>hWnd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">UINT&#160;</td>
<td class="paramname"><em>msg</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">WPARAM&#160;</td>
<td class="paramname"><em>wParam</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">LPARAM&#160;</td>
<td class="paramname"><em>lParam</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="_win32_window_8cpp_source.html#l00161">161</a> of file <a class="el" href="_win32_window_8cpp_source.html">Win32Window.cpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/libUnuk/<a class="el" href="_win32_window_8h_source.html">Win32Window.h</a></li>
<li>src/libUnuk/<a class="el" href="_win32_window_8cpp_source.html">Win32Window.cpp</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="class_win32_window.html">Win32Window</a> </li>
<li class="footer">Generated on Wed Nov 2 2011 22:46:25 for Unuk by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></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>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink