1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../../css/manpage.css" type="text/css" />
7<title>GetParallax</title>
8  </head>
9  <body>
10<h1><CODE>nn::ulcd::CTR::StereoCamera::GetParallax</CODE> Member Function</h1>
11<h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nn/ulcd.h&gt;
14
15f32 GetParallax(
16     const f32 distance
17) const;
18</pre>
19    </div>
20<h2>Arguments</h2>
21    <div class="section">
22      <table class="arguments">
23        <thead>
24          <tr>
25            <td width="15" />
26<th>Name</th>
27<td>Description</td>
28          </tr>
29        </thead>
30        <tr>
31<td>in</td>
32<th>distance</th>
33<td>Distance from the camera.</td>
34        </tr> </table>
35    </div>
36<h2>Return Values</h2>
37<div class="section">Amount of offset, both to the left and right, of an object at the specified location (as a ratio with <CODE>1.0f</CODE> = 100%). </div>
38<h2>Description</h2>
39    <div class="section">
40<p>Gets the ratio of the parallax at a point located a specified distance away from the camera to the screen width.</p><!-- write here --><P>This function calculates and returns a value indicating the screen ratio by which to shift an object for both the left and right cameras at a distance specified by <SPAN class="argument">distance</SPAN>, where <CODE>1.0f</CODE> indicates 100% (in other words, the return value is half of the offset between the images for the left and right eyes).
41</P><P>If a negative value is specified for <CODE>distance</CODE>, it returns <CODE>0.0</CODE>f. It returns a positive value for objects located beyond the base plane. It returns a negative value for objects located in front of the base plane.
42</P><P>The results from this function are calculated based on the results obtained during the last call to the <CODE>CalculateMatrices*</CODE> functions.
43            </P></div>
44<h2>Revision History</h2>
45    <div class="section">
46      <dl class="history">
47        <dt>2010/09/13</dt>
48<dd>Revised <B>Description</B> to make it easier to understand.
49        </dd>
50        <dt>2010/04/02</dt>
51<dd>Initial version.<br />
52        </dd>
53      </dl>
54    </div>
55  <hr><p>CONFIDENTIAL</p></body>
56</html>