VIEnableDimming

C Specification

#include <revolution/vi.h>
BOOL VIEnableDimming( BOOL enable )

Arguments

enable If FALSE is specified, the screen burn-in protection is disabled. If TRUE is specified, the burn-in protection setting values of the system settings menu are applied.

Return Values

Returns the previously set value.

Description

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 VIGetDimmingCount function.

Disables the screen burn-in protection if FALSE has been specified. Note that the display returns to the bright state immediately (recovery from the burn-in protection state) if the screen was already dark and FALSE was passed as the argument.

When TRUE is specified, the burn-in protection setting values of the system settings menu are applied.
Note that burn-in protection will not function even if TRUE is passed as an argument 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 VIEnableDimming(TRUE).

This function is enabled at the next field after execution. There is no need to execute VIFlush at this time.
Note that this function will always reflect the burn-in protection setting from the system settings menu through the VIInit function.

See Also

VIResetDimmingCount, VIGetDimmingCount, VISetTimeToDimming

Revision History

2007/07/11 Added a link to VIResetDimmingCount.
2006/09/21 Changed "screen saver" to "burn-in protection."
2006/09/13 Deleted VIGetDVDStopMotorCount.
2006/09/01 Initial version.


CONFIDENTIAL