me.fier.engine/modules/engine/FUNCTIONS.toml

96 lines
2.5 KiB
TOML
Raw Normal View History

# MEMORY
[engine_malloc]
type = "void *"
arguments = ["void *","size_t"]
2023-05-14 19:59:24 +00:00
argNames = ["ptr","size"]
description = "Allocate memory, equivalent to C's realloc(), with the difference that it quits on failure."
[engine_free]
type = "void"
arguments = ["void *"]
2023-05-14 19:59:24 +00:00
argNames = ["ptr"]
description = "Allocate memory, equivalent to C's free()."
# WINDOW
[engine_window_init]
type = "void"
arguments = ["int","int","char *"]
2023-05-14 19:59:24 +00:00
argNames = ["width","height","title]
description = "Creates a window."
[engine_window_present]
type = "void"
arguments = []
2023-05-14 19:59:24 +00:00
argNames = []
description = "Updates the window's surface."
# SURFACE
[engine_surface_color_set]
type = "void"
arguments = ["char","char","char","char"]
2023-05-14 19:59:24 +00:00
argNames = ["r","g","b","a"]
description = "Set the color that will be drawn to the window surface."
[engine_surface_draw_pixel]
type = "void"
arguments = ["int","int"]
2023-05-14 19:59:24 +00:00
argNames = ["x","y"]
description = "Draw a pixel to the window surface."
# TIME
[engine_time_get]
type = "long long"
arguments = []
2023-05-14 19:59:24 +00:00
argNames = []
description = "Get the time passed since program start in milliseconds."
[engine_time_sleep]
type = "void"
arguments = ["long long"]
2023-05-14 19:59:24 +00:00
argNames = ["ms"]
description = "Halt the program for some amount of time."
# LOGIC
[engine_event_get]
type = "struct ENGINE_EVENT *"
arguments = []
2023-05-14 19:59:24 +00:00
argNames = []
description = "Get an event. If the type is ENGINE_EVENT_TYPE_NONE, there are no more events. Needs to be freed with engine_free()."
# TEXTURES
[engine_texture_create]
type = "struct ENGINE_TEXTURE *"
arguments = ["int","int"]
2023-05-14 19:59:24 +00:00
argNames = ["width","height"]
description = "Creates a texture. Needs to be freed when no longer needed with engine_texture_destroy()."
[engine_texture_color_set]
type = "void"
arguments = ["char","char","char","char"]
2023-05-14 19:59:24 +00:00
argNames = ["r","g","b","a"]
description = "Set the color that will be drawn to the texture."
[engine_texture_draw_pixel]
type = "void"
arguments = ["struct ENGINE_TEXTURE *","int","int"]
2023-05-14 19:59:24 +00:00
argNames = ["texture","x","y"]
description = "Draw a pixel to the texture."
[engine_texture_destroy]
type = "void"
arguments = ["struct ENGINE_TEXTURE *"]
2023-05-14 19:59:24 +00:00
argNames = ["texture"]
description = "Destroy a texture, freeing up memory."
[engine_texture_render_2d]
type = "void"
arguments = ["struct ENGINE_TEXTURE *","int","int"]
2023-05-14 19:59:24 +00:00
argNames = ["texture","sx","sy"]
description = "Render texture to the window surface."
[engine_texture_from_file]
type = "void"
arguments = ["struct ENGINE_TEXTURE *","char *"]
2023-05-14 19:59:24 +00:00
argNames = ["texture","fpath"]
description = "Read a raw RGBA image file into a texture."