The-Homebrew-Cloud/wut
2
0
Fork 0
mirror of https://github.com/wiiu-env/wut.git synced 2025-01-05 21:18:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

include/coreinit/core.h: Add Doxygen docs for Core group.

Browse Source
This commit is contained in:
Ash 2018-07-18 21:33:50 +10:00
parent 2e9643e342
commit 9db6278915
No known key found for this signature in database
GPG Key ID: 461BAD1D1531729D
1 changed files with 23 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
include/coreinit/core.h
View File

@ -4,6 +4,9 @@
/**
* \defgroup coreinit_core Core
* \ingroup coreinit
*
* The coreinit Core group of functions provide information about each core of
* the system's processor.
* @{
*/
@ -13,28 +16,44 @@ extern "C" {
/**
* Returns the number of cores, should always be 3.
* Gets the number of cores in the system. On a retail Wii U, this is always 3.
*
* \returns
* The core count of the system.
*/
uint32_t
OSGetCoreCount();
/**
* Returns the ID of the core currently executing this thread.
* Gets the core executing the current thread.
*
* \returns
* The ID of the current core.
*/
uint32_t
OSGetCoreId();
/**
* Returns the ID of the main core.
* Gets the main core of the system. On a retail Wii U, this is always core 1.
*
* \returns
* The ID of the main core.
*/
uint32_t
OSGetMainCoreId();
/**
* Returns true if the current core is the main core.
* Determines whether the current thread is running on the main core.
* On a retail Wii U, the main core is always core 1.
*
* \returns
* \c true if the current core is the main core.
*
* \sa
* <ul><li>\link OSGetMainCoreId \endlink</li></ul>
*/
BOOL
OSIsMainCore();