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