v1.0

RandyGaul · Jul 7, 2024 · bb455a7 · bb455a7
1 parent 8a1ac22
commit bb455a7
Show file tree

Hide file tree

Showing 67 changed files with 772 additions and 1,062 deletions.
diff --git a/docs/api_reference.md b/docs/api_reference.md
@@ -321,7 +321,6 @@ This is a list of all functions in Cute Framework organized by categories. This
 ## draw
 
 ### functions
-- [cf_draw_arc](/draw/cf_draw_arc.md)
 - [cf_draw_arrow](/draw/cf_draw_arrow.md)
 - [cf_draw_bezier_line](/draw/cf_draw_bezier_line.md)
 - [cf_draw_bezier_line2](/draw/cf_draw_bezier_line2.md)

diff --git a/docs/draw/cf_draw_arc.md b/docs/draw/cf_draw_arc.md
diff --git a/docs/draw/cf_draw_circle.md b/docs/draw/cf_draw_circle.md
@@ -22,7 +22,6 @@ thickness | The thickness of each line to draw.
 
 ## Related Pages
 
-[cf_draw_arc](/draw/cf_draw_arc.md)  
+[cf_draw_circle_fill2](/draw/cf_draw_circle_fill2.md)  
 [cf_draw_circle2](/draw/cf_draw_circle2.md)  
 [cf_draw_circle_fill](/draw/cf_draw_circle_fill.md)  
-[cf_draw_circle_fill2](/draw/cf_draw_circle_fill2.md)  
diff --git a/docs/draw/cf_draw_circle2.md b/docs/draw/cf_draw_circle2.md
@@ -24,6 +24,5 @@ thickness | The thickness of each line to draw.
 ## Related Pages
 
 [cf_draw_circle](/draw/cf_draw_circle.md)  
-[cf_draw_arc](/draw/cf_draw_arc.md)  
-[cf_draw_circle_fill](/draw/cf_draw_circle_fill.md)  
 [cf_draw_circle_fill2](/draw/cf_draw_circle_fill2.md)  
+[cf_draw_circle_fill](/draw/cf_draw_circle_fill.md)  
diff --git a/docs/draw/cf_draw_circle_fill.md b/docs/draw/cf_draw_circle_fill.md
@@ -23,5 +23,4 @@ circle | The circle.
 
 [cf_draw_circle](/draw/cf_draw_circle.md)  
 [cf_draw_circle2](/draw/cf_draw_circle2.md)  
-[cf_draw_arc](/draw/cf_draw_arc.md)  
 [cf_draw_circle_fill2](/draw/cf_draw_circle_fill2.md)  
diff --git a/docs/draw/cf_draw_circle_fill2.md b/docs/draw/cf_draw_circle_fill2.md
@@ -25,4 +25,3 @@ r | Radius of the circle.
 [cf_draw_circle](/draw/cf_draw_circle.md)  
 [cf_draw_circle2](/draw/cf_draw_circle2.md)  
 [cf_draw_circle_fill](/draw/cf_draw_circle_fill.md)  
-[cf_draw_arc](/draw/cf_draw_arc.md)  
diff --git a/docs/ecs/cf_component_begin.md b/docs/ecs/cf_component_begin.md
@@ -9,16 +9,20 @@ Category: [ecs](/api_reference?id=ecs)
 GitHub: [cute_ecs.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_ecs.h)  
 ---
 
-TODO
+Beings the defnition of a new component type.
 
 ```cpp
 void cf_component_begin();
 ```
 
 ## Remarks
 
-TODO
+Once [cf_component_end](/ecs/cf_component_end.md) is called you may instantiate components of this type when creating entities.
 
 ## Related Pages
 
-TODO  
+[cf_component_end](/ecs/cf_component_end.md)  
+[cf_component_set_name](/ecs/cf_component_set_name.md)  
+[cf_component_set_size](/ecs/cf_component_set_size.md)  
+[cf_component_set_optional_initializer](/ecs/cf_component_set_optional_initializer.md)  
+[cf_component_set_optional_cleanup](/ecs/cf_component_set_optional_cleanup.md)  
diff --git a/docs/ecs/cf_component_end.md b/docs/ecs/cf_component_end.md
@@ -9,16 +9,16 @@ Category: [ecs](/api_reference?id=ecs)
 GitHub: [cute_ecs.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_ecs.h)  
 ---
 
-TODO
+Completes the definition of this new component type.
 
 ```cpp
 void cf_component_end();
 ```
 
-## Remarks
-
-TODO
-
 ## Related Pages
 
-TODO  
+[cf_component_begin](/ecs/cf_component_begin.md)  
+[cf_component_set_name](/ecs/cf_component_set_name.md)  
+[cf_component_set_size](/ecs/cf_component_set_size.md)  
+[cf_component_set_optional_initializer](/ecs/cf_component_set_optional_initializer.md)  
+[cf_component_set_optional_cleanup](/ecs/cf_component_set_optional_cleanup.md)  
diff --git a/docs/ecs/cf_component_rename.md b/docs/ecs/cf_component_rename.md
@@ -9,16 +9,21 @@ Category: [ecs](/api_reference?id=ecs)
 GitHub: [cute_ecs.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_ecs.h)  
 ---
 
-TODO
+Changes the name of this component type.
 
 ```cpp
 void cf_component_rename(const char* component_name, const char* new_component_name);
 ```
 
 ## Remarks
 
-TODO
+This is useful for implementing certain editors.
 
 ## Related Pages
 
-TODO  
+[cf_component_begin](/ecs/cf_component_begin.md)  
+[cf_component_set_name](/ecs/cf_component_set_name.md)  
+[cf_component_set_size](/ecs/cf_component_set_size.md)  
+[cf_component_set_optional_initializer](/ecs/cf_component_set_optional_initializer.md)  
+[cf_component_set_optional_cleanup](/ecs/cf_component_set_optional_cleanup.md)  
+[cf_component_end](/ecs/cf_component_end.md)  
diff --git a/docs/ecs/cf_component_set_name.md b/docs/ecs/cf_component_set_name.md
@@ -9,16 +9,16 @@ Category: [ecs](/api_reference?id=ecs)
 GitHub: [cute_ecs.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_ecs.h)  
 ---
 
-TODO
+Defines the name of this new component type.
 
 ```cpp
 void cf_component_set_name(const char* name);
 ```
 
-## Remarks
-
-TODO
-
 ## Related Pages
 
-TODO  
+[cf_component_begin](/ecs/cf_component_begin.md)  
+[cf_component_end](/ecs/cf_component_end.md)  
+[cf_component_set_size](/ecs/cf_component_set_size.md)  
+[cf_component_set_optional_initializer](/ecs/cf_component_set_optional_initializer.md)  
+[cf_component_set_optional_cleanup](/ecs/cf_component_set_optional_cleanup.md)  
diff --git a/docs/ecs/cf_component_set_optional_cleanup.md b/docs/ecs/cf_component_set_optional_cleanup.md
@@ -9,16 +9,16 @@ Category: [ecs](/api_reference?id=ecs)
 GitHub: [cute_ecs.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_ecs.h)  
 ---
 
-TODO
+Sets an optional cleanup callback, called whenever a component of this type is free'd.
 
 ```cpp
 void cf_component_set_optional_cleanup(CF_ComponentFn* cleanup, void* udata);
 ```
 
-## Remarks
-
-TODO
-
 ## Related Pages
 
-TODO  
+[cf_component_begin](/ecs/cf_component_begin.md)  
+[cf_component_set_name](/ecs/cf_component_set_name.md)  
+[cf_component_set_size](/ecs/cf_component_set_size.md)  
+[cf_component_set_optional_initializer](/ecs/cf_component_set_optional_initializer.md)  
+[cf_component_end](/ecs/cf_component_end.md)  
diff --git a/docs/ecs/cf_component_set_optional_initializer.md b/docs/ecs/cf_component_set_optional_initializer.md
@@ -9,16 +9,16 @@ Category: [ecs](/api_reference?id=ecs)
 GitHub: [cute_ecs.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_ecs.h)  
 ---
 
-TODO
+Sets an optional initializer callback, called whenever a component of this type is instantiated.
 
 ```cpp
 void cf_component_set_optional_initializer(CF_ComponentFn* initializer, void* udata);
 ```
 
-## Remarks
-
-TODO
-
 ## Related Pages
 
-TODO  
+[cf_component_begin](/ecs/cf_component_begin.md)  
+[cf_component_set_name](/ecs/cf_component_set_name.md)  
+[cf_component_set_size](/ecs/cf_component_set_size.md)  
+[cf_component_end](/ecs/cf_component_end.md)  
+[cf_component_set_optional_cleanup](/ecs/cf_component_set_optional_cleanup.md)  
diff --git a/docs/ecs/cf_component_set_size.md b/docs/ecs/cf_component_set_size.md
@@ -9,16 +9,16 @@ Category: [ecs](/api_reference?id=ecs)
 GitHub: [cute_ecs.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_ecs.h)  
 ---
 
-TODO
+Sets the size in bytes of this new component type.
 
 ```cpp
 void cf_component_set_size(size_t size);
 ```
 
-## Remarks
-
-TODO
-
 ## Related Pages
 
-TODO  
+[cf_component_begin](/ecs/cf_component_begin.md)  
+[cf_component_set_name](/ecs/cf_component_set_name.md)  
+[cf_component_end](/ecs/cf_component_end.md)  
+[cf_component_set_optional_initializer](/ecs/cf_component_set_optional_initializer.md)  
+[cf_component_set_optional_cleanup](/ecs/cf_component_set_optional_cleanup.md)  
diff --git a/docs/ecs/cf_destroy_entity.md b/docs/ecs/cf_destroy_entity.md
@@ -15,10 +15,8 @@ Destroys a specific entity right now.
 void cf_destroy_entity(CF_Entity entity);
 ```
 
-## Remarks
-
-TODO
-
 ## Related Pages
 
-TODO  
+[cf_make_entity](/ecs/cf_make_entity.md)  
+[cf_entity_get_component](/ecs/cf_entity_get_component.md)  
+[cf_entity_has_component](/ecs/cf_entity_has_component.md)  
diff --git a/docs/ecs/cf_destroy_entity_delayed.md b/docs/ecs/cf_destroy_entity_delayed.md
@@ -15,10 +15,9 @@ Marks a specific entity for delayed destruction.
 void cf_destroy_entity_delayed(CF_Entity entity);
 ```
 
-## Remarks
-
-TODO
-
 ## Related Pages
 
-TODO  
+[cf_make_entity](/ecs/cf_make_entity.md)  
+[cf_destroy_entity](/ecs/cf_destroy_entity.md)  
+[cf_entity_has_component](/ecs/cf_entity_has_component.md)  
+[cf_entity_get_component](/ecs/cf_entity_get_component.md)  
diff --git a/docs/ecs/cf_destroy_world.md b/docs/ecs/cf_destroy_world.md
@@ -9,16 +9,17 @@ Category: [ecs](/api_reference?id=ecs)
 GitHub: [cute_ecs.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_ecs.h)  
 ---
 
-TODO
+Destroys the world.
 
 ```cpp
 void cf_destroy_world(CF_World world);
 ```
 
-## Remarks
-
-TODO
-
 ## Related Pages
 
-TODO  
+[CF_World](/ecs/cf_world.md)  
+[cf_make_world](/ecs/cf_make_world.md)  
+[cf_world_equals](/ecs/cf_world_equals.md)  
+[cf_world_push](/ecs/cf_world_push.md)  
+[cf_world_pop](/ecs/cf_world_pop.md)  
+[cf_world_peek](/ecs/cf_world_peek.md)  
diff --git a/docs/ecs/cf_entity_activate.md b/docs/ecs/cf_entity_activate.md
@@ -9,12 +9,15 @@ Category: [ecs](/api_reference?id=ecs)
 GitHub: [cute_ecs.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_ecs.h)  
 ---
 
-TODO
+Stops updating the entity, it will not be passed into any system updates.
 
 ```cpp
 void cf_entity_activate(CF_Entity entity);
 ```
 
 ## Related Pages
 
-TODO  
+[CF_Entity](/ecs/cf_entity.md)  
+[cf_entity_delayed_activate](/ecs/cf_entity_delayed_activate.md)  
+[cf_entity_deactivate](/ecs/cf_entity_deactivate.md)  
+[cf_entity_is_active](/ecs/cf_entity_is_active.md)  
diff --git a/docs/ecs/cf_entity_begin.md b/docs/ecs/cf_entity_begin.md
@@ -17,7 +17,8 @@ void cf_entity_begin();
 
 ## Remarks
 
-TODO
+Call [cf_entity_end](/ecs/cf_entity_end.md) to finish the entity definition. Once done you may instantiate entities
+of this type via [cf_make_entity](/ecs/cf_make_entity.md).
 
 ## Related Pages
 

diff --git a/docs/ecs/cf_entity_change_type.md b/docs/ecs/cf_entity_change_type.md
@@ -9,12 +9,14 @@ Category: [ecs](/api_reference?id=ecs)
 GitHub: [cute_ecs.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_ecs.h)  
 ---
 
-TODO
+Changes the type of this entity.
 
 ```cpp
 void cf_entity_change_type(CF_Entity entity, const char* entity_type);
 ```
 
 ## Related Pages
 
-TODO  
+[cf_entity_delayed_change_type](/ecs/cf_entity_delayed_change_type.md)  
+entity_get_type_string  
+[cf_entity_type_rename](/ecs/cf_entity_type_rename.md)  
diff --git a/docs/ecs/cf_entity_deactivate.md b/docs/ecs/cf_entity_deactivate.md
@@ -9,12 +9,15 @@ Category: [ecs](/api_reference?id=ecs)
 GitHub: [cute_ecs.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_ecs.h)  
 ---
 
-TODO
+Activates this entity, it will be passed to system updates.
 
 ```cpp
 void cf_entity_deactivate(CF_Entity entity);
 ```
 
 ## Related Pages
 
-TODO  
+[CF_Entity](/ecs/cf_entity.md)  
+[cf_entity_delayed_activate](/ecs/cf_entity_delayed_activate.md)  
+[cf_entity_is_active](/ecs/cf_entity_is_active.md)  
+[cf_entity_activate](/ecs/cf_entity_activate.md)  
diff --git a/docs/ecs/cf_entity_delayed_activate.md b/docs/ecs/cf_entity_delayed_activate.md
@@ -9,12 +9,19 @@ Category: [ecs](/api_reference?id=ecs)
 GitHub: [cute_ecs.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_ecs.h)  
 ---
 
-TODO
+Activates this entity, it will be passed to system updates.
 
 ```cpp
 void cf_entity_delayed_activate(CF_Entity entity);
 ```
 
+## Remarks
+
+The activation is delayed until the end of the frame.
+
 ## Related Pages
 
-TODO  
+[CF_Entity](/ecs/cf_entity.md)  
+[cf_entity_is_active](/ecs/cf_entity_is_active.md)  
+[cf_entity_deactivate](/ecs/cf_entity_deactivate.md)  
+[cf_entity_activate](/ecs/cf_entity_activate.md)  
diff --git a/docs/ecs/cf_entity_delayed_change_type.md b/docs/ecs/cf_entity_delayed_change_type.md
@@ -9,16 +9,22 @@ Category: [ecs](/api_reference?id=ecs)
 GitHub: [cute_ecs.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_ecs.h)  
 ---
 
-TODO
+Changes the type of this entity.
 
 ```cpp
 void cf_entity_delayed_change_type(CF_Entity entity, const char* entity_type);
 ```
 
 ## Remarks
 
-CURRENTLY NOT IMPLEMENTED.
+The change is delayed to the end of the frame. Since this function can clean up components
+that disappear it may be beneficial to delay in order to avoid dangling references, or simplify
+gameplay logic that depends on these components.
+
+This function can be useful for implementing certain editors.
 
 ## Related Pages
 
-TODO  
+entity_get_type_string  
+[cf_entity_change_type](/ecs/cf_entity_change_type.md)  
+[cf_entity_type_rename](/ecs/cf_entity_type_rename.md)