RetroArch
Classes | Macros | Typedefs | Enumerations | Functions
configuration.h File Reference
#include <stdint.h>
#include <boolean.h>
#include <retro_common_api.h>
#include <retro_miscellaneous.h>
#include "gfx/video_driver.h"
#include "input/input_defines.h"
#include "led/led_defines.h"
Include dependency graph for configuration.h:

Go to the source code of this file.

Classes

struct  settings
 

Macros

#define configuration_set_float(settings, var, newvar)
 
#define configuration_set_bool(settings, var, newvar)
 
#define configuration_set_uint(settings, var, newvar)
 
#define configuration_set_int(settings, var, newvar)
 

Typedefs

typedef RETRO_BEGIN_DECLS struct settings settings_t
 

Enumerations

enum  crt_switch_type { CRT_SWITCH_NONE = 0, CRT_SWITCH_15KHZ, CRT_SWITCH_31KHZ }
 
enum  override_type { OVERRIDE_NONE = 0, OVERRIDE_CORE, OVERRIDE_CONTENT_DIR, OVERRIDE_GAME }
 

Functions

const char * config_get_default_camera (void)
 
const char * config_get_default_wifi (void)
 
const char * config_get_default_location (void)
 
const char * config_get_default_video (void)
 
const char * config_get_default_audio (void)
 
const char * config_get_default_audio_resampler (void)
 
const char * config_get_default_input (void)
 
const char * config_get_default_joypad (void)
 
const char * config_get_default_menu (void)
 
const char * config_get_default_midi (void)
 
const char * config_get_midi_driver_options (void)
 
const char * config_get_default_record (void)
 
void config_load (void)
 
bool config_load_override (void)
 
bool config_unload_override (void)
 
bool config_load_remap (void)
 
bool config_load_shader_preset (void)
 
bool config_save_autoconf_profile (const char *path, unsigned user)
 
bool config_save_file (const char *path)
 
bool config_save_overrides (int override_type)
 
bool config_replace (bool config_save_on_exit, char *path)
 
bool config_init (void)
 
bool config_overlay_enable_default (void)
 
void config_set_defaults (void)
 
void config_free (void)
 
settings_tconfig_get_ptr (void)
 

Macro Definition Documentation

◆ configuration_set_bool

#define configuration_set_bool (   settings,
  var,
  newvar 
)
Value:
{ \
settings->modified = true; \
var = newvar; \
}

◆ configuration_set_float

#define configuration_set_float (   settings,
  var,
  newvar 
)
Value:
{ \
settings->modified = true; \
var = newvar; \
}

◆ configuration_set_int

#define configuration_set_int (   settings,
  var,
  newvar 
)
Value:
{ \
settings->modified = true; \
var = newvar; \
}

◆ configuration_set_uint

#define configuration_set_uint (   settings,
  var,
  newvar 
)
Value:
{ \
settings->modified = true; \
var = newvar; \
}

Typedef Documentation

◆ settings_t

Enumeration Type Documentation

◆ crt_switch_type

Enumerator
CRT_SWITCH_NONE 
CRT_SWITCH_15KHZ 
CRT_SWITCH_31KHZ 

◆ override_type

Enumerator
OVERRIDE_NONE 
OVERRIDE_CORE 
OVERRIDE_CONTENT_DIR 
OVERRIDE_GAME 

Function Documentation

◆ config_free()

void config_free ( void  )
Here is the call graph for this function:
Here is the caller graph for this function:

◆ config_get_default_audio()

const char* config_get_default_audio ( void  )

config_get_default_audio:

Gets default audio driver.

Returns: Default audio driver.

Here is the caller graph for this function:

◆ config_get_default_audio_resampler()

const char* config_get_default_audio_resampler ( void  )

config_get_default_audio_resampler:

Gets default audio resampler driver.

Returns: Default audio resampler driver.

Here is the caller graph for this function:

◆ config_get_default_camera()

const char* config_get_default_camera ( void  )

config_get_default_camera:

Gets default camera driver.

Returns: Default camera driver.

Here is the caller graph for this function:

◆ config_get_default_input()

const char* config_get_default_input ( void  )

config_get_default_input:

Gets default input driver.

Returns: Default input driver.

Here is the caller graph for this function:

◆ config_get_default_joypad()

const char* config_get_default_joypad ( void  )

config_get_default_joypad:

Gets default input joypad driver.

Returns: Default input joypad driver.

Here is the caller graph for this function:

◆ config_get_default_location()

const char* config_get_default_location ( void  )

config_get_default_location:

Gets default location driver.

Returns: Default location driver.

Here is the caller graph for this function:

◆ config_get_default_menu()

const char* config_get_default_menu ( void  )

config_get_default_menu:

Gets default menu driver.

Returns: Default menu driver.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ config_get_default_midi()

const char* config_get_default_midi ( void  )
Here is the caller graph for this function:

◆ config_get_default_record()

const char* config_get_default_record ( void  )
Here is the caller graph for this function:

◆ config_get_default_video()

const char* config_get_default_video ( void  )

config_get_default_video:

Gets default video driver.

Returns: Default video driver.

Here is the caller graph for this function:

◆ config_get_default_wifi()

const char* config_get_default_wifi ( void  )

config_get_default_wifi:

Gets default wifi driver.

Returns: Default wifi driver.

Here is the caller graph for this function:

◆ config_get_midi_driver_options()

const char* config_get_midi_driver_options ( void  )
Here is the call graph for this function:
Here is the caller graph for this function:

◆ config_get_ptr()

settings_t* config_get_ptr ( void  )

◆ config_init()

bool config_init ( void  )
Here is the caller graph for this function:

◆ config_load()

void config_load ( void  )

config_load:

Loads a config file and reads all the values into memory.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ config_load_override()

bool config_load_override ( void  )

config_load_override:

Tries to append game-specific and core-specific configuration. These settings will always have precedence, thus this feature can be used to enforce overrides.

Returns: false if there was an error or no action was performed.

config_load_override:

Tries to append game-specific and core-specific configuration. These settings will always have precedence, thus this feature can be used to enforce overrides.

This function only has an effect if a game-specific or core-specific configuration file exists at respective locations.

core-specific: $CONFIG_DIR/$CORE_NAME/$CORE_NAME.cfg fallback: $CURRENT_CFG_LOCATION/$CORE_NAME/$CORE_NAME.cfg

game-specific: $CONFIG_DIR/$CORE_NAME/$ROM_NAME.cfg fallback: $CURRENT_CFG_LOCATION/$CORE_NAME/$GAME_NAME.cfg

Returns: false if there was an error or no action was performed.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ config_load_remap()

bool config_load_remap ( void  )

config_load_remap:

Tries to append game-specific and core-specific remap files.

Returns: false if there was an error or no action was performed.

config_load_remap:

Tries to append game-specific and core-specific remap files.

This function only has an effect if a game-specific or core-specific configuration file exists at respective locations.

core-specific: $REMAP_DIR/$CORE_NAME/$CORE_NAME.cfg game-specific: $REMAP_DIR/$CORE_NAME/$GAME_NAME.cfg

Returns: false if there was an error or no action was performed.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ config_load_shader_preset()

bool config_load_shader_preset ( void  )

config_load_shader_preset:

Tries to append game-specific and core-specific shader presets.

Returns: false if there was an error or no action was performed.

config_load_shader_preset:

Tries to append game-specific and core-specific shader presets.

This function only has an effect if a game-specific or core-specific configuration file exists at respective locations.

core-specific: $SHADER_DIR/presets/$CORE_NAME/$CORE_NAME.cfg game-specific: $SHADER_DIR/presets/$CORE_NAME/$GAME_NAME.cfg

Returns: false if there was an error or no action was performed.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ config_overlay_enable_default()

bool config_overlay_enable_default ( void  )
Here is the caller graph for this function:

◆ config_replace()

bool config_replace ( bool  config_save_on_exit,
char *  path 
)
Here is the call graph for this function:
Here is the caller graph for this function:

◆ config_save_autoconf_profile()

bool config_save_autoconf_profile ( const char *  path,
unsigned  user 
)

config_save_autoconf_profile: : Path that shall be written to. : Controller number to save Writes a controller autoconf file to disk.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ config_save_file()

bool config_save_file ( const char *  path)

config_save_file: : Path that shall be written to.

Writes a config file to disk.

Returns: true (1) on success, otherwise returns false (0).

Here is the call graph for this function:
Here is the caller graph for this function:

◆ config_save_overrides()

bool config_save_overrides ( int  override_type)

config_save_overrides: : Path that shall be written to.

Writes a config file override to disk.

Returns: true (1) on success, otherwise returns false (0).

Here is the call graph for this function:
Here is the caller graph for this function:

◆ config_set_defaults()

void config_set_defaults ( void  )

config_set_defaults:

Set 'default' configuration values.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ config_unload_override()

bool config_unload_override ( void  )

config_unload_override:

Unloads configuration overrides if overrides are active.

Returns: false if there was an error.

Here is the call graph for this function:
Here is the caller graph for this function: