Kohi Game Engine
Data Structures | Typedefs | Functions
engine.h File Reference

This file contains structures and logic pertaining to the overall engine itself. The engine is responsible for managing both the platform layers as well as all systems within the engine. More...

#include "audio/audio_types.h"
#include "defines.h"
#include "renderer/renderer_types.h"
#include "systems/font_system.h"

Go to the source code of this file.

Data Structures

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_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 engine_create (struct application *game_inst)
 Creates the engine, standing up the platform layer and all underlying subsystems. More...
 
KAPI b8 engine_run (struct application *game_inst)
 Starts the main engine loop. More...
 
void engine_on_event_system_initialized (void)
 A callback made when the event system is initialized, which internally allows the engine to begin listening for events required for initialization. More...
 
KAPI const struct frame_data * engine_frame_data_get (struct application *game_inst)
 Obtains a constant pointer to the current frame data. More...
 

Detailed Description

This file contains structures and logic pertaining to the overall engine itself. The engine is responsible for managing both the platform layers as well as all systems within the engine.

Author
Travis Vroman (travi.nosp@m.s@ko.nosp@m.hieng.nosp@m.ine..nosp@m.com)
Version
1.0
Date
2022-01-10
Copyright
Kohi Game Engine is Copyright (c) Travis Vroman 2021-2022

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.

Function Documentation

◆ engine_create()

KAPI b8 engine_create ( struct application *  game_inst)

Creates the engine, standing up the platform layer and all underlying subsystems.

Parameters
game_instA pointer to the application instance associated with the engine
Returns
True on success; otherwise false.

◆ engine_frame_data_get()

KAPI const struct frame_data* engine_frame_data_get ( struct application *  game_inst)

Obtains a constant pointer to the current frame data.

Parameters
game_instA pointer to the application instance.
Returns
A constant pointer to the current frame data.

◆ engine_on_event_system_initialized()

void engine_on_event_system_initialized ( void  )

A callback made when the event system is initialized, which internally allows the engine to begin listening for events required for initialization.

◆ engine_run()

KAPI b8 engine_run ( struct application *  game_inst)

Starts the main engine loop.

Parameters
game_instA pointer to the application instance associated with the engine
Returns
True on success; otherwise false.