application_config.h File Reference

#include "strings/kname.h"
#include <defines.h>
#include <math/math_types.h>

Go to the source code of this file.

Data Structures
struct	application_plugin_config
	Configuration for an application runtime plugin. More...
struct	application_system_config
	Represents the top-level configuration for a core engine system. Each system is responsible for parsing its own portion of the configuration structure, which is provided here in string format. Systems not requiring config can simply not set this. More...
struct	application_rendergraph_config
struct	application_config
	Represents configuration for the application. The application config is fed to the engine on creation, so it knows how to configure itself internally. More...

Typedefs
typedef struct application_plugin_config	application_plugin_config
	Configuration for an application runtime plugin. More...
typedef struct application_system_config	application_system_config
	Represents the top-level configuration for a core engine system. Each system is responsible for parsing its own portion of the configuration structure, which is provided here in string format. Systems not requiring config can simply not set this. More...
typedef struct application_rendergraph_config	application_rendergraph_config
typedef struct application_config	application_config
	Represents configuration for the application. The application config is fed to the engine on creation, so it knows how to configure itself internally. More...

Functions
KAPI b8	application_config_parse_file_content (const char *file_content, application_config *out_config)
	Attempt to parse the application config file's content into the actual application config structure. More...
KAPI b8	application_config_system_config_get (const application_config *config, const char *system_name, application_system_config *out_sys_config)
	Attempts to get the generic-level configuration for the system with the provided name. More...

Typedef Documentation

application_config

typedef struct application_config application_config

Represents configuration for the application. The application config is fed to the engine on creation, so it knows how to configure itself internally.

application_plugin_config

typedef struct application_plugin_config application_plugin_config

Configuration for an application runtime plugin.

application_rendergraph_config

typedef struct application_rendergraph_config application_rendergraph_config

application_system_config

typedef struct application_system_config application_system_config

Represents the top-level configuration for a core engine system. Each system is responsible for parsing its own portion of the configuration structure, which is provided here in string format. Systems not requiring config can simply not set this.

Function Documentation

application_config_parse_file_content()

KAPI b8 application_config_parse_file_content	(	const char *	file_content,
		application_config *	out_config
	)

Attempt to parse the application config file's content into the actual application config structure.

Parameters

The	file content of the application config (KSON format).
out_config	A pointer to hold the application config structure.

Returns

True on success; otherwise false.

application_config_system_config_get()

KAPI b8 application_config_system_config_get	(	const application_config *	config,
		const char *	system_name,
		application_system_config *	out_sys_config
	)

Attempts to get the generic-level configuration for the system with the provided name.

Parameters

config	A constant pointer to the top-level application config.
system_name	The name of the system to retrieve the top-level config for.
out_sys_config	A pointer to hold the selected system config, if found.

Returns

True on success; otherwise false.