IMDisableDim

Syntax

#include <cafe/im.h>

IM_ERROR_CODE IMDisableDim(void);

Parameters

None.

Return Values

IM_ERROR_NONE upon success. All other values indicate failure.

Description

Disables the screen burn-in reduction feature. If the screen burn-in reduction feature is enabled in the system settings, this function overrides that setting to disable screen burn-in reduction.

If you disable the screen burn-in reduction feature, it remains disabled until you call IMEnableDim.

If you disable screen burn-in reduction in the current scene, 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

IMEnableDim
IMGetDimPeriod
IMGetTimeBeforeDimming
IMIsDimEnabled

Revision History

2013-10-25 Dimming is now called screen burn-in reduction.
2013-05-08 Automated cleanup pass.
2012-06-08 Initial version.


CONFIDENTIAL