Merge branch 'master' of https://github.com/RandyGaul/cute_framework

Author: RandyGaul

include/cute_alloc.h

@@ -210,7 +210,7 @@ CF_API void CF_CALL cf_arena_reset(CF_Arena* arena);
 /**
  * @function cf_destroy_arena
  * @category allocator
- * @brief    Free's up all resources used by the allocator.
+ * @brief    Frees up all resources used by the allocator.
  * @param    arena         The arena to free.
  * @related  cf_arena_init cf_arena_alloc cf_arena_reset cf_arena_free
  */

include/cute_app.h

@@ -61,7 +61,7 @@ CF_API CF_DisplayID CF_CALL cf_default_display(void);
  * @function cf_display_count
  * @category app
  * @brief    Returns the number of displays on the system.
- * @remarks  Inidices >= 0 and < the return value are valid display indices.
+ * @remarks  Indices >= 0 and < the return value are valid display indices.
  * @related  cf_make_app cf_display_count cf_display_x cf_display_y cf_display_width cf_display_height cf_display_refresh_rate cf_display_bounds cf_display_name cf_display_orientation
  */
 CF_API int CF_CALL cf_display_count(void);
@@ -605,7 +605,7 @@ CF_API void* CF_CALL cf_app_init_imgui(void);
  * @enum     CF_MSAA
  * @category app
  * @brief    Multisample count used for MSAA for the app's offscreen canvas.
- * @remarks  This function turns on .
+ * @remarks  This function turns on MSAA.
  * @related  cf_app_set_msaa cf_msaa_string
  */
 #define CF_MSAA_DEFS \
@@ -749,7 +749,7 @@ CF_API void CF_CALL cf_app_set_fullscreen_mode(void);
 /**
  * @function cf_app_set_title
  * @category app
- * @brief    Sets the application' true fullscreen mode's title.
+ * @brief    Sets the application's true fullscreen mode's title.
  * @related  cf_app_set_windowed_mode cf_app_set_borderless_fullscreen_mode cf_app_set_fullscreen_mode cf_app_set_title cf_app_set_icon
  */
 CF_API void CF_CALL cf_app_set_title(const char* title);
@@ -775,7 +775,7 @@ CF_API float CF_CALL cf_app_get_framerate(void);
 /**
  * @function cf_app_get_smoothed_framerate
  * @category app
- * @brief    Returns the smoothed framerate of the application. Last 60 frames are averaged. This values is controlled by `CF_FRAMERATE_SMOOTHING`.
+ * @brief    Returns the smoothed framerate of the application. Last 60 frames are averaged. This value is controlled by `CF_FRAMERATE_SMOOTHING`.
  * @related  cf_app_get_framerate cf_app_get_smoothed_framerate
  */
 CF_API float CF_CALL cf_app_get_smoothed_framerate(void);

include/cute_array.h

@@ -47,7 +47,7 @@
  *     alen(a)--;
  *     CF_ASSERT(alen(a) == 0);
  *     afree(a);
- * @remarks  `a` must not by `NULL`. This function returns a proper l-value, so you can assign to it, i.e. increment/decrement can be quite useful.
+ * @remarks  `a` must not be `NULL`. This function returns a proper l-value, so you can assign to it, i.e. increment/decrement can be quite useful.
  * @related  dyna asize acount acap afit apush apop aend alast aclear aset arev ahash adel astatic afree
  */
 #define alen(a) cf_array_len(a)

include/cute_audio.h

@@ -312,7 +312,7 @@ typedef struct CF_SoundParams
 	/* @member Default: 1.0f. Lower numbers lower the pitch and increase playback speed. Higher numbers increase the pitch and reduce playback speed. */
 	float pitch;
 
-	/* @member Default: 0. Specify the sample to start playing at. In term of seconds this would be the `cf_audio_sample_rate` * seconds. */
+	/* @member Default: 0. Specify the sample to start playing at. In terms of seconds this would be the `cf_audio_sample_rate` * seconds. */
 	int sample_index;
 } CF_SoundParams;
 // @end
@@ -362,7 +362,7 @@ CF_API void CF_CALL cf_sound_set_on_finish_callback(void (*on_finished)(CF_Sound
  * @category audio
  * @brief    Returns whether or not a sound is active.
  * @param    sound          The sound.
- * @return   Rreturns true if the sound is active, or false if it finished playing (and was not looped).
+ * @return   Returns true if the sound is active, or false if it finished playing (and was not looped).
  * @related  CF_SoundParams CF_Sound cf_sound_params_defaults cf_play_sound cf_sound_is_active cf_sound_get_is_paused cf_sound_get_is_looped cf_sound_get_volume cf_sound_get_sample_index cf_sound_set_sample_index cf_sound_set_is_paused cf_sound_set_is_looped cf_sound_set_volume cf_sound_stop cf_sound_set_pitch cf_sound_get_pitch
  */
 CF_API bool CF_CALL cf_sound_is_active(CF_Sound sound);

include/cute_base64.h

@@ -38,7 +38,7 @@ extern "C" {
  * @category base64
  * @brief    Calculates the size of data after base64 decoding it.
  * @param    size         The size of base64 encoded data.
- * @return   Returns the number of bytes the raw dencoded data will take up. This will deflate the size ~33%.
+ * @return   Returns the number of bytes the raw decoded data will take up. This will deflate the size ~33%.
  * @remarks  Use this for the `dst_size` in `cf_base64_decode`.
  *           Base64 encoding is useful for storing data as text in a copy-paste-safe manner. For more information about
  *           base64 encoding see this link: [RFC-4648](https://tools.ietf.org/html/rfc4648) or [Wikipedia Base64](https://en.wikipedia.org/wiki/Base64).

include/cute_color.h

@@ -203,7 +203,7 @@ CF_INLINE CF_Pixel cf_make_pixel_rgba(uint8_t r, uint8_t g, uint8_t b, uint8_t a
  * @param    hex        An integer value, e.g. 0xFFAACC11.
  * @related  CF_Pixel cf_make_pixel_rgb_f cf_make_pixel_rgba_f cf_make_pixel_rgb cf_make_pixel_rgba cf_make_pixel_hex cf_make_pixel_hex_string
  */
-CF_INLINE CF_Pixel cf_make_pixel_hex(int hex) { return cf_make_pixel_rgba((uint8_t)((hex & 0xFF000000) >> 24), (uint8_t)((hex & 0x00FF0000) >> 16), (uint8_t)((hex & 0x0000FF00) >> 8), (uint8_t)(hex & 0x000000FF)); }
+CF_INLINE CF_Pixel cf_make_pixel_hex(int hex) { unsigned int h = (unsigned int)hex; return cf_make_pixel_rgba((uint8_t)((h & 0xFF000000) >> 24), (uint8_t)((h & 0x00FF0000) >> 16), (uint8_t)((h & 0x0000FF00) >> 8), (uint8_t)(h & 0x000000FF)); }
 
 /**
  * @function cf_make_pixel_hex_string
@@ -618,7 +618,7 @@ CF_INLINE char* cf_pixel_to_string(CF_Pixel p) { char* s = NULL; return shex(s,
  * @param    c          The color.
  * @related  cf_color_to_pixel cf_color_to_int_rgb cf_color_to_int_rgba cf_color_to_string
  */
-CF_INLINE CF_Pixel cf_color_to_pixel(CF_Color c) { CF_Pixel p; p.colors.r = (int)((uint8_t)(c.r * 255.0f)); p.colors.g = (int)((uint8_t)(c.g * 255.0f)); p.colors.b = (int)((uint8_t)(c.b * 255.0f)); p.colors.a = (int)((uint8_t)(c.a * 255.0f)); return p; }
+CF_INLINE CF_Pixel cf_color_to_pixel(CF_Color c) { CF_Pixel p; p.colors.r = (uint8_t)(c.r * 255.0f); p.colors.g = (uint8_t)(c.g * 255.0f); p.colors.b = (uint8_t)(c.b * 255.0f); p.colors.a = (uint8_t)(c.a * 255.0f); return p; }
 
 /**
  * @function cf_color_to_int_rgb
@@ -791,7 +791,7 @@ CF_INLINE CF_Pixel cf_pixel_black(void) { return cf_make_pixel_rgb(0, 0, 0); }
 /**
  * @function cf_pixel_white
  * @category graphics
- * @brief    Helper function to return a invisible `white`.
+ * @brief    Helper function to return a white `CF_Pixel`.
  * @related  cf_pixel_invisible cf_pixel_black cf_pixel_white cf_pixel_red cf_pixel_green cf_pixel_blue cf_pixel_yellow cf_pixel_orange cf_pixel_purple cf_pixel_grey cf_pixel_cyan cf_pixel_magenta
  */
 CF_INLINE CF_Pixel cf_pixel_white(void) { return cf_make_pixel_rgb(255, 255, 255); }
@@ -925,8 +925,8 @@ CF_INLINE float softlight(float base, float blend) { return cf_softlight(base, b
 CF_INLINE CF_Color overlay(CF_Color base, CF_Color blend) { return cf_overlay_color(base, blend); }
 CF_INLINE CF_Color softlight(CF_Color base, CF_Color blend) { return cf_softlight_color(base, blend); }
 
-CF_INLINE CF_Pixel operator*(CF_Pixel a, int s) { return cf_mul_pixel(a, s); }
-CF_INLINE CF_Pixel operator/(CF_Pixel a, int s) { return cf_div_pixel(a, s); }
+CF_INLINE CF_Pixel operator*(CF_Pixel a, int s) { return cf_mul_pixel(a, (uint8_t)s); }
+CF_INLINE CF_Pixel operator/(CF_Pixel a, int s) { return cf_div_pixel(a, (uint8_t)s); }
 CF_INLINE CF_Pixel operator+(CF_Pixel a, CF_Pixel b) { return cf_add_pixel(a, b); }
 CF_INLINE CF_Pixel operator-(CF_Pixel a, CF_Pixel b) { return cf_sub_pixel(a, b); }
 CF_INLINE bool operator==(CF_Pixel a, CF_Pixel b) { return a.val == b.val; }

include/cute_coroutine.h

@@ -62,7 +62,7 @@ CF_API CF_Coroutine CF_CALL cf_make_coroutine(CF_CoroutineFn* fn, int stack_size
  * @category coroutine
  * @brief    Destroys a coroutine created by `cf_make_coroutine`.
  * @param    co            The coroutine.
- * @remarks  All objects on the coroutine's stack will get automically cleaned up.
+ * @remarks  All objects on the coroutine's stack will get automatically cleaned up.
  * @related  CF_Coroutine CF_CoroutineFn CF_CoroutineState cf_make_coroutine cf_destroy_coroutine cf_coroutine_state_to_string cf_coroutine_resume cf_coroutine_yield cf_coroutine_state cf_coroutine_get_udata cf_coroutine_push cf_coroutine_pop cf_coroutine_bytes_pushed cf_coroutine_space_remaining cf_coroutine_currently_running
  */
 CF_API void CF_CALL cf_destroy_coroutine(CF_Coroutine co);
@@ -205,7 +205,7 @@ CF_API size_t CF_CALL cf_coroutine_space_remaining(CF_Coroutine co);
  * @function cf_coroutine_currently_running
  * @category coroutine
  * @brief    Returns the opaque pointer to the coroutine currently running.
- * @remarks  Each coroutine has ther `co` pointer handed to them as the only parameter in `CF_CoroutineFn`, so you likely
+ * @remarks  Each coroutine has their `co` pointer handed to them as the only parameter in `CF_CoroutineFn`, so you likely
  *           already have access to the coroutine pointer. However, this function is made available here for convenience.
  *           For example, your coroutines may call into other functions -- instead of passing around a `co` pointer everywhere,
  *           your helper functions can simply fetch the `CF_Coroutine` pointer themselves on an as-needed basis by calling

include/cute_draw.h

@@ -377,7 +377,7 @@ CF_API void CF_CALL cf_draw_bezier_line2(CF_V2 a, CF_V2 c0, CF_V2 c1, CF_V2 b, i
  * @param    b            The end point.
  * @param    thickness    The thickness of the line to draw.
  * @param    arrow_width  The width of the arrow to draw.
- * @remarks  This function is intended only for debug purposes. It's implemented in naive way so the
+ * @remarks  This function is intended only for debug purposes. It's implemented in a naive way so the
  *           arrow shaft will overdraw atop the arrow head. This will become visible if the arrow is
  *           drawn with any transparency.
  * @related  cf_draw_line cf_draw_polyline cf_draw_bezier_line cf_draw_bezier_line2 cf_draw_arrow
@@ -676,8 +676,8 @@ typedef struct CF_Vertex
  *
  *           Call `cf_set_vertex_callback` to setup your callback.
  *
- *           There is no adjecancy info provided. If you need to know which triangles connect to others you
- *           should probably redesign your feature to not require adjecancy information, or use your own custom
+ *           There is no adjacency info provided. If you need to know which triangles connect to others you
+ *           should probably redesign your feature to not require adjacency information, or use your own custom
  *           rendering solution. With a custom solution you may use low-level graphics in cute_graphics.h, where
  *           any adjacency info can be controlled 100% by you a-priori.
  * @related  CF_Vertex CF_VertexFn cf_set_vertex_callback
@@ -1091,7 +1091,7 @@ typedef bool (CF_TextEffectFn)(CF_TextEffect* fx);
  *           When registering a custom text effect, any parameters in the string will be stored for you
  *           automatically. You only need to fetch them with the appropriate cf_text_effect_get*** function.
  *           Note: You can also setup parameters for markup as strings, not just numbers/colors. Example: `<color=#2c5ee8 metadata=\"Just some string.\">blue text</color>`,
- *           where the `color` markup contains a parameter called `metadata` and a strinf value of `"Just some string."`.
+ *           where the `color` markup contains a parameter called `metadata` and a string value of `"Just some string."`.
  * @related  CF_TextEffect CF_TextEffectFn cf_text_effect_register cf_text_effect_get_number cf_text_effect_get_color cf_text_effect_get_string
  */
 CF_API void CF_CALL cf_text_effect_register(const char* name, CF_TextEffectFn* fn);
@@ -1155,7 +1155,7 @@ typedef struct CF_MarkupInfo
 	/* @member The number of `CF_Aabb`'s in `bounds`. */
 	int bounds_count;
 
-	/* @member An arry of `CF_Aabb`'s, one per line the `text` string provided in the `cf_text_markup_info_fn` callback. */
+	/* @member An array of `CF_Aabb`'s, one per line the `text` string provided in the `cf_text_markup_info_fn` callback. */
 	CF_Aabb* bounds;
 } CF_MarkupInfo;
 // @end
@@ -1307,7 +1307,7 @@ CF_API CF_RenderState CF_CALL cf_draw_peek_render_state(void);
  *           can likely get away with 4096 on most devices. Larger internal atlases can be useful to decrease the number of
  *           draw calls used, and also enables support for high-res image rendering.
  *
- *           Please not you should put in power of 2 atlases sizes to make the hardware happy. Here are the recommended range
+ *           Please note you should put in power of 2 atlases sizes to make the hardware happy. Here are the recommended range
  *           of sizes available:
  *
  *           - 256

include/cute_file_system.h

@@ -33,7 +33,7 @@ extern "C" {
  *     const char* filename = spfname("/data/collections/rare/big_gem.txt");
  *     printf("%s\n", filename);
  *     // Prints: big_gem.txt
- * @remarks  Call `sfree` on the return value when done. `sp` stands for "sting path".
+ * @remarks  Call `sfree` on the return value when done. `sp` stands for "string path".
  * @related  spfname spfname_no_ext spext spext_equ sppop sppopn spcompact spdir_of sptop_of spnorm
  */
 #define spfname(s) cf_path_get_filename(s)
@@ -47,7 +47,7 @@ extern "C" {
  *     const char* filename = spfname("/data/collections/rare/big_gem.txt");
  *     printf("%s\n", filename);
  *     // Prints: big_gem
- * @remarks  Call `sfree` on the return value when done. `sp` stands for "sting path".
+ * @remarks  Call `sfree` on the return value when done. `sp` stands for "string path".
  * @related  spfname spfname_no_ext spext spext_equ sppop sppopn spcompact spdir_of sptop_of spnorm
  */
 #define spfname_no_ext(s) cf_path_get_filename_no_ext(s)
@@ -61,7 +61,7 @@ extern "C" {
  *     const char* ext = spfname("/data/collections/rare/big_gem.txt");
  *     printf("%s\n", ext);
  *     // Prints: .txt
- * @remarks  Call `sfree` on the return value when done. `sp` stands for "sting path".
+ * @remarks  Call `sfree` on the return value when done. `sp` stands for "string path".
  * @related  spfname spfname_no_ext spext spext_equ sppop sppopn spcompact spdir_of sptop_of spnorm
  */
 #define spext(s) cf_path_get_ext(s)
@@ -72,7 +72,7 @@ extern "C" {
  * @brief    Returns true if the file's extension matches, false otherwise.
  * @param    s          The path string.
  * @param    ext        The file extension.
- * @remarks  `sp` stands for "sting path".
+ * @remarks  `sp` stands for "string path".
  * @related  spfname spfname_no_ext spext spext_equ sppop sppopn spcompact spdir_of sptop_of spnorm
  */
 #define spext_equ(s, ext) cf_path_ext_equ(s, ext)
@@ -84,7 +84,7 @@ extern "C" {
  * @param    s          The path string.
  * @return   If the string is not a dynamic string from CF's string API, a new string is returned. Otherwise the
  *           string is modified in-place. You must call `sfree` if a new dynamic string is returned, when done.
- * @remarks  `sp` stands for "sting path".
+ * @remarks  `sp` stands for "string path".
  * @related  spfname spfname_no_ext spext spext_equ sppop sppopn spcompact spdir_of sptop_of spnorm
  */
 #define sppop(s) cf_path_pop(s)
@@ -97,7 +97,7 @@ extern "C" {
  * @param    n          The number of files to pop from the directory path.
  * @return   If the string is not a dynamic string from CF's string API, a new string is returned. Otherwise the
  *           string is modified in-place. You must call `sfree` if a new dynamic string is returned, when done.
- * @remarks  `sp` stands for "sting path".
+ * @remarks  `sp` stands for "string path".
  * @related  spfname spfname_no_ext spext spext_equ sppop sppopn spcompact spdir_of sptop_of spnorm
  */
 #define sppopn(s, n) cf_path_pop_n(s, n)
@@ -125,7 +125,7 @@ extern "C" {
  *     const char* filename = spfname("/data/collections/rare/big_gem.txt");
  *     printf("%s\n", filename);
  *     // Prints: /rare
- * @remarks  `sp` stands for "sting path". Call `sfree` on the return value when done.
+ * @remarks  `sp` stands for "string path". Call `sfree` on the return value when done.
  * @related  spfname spfname_no_ext spext spext_equ sppop sppopn spcompact spdir_of sptop_of spnorm
  */
 #define spdir_of(s) cf_path_directory_of(s)
@@ -139,7 +139,7 @@ extern "C" {
  *     const char* filename = spfname("/data/collections/rare/big_gem.txt");
  *     printf("%s\n", filename);
  *     // Prints: /data
- * @remarks  `sp` stands for "sting path". Call `sfree` on the return value when done.
+ * @remarks  `sp` stands for "string path". Call `sfree` on the return value when done.
  * @related  spfname spfname_no_ext spext spext_equ sppop sppopn spcompact spdir_of sptop_of spnorm
  */
 #define sptop_of(s) cf_path_top_directory(s)
@@ -263,7 +263,7 @@ typedef struct CF_File CF_File;
  * @related  CF_File CF_Stat cf_file_type_to_string
  */
 #define CF_FILE_TYPE_DEFS \
-	/* @entry A reguler file, such as a .txt or .pdf file. */ \
+	/* @entry A regular file, such as a .txt or .pdf file. */ \
 	CF_ENUM(FILE_TYPE_REGULAR, 0)                             \
 	/* @entry A directory/folder. */                          \
 	CF_ENUM(FILE_TYPE_DIRECTORY, 1)                           \
@@ -338,7 +338,7 @@ CF_API const char* CF_CALL cf_fs_get_base_directory(void);
  * @function cf_fs_get_working_directory
  * @category file
  * @brief    Returns the current working directory in platform-dependent notation.
- * @remarks  Not all platforms have the concept of a working directory, but this function will sill try to return something sane in these cases.
+ * @remarks  Not all platforms have the concept of a working directory, but this function will still try to return something sane in these cases.
  * @related  cf_fs_get_base_directory cf_fs_set_write_directory cf_fs_get_user_directory cf_fs_mount cf_fs_dismount cf_fs_get_working_directory
  */
 CF_API const char* CF_CALL cf_fs_get_working_directory(void);
@@ -395,7 +395,7 @@ CF_API const char* CF_CALL cf_fs_get_user_directory(const char* company_name, co
  *           modding or download patches, as duplicate entries will be searched for on the path as normal,
  *           without the need to overwrite each other on the actual disk.
  *           
- *           You can mount an actual directory or an archive file. If it's an archive the vitrual file
+ *           You can mount an actual directory or an archive file. If it's an archive the virtual file
  *           system will treat it like a normal directory for you. There are a variety of archive file
  *           formats supported (see top of file).
  *