clutchlog/docs/structclutchlog_1_1fmt_1_1bg__256.html
2023-01-28 15:22:21 +01:00

254 lines
20 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>clutchlog: clutchlog::fmt::bg_256 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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-style.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="projectlogo"><img alt="Logo" src="clutchlog_logo.svg"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">clutchlog
&#160;<span id="projectnumber">0.14</span>
</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&amp;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&amp;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>
</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&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('structclutchlog_1_1fmt_1_1bg__256.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="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="structclutchlog_1_1fmt_1_1bg__256-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">clutchlog::fmt::bg_256 Struct Reference<div class="ingroups"><a class="el" href="group__colors256__16_m.html">Internal colors management in 256 and 16M colors modes.</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Background in 256-colors mode.
<a href="structclutchlog_1_1fmt_1_1bg__256.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for clutchlog::fmt::bg_256:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="structclutchlog_1_1fmt_1_1bg__256__inherit__graph.svg" width="176" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for clutchlog::fmt::bg_256:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="structclutchlog_1_1fmt_1_1bg__256__coll__graph.svg" width="176" height="187"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Background in 256-colors mode. </p>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00556">556</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0d244a542b6b98a373f8b1f9e92a6a90"><td class="memItemLeft" align="right" valign="top"><a id="a0d244a542b6b98a373f8b1f9e92a6a90"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structclutchlog_1_1fmt_1_1bg__256.html#a0d244a542b6b98a373f8b1f9e92a6a90">bg_256</a> ()</td></tr>
<tr class="memdesc:a0d244a542b6b98a373f8b1f9e92a6a90"><td class="mdescLeft">&#160;</td><td class="mdescRight">Empty constructor: no color. <br /></td></tr>
<tr class="separator:a0d244a542b6b98a373f8b1f9e92a6a90"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a83c663b1a9f00ba7ba7649c9c5605fad"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structclutchlog_1_1fmt_1_1bg__256.html#a83c663b1a9f00ba7ba7649c9c5605fad">bg_256</a> (const short b)</td></tr>
<tr class="memdesc:a83c663b1a9f00ba7ba7649c9c5605fad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="structclutchlog_1_1fmt_1_1bg__256.html#a83c663b1a9f00ba7ba7649c9c5605fad">More...</a><br /></td></tr>
<tr class="separator:a83c663b1a9f00ba7ba7649c9c5605fad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a096d302be7373acaaf225644683408bd"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structclutchlog_1_1fmt_1_1bg__256.html#a096d302be7373acaaf225644683408bd">bg_256</a> (const <a class="el" href="group__colors16.html#ga1cf3e27e4041250ffea0a6d58010da1e">bg</a> &amp;)</td></tr>
<tr class="memdesc:a096d302be7373acaaf225644683408bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Conversion constructor from 16-colors mode. <a href="structclutchlog_1_1fmt_1_1bg__256.html#a096d302be7373acaaf225644683408bd">More...</a><br /></td></tr>
<tr class="separator:a096d302be7373acaaf225644683408bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structclutchlog_1_1fmt_1_1color__256"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structclutchlog_1_1fmt_1_1color__256')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structclutchlog_1_1fmt_1_1color__256.html">clutchlog::fmt::color_256</a></td></tr>
<tr class="memitem:a12fdff3c5c4edbf952aaa31519f0171c inherit pub_methods_structclutchlog_1_1fmt_1_1color__256"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structclutchlog_1_1fmt_1_1color__256.html#a12fdff3c5c4edbf952aaa31519f0171c">color_256</a> (<a class="el" href="structclutchlog_1_1fmt_1_1color.html#ad4d10c015b3af3cc10d1cf40fe38e4f0">ground</a> t)</td></tr>
<tr class="memdesc:a12fdff3c5c4edbf952aaa31519f0171c inherit pub_methods_structclutchlog_1_1fmt_1_1color__256"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="structclutchlog_1_1fmt_1_1color__256.html#a12fdff3c5c4edbf952aaa31519f0171c">More...</a><br /></td></tr>
<tr class="separator:a12fdff3c5c4edbf952aaa31519f0171c inherit pub_methods_structclutchlog_1_1fmt_1_1color__256"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b68065b35141c018b33c3f2c45f5726 inherit pub_methods_structclutchlog_1_1fmt_1_1color__256"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structclutchlog_1_1fmt_1_1color__256.html#a1b68065b35141c018b33c3f2c45f5726">color_256</a> (<a class="el" href="structclutchlog_1_1fmt_1_1color.html#ad4d10c015b3af3cc10d1cf40fe38e4f0">ground</a> t, const short i)</td></tr>
<tr class="memdesc:a1b68065b35141c018b33c3f2c45f5726 inherit pub_methods_structclutchlog_1_1fmt_1_1color__256"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="structclutchlog_1_1fmt_1_1color__256.html#a1b68065b35141c018b33c3f2c45f5726">More...</a><br /></td></tr>
<tr class="separator:a1b68065b35141c018b33c3f2c45f5726 inherit pub_methods_structclutchlog_1_1fmt_1_1color__256"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad79557682cec1c053dda258581972111 inherit pub_methods_structclutchlog_1_1fmt_1_1color__256"><td class="memItemLeft" align="right" valign="top"><a id="ad79557682cec1c053dda258581972111"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structclutchlog_1_1fmt_1_1color__256.html#ad79557682cec1c053dda258581972111">is_set</a> () const</td></tr>
<tr class="memdesc:ad79557682cec1c053dda258581972111 inherit pub_methods_structclutchlog_1_1fmt_1_1color__256"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the underying representation encodes an existing color. <br /></td></tr>
<tr class="separator:ad79557682cec1c053dda258581972111 inherit pub_methods_structclutchlog_1_1fmt_1_1color__256"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaae6106a11eddade981172324a43df68 inherit pub_methods_structclutchlog_1_1fmt_1_1color__256"><td class="memItemLeft" align="right" valign="top"><a id="aaae6106a11eddade981172324a43df68"></a>
std::ostream &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structclutchlog_1_1fmt_1_1color__256.html#aaae6106a11eddade981172324a43df68">print_on</a> (std::ostream &amp;os) const</td></tr>
<tr class="memdesc:aaae6106a11eddade981172324a43df68 inherit pub_methods_structclutchlog_1_1fmt_1_1color__256"><td class="mdescLeft">&#160;</td><td class="mdescRight">Print the color index on the given stream. <br /></td></tr>
<tr class="separator:aaae6106a11eddade981172324a43df68 inherit pub_methods_structclutchlog_1_1fmt_1_1color__256"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_structclutchlog_1_1fmt_1_1color"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structclutchlog_1_1fmt_1_1color')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="structclutchlog_1_1fmt_1_1color.html">clutchlog::fmt::color</a></td></tr>
<tr class="memitem:a741d0165287350d8fcacb1f472ce5dac inherit pub_methods_structclutchlog_1_1fmt_1_1color"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structclutchlog_1_1fmt_1_1color.html#a741d0165287350d8fcacb1f472ce5dac">color</a> (<a class="el" href="classclutchlog_1_1fmt.html#a4d0b3c87ba935addf3581b000c0d7502">ansi</a> a, <a class="el" href="structclutchlog_1_1fmt_1_1color.html#ad4d10c015b3af3cc10d1cf40fe38e4f0">ground</a> g)</td></tr>
<tr class="memdesc:a741d0165287350d8fcacb1f472ce5dac inherit pub_methods_structclutchlog_1_1fmt_1_1color"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="structclutchlog_1_1fmt_1_1color.html#a741d0165287350d8fcacb1f472ce5dac">More...</a><br /></td></tr>
<tr class="separator:a741d0165287350d8fcacb1f472ce5dac inherit pub_methods_structclutchlog_1_1fmt_1_1color"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pub_attribs_structclutchlog_1_1fmt_1_1color__256"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structclutchlog_1_1fmt_1_1color__256')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="structclutchlog_1_1fmt_1_1color__256.html">clutchlog::fmt::color_256</a></td></tr>
<tr class="memitem:a8e0b13d6bad87c83c3465524a5d33988 inherit pub_attribs_structclutchlog_1_1fmt_1_1color__256"><td class="memItemLeft" align="right" valign="top">short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structclutchlog_1_1fmt_1_1color__256.html#a8e0b13d6bad87c83c3465524a5d33988">index</a></td></tr>
<tr class="memdesc:a8e0b13d6bad87c83c3465524a5d33988 inherit pub_attribs_structclutchlog_1_1fmt_1_1color__256"><td class="mdescLeft">&#160;</td><td class="mdescRight">The encoded color index in 4-bits ANSI. <a href="structclutchlog_1_1fmt_1_1color__256.html#a8e0b13d6bad87c83c3465524a5d33988">More...</a><br /></td></tr>
<tr class="separator:a8e0b13d6bad87c83c3465524a5d33988 inherit pub_attribs_structclutchlog_1_1fmt_1_1color__256"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_attribs_structclutchlog_1_1fmt_1_1color"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_structclutchlog_1_1fmt_1_1color')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="structclutchlog_1_1fmt_1_1color.html">clutchlog::fmt::color</a></td></tr>
<tr class="memitem:aacbc3cd9447fdb7d51e02b29b5028a6b inherit pub_attribs_structclutchlog_1_1fmt_1_1color"><td class="memItemLeft" align="right" valign="top"><a id="aacbc3cd9447fdb7d51e02b29b5028a6b"></a>
<a class="el" href="classclutchlog_1_1fmt.html#a4d0b3c87ba935addf3581b000c0d7502">ansi</a>&#160;</td><td class="memItemRight" valign="bottom"><b>mode</b></td></tr>
<tr class="separator:aacbc3cd9447fdb7d51e02b29b5028a6b inherit pub_attribs_structclutchlog_1_1fmt_1_1color"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3fd18c290567bd5c4971663a1aed12ae inherit pub_attribs_structclutchlog_1_1fmt_1_1color"><td class="memItemLeft" align="right" valign="top"><a id="a3fd18c290567bd5c4971663a1aed12ae"></a>
enum <a class="el" href="structclutchlog_1_1fmt_1_1color.html#ad4d10c015b3af3cc10d1cf40fe38e4f0">clutchlog::fmt::color::ground</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structclutchlog_1_1fmt_1_1color.html#a3fd18c290567bd5c4971663a1aed12ae">type</a></td></tr>
<tr class="memdesc:a3fd18c290567bd5c4971663a1aed12ae inherit pub_attribs_structclutchlog_1_1fmt_1_1color"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type of color (foreground or background). <br /></td></tr>
<tr class="separator:a3fd18c290567bd5c4971663a1aed12ae inherit pub_attribs_structclutchlog_1_1fmt_1_1color"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_types_structclutchlog_1_1fmt_1_1color"><td colspan="2" onclick="javascript:toggleInherit('pub_types_structclutchlog_1_1fmt_1_1color')"><img src="closed.png" alt="-"/>&#160;Public Types inherited from <a class="el" href="structclutchlog_1_1fmt_1_1color.html">clutchlog::fmt::color</a></td></tr>
<tr class="memitem:ad4d10c015b3af3cc10d1cf40fe38e4f0 inherit pub_types_structclutchlog_1_1fmt_1_1color"><td class="memItemLeft" align="right" valign="top"><a id="ad4d10c015b3af3cc10d1cf40fe38e4f0"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structclutchlog_1_1fmt_1_1color.html#ad4d10c015b3af3cc10d1cf40fe38e4f0">ground</a> { <b>fore</b> = 38,
<b>back</b> = 48
}</td></tr>
<tr class="memdesc:ad4d10c015b3af3cc10d1cf40fe38e4f0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Codes for representing foreground or background. <br /></td></tr>
<tr class="separator:ad4d10c015b3af3cc10d1cf40fe38e4f0 inherit pub_types_structclutchlog_1_1fmt_1_1color"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a83c663b1a9f00ba7ba7649c9c5605fad"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a83c663b1a9f00ba7ba7649c9c5605fad">&#9670;&nbsp;</a></span>bg_256() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">clutchlog::fmt::bg_256::bg_256 </td>
<td>(</td>
<td class="paramtype">const short&#160;</td>
<td class="paramname"><em>b</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">b</td><td>Background color index (within [-1,255], -1 being "no color"). </td></tr>
</table>
</dd>
</dl>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00563">563</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
</div>
</div>
<a id="a096d302be7373acaaf225644683408bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a096d302be7373acaaf225644683408bd">&#9670;&nbsp;</a></span>bg_256() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">clutchlog::fmt::bg_256::bg_256 </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="group__colors16.html#ga1cf3e27e4041250ffea0a6d58010da1e">bg</a> &amp;&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Conversion constructor from 16-colors mode. </p>
<dl class="section warning"><dt>Warning</dt><dd>Only encodes "no color", whatever is passed. </dd></dl>
<p class="definition">Definition at line <a class="el" href="clutchlog_8h_source.html#l00568">568</a> of file <a class="el" href="clutchlog_8h_source.html">clutchlog.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="clutchlog_8h_source.html">clutchlog.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="classclutchlog.html">clutchlog</a></li><li class="navelem"><a class="el" href="classclutchlog_1_1fmt.html">fmt</a></li><li class="navelem"><a class="el" href="structclutchlog_1_1fmt_1_1bg__256.html">bg_256</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>