Skip to content

Commit

Permalink
Docs for blit refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
RandyGaul committed Sep 27, 2024
1 parent fe9a334 commit c4a83cb
Show file tree
Hide file tree
Showing 5 changed files with 58 additions and 40 deletions.
3 changes: 2 additions & 1 deletion docs/api_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -852,7 +852,6 @@ This is a list of all functions in Cute Framework organized by categories. This
- [cf_backend_type_to_string](/graphics/cf_backend_type_to_string.md)
- [cf_blend_factor_string](/graphics/cf_blend_factor_string.md)
- [cf_blend_op_string](/graphics/cf_blend_op_string.md)
- [cf_canvas_blit](/graphics/cf_canvas_blit.md)
- [cf_canvas_defaults](/graphics/cf_canvas_defaults.md)
- [cf_canvas_get_depth_stencil_target](/graphics/cf_canvas_get_depth_stencil_target.md)
- [cf_canvas_get_target](/graphics/cf_canvas_get_target.md)
Expand Down Expand Up @@ -1076,6 +1075,7 @@ This is a list of all functions in Cute Framework organized by categories. This
- [cf_input_set_ime_rect](/input/cf_input_set_ime_rect.md)
- [cf_input_text_add_utf8](/input/cf_input_text_add_utf8.md)
- [cf_input_text_clear](/input/cf_input_text_clear.md)
- [cf_input_text_get_buffer](/input/cf_input_text_get_buffer.md)
- [cf_input_text_has_data](/input/cf_input_text_has_data.md)
- [cf_input_text_pop_utf32](/input/cf_input_text_pop_utf32.md)
- [cf_joypad_add_mapping](/input/cf_joypad_add_mapping.md)
Expand Down Expand Up @@ -1128,6 +1128,7 @@ This is a list of all functions in Cute Framework organized by categories. This

### structs
- [CF_ImeComposition](/input/cf_imecomposition.md)
- [CF_InputTextBuffer](/input/cf_inputtextbuffer.md)
- [CF_Touch](/input/cf_touch.md)


Expand Down
3 changes: 1 addition & 2 deletions docs/draw/cf_draw_mul.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,11 @@ GitHub: [cute_draw.h](https://github.com/RandyGaul/cute_framework/blob/master/in
Applies the current draw transform to a point.

```cpp
CF_V2 cf_draw_mul(CF_M3x2 m, CF_V2 p);
CF_V2 cf_draw_mul(CF_V2 p);
```
Parameters | Description
--- | ---
m | The transform to apply.
p | The point to transform.
## Related Pages
Expand Down
37 changes: 0 additions & 37 deletions docs/graphics/cf_canvas_blit.md

This file was deleted.

31 changes: 31 additions & 0 deletions docs/input/cf_input_text_get_buffer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
[//]: # (This file is automatically generated by Cute Framework's docs parser.)
[//]: # (Do not edit this file by hand!)
[//]: # (See: https://github.com/RandyGaul/cute_framework/blob/master/samples/docs_parser.cpp)
[](../header.md ':include')

# cf_input_text_get_buffer

Category: [input](/api_reference?id=input)
GitHub: [cute_input.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_input.h)
---

Returns the content of the text input buffer.

```cpp
bool cf_input_text_get_buffer(CF_InputTextBuffer* buffer);
```
## Return Value
Returns true if the input buffer of the application has any text within.
## Remarks
The input text functions are for dealing with text input. Not all text inputs come from a single key-stroke, as some are comprised of
multiple keystrokes, especially when dealing with non-Latin based inputs.
## Related Pages
[cf_input_enable_ime](/input/cf_input_enable_ime.md)
[cf_input_disable_ime](/input/cf_input_disable_ime.md)
[cf_input_text_clear](/input/cf_input_text_clear.md)
24 changes: 24 additions & 0 deletions docs/input/cf_inputtextbuffer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[//]: # (This file is automatically generated by Cute Framework's docs parser.)
[//]: # (Do not edit this file by hand!)
[//]: # (See: https://github.com/RandyGaul/cute_framework/blob/master/samples/docs_parser.cpp)
[](../header.md ':include')

# CF_InputTextBuffer

Category: [input](/api_reference?id=input)
GitHub: [cute_input.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_input.h)
---

Represents the application's input text buffer.

Struct Members | Description
--- | ---
`int len` | The length of the buffer.
`const int* codepoints` | The buffer's data which is a sequence of utf32 codepoints.

## Related Pages

[cf_input_enable_ime](/input/cf_input_enable_ime.md)
[cf_input_disable_ime](/input/cf_input_disable_ime.md)
[cf_input_text_get_buffer](/input/cf_input_text_get_buffer.md)
[cf_input_text_clear](/input/cf_input_text_clear.md)

0 comments on commit c4a83cb

Please sign in to comment.