IMGetDimPeriod

Syntax

#include <cafe/im.h>

IM_ERROR_CODE IMGetDimPeriod(u32 *second);

Parameters

second Pointer to the variable that stores the return value.

Return Values

IM_ERROR_NONE when the call was successful. All other values indicate failure.

Description

Returns the time period (in seconds) of user inactivity after which screen burn-in reduction will be triggered.

Do Not Call From

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

See Also

IMEnableDim
IMDisableDim
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