core_option_manager.h File Reference

#include <stddef.h>
#include <boolean.h>
#include <retro_common_api.h>
#include <lists/string_list.h>

Include dependency graph for core_option_manager.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	core_option
struct	core_option_manager

Typedefs
typedef struct core_option_manager	core_option_manager_t

Functions
core_option_manager_t *	core_option_manager_new (const char *conf_path, const void *data)
bool	core_option_manager_updated (core_option_manager_t *opt)
bool	core_option_manager_flush (core_option_manager_t *opt)
bool	core_option_manager_flush_game_specific (core_option_manager_t *opt, const char *path)
void	core_option_manager_free (core_option_manager_t *opt)
void	core_option_manager_get (core_option_manager_t *opt, void *data)
size_t	core_option_manager_size (core_option_manager_t *opt)
const char *	core_option_manager_get_desc (core_option_manager_t *opt, size_t idx)
const char *	core_option_manager_get_val (core_option_manager_t *opt, size_t idx)
void	core_option_manager_set_val (core_option_manager_t *opt, size_t idx, size_t val_idx)
void	core_option_manager_next (core_option_manager_t *opt, size_t idx)
void	core_option_manager_prev (core_option_manager_t *opt, size_t idx)
void	core_option_manager_set_default (core_option_manager_t *opt, size_t idx)

Typedef Documentation

core_option_manager_t

typedef struct core_option_manager core_option_manager_t

Function Documentation

core_option_manager_flush()

bool core_option_manager_flush

(

core_option_manager_t *

opt

)

core_option_manager_flush: : options manager handle

Writes core option key-pair values to file.

Returns: true (1) if core option values could be successfully saved to disk, otherwise false (0).

Here is the call graph for this function:

Here is the caller graph for this function:

core_option_manager_flush_game_specific()

bool core_option_manager_flush_game_specific	(	core_option_manager_t *	opt,
		const char *	path
	)

core_option_manager_flush_game_specific: : options manager handle : path for the core options file

Writes core option key-pair values to a custom file.

Returns: true (1) if core option values could be successfully saved to disk, otherwise false (0).

Here is the call graph for this function:

Here is the caller graph for this function:

core_option_manager_free()

void core_option_manager_free

(

core_option_manager_t *

opt

)

core_option_manager_free: : options manager handle

Frees core option manager handle.

Here is the call graph for this function:

Here is the caller graph for this function:

core_option_manager_get()

void core_option_manager_get	(	core_option_manager_t *	opt,
		void *	data
	)

Here is the call graph for this function:

Here is the caller graph for this function:

core_option_manager_get_desc()

const char* core_option_manager_get_desc	(	core_option_manager_t *	opt,
		size_t	idx
	)

core_option_manager_get_desc: : options manager handle : idx identifier of the option

Gets description for an option.

Returns: Description for an option.

core_option_manager_get_desc: : options manager handle : index identifier of the option

Gets description for an option.

Returns: Description for an option.

Here is the call graph for this function:

Here is the caller graph for this function:

core_option_manager_get_val()

const char* core_option_manager_get_val	(	core_option_manager_t *	opt,
		size_t	idx
	)

core_option_manager_get_val: : options manager handle : idx identifier of the option

Gets value for an option.

Returns: Value for an option.

core_option_manager_get_val: : options manager handle : index identifier of the option

Gets value for an option.

Returns: Value for an option.

Here is the call graph for this function:

Here is the caller graph for this function:

core_option_manager_new()

core_option_manager_t* core_option_manager_new	(	const char *	conf_path,
		const void *	data
	)

core_option_manager_new: : Filesystem path to write core option config file to. : Pointer to variable array handle.

Creates and initializes a core manager handle.

Returns: handle to new core manager handle, otherwise NULL.

Here is the call graph for this function:

Here is the caller graph for this function:

core_option_manager_next()

void core_option_manager_next	(	core_option_manager_t *	opt,
		size_t	idx
	)

core_option_manager_next: : pointer to core option manager object. : idx of core option to be reset to defaults.

Get next value for core option specified by . Options wrap around.

core_option_manager_next: : pointer to core option manager object. : index of core option to be reset to defaults.

Get next value for core option specified by . Options wrap around.

Here is the call graph for this function:

Here is the caller graph for this function:

core_option_manager_prev()

void core_option_manager_prev	(	core_option_manager_t *	opt,
		size_t	idx
	)

core_option_manager_prev: : pointer to core option manager object. : idx of core option to be reset to defaults. Options wrap around.

Get previous value for core option specified by . Options wrap around.

core_option_manager_prev: : pointer to core option manager object. : index of core option to be reset to defaults. Options wrap around.

Get previous value for core option specified by . Options wrap around.

Here is the call graph for this function:

Here is the caller graph for this function:

core_option_manager_set_default()

void core_option_manager_set_default	(	core_option_manager_t *	opt,
		size_t	idx
	)

core_option_manager_set_default: : pointer to core option manager object. : idx of core option to be reset to defaults.

Reset core option specified by and sets default value for option.

core_option_manager_set_default: : pointer to core option manager object. : index of core option to be reset to defaults.

Reset core option specified by and sets default value for option.

Here is the call graph for this function:

Here is the caller graph for this function:

core_option_manager_set_val()

void core_option_manager_set_val	(	core_option_manager_t *	opt,
		size_t	idx,
		size_t	val_idx
	)

Here is the call graph for this function:

Here is the caller graph for this function:

core_option_manager_size()

size_t core_option_manager_size

(

core_option_manager_t *

opt

)

core_option_manager_size: : options manager handle

Gets total number of options.

Returns: Total number of options.

Here is the call graph for this function:

Here is the caller graph for this function:

core_option_manager_updated()

bool core_option_manager_updated

(

core_option_manager_t *

opt

)

core_option_manager_updated: : options manager handle

Has a core option been updated?

Returns: true (1) if a core option has been updated, otherwise false (0).

Here is the call graph for this function:

Here is the caller graph for this function: