IMEnableDim

Syntax

#include <cafe/im.h>

IM_ERROR_CODE IMEnableDim(void);

Parameters

None.

Return Values

IM_ERROR_NONE upon success. All other values indicate failure.

Description

Enables the screen burn-in reduction feature. If screen burn-in reduction is disabled in the system settings, this function returns IM_ERROR_NONE and the screen burn-in reduction feature remains disabled.

Call this function to re-enable the screen burn-in reduction feature after disabling it with IMDisableDim.

If you have disabled screen burn-in reduction in the current scene by calling IMDisableDim, be sure to call IMEnableDim to re-enable burn-in reduction if the user transitions to the HOME Menu.

Do Not Call From

Background Do not call this function from the background.
Multiple threads This function is not thread-safe.

See Also

IMDisableDim
IMGetDimPeriod
IMGetTimeBeforeDimming
IMIsDimEnabled

Revision History

2013/10/25 Dimming is now called screen burn-in reduction.
2013/05/08 Automated cleanup pass.
2012/08/18 Auto-dimming is not enabled when system configuration disables it.
2012/06/08 Initial version.


CONFIDENTIAL