OSReleaseForeground

Syntax

#include <cafe/os.h>

void OSReleaseForeground(void);

Parameters

None.

Return Values

None.

Description

This function must be called by all three processor cores when a process is releasing the foreground resources. At least one core in the process must call OSSavesDone_ReadyToRelease before the coordinated release on all three cores. This signifies to the operating system that the game has completed any in-progress data saves to storage so that it may be safely resumed if the system stops.

A process releases the foreground resources in response to receiving a message to do so from the system message queue. A process will receive another message on the system message queue when it has reacquired the foreground resources. All processes start in the foreground.

Do Not Call From

Multiple threads This function is not thread-safe.

See Also

APP_IN_FOREGROUND
OSGetCallArgs
OSGetForegroundBucket
OSGetSystemMessageQueue
OSSavesDone_ReadyToRelease
OSSendAppSwitchRequest

Revision History

2013/05/08 Automated cleanup pass.
2012/08/20 Remove ALPHA tag.
2012/07/27 Cleanup Pass
2011/08/29 Initial version.


CONFIDENTIAL