#include <cafe/procui.h> ProcUIStatus ProcUIProcessMessages(BOOL block);
||The process is currently in the foreground.|
||The process is currently in the background. This can only be returned if block is set to
||The process needs to release the foreground. Upon receiving this,
||The process needs to exit. It may be returned in the foreground or the background.|
ProcUIProcessMessages is called at every frame, all system messages are handled automatically. The
ProcUIProcessMessages function performs the following:
OSReleaseForegroundon all 3 cores.
MEM1and the foreground bucket at a user-defined location (optional).
ProcUIProcessMessages function can perform process switching when
TRUE is passed as the argument in blocking mode, or in non-blocking mode. Blocking mode is easier to implement.
If you pass
TRUE as the argument, you need to call only the following four functions used by ProcUI:
TRUE to this function unless a reason exists not to.
While a process transitions to the background (i.e., it is in the "RELEASING" state), it may continue to use GX2 and MEM1 as normal. However, it should complete all drawing activity, display its final frame, and release all MEM1 resources before doing its final transition to the background state. Prior to releasing the foreground, the main graphics core (the one which called GX2Init) must call GX2DrawDone when all rendering is complete. This guarantees that all command buffer data has been dispatched to the GPU and completed. There are two ways to do this using the ProcUI system:
ProcUIRegisterCallbackthat performs the following.
In addition to guaranteeing that the main core's command buffer has been flushed, all display list generation on the other threads/cores must also stop. The application must call GX2EndDisplayList in all other rendering threads/cores if a display list is being generated prior to switching to the background. While in the background state, no further GX2 operations should be performed until the main core has reentered the foreground. After the main core switches to the background, other threads/cores may partially overrun their time slice. To avoid overrunning and writing new GX2 commands on these cores, stop all threads that issue GX2 commands prior to calling GX2DrawDone in the above sequence.
After performing a process switch using the
ProcUIProcessMessages function, threads overrun slightly, except the thread that called
ProcUIProcessMessages. To avoid the overrun when calling
ProcUIProcessMessages, stop the thread on which a GX2 command is issued.
For example, if you have an asynchronous thread for loading that also creates a display list, use a mutex or other exclusive locking construct to lock the place where the display list is created and the place where
ProcUIProcessMessages is called.
The GX2SetTVEnable and GX2SetDRCEnable functions sets a flag after the last frame is cleared that tells the system that the application allowed rendering to occur. When a process releases the foreground, GX2 can store the last frame that the application displayed. The flag that these functions set determines whether the frame is stored.
In addition, under the current implementation, at each process switch, this flag is cleared after the last frame is stored. Although the black screen is cleared when the application acquires the foreground, the application must pass
TRUE to these functions every time.
To simplify your implementation:
GX2_TRUEwhen you call GX2SetTVEnable and GX2SetDRCEnable. Never pass
GX2_FALSEwhen you call these functions.
ProcUIDrawDoneReleasefunction with GX2SetTVEnable and GX2SetDRCEnable before switching processes.
When a user presses the HOME Button during gameplay, the game moves to the background. Some games continue to run in the background. For example, an online game might communicate in the background to maintain its connection. Only Core 2 is available in the background. Core 0 and Core 1 are not available.
If the game moves to the background with a thread on Core 0 or Core 1, and the thread leaves a mutex locked:
Upon reacquiring the foreground state, the application should make few assumptions about what GPU state remains from its previous foreground instance. MEM2 resources remained where they were. Any MEM1 resources will need to be reloaded. Display settings (see GX2DisplayPage) should not require resetting, though it does not hurt to do so.
The application must start the rendering with a context state reset. This means it should begin the frame by calling either GX2ClearColor (or similar APIs, see GX2 Functions Which Disable State Shadowing) or GX2SetContextState. This is mandatory. It is not acceptable to attempt to reset every GX2 state manually, since this may not reset all of the GPU pipeline state.
|Multiple threads||This function is not thread-safe.|
2014/01/20 Terminology fix.
2013/05/08 Automated cleanup pass.
2012/05/04 Initial version.