MAK Legion 1.1 API Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
c_config.h
Go to the documentation of this file.
1 /*********************************************************************************
2 ** Copyright (c) 2021 MAK Technologies, Inc.
3 ** All rights reserved.
4 *********************************************************************************/
5 
9 #pragma once
10 
13 
14 #ifdef __cplusplus
15 extern "C" {
16 #endif
17 
18 
19  /* C API of Legion configuration */
20 
26  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_create(const char* filepath, ConfigHandle *retConfig);
27 
33  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_clone(const ConfigHandle orig, ConfigHandle* clone);
34 
39  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_delete(ConfigHandle config);
40 
42  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_helpString(ConfigHandle config, const char** out);
43 
51  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_processParameters(ConfigHandle config, const char** paramNames, const char** paramValues, const int count);
52 
60  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_processArguments(ConfigHandle config, int argc, char** argv, int* processedArgCount);
61 
64  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_hasParameter(ConfigHandle config, const char* name, LEG_Bool* out);
65  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_isParameterSet(ConfigHandle config, const char* name, LEG_Bool* out);
66  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_loadParameters(ConfigHandle config, const char* filename, LEG_Bool* out);
67  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_saveParameters(ConfigHandle config, const char* filename, LEG_Bool* out);
68  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_registerBoolParameter(ConfigHandle config, const char* name);
69  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_registerIntParameter(ConfigHandle config, const char* name);
70  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_registerFloatParameter(ConfigHandle config, const char* name);
71  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_registerStringParameter(ConfigHandle config, const char* name);
72  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_setBoolParameter(ConfigHandle config, const char* name, const bool val);
73  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_setIntParameter(ConfigHandle config, const char* name, const int val);
74  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_setFloatParameter(ConfigHandle config, const char* name, const float val);
75  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_setStringParameter(ConfigHandle config, const char* name, const char* val);
76  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_getBoolParameter(ConfigHandle config, const char* name, LEG_Bool* out);
77  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_getIntParameter(ConfigHandle config, const char* name, Int32* out);
78  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_getFloatParameter(ConfigHandle config, const char* name, float* out);
79  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_getStringParameter(ConfigHandle config, const char* name, const char** out);
80  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_getUnitMultiplier(ConfigHandle config, const char* param, float* out);
81  LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_setUnitMultiplier(ConfigHandle config, const char* param, const float multiplier);
84 #ifdef __cplusplus
85 }
86 #endif
87 
LEG_ReturnCode
Definition: c_api.h:62
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_isParameterSet(ConfigHandle config, const char *name, LEG_Bool *out)
C API to get/set/register/save configuration parameters.
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_getBoolParameter(ConfigHandle config, const char *name, LEG_Bool *out)
C API to get/set/register/save configuration parameters.
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_clone(const ConfigHandle orig, ConfigHandle *clone)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_setUnitMultiplier(ConfigHandle config, const char *param, const float multiplier)
C API to get/set/register/save configuration parameters.
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_getFloatParameter(ConfigHandle config, const char *name, float *out)
C API to get/set/register/save configuration parameters.
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_registerBoolParameter(ConfigHandle config, const char *name)
C API to get/set/register/save configuration parameters.
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_registerStringParameter(ConfigHandle config, const char *name)
C API to get/set/register/save configuration parameters.
int Int32
Definition: c_api.h:55
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_getIntParameter(ConfigHandle config, const char *name, Int32 *out)
C API to get/set/register/save configuration parameters.
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_setFloatParameter(ConfigHandle config, const char *name, const float val)
C API to get/set/register/save configuration parameters.
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_registerIntParameter(ConfigHandle config, const char *name)
C API to get/set/register/save configuration parameters.
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_loadParameters(ConfigHandle config, const char *filename, LEG_Bool *out)
C API to get/set/register/save configuration parameters.
unsigned long long ConfigHandle
Definition: c_api.h:22
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_getStringParameter(ConfigHandle config, const char *name, const char **out)
C API to get/set/register/save configuration parameters.
LEG_Bool
Definition: c_api.h:111
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_setStringParameter(ConfigHandle config, const char *name, const char *val)
C API to get/set/register/save configuration parameters.
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_helpString(ConfigHandle config, const char **out)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_getUnitMultiplier(ConfigHandle config, const char *param, float *out)
C API to get/set/register/save configuration parameters.
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_registerFloatParameter(ConfigHandle config, const char *name)
C API to get/set/register/save configuration parameters.
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_saveParameters(ConfigHandle config, const char *filename, LEG_Bool *out)
C API to get/set/register/save configuration parameters.
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_hasParameter(ConfigHandle config, const char *name, LEG_Bool *out)
C API to get/set/register/save configuration parameters.
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_processArguments(ConfigHandle config, int argc, char **argv, int *processedArgCount)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_setBoolParameter(ConfigHandle config, const char *name, const bool val)
C API to get/set/register/save configuration parameters.
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_create(const char *filepath, ConfigHandle *retConfig)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_processParameters(ConfigHandle config, const char **paramNames, const char **paramValues, const int count)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_delete(ConfigHandle config)
LEGIONRUNTIME_DLL LEG_ReturnCode legion_config_setIntParameter(ConfigHandle config, const char *name, const int val)
C API to get/set/register/save configuration parameters.

Document ID: Generated on Wed May 26 15:17:05 EDT 2021 from SVN revision 229676
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)