- Generated by
1.9.1
|
Kohi Game Engine
|
This file contains the platform layer, or at least the interface to it. Each platform should provide its own implementation of this in a .c file, and should be compiled exclusively of the rest. More...
Go to the source code of this file.
Data Structures | |
| struct | platform_system_config |
| struct | dynamic_library_function |
| struct | dynamic_library |
| struct | kwindow_config |
| A configuration structure used to create new windows. More... | |
| struct | kwindow |
| Represents a window in the application. More... | |
| struct | kstorage_info |
| struct | ksystem_info |
| struct | kclipboard_context |
Macros | |
| #define | KMAX_STORAGE_DEVICES 32 |
| #define | KMAX_PATH_LEN 256 |
Functions | |
| KINLINE const char * | kdrive_type_to_string (kdrive_type type) |
| KAPI b8 | platform_system_startup (u64 *memory_requirement, struct platform_state *state, platform_system_config *config) |
| Performs startup routines within the platform layer. Should be called twice, once to obtain the memory requirement (with state=0), then a second time passing an allocated block of memory to state. More... | |
| KAPI void | platform_system_shutdown (struct platform_state *state) |
| Shuts down the platform layer. More... | |
| KAPI b8 | platform_window_create (const kwindow_config *config, struct kwindow *window, b8 show_immediately) |
| Creates a new window from the given config and optionally opens it immediately. More... | |
| KAPI void | platform_window_destroy (struct kwindow *window) |
| Destroys the given window. More... | |
| KAPI b8 | platform_window_show (struct kwindow *window) |
| Shows the given window. Has no effect if the window is already shown. More... | |
| KAPI b8 | platform_window_hide (struct kwindow *window) |
| Hides the given window. Has no effect if the window is already hidden. Note that this does not destroy the window. More... | |
| KAPI const char * | platform_window_title_get (const struct kwindow *window) |
| Obtains the window title from the given window, if it exists. NOTE: Returns a constant copy of the string, which must be freed by the caller. More... | |
| KAPI b8 | platform_window_title_set (struct kwindow *window, const char *title) |
| Sets the given window's title, if it exists. More... | |
| KAPI b8 | platform_pump_messages (void) |
| Performs any platform-specific message pumping that is required for windowing, etc. More... | |
| KAPI void * | platform_allocate (u64 size, b8 aligned) |
| Performs platform-specific memory allocation of the given size. More... | |
| KAPI void | platform_free (void *block, b8 aligned) |
| Frees the given block of memory. More... | |
| KAPI void * | platform_zero_memory (void *block, u64 size) |
| Performs platform-specific zeroing out of the given block of memory. More... | |
| KAPI void * | platform_copy_memory (void *dest, const void *source, u64 size) |
| Copies the bytes of memory in source to dest, of the given size. More... | |
| KAPI void * | platform_set_memory (void *dest, i32 value, u64 size) |
| Sets the bytes of memory to the given value. More... | |
| KAPI void | platform_console_write (struct platform_state *platform, log_level level, const char *message) |
| Performs platform-specific printing to the console of the given message and log level. More... | |
| KAPI f64 | platform_get_absolute_time (void) |
| Gets the absolute time since the application started. More... | |
| KAPI void | platform_sleep (u64 ms) |
| Sleep on the thread for the provided milliseconds. This blocks the main thread. Should only be used for giving time back to the OS for unused update power. Therefore it is not exported. Times are approximate. More... | |
| KAPI i32 | platform_get_processor_count (void) |
| Obtains the number of logical processor cores. More... | |
| KAPI void | platform_get_handle_info (u64 *out_size, void *memory) |
| Obtains the required memory amount for platform-specific handle data, and optionally obtains a copy of that data. Call twice, once with memory=0 to obtain size, then a second time where memory = allocated block. More... | |
| KAPI f32 | platform_device_pixel_ratio (const struct kwindow *window) |
| Returns the device pixel ratio of the supplied window. More... | |
| KAPI b8 | platform_dynamic_library_load (const char *name, dynamic_library *out_library) |
| Loads a dynamic library. More... | |
| KAPI b8 | platform_dynamic_library_unload (dynamic_library *library) |
| Unloads the given dynamic library. More... | |
| KAPI void * | platform_dynamic_library_load_function (const char *name, dynamic_library *library) |
| Loads an exported function of the given name from the provided loaded library. More... | |
| KAPI const char * | platform_dynamic_library_extension (void) |
| Returns the file extension for the current platform. More... | |
| KAPI const char * | platform_dynamic_library_prefix (void) |
| Returns a file prefix for libraries for the current platform. More... | |
| KAPI platform_error_code | platform_copy_file (const char *source, const char *dest, b8 overwrite_if_exists) |
| Copies file at source to destination, optionally overwriting. More... | |
| KAPI void | platform_register_window_closed_callback (platform_window_closed_callback callback) |
| Registers the system-level handler for a window being closed. More... | |
| KAPI void | platform_register_window_resized_callback (platform_window_resized_callback callback) |
| Registers the system-level handler for a window being resized. More... | |
| KAPI void | platform_register_process_key (platform_process_key callback) |
| Registers the system-level handler for a keyboard key being pressed. More... | |
| KAPI void | platform_register_process_mouse_button_callback (platform_process_mouse_button callback) |
| Registers the system-level handler for a mouse button being pressed. More... | |
| KAPI void | platform_register_process_mouse_move_callback (platform_process_mouse_move callback) |
| Registers the system-level handler for a mouse being moved. More... | |
| KAPI void | platform_register_process_mouse_wheel_callback (platform_process_mouse_wheel callback) |
| Registers the system-level handler for a mouse wheel being scrolled. More... | |
| KAPI void | platform_register_clipboard_paste_callback (platform_clipboard_on_paste_callback callback) |
| Registers the system-level handler for content being ready to paste from the clipboard. More... | |
| KAPI b8 | platform_watch_file (const char *file_path, b8 is_binary, platform_filewatcher_file_written_callback watcher_written_callback, void *watcher_written_context, platform_filewatcher_file_deleted_callback watcher_deleted_callback, void *watcher_deleted_context, u32 *out_watch_id) |
| Watch a file at the given path. More... | |
| KAPI b8 | platform_unwatch_file (u32 watch_id) |
| Stops watching the file with the given watch identifier. More... | |
| KAPI kunix_time_ns | platform_get_file_mtime (const char *path) |
| Returns the last-modified timestamp in unix time, or 0 if the file is not found. More... | |
| KAPI b8 | platform_system_info_collect (ksystem_info *out_info) |
| KAPI void | platform_request_clipboard_content (kwindow *window) |
| KAPI void | platform_clipboard_content_set (kwindow *window, kclipboard_content_type type, u32 size, void *content) |
This file contains the platform layer, or at least the interface to it. Each platform should provide its own implementation of this in a .c file, and should be compiled exclusively of the rest.
| #define KMAX_PATH_LEN 256 |
| #define KMAX_STORAGE_DEVICES 32 |
| typedef struct dynamic_library dynamic_library |
| typedef struct dynamic_library_function dynamic_library_function |
| typedef enum kclipboard_content_type kclipboard_content_type |
| typedef struct kclipboard_context kclipboard_context |
| typedef u32 kcpu_feature_flag_bits |
| typedef enum kcpu_feature_flags kcpu_feature_flags |
| typedef enum kdrive_type kdrive_type |
| typedef struct kstorage_info kstorage_info |
| typedef struct ksystem_info ksystem_info |
| typedef u32 ksystem_info_flag_bits |
| typedef enum ksystem_info_flags ksystem_info_flags |
| typedef u64 kunix_time_ns |
| typedef struct kwindow_config kwindow_config |
A configuration structure used to create new windows.
| typedef void(* platform_clipboard_on_paste_callback) (kclipboard_context context) |
| typedef enum platform_error_code platform_error_code |
| typedef void(* platform_filewatcher_file_deleted_callback) (u32 watcher_id, void *context) |
| typedef void(* platform_filewatcher_file_written_callback) (u32 watcher_id, const char *file_path, b8 is_binary, void *context) |
| typedef void(* platform_process_mouse_button) (mouse_buttons button, b8 pressed) |
| typedef void(* platform_process_mouse_wheel) (i8 z_delta) |
| typedef struct platform_system_config platform_system_config |
| typedef void(* platform_window_closed_callback) (const struct kwindow *window) |
| typedef void(* platform_window_resized_callback) (const struct kwindow *window) |
| enum kcpu_feature_flags |
| enum kdrive_type |
| enum ksystem_info_flags |
| enum platform_error_code |
| KINLINE const char* kdrive_type_to_string | ( | kdrive_type | type | ) |
Performs platform-specific memory allocation of the given size.
| size | The size of the allocation in bytes. |
| aligned | Indicates if the allocation should be aligned. |
| KAPI void platform_clipboard_content_set | ( | kwindow * | window, |
| kclipboard_content_type | type, | ||
| u32 | size, | ||
| void * | content | ||
| ) |
| KAPI void platform_console_write | ( | struct platform_state * | platform, |
| log_level | level, | ||
| const char * | message | ||
| ) |
Performs platform-specific printing to the console of the given message and log level.
| platform | A pointer to the platform state. |
| message | The message to be printed. |
| colour | The colour to print the text in (if supported). |
| KAPI platform_error_code platform_copy_file | ( | const char * | source, |
| const char * | dest, | ||
| b8 | overwrite_if_exists | ||
| ) |
Copies file at source to destination, optionally overwriting.
| source | The source file path. |
| dest | The destination file path. |
| overwrite_if_exists | Indicates if the file should be overwritten if it exists. |
Copies the bytes of memory in source to dest, of the given size.
| dest | The destination memory block. |
| source | The source memory block. |
| size | The size of data to be copied. |
Returns the device pixel ratio of the supplied window.
| window | A constant pointer to the window to retrieve device pixel ratio for. |
| KAPI const char* platform_dynamic_library_extension | ( | void | ) |
Returns the file extension for the current platform.
| KAPI b8 platform_dynamic_library_load | ( | const char * | name, |
| dynamic_library * | out_library | ||
| ) |
Loads a dynamic library.
| name | The name of the library file, excluding the extension. Required. |
| out_library | A pointer to hold the loaded library. Required. |
| KAPI void* platform_dynamic_library_load_function | ( | const char * | name, |
| dynamic_library * | library | ||
| ) |
Loads an exported function of the given name from the provided loaded library.
| name | The function name to be loaded. |
| library | A pointer to the library to load the function from. |
| KAPI const char* platform_dynamic_library_prefix | ( | void | ) |
Returns a file prefix for libraries for the current platform.
| KAPI b8 platform_dynamic_library_unload | ( | dynamic_library * | library | ) |
Unloads the given dynamic library.
| library | A pointer to the loaded library. Required. |
Frees the given block of memory.
| block | The block to be freed. |
| aligned | Indicates if the block of memory is aligned. |
Gets the absolute time since the application started.
| KAPI kunix_time_ns platform_get_file_mtime | ( | const char * | path | ) |
Returns the last-modified timestamp in unix time, or 0 if the file is not found.
Obtains the required memory amount for platform-specific handle data, and optionally obtains a copy of that data. Call twice, once with memory=0 to obtain size, then a second time where memory = allocated block.
| out_size | A pointer to hold the memory requirement. |
| memory | Allocated block of memory. |
Obtains the number of logical processor cores.
Performs any platform-specific message pumping that is required for windowing, etc.
| KAPI void platform_register_clipboard_paste_callback | ( | platform_clipboard_on_paste_callback | callback | ) |
Registers the system-level handler for content being ready to paste from the clipboard.
| callback | A pointer to the handler function. |
| KAPI void platform_register_process_key | ( | platform_process_key | callback | ) |
Registers the system-level handler for a keyboard key being pressed.
| callback | A pointer to the handler function. |
| KAPI void platform_register_process_mouse_button_callback | ( | platform_process_mouse_button | callback | ) |
Registers the system-level handler for a mouse button being pressed.
| callback | A pointer to the handler function. |
| KAPI void platform_register_process_mouse_move_callback | ( | platform_process_mouse_move | callback | ) |
Registers the system-level handler for a mouse being moved.
| callback | A pointer to the handler function. |
| KAPI void platform_register_process_mouse_wheel_callback | ( | platform_process_mouse_wheel | callback | ) |
Registers the system-level handler for a mouse wheel being scrolled.
| callback | A pointer to the handler function. |
| KAPI void platform_register_window_closed_callback | ( | platform_window_closed_callback | callback | ) |
Registers the system-level handler for a window being closed.
| callback | A pointer to the handler function. |
| KAPI void platform_register_window_resized_callback | ( | platform_window_resized_callback | callback | ) |
Registers the system-level handler for a window being resized.
| callback | A pointer to the handler function. |
Sets the bytes of memory to the given value.
| dest | The destination block of memory. |
| value | The value to be set. |
| size | The size of data to set. |
Sleep on the thread for the provided milliseconds. This blocks the main thread. Should only be used for giving time back to the OS for unused update power. Therefore it is not exported. Times are approximate.
| ms | The number of milliseconds to sleep for. |
| KAPI b8 platform_system_info_collect | ( | ksystem_info * | out_info | ) |
| KAPI void platform_system_shutdown | ( | struct platform_state * | state | ) |
Shuts down the platform layer.
| state | A pointer to the platform layer state. |
| KAPI b8 platform_system_startup | ( | u64 * | memory_requirement, |
| struct platform_state * | state, | ||
| platform_system_config * | config | ||
| ) |
Performs startup routines within the platform layer. Should be called twice, once to obtain the memory requirement (with state=0), then a second time passing an allocated block of memory to state.
| memory_requirement | A pointer to hold the memory requirement in bytes. |
| state | A pointer to a block of memory to hold state. If obtaining memory requirement only, pass 0. |
| config | A pointer to a configuration platform_system_config structure required by this system. |
Stops watching the file with the given watch identifier.
| watch_id | The watch identifier |
| KAPI b8 platform_watch_file | ( | const char * | file_path, |
| b8 | is_binary, | ||
| platform_filewatcher_file_written_callback | watcher_written_callback, | ||
| void * | watcher_written_context, | ||
| platform_filewatcher_file_deleted_callback | watcher_deleted_callback, | ||
| void * | watcher_deleted_context, | ||
| u32 * | out_watch_id | ||
| ) |
Watch a file at the given path.
| file_path | The file path. Required. |
| is_binary | Indicates if the file being watched is binary (if not, then text). |
| watcher_written_callback | Callback to be invoked when the watched file is written to. |
| watcher_written_context | Context to be passed along when a file write occurs. |
| watcher_deleted_callback | Callback to be invoked when the watched file is deleted from disk. |
| watcher_deleted_context | Context to be passed along when a file deletion occurs. |
| out_watch_id | A pointer to hold the watch identifier. |
| KAPI b8 platform_window_create | ( | const kwindow_config * | config, |
| struct kwindow * | window, | ||
| b8 | show_immediately | ||
| ) |
Creates a new window from the given config and optionally opens it immediately.
| config | A constant pointer to the configuration to be used for creating the window. |
| window | A pointer to hold the newly-created window. |
| show_immediately | Indicates whether the window should open immediately upon creation. |
Destroys the given window.
| window | A pointer to the window to be destroyed. |
Hides the given window. Has no effect if the window is already hidden. Note that this does not destroy the window.
| window | A pointer to the window to be hidden. |
Shows the given window. Has no effect if the window is already shown.
| window | A pointer to the window to be shown. |
Obtains the window title from the given window, if it exists. NOTE: Returns a constant copy of the string, which must be freed by the caller.
| window | A pointer to the window whose title to get. |
Sets the given window's title, if it exists.
| window | A pointer to the window whose title is to be set. |
| title | The title to be set. |
1.9.1