<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXVisual
— FXRuby API Documentation
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "Fox::FXVisual";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (F)</a> »
<span class='title'><span class='object_link'><a href="../Fox.html" title="Fox (module)">Fox</a></span></span>
»
<span class="title">FXVisual</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: Fox::FXVisual
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="FXId.html" title="Fox::FXId (class)">FXId</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="FXObject.html" title="Fox::FXObject (class)">FXObject</a></span></li>
<li class="next"><span class='object_link'><a href="FXId.html" title="Fox::FXId (class)">FXId</a></span></li>
<li class="next">Fox::FXVisual</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXVisual.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>An FXVisual instance describes the pixel format for a drawable (i.e. an FXDrawable instance).</p>
<h3 id="label-Construction+options+for+FXVisual">Construction options for FXVisual</h3>
<dl class="rdoc-list note-list"><dt><code>VISUAL_DEFAULT</code>
<dd>
<p>Default visual</p>
</dd><dt><code>VISUAL_MONOCHROME</code>
<dd>
<p>Must be monochrome visual</p>
</dd><dt><code>VISUAL_BEST</code>
<dd>
<p>Best (deepest) visual</p>
</dd><dt><code>VISUAL_INDEXCOLOR</code>
<dd>
<p>Palette visual</p>
</dd><dt><code>VISUAL_GRAYSCALE</code>
<dd>
<p>Gray scale visual</p>
</dd><dt><code>VISUAL_TRUECOLOR</code>
<dd>
<p>Must be true color visual</p>
</dd><dt><code>VISUAL_OWNCOLORMAP</code>
<dd>
<p>Allocate private colormap</p>
</dd><dt><code>VISUAL_DOUBLEBUFFER</code>
<dd>
<p>Double-buffered <span class='object_link'><a href="FXGLVisual.html" title="Fox::FXGLVisual (class)">FXGLVisual</a></span></p>
</dd><dt><code>VISUAL_STEREO</code>
<dd>
<p>Stereo <span class='object_link'><a href="FXGLVisual.html" title="Fox::FXGLVisual (class)">FXGLVisual</a></span></p>
</dd><dt><code>VISUAL_NOACCEL</code>
<dd>
<p>No hardware acceleration [for broken h/w]</p>
</dd><dt><code>VISUAL_SWAP_COPY</code>
<dd>
<p>Buffer swap by copying (for FXGLVisual)</p>
</dd></dl>
<h3 id="label-Visual+type">Visual type</h3>
<dl class="rdoc-list note-list"><dt><code>VISUALTYPE_UNKNOWN</code>
<dd>
<p>Undetermined visual type</p>
</dd><dt><code>VISUALTYPE_MONO</code>
<dd>
<p>Visual for drawing into 1-bpp surfaces</p>
</dd><dt><code>VISUALTYPE_TRUE</code>
<dd>
<p>True color</p>
</dd><dt><code>VISUALTYPE_INDEX</code>
<dd>
<p>Index [palette] color</p>
</dd><dt><code>VISUALTYPE_GRAY</code>
<dd>
<p>Gray scale</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><div id="subclasses">
<h2>Direct Known Subclasses</h2>
<p class="children"><span class='object_link'><a href="FXGLVisual.html" title="Fox::FXGLVisual (class)">FXGLVisual</a></span></p>
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#depth-instance_method" title="#depth (instance method)">#<strong>depth</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Visual depth, i.e.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#flags-instance_method" title="#flags (instance method)">#<strong>flags</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Visual construction flags [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#maxColors-instance_method" title="#maxColors (instance method)">#<strong>maxColors</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Maximum number of colors [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#numBlue-instance_method" title="#numBlue (instance method)">#<strong>numBlue</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Number of bits of blue [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#numColors-instance_method" title="#numColors (instance method)">#<strong>numColors</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Number of colors [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#numGreen-instance_method" title="#numGreen (instance method)">#<strong>numGreen</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Number of bits of green [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#numRed-instance_method" title="#numRed (instance method)">#<strong>numRed</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Number of bits of red [Integer].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#visualType-instance_method" title="#visualType (instance method)">#<strong>visualType</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>The visual type, one of <code>VISUALTYPE_MONO</code>, <code>VISUALTYPE_TRUE</code> <code>VISUALTYPE_INDEX</code> or <code>VISUALTYPE_GRAY</code>.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Attributes inherited from <span class='object_link'><a href="FXId.html" title="Fox::FXId (class)">FXId</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXId.html#app-instance_method" title="Fox::FXId#app (method)">#app</a></span>, <span class='object_link'><a href="FXId.html#userData-instance_method" title="Fox::FXId#userData (method)">#userData</a></span>, <span class='object_link'><a href="FXId.html#xid-instance_method" title="Fox::FXId#xid (method)">#xid</a></span></p>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#getColor-instance_method" title="#getColor (instance method)">#<strong>getColor</strong>(pix) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Get color value for device pixel value <em>pix</em>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#getPixel-instance_method" title="#getPixel (instance method)">#<strong>getPixel</strong>(clr) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Get device pixel value for color value <em>clr</em>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(a, flgs, d = 32) ⇒ FXVisual </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Return an initialized FXVisual instance.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="FXId.html" title="Fox::FXId (class)">FXId</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXId.html#create-instance_method" title="Fox::FXId#create (method)">#create</a></span>, <span class='object_link'><a href="FXId.html#created%3F-instance_method" title="Fox::FXId#created? (method)">#created?</a></span>, <span class='object_link'><a href="FXId.html#destroy-instance_method" title="Fox::FXId#destroy (method)">#destroy</a></span>, <span class='object_link'><a href="FXId.html#detach-instance_method" title="Fox::FXId#detach (method)">#detach</a></span>, <span class='object_link'><a href="FXId.html#runOnUiThread-instance_method" title="Fox::FXId#runOnUiThread (method)">#runOnUiThread</a></span></p>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="FXObject.html" title="Fox::FXObject (class)">FXObject</a></span></h3>
<p class="inherited"><span class='object_link'><a href="FXObject.html#bind-instance_method" title="Fox::FXObject#bind (method)">#bind</a></span>, <span class='object_link'><a href="FXObject.html#handle-instance_method" title="Fox::FXObject#handle (method)">#handle</a></span>, <span class='object_link'><a href="FXObject.html#load-instance_method" title="Fox::FXObject#load (method)">#load</a></span>, <span class='object_link'><a href="FXObject.html#save-instance_method" title="Fox::FXObject#save (method)">#save</a></span>, <span class='object_link'><a href="FXObject.html#subclasses-class_method" title="Fox::FXObject.subclasses (method)">subclasses</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(a, flgs, d = 32) ⇒ <tt><span class='object_link'><a href="" title="Fox::FXVisual (class)">FXVisual</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Return an initialized FXVisual instance.</p>
<h4 id="label-Parameters-3A">Parameters:</h4>
<dl class="rdoc-list note-list"><dt><code>a</code>
<dd>
<p>an application instance <span class='object_link'><a href="FXApp.html" title="Fox::FXApp (class)">Fox::FXApp</a></span></p>
</dd><dt><code>flgs</code>
<dd>
<p>visual construction flags [Integer]</p>
</dd><dt><code>d</code>
<dd>
<p>requested visual depth, in bits [Integer]</p>
</dd></dl>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
66</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXVisual.rb', line 66</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_a'>a</span><span class='comma'>,</span> <span class='id identifier rubyid_flgs'>flgs</span><span class='comma'>,</span> <span class='id identifier rubyid_d'>d</span><span class='op'>=</span><span class='int'>32</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="depth-instance_method">
#<strong>depth</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Visual depth, i.e. number of significant bits in color representation [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXVisual.rb', line 32</span>
<span class='kw'>def</span> <span class='id identifier rubyid_depth'>depth</span>
<span class='ivar'>@depth</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="flags-instance_method">
#<strong>flags</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Visual construction flags [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXVisual.rb', line 29</span>
<span class='kw'>def</span> <span class='id identifier rubyid_flags'>flags</span>
<span class='ivar'>@flags</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="maxColors=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="maxColors-instance_method">
#<strong>maxColors</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Maximum number of colors [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXVisual.rb', line 47</span>
<span class='kw'>def</span> <span class='id identifier rubyid_maxColors'>maxColors</span>
<span class='ivar'>@maxColors</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="numBlue-instance_method">
#<strong>numBlue</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Number of bits of blue [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
44
45
46</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXVisual.rb', line 44</span>
<span class='kw'>def</span> <span class='id identifier rubyid_numBlue'>numBlue</span>
<span class='ivar'>@numBlue</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="numColors-instance_method">
#<strong>numColors</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Number of colors [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
35
36
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXVisual.rb', line 35</span>
<span class='kw'>def</span> <span class='id identifier rubyid_numColors'>numColors</span>
<span class='ivar'>@numColors</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="numGreen-instance_method">
#<strong>numGreen</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Number of bits of green [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
41
42
43</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXVisual.rb', line 41</span>
<span class='kw'>def</span> <span class='id identifier rubyid_numGreen'>numGreen</span>
<span class='ivar'>@numGreen</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="numRed-instance_method">
#<strong>numRed</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Number of bits of red [Integer]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
38
39
40</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXVisual.rb', line 38</span>
<span class='kw'>def</span> <span class='id identifier rubyid_numRed'>numRed</span>
<span class='ivar'>@numRed</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="visualType-instance_method">
#<strong>visualType</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>The visual type, one of <code>VISUALTYPE_MONO</code>, <code>VISUALTYPE_TRUE</code> <code>VISUALTYPE_INDEX</code> or <code>VISUALTYPE_GRAY</code>. The visual type may also be <code>VISUALTYPE_UNKNOWN</code> before the visual is actually created.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
55
56
57</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXVisual.rb', line 55</span>
<span class='kw'>def</span> <span class='id identifier rubyid_visualType'>visualType</span>
<span class='ivar'>@visualType</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="getColor-instance_method">
#<strong>getColor</strong>(pix) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get color value for device pixel value <em>pix</em>.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
76</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXVisual.rb', line 76</span>
<span class='kw'>def</span> <span class='id identifier rubyid_getColor'>getColor</span><span class='lparen'>(</span><span class='id identifier rubyid_pix'>pix</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="getPixel-instance_method">
#<strong>getPixel</strong>(clr) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Get device pixel value for color value <em>clr</em>.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
71</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXVisual.rb', line 71</span>
<span class='kw'>def</span> <span class='id identifier rubyid_getPixel'>getPixel</span><span class='lparen'>(</span><span class='id identifier rubyid_clr'>clr</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jan 2 11:47:31 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.2).
</div>
</div>
</body>
</html>