1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html>
3
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
6<meta name="GENERATOR" content="Microsoft FrontPage 3.0">
7<meta http-equiv="Content-Style-Type" content="text/css">
8<link rel="stylesheet" type="text/css" href="../CSS/revolution.css">
9<title>VIEnableDimming</title>
10</head>
11
12<body>
13
14<h1 align="left">VIEnableDimming</h1>
15
16<h2>Syntax</h2>
17<dl><dd><pre class="construction">
18#include &lt;revolution/vi.h&gt;
19
20BOOL VIEnableDimming( BOOL enable );
21</pre></dd></dl>
22
23<h2>Arguments</h2>
24<TABLE class="arguments" border="1" >
25<TBODY>
26  <tr>
27<th><STRONG><EM><CODE>enable</CODE></EM></STRONG></th>
28<td>If <CODE>FALSE</CODE> is specified, screen burn-in reduction is disabled. If <CODE>TRUE</CODE> is specified, the screen burn-in reduction settings from the system settings menu are applied.</td>
29  </tr>
30</TBODY>
31</table>
32
33<h2>Return Values</h2>
34<p>Returns the previously set value.</p>
35
36<h2>Description</h2>
37<p>This function enables (using the value from the system setting menu) or disables screen burn-in protection. The burn-in protection feature is activated once the controller input state remains unchanged for approximately five minutes. The exact time until activation can be obtained using the <a href="VIGetDimmingCount.html"><code>VIGetDimmingCount</code></a> function.
38</p>
39<p>
40Forcibly disables screen burn-in reduction if <code>FALSE</code> has been specified. Note that the display will brighten immediately (recover from the burn-in reduction state) if the screen was already dark when <CODE>FALSE</code> was specified.
41</p>
42
43<p>
44When <code>TRUE</code> is specified, the burn-in protection setting values of the system settings menu are applied.<br>Note that burn-in protection will not function even if <code>TRUE</code> is specified in the case where the system settings menu for burn-in protection has been set to OFF. Please also note that screen burn-in protection functions only if burn-in protection has been set to ON in the system settings menu with <code>VIEnableDimming(TRUE)</code>.</p>
45
46<p>
47This function is enabled at the next field after execution. There is no need to execute <a href="VIFlush.html"><code>VIFlush</code></a> at this time.<br>Note that this function will always reflect the burn-in protection setting from the system settings menu through the <a href="VIInit.html"><code>VIInit</code></a> function.
48</p>
49
50
51<h2>See Also</h2>
52<P class="reference">
53
54<a href="VIResetDimmingCount.html"><CODE>VIResetDimmingCount</CODE></a><br><a href="VIGetDimmingCount.html"><CODE>VIGetDimmingCount</CODE></a><br><a href="VISetTimeToDimming.html"><CODE>VISetTimeToDimming</CODE></a>
55
56</p>
57
58<h2>Revision History</h2>
59<p>
602007/07/11 Added a link to <CODE>VIResetDimmingCount</CODE>.<br>
61
622006/09/21 Changed &quot;screen saver&quot; to &quot;burn-in protection.&quot; <br>2006/09/13 Deleted <CODE>VIGetDVDStopMotorCount</CODE>.<br>2006/09/01 Initial version.<br>
63</p>
64
65<hr><p>CONFIDENTIAL</p></body>
66</html>
67