MRSystem.h

Go to the documentation of this file.

#pragma once
 
#include <MRCMisc/common.h>
#include <MRCMisc/exports.h>
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct MR_std_filesystem_path MR_std_filesystem_path; // Defined in `#include <MRCMisc/std_filesystem_path.h>`.
typedef struct MR_std_string MR_std_string; // Defined in `#include <MRCMisc/std_string.h>`.
 
 
typedef struct MR_SystemMemory MR_SystemMemory;
 
// sets debug name for the current thread
MRC_API void MR_SetCurrentThreadName(const char *name);
 
// return path to the folder with user config file(s)
MRC_API MR_std_filesystem_path *MR_getUserConfigDir(void);
 
// returns path of config file in APPDATA
MRC_API MR_std_filesystem_path *MR_getUserConfigFilePath(void);
 
// returns temp directory
MRC_API MR_std_filesystem_path *MR_GetTempDirectory(void);
 
// returns home directory
MRC_API MR_std_filesystem_path *MR_GetHomeDirectory(void);
 
// returns version of MR
MRC_API const char *MR_GetMRVersionString(void);
 
// Opens given link in default browser
MRC_API void MR_OpenLink(const MR_std_string *url);
 
// Opens given file (or directory) in associated application
MRC_API bool MR_OpenDocument(const char *path, const char *path_end);
 
// returns string identification of the CPU
MRC_API MR_std_string *MR_GetCpuId(void);
 
// returns string with OS name with details
MRC_API MR_std_string *MR_GetDetailedOSName(void);
 
// returns string identification of the OS
MRC_API MR_std_string *MR_getOSNoSpaces(void);
 
// sets new handler for operator new if needed for some platforms
MRC_API void MR_setNewHandlerIfNeeded(void);
 
MRC_API MR_std_string *MR_getCurrentStacktrace(void);
 
MRC_API const MR_uint64_t *MR_SystemMemory_Get_physicalTotal(const MR_SystemMemory *_this);
 
MRC_API void MR_SystemMemory_Set_physicalTotal(MR_SystemMemory *_this, MR_uint64_t value);
 
MRC_API MR_uint64_t *MR_SystemMemory_GetMutable_physicalTotal(MR_SystemMemory *_this);
 
MRC_API const MR_uint64_t *MR_SystemMemory_Get_physicalAvailable(const MR_SystemMemory *_this);
 
MRC_API void MR_SystemMemory_Set_physicalAvailable(MR_SystemMemory *_this, MR_uint64_t value);
 
MRC_API MR_uint64_t *MR_SystemMemory_GetMutable_physicalAvailable(MR_SystemMemory *_this);
 
MRC_API MR_SystemMemory *MR_SystemMemory_DefaultConstruct(void);
 
MRC_API MR_SystemMemory *MR_SystemMemory_DefaultConstructArray(size_t num_elems);
 
MRC_API MR_SystemMemory *MR_SystemMemory_ConstructFrom(MR_uint64_t physicalTotal, MR_uint64_t physicalAvailable);
 
MRC_API const MR_SystemMemory *MR_SystemMemory_OffsetPtr(const MR_SystemMemory *ptr, ptrdiff_t i);
 
MRC_API MR_SystemMemory *MR_SystemMemory_OffsetMutablePtr(MR_SystemMemory *ptr, ptrdiff_t i);
 
MRC_API MR_SystemMemory *MR_SystemMemory_ConstructFromAnother(const MR_SystemMemory *_other);
 
MRC_API void MR_SystemMemory_Destroy(const MR_SystemMemory *_this);
 
MRC_API void MR_SystemMemory_DestroyArray(const MR_SystemMemory *_this);
 
MRC_API MR_SystemMemory *MR_SystemMemory_AssignFromAnother(MR_SystemMemory *_this, const MR_SystemMemory *_other);
 
MRC_API MR_SystemMemory *MR_getSystemMemory(void);
 
MRC_API void MR_setupLoggerByDefault(void);
 
#ifdef __cplusplus
} // extern "C"
#endif