<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Fox::FXLight
— 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::FXLight";
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">FXLight</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::FXLight
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Fox::FXLight</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>rdoc-sources/FXGLViewer.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>OpenGL Light Source</p>
</div>
</div>
<div class="tags">
</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="#ambient-instance_method" title="#ambient (instance method)">#<strong>ambient</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Ambient light color <span class='object_link'><a href="FXVec4f.html" title="Fox::FXVec4f (class)">FXVec4f</a></span>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#c_attn-instance_method" title="#c_attn (instance method)">#<strong>c_attn</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Constant attenuation factor [Float].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#cutoff-instance_method" title="#cutoff (instance method)">#<strong>cutoff</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Spotlight cutoff angle [Float].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#diffuse-instance_method" title="#diffuse (instance method)">#<strong>diffuse</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Diffuse light color <span class='object_link'><a href="FXVec4f.html" title="Fox::FXVec4f (class)">FXVec4f</a></span>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#direction-instance_method" title="#direction (instance method)">#<strong>direction</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Spot direction <span class='object_link'><a href="FXVec3f.html" title="Fox::FXVec3f (class)">FXVec3f</a></span>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#exponent-instance_method" title="#exponent (instance method)">#<strong>exponent</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Spotlight exponent [Float].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#l_attn-instance_method" title="#l_attn (instance method)">#<strong>l_attn</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Linear attenuation factor [Float].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#position-instance_method" title="#position (instance method)">#<strong>position</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Light position <span class='object_link'><a href="FXVec4f.html" title="Fox::FXVec4f (class)">FXVec4f</a></span>.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#q_attn-instance_method" title="#q_attn (instance method)">#<strong>q_attn</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Quadratic attenuation factor [Float].</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#specular-instance_method" title="#specular (instance method)">#<strong>specular</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Specular light color <span class='object_link'><a href="FXVec4f.html" title="Fox::FXVec4f (class)">FXVec4f</a></span>.</p>
</div></span>
</li>
</ul>
<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="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ FXLight </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Returns an initialized FXLight instance.</p>
</div></span>
</li>
</ul>
<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> ⇒ <tt><span class='object_link'><a href="" title="Fox::FXLight (class)">FXLight</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns an initialized FXLight instance</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
65</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXGLViewer.rb', line 65</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</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="ambient=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="ambient-instance_method">
#<strong>ambient</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Ambient light color <span class='object_link'><a href="FXVec4f.html" title="Fox::FXVec4f (class)">Fox::FXVec4f</a></span></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/FXGLViewer.rb', line 35</span>
<span class='kw'>def</span> <span class='id identifier rubyid_ambient'>ambient</span>
<span class='ivar'>@ambient</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="c_attn=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="c_attn-instance_method">
#<strong>c_attn</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Constant attenuation factor [Float]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
56
57
58</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXGLViewer.rb', line 56</span>
<span class='kw'>def</span> <span class='id identifier rubyid_c_attn'>c_attn</span>
<span class='ivar'>@c_attn</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="cutoff=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="cutoff-instance_method">
#<strong>cutoff</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Spotlight cutoff angle [Float]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
53
54
55</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXGLViewer.rb', line 53</span>
<span class='kw'>def</span> <span class='id identifier rubyid_cutoff'>cutoff</span>
<span class='ivar'>@cutoff</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="diffuse=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="diffuse-instance_method">
#<strong>diffuse</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Diffuse light color <span class='object_link'><a href="FXVec4f.html" title="Fox::FXVec4f (class)">Fox::FXVec4f</a></span></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/FXGLViewer.rb', line 38</span>
<span class='kw'>def</span> <span class='id identifier rubyid_diffuse'>diffuse</span>
<span class='ivar'>@diffuse</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="direction=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="direction-instance_method">
#<strong>direction</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Spot direction <span class='object_link'><a href="FXVec3f.html" title="Fox::FXVec3f (class)">Fox::FXVec3f</a></span></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/FXGLViewer.rb', line 47</span>
<span class='kw'>def</span> <span class='id identifier rubyid_direction'>direction</span>
<span class='ivar'>@direction</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="exponent=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="exponent-instance_method">
#<strong>exponent</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Spotlight exponent [Float]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXGLViewer.rb', line 50</span>
<span class='kw'>def</span> <span class='id identifier rubyid_exponent'>exponent</span>
<span class='ivar'>@exponent</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="l_attn=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="l_attn-instance_method">
#<strong>l_attn</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Linear attenuation factor [Float]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
59
60
61</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXGLViewer.rb', line 59</span>
<span class='kw'>def</span> <span class='id identifier rubyid_l_attn'>l_attn</span>
<span class='ivar'>@l_attn</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="position=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="position-instance_method">
#<strong>position</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Light position <span class='object_link'><a href="FXVec4f.html" title="Fox::FXVec4f (class)">Fox::FXVec4f</a></span></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/FXGLViewer.rb', line 44</span>
<span class='kw'>def</span> <span class='id identifier rubyid_position'>position</span>
<span class='ivar'>@position</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="q_attn=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="q_attn-instance_method">
#<strong>q_attn</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Quadratic attenuation factor [Float]</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
62
63
64</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'rdoc-sources/FXGLViewer.rb', line 62</span>
<span class='kw'>def</span> <span class='id identifier rubyid_q_attn'>q_attn</span>
<span class='ivar'>@q_attn</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="specular=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="specular-instance_method">
#<strong>specular</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Specular light color <span class='object_link'><a href="FXVec4f.html" title="Fox::FXVec4f (class)">Fox::FXVec4f</a></span></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/FXGLViewer.rb', line 41</span>
<span class='kw'>def</span> <span class='id identifier rubyid_specular'>specular</span>
<span class='ivar'>@specular</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jan 2 11:47:42 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>