c
/
Immediate-Mode-UI.Nuklear
mirror of https://github.com/Immediate-Mode-UI/Nuklear.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327
							<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Nuklear: nk_buffer Struct 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="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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  $(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 id="projectrow">
  <td id="projectalign">
   <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">
          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
          <input type="text" id="MSearchField" value="" placeholder="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.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('structnk__buffer.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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle"><div class="title">nk_buffer Struct Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for nk_buffer:</div>
<div class="dyncontent">
<div class="center"><img src="structnk__buffer__coll__graph.png" border="0" usemap="#ank__buffer_coll__map" alt="Collaboration graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:aaa4beec86444feb7908aad98c20b6849" id="r_aaa4beec86444feb7908aad98c20b6849"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structnk__buffer__marker.html">nk_buffer_marker</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnk__buffer.html#aaa4beec86444feb7908aad98c20b6849">marker</a> [NK_BUFFER_MAX]</td></tr>
<tr class="separator:aaa4beec86444feb7908aad98c20b6849"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cd2b90bb2994190fa1aa0e9ffbc1184" id="r_a0cd2b90bb2994190fa1aa0e9ffbc1184"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structnk__allocator.html">nk_allocator</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnk__buffer.html#a0cd2b90bb2994190fa1aa0e9ffbc1184">pool</a></td></tr>
<tr class="memdesc:a0cd2b90bb2994190fa1aa0e9ffbc1184"><td class="mdescLeft">&#160;</td><td class="mdescRight">!&lt; buffer marker to free a buffer to a certain offset  <br /></td></tr>
<tr class="separator:a0cd2b90bb2994190fa1aa0e9ffbc1184"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3842a03554db557944e84bc5af61249e" id="r_a3842a03554db557944e84bc5af61249e"><td class="memItemLeft" align="right" valign="top">enum nk_allocation_type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnk__buffer.html#a3842a03554db557944e84bc5af61249e">type</a></td></tr>
<tr class="memdesc:a3842a03554db557944e84bc5af61249e"><td class="mdescLeft">&#160;</td><td class="mdescRight">!&lt; allocator callback for dynamic buffers  <br /></td></tr>
<tr class="separator:a3842a03554db557944e84bc5af61249e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a228b585debec1d328859fb52080ca3fd" id="r_a228b585debec1d328859fb52080ca3fd"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structnk__memory.html">nk_memory</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnk__buffer.html#a228b585debec1d328859fb52080ca3fd">memory</a></td></tr>
<tr class="memdesc:a228b585debec1d328859fb52080ca3fd"><td class="mdescLeft">&#160;</td><td class="mdescRight">!&lt; memory management type  <br /></td></tr>
<tr class="separator:a228b585debec1d328859fb52080ca3fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab4ec59165f6aa6e9358bced8070cc84e" id="r_ab4ec59165f6aa6e9358bced8070cc84e"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnk__buffer.html#ab4ec59165f6aa6e9358bced8070cc84e">grow_factor</a></td></tr>
<tr class="memdesc:ab4ec59165f6aa6e9358bced8070cc84e"><td class="mdescLeft">&#160;</td><td class="mdescRight">!&lt; memory and size of the current memory block  <br /></td></tr>
<tr class="separator:ab4ec59165f6aa6e9358bced8070cc84e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a91e9be62aa08687400bc00059825de02" id="r_a91e9be62aa08687400bc00059825de02"><td class="memItemLeft" align="right" valign="top">nk_size&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnk__buffer.html#a91e9be62aa08687400bc00059825de02">allocated</a></td></tr>
<tr class="memdesc:a91e9be62aa08687400bc00059825de02"><td class="mdescLeft">&#160;</td><td class="mdescRight">!&lt; growing factor for dynamic memory management  <br /></td></tr>
<tr class="separator:a91e9be62aa08687400bc00059825de02"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b0ea49209eaba5285b715d902c5f446" id="r_a6b0ea49209eaba5285b715d902c5f446"><td class="memItemLeft" align="right" valign="top">nk_size&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnk__buffer.html#a6b0ea49209eaba5285b715d902c5f446">needed</a></td></tr>
<tr class="memdesc:a6b0ea49209eaba5285b715d902c5f446"><td class="mdescLeft">&#160;</td><td class="mdescRight">!&lt; total amount of memory allocated  <br /></td></tr>
<tr class="separator:a6b0ea49209eaba5285b715d902c5f446"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd962a6e042a8ffabac679768e4851bb" id="r_acd962a6e042a8ffabac679768e4851bb"><td class="memItemLeft" align="right" valign="top">nk_size&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnk__buffer.html#acd962a6e042a8ffabac679768e4851bb">calls</a></td></tr>
<tr class="memdesc:acd962a6e042a8ffabac679768e4851bb"><td class="mdescLeft">&#160;</td><td class="mdescRight">!&lt; totally consumed memory given that enough memory is present  <br /></td></tr>
<tr class="separator:acd962a6e042a8ffabac679768e4851bb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a71e66eb6dad2c5827e363f2389ad4505" id="r_a71e66eb6dad2c5827e363f2389ad4505"><td class="memItemLeft" align="right" valign="top">nk_size&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structnk__buffer.html#a71e66eb6dad2c5827e363f2389ad4505">size</a></td></tr>
<tr class="memdesc:a71e66eb6dad2c5827e363f2389ad4505"><td class="mdescLeft">&#160;</td><td class="mdescRight">!&lt; number of allocation calls  <br /></td></tr>
<tr class="separator:a71e66eb6dad2c5827e363f2389ad4505"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="nuklear_8h_source.html#l04189">4189</a> of file <a class="el" href="nuklear_8h_source.html">nuklear.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a id="a91e9be62aa08687400bc00059825de02" name="a91e9be62aa08687400bc00059825de02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91e9be62aa08687400bc00059825de02">&#9670;&#160;</a></span>allocated</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">nk_size nk_buffer::allocated</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>!&lt; growing factor for dynamic memory management </p>

<p class="definition">Definition at line <a class="el" href="nuklear_8h_source.html#l04195">4195</a> of file <a class="el" href="nuklear_8h_source.html">nuklear.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="nuklear__context_8c_source.html#l00332">nk__next()</a>.</p>

</div>
</div>
<a id="acd962a6e042a8ffabac679768e4851bb" name="acd962a6e042a8ffabac679768e4851bb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acd962a6e042a8ffabac679768e4851bb">&#9670;&#160;</a></span>calls</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">nk_size nk_buffer::calls</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>!&lt; totally consumed memory given that enough memory is present </p>

<p class="definition">Definition at line <a class="el" href="nuklear_8h_source.html#l04197">4197</a> of file <a class="el" href="nuklear_8h_source.html">nuklear.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="nuklear__context_8c_source.html#l00110">nk_clear()</a>.</p>

</div>
</div>
<a id="ab4ec59165f6aa6e9358bced8070cc84e" name="ab4ec59165f6aa6e9358bced8070cc84e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab4ec59165f6aa6e9358bced8070cc84e">&#9670;&#160;</a></span>grow_factor</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">float nk_buffer::grow_factor</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>!&lt; memory and size of the current memory block </p>

<p class="definition">Definition at line <a class="el" href="nuklear_8h_source.html#l04194">4194</a> of file <a class="el" href="nuklear_8h_source.html">nuklear.h</a>.</p>

</div>
</div>
<a id="aaa4beec86444feb7908aad98c20b6849" name="aaa4beec86444feb7908aad98c20b6849"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaa4beec86444feb7908aad98c20b6849">&#9670;&#160;</a></span>marker</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structnk__buffer__marker.html">nk_buffer_marker</a> nk_buffer::marker[NK_BUFFER_MAX]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="nuklear_8h_source.html#l04190">4190</a> of file <a class="el" href="nuklear_8h_source.html">nuklear.h</a>.</p>

</div>
</div>
<a id="a228b585debec1d328859fb52080ca3fd" name="a228b585debec1d328859fb52080ca3fd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a228b585debec1d328859fb52080ca3fd">&#9670;&#160;</a></span>memory</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structnk__memory.html">nk_memory</a> nk_buffer::memory</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>!&lt; memory management type </p>

<p class="definition">Definition at line <a class="el" href="nuklear_8h_source.html#l04193">4193</a> of file <a class="el" href="nuklear_8h_source.html">nuklear.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="nuklear__context_8c_source.html#l00310">nk__begin()</a>, <a class="el" href="nuklear__context_8c_source.html#l00332">nk__next()</a>, and <a class="el" href="nuklear__context_8c_source.html#l00045">nk_init_custom()</a>.</p>

</div>
</div>
<a id="a6b0ea49209eaba5285b715d902c5f446" name="a6b0ea49209eaba5285b715d902c5f446"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b0ea49209eaba5285b715d902c5f446">&#9670;&#160;</a></span>needed</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">nk_size nk_buffer::needed</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>!&lt; total amount of memory allocated </p>

<p class="definition">Definition at line <a class="el" href="nuklear_8h_source.html#l04196">4196</a> of file <a class="el" href="nuklear_8h_source.html">nuklear.h</a>.</p>

</div>
</div>
<a id="a0cd2b90bb2994190fa1aa0e9ffbc1184" name="a0cd2b90bb2994190fa1aa0e9ffbc1184"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0cd2b90bb2994190fa1aa0e9ffbc1184">&#9670;&#160;</a></span>pool</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structnk__allocator.html">nk_allocator</a> nk_buffer::pool</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>!&lt; buffer marker to free a buffer to a certain offset </p>

<p class="definition">Definition at line <a class="el" href="nuklear_8h_source.html#l04191">4191</a> of file <a class="el" href="nuklear_8h_source.html">nuklear.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="nuklear__context_8c_source.html#l00045">nk_init_custom()</a>.</p>

</div>
</div>
<a id="a71e66eb6dad2c5827e363f2389ad4505" name="a71e66eb6dad2c5827e363f2389ad4505"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a71e66eb6dad2c5827e363f2389ad4505">&#9670;&#160;</a></span>size</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">nk_size nk_buffer::size</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>!&lt; number of allocation calls </p>

<p class="definition">Definition at line <a class="el" href="nuklear_8h_source.html#l04198">4198</a> of file <a class="el" href="nuklear_8h_source.html">nuklear.h</a>.</p>

</div>
</div>
<a id="a3842a03554db557944e84bc5af61249e" name="a3842a03554db557944e84bc5af61249e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3842a03554db557944e84bc5af61249e">&#9670;&#160;</a></span>type</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum nk_allocation_type nk_buffer::type</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>!&lt; allocator callback for dynamic buffers </p>

<p class="definition">Definition at line <a class="el" href="nuklear_8h_source.html#l04192">4192</a> of file <a class="el" href="nuklear_8h_source.html">nuklear.h</a>.</p>

<p class="reference">Referenced by <a class="el" href="nuklear__context_8c_source.html#l00045">nk_init_custom()</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>src/<a class="el" href="nuklear_8h_source.html">nuklear.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="structnk__buffer.html">nk_buffer</a></li>
    <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.8 </li>
  </ul>
</div>
</body>
</html>