-
Notifications
You must be signed in to change notification settings - Fork 570
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit c93c116
Showing
487 changed files
with
78,420 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| <!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.9.1"/> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | ||
| <title>Nuklear: $title</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="navtree.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="resize.js"></script> | ||
| <script type="text/javascript" src="navtreedata.js"></script> | ||
| <script type="text/javascript" src="navtree.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> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ | ||
| $(document).ready(function() { init_search(); }); | ||
| /* @license-end */ | ||
| </script> | ||
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> | ||
| <link href="doxygen-awesome.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">Nuklear | ||
| </div> | ||
| <div id="projectbrief">This is a minimal-state, immediate-mode graphical user interface toolkit written in ANSI C and licensed under public domain. It was designed as a simple embeddable user interface for application and does not have any dependencies, a default render backend or OS window/input handling but instead provides a highly modular, library-based approach, with simple input state for input and draw commands describing primitive shapes as output. So instead of providing a layered library that tries to abstract over a number of platform and render backends, it focuses only on the actual UI.</div> | ||
| </td> | ||
| <td> <div id="MSearchBox" class="MSearchBoxInactive"> | ||
| <span class="left"> | ||
| <img id="MSearchSelect" src="search/mag_sel.svg" | ||
| 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.svg" alt=""/></a> | ||
| </span> | ||
| </div> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| <!-- end header part --> | ||
| <!-- Generated by Doxygen 1.9.1 --> | ||
| <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','.html'); | ||
| /* @license-end */ | ||
| </script> | ||
| </div><!-- top --> | ||
| <div id="side-nav" class="ui-resizable side-nav-resizable"> | ||
| <div id="nav-tree"> | ||
| <div id="nav-tree-contents"> | ||
| <div id="nav-sync" class="sync"></div> | ||
| </div> | ||
| </div> | ||
| <div id="splitbar" style="-moz-user-select:none;" | ||
| class="ui-resizable-handle"> | ||
| </div> | ||
| </div> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ | ||
| $(document).ready(function(){initNavTree('Context.html',''); initResizable(); }); | ||
| /* @license-end */ | ||
| </script> | ||
| <div id="doc-content"> | ||
| <!-- 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 class="PageDoc"><div class="contents"> | ||
| <div class="textblock"><p>Contexts are the main entry point and the majestro of nuklear and contain all required state.</p> | ||
| <p>They are used for window, memory, input, style, stack, commands and time management and need to be passed into all nuklear GUI specific functions.</p> | ||
| <h1><a class="anchor" id="autotoc_md11"></a> | ||
| Usage</h1> | ||
| <p>To use a context it first has to be initialized which can be achieved by calling one of either <code>nk_init_default</code>, <code>nk_init_fixed</code>, <code>nk_init</code>, <code>nk_init_custom</code>. Each takes in a font handle and a specific way of handling memory. Memory control hereby ranges from standard library to just specifying a fixed sized block of memory which nuklear has to manage itself from.</p> | ||
| <div class="fragment"><div class="line"><span class="keyword">struct </span><a class="code" href="structnk__context.html">nk_context</a> ctx;</div> | ||
| <div class="line">nk_init_xxx(&ctx, ...);</div> | ||
| <div class="line"><span class="keywordflow">while</span> (1) {</div> | ||
| <div class="line"> <span class="comment">// [...]</span></div> | ||
| <div class="line"> <a class="code" href="nuklear_8h.html#ade3301f0a92370be1b4beac7eceac279">nk_clear</a>(&ctx);</div> | ||
| <div class="line">}</div> | ||
| <div class="line"><a class="code" href="nuklear_8h.html#a06772e194320fa99524681fd32df85e9">nk_free</a>(&ctx);</div> | ||
| <div class="ttc" id="anuklear_8h_html_a06772e194320fa99524681fd32df85e9"><div class="ttname"><a href="nuklear_8h.html#a06772e194320fa99524681fd32df85e9">nk_free</a></div><div class="ttdeci">NK_API void nk_free(struct nk_context *)</div><div class="ttdoc">Frees all memory allocated by nuklear; Not needed if context was initialized with nk_init_fixed.</div><div class="ttdef"><b>Definition:</b> <a href="nuklear__context_8c_source.html#l00088">nuklear_context.c:88</a></div></div> | ||
| <div class="ttc" id="anuklear_8h_html_ade3301f0a92370be1b4beac7eceac279"><div class="ttname"><a href="nuklear_8h.html#ade3301f0a92370be1b4beac7eceac279">nk_clear</a></div><div class="ttdeci">NK_API void nk_clear(struct nk_context *)</div><div class="ttdoc">Resets the context state at the end of the frame.</div><div class="ttdef"><b>Definition:</b> <a href="nuklear__context_8c_source.html#l00110">nuklear_context.c:110</a></div></div> | ||
| <div class="ttc" id="astructnk__context_html"><div class="ttname"><a href="structnk__context.html">nk_context</a></div><div class="ttdef"><b>Definition:</b> <a href="nuklear_8h_source.html#l05704">nuklear.h:5704</a></div></div> | ||
| </div><!-- fragment --><h1><a class="anchor" id="autotoc_md12"></a> | ||
| Reference</h1> | ||
| <table class="markdownTable"> | ||
| <tr class="markdownTableHead"> | ||
| <th class="markdownTableHeadNone">Function </th><th class="markdownTableHeadNone">Description </th></tr> | ||
| <tr class="markdownTableRowOdd"> | ||
| <td class="markdownTableBodyNone">nk_init_default </td><td class="markdownTableBodyNone">Initializes context with standard library memory allocation (malloc,free) </td></tr> | ||
| <tr class="markdownTableRowEven"> | ||
| <td class="markdownTableBodyNone"><a class="el" href="nuklear_8h.html#a27a65e767320f4d72cee9c3175153b56">nk_init_fixed</a> </td><td class="markdownTableBodyNone">Initializes context from single fixed size memory block </td></tr> | ||
| <tr class="markdownTableRowOdd"> | ||
| <td class="markdownTableBodyNone"><a class="el" href="nuklear_8h.html#ab5c6cdd02a560dbcbdb5bd54ed753b2c">nk_init</a> </td><td class="markdownTableBodyNone">Initializes context with memory allocator callbacks for alloc and free </td></tr> | ||
| <tr class="markdownTableRowEven"> | ||
| <td class="markdownTableBodyNone"><a class="el" href="nuklear_8h.html#a4122ba85b642a16b61268932b1fed694">nk_init_custom</a> </td><td class="markdownTableBodyNone">Initializes context from two buffers. One for draw commands the other for window/panel/table allocations </td></tr> | ||
| <tr class="markdownTableRowOdd"> | ||
| <td class="markdownTableBodyNone"><a class="el" href="nuklear_8h.html#ade3301f0a92370be1b4beac7eceac279">nk_clear</a> </td><td class="markdownTableBodyNone">Called at the end of the frame to reset and prepare the context for the next frame </td></tr> | ||
| <tr class="markdownTableRowEven"> | ||
| <td class="markdownTableBodyNone"><a class="el" href="nuklear_8h.html#a06772e194320fa99524681fd32df85e9">nk_free</a> </td><td class="markdownTableBodyNone">Shutdown and free all memory allocated inside the context </td></tr> | ||
| <tr class="markdownTableRowOdd"> | ||
| <td class="markdownTableBodyNone">nk_set_user_data </td><td class="markdownTableBodyNone">Utility function to pass user data to draw command </td></tr> | ||
| </table> | ||
| </div></div><!-- contents --> | ||
| </div><!-- PageDoc --> | ||
| </div><!-- doc-content --> | ||
| <!-- start footer part --> | ||
| <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> | ||
| <ul> | ||
| <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li> | ||
| </ul> | ||
| </div> | ||
| </body> | ||
| </html> |
Oops, something went wrong.