The-Homebrew-Cloud/wut
2
0
Fork 0
mirror of https://github.com/wiiu-env/wut.git synced 2024-12-05 03:04:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

include/proc_ui: Spelling; correct ProcessMessagesCore, DrawDoneRelease

Browse Source
This commit is contained in:
Ash 2018-06-25 22:07:01 +10:00
parent b37c405af8
commit dbb45f54e1
1 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
include/proc_ui/procui.h
View File

@ -77,7 +77,7 @@ typedef enum ProcUIStatus
PROCUI_STATUS_IN_FOREGROUND, PROCUI_STATUS_IN_FOREGROUND,
//! The application is in the background, only limited resources are usable. //! The application is in the background, only limited resources are usable.
PROCUI_STATUS_IN_BACKGROUND, PROCUI_STATUS_IN_BACKGROUND,
//! The application must relelase the foregound - see ProcUIDrawDoneRelease() //! The application must release the foregound - see ProcUIDrawDoneRelease()
PROCUI_STATUS_RELEASE_FOREGROUND, PROCUI_STATUS_RELEASE_FOREGROUND,
//! The application must release all resources (including ProcUI) and quit //! The application must release all resources (including ProcUI) and quit
PROCUI_STATUS_EXITING, PROCUI_STATUS_EXITING,
@ -107,18 +107,19 @@ ProcUIClearCallbacks();
* #PROCUI_STATUS_RELEASE_FOREGROUND state. * #PROCUI_STATUS_RELEASE_FOREGROUND state.
* *
* \note * \note
* Upon calling this function, all application threads on cores 0 or 1 are * After calling this function, the context will switch next time
* suspended as soon as possible - see coreinit/Thread for information on when * ProcUIProcessMessages() is called. All user threads on core 0 and 1 will
* threads are suspended. * be suspended once this happens.
* *
* \warning * \warning
* Do not attempt to use foreground-only resources after calling this function. * Do not attempt to use foreground-only resources after calling this function
* and its accompanying ProcUIProcessMessages().
* You should wait until ProcUI indicates #PROCUI_STATUS_IN_FOREGROUND. * You should wait until ProcUI indicates #PROCUI_STATUS_IN_FOREGROUND.
* *
* \if false * \if false
* meta: Does the context switch occur before this function returns? the next * how does SubProcessMessages fit in?
* ProcessMessages call? how does SubProcessMessages fit in? * doxy: how do you link to the description of coreinit/thread? would like to
* doxy: how do you link to the description of coreinit/thread? * note that threads can't be suspended immediately
* \endif * \endif
*/ */
void void
@ -221,7 +222,7 @@ ProcUIIsRunning();
* and ProcUISubProcessMessages(). * and ProcUISubProcessMessages().
* *
* \if false * \if false
* Assuming * Assuming the note about core behaviour is true, based on homebrew
* \endif * \endif
*/ */
ProcUIStatus ProcUIStatus
@ -256,7 +257,7 @@ ProcUIRegisterCallback(ProcUICallbackType type,
uint32_t priority); uint32_t priority);
/** /**
* Register a callback for certain ProcUI events on the given core. * Register a callback for certain ProcUI events, executed on the given core.
* *
* \param type * \param type
* The event to register a callback for. See #ProcUICallbackType. * The event to register a callback for. See #ProcUICallbackType.
@ -271,12 +272,10 @@ ProcUIRegisterCallback(ProcUICallbackType type,
* The priority of the callback. * The priority of the callback.
* *
* \param core * \param core
* The core to register the callback for. * The core ID to run the callback on.
* *
* \if false * \sa
* is core the core that the callback executes on? or is it about having * - ProcUIRegisterCallback()
* different callbacks for each core
* \false
*/ */
void void
ProcUIRegisterCallbackCore(ProcUICallbackType type, ProcUIRegisterCallbackCore(ProcUICallbackType type,