-
-
Notifications
You must be signed in to change notification settings - Fork 32
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
28 changed files
with
549 additions
and
137 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| [](../header.md ':include') | ||
|
|
||
| # cf_app_request_attention | ||
|
|
||
| Category: [app](/api_reference?id=app) | ||
| GitHub: [cute_app.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_app.h) | ||
| --- | ||
|
|
||
| Requests attention for the window for a brief period. | ||
|
|
||
| ```cpp | ||
| void cf_app_request_attention(); | ||
| ``` | ||
|
|
||
| ## Remarks | ||
|
|
||
| On Windows this flashes the tab icon, and bounces the dock icon on OSX. | ||
|
|
||
| ## Related Pages | ||
|
|
||
| [cf_app_request_attention_cancel](/app/cf_app_request_attention_cancel.md) | ||
| [cf_app_request_attention_continuously](/app/cf_app_request_attention_continuously.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| [](../header.md ':include') | ||
|
|
||
| # cf_app_request_attention_cancel | ||
|
|
||
| Category: [app](/api_reference?id=app) | ||
| GitHub: [cute_app.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_app.h) | ||
| --- | ||
|
|
||
| Cancels any previous requests for attention. | ||
|
|
||
| ```cpp | ||
| void cf_app_request_attention_cancel(); | ||
| ``` | ||
|
|
||
| ## Related Pages | ||
|
|
||
| [cf_app_request_attention](/app/cf_app_request_attention.md) | ||
| [cf_app_request_attention_continuously](/app/cf_app_request_attention_continuously.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| [](../header.md ':include') | ||
|
|
||
| # cf_app_request_attention_continuously | ||
|
|
||
| Category: [app](/api_reference?id=app) | ||
| GitHub: [cute_app.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_app.h) | ||
| --- | ||
|
|
||
| Requests attention for the window for continuously. | ||
|
|
||
| ```cpp | ||
| void cf_app_request_attention_continuously(); | ||
| ``` | ||
|
|
||
| ## Remarks | ||
|
|
||
| On Windows this flashes the tab icon, and bounces the dock icon on OSX. | ||
|
|
||
| ## Related Pages | ||
|
|
||
| [cf_app_request_attention](/app/cf_app_request_attention.md) | ||
| [cf_app_request_attention_cancel](/app/cf_app_request_attention_cancel.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| [](../header.md ':include') | ||
|
|
||
| # cf_audio_channel_count | ||
|
|
||
| Category: [audio](/api_reference?id=audio) | ||
| GitHub: [cute_audio.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_audio.h) | ||
| --- | ||
|
|
||
| Returns the channel count for a loaded audio resource. | ||
|
|
||
| ```cpp | ||
| int cf_audio_channel_count(CF_Audio audio); | ||
| ``` | ||
| ## Related Pages | ||
| [CF_Audio](/audio/cf_audio.md) | ||
| [cf_audio_sample_rate](/audio/cf_audio_sample_rate.md) | ||
| [cf_audio_sample_count](/audio/cf_audio_sample_count.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| [](../header.md ':include') | ||
|
|
||
| # cf_audio_sample_count | ||
|
|
||
| Category: [audio](/api_reference?id=audio) | ||
| GitHub: [cute_audio.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_audio.h) | ||
| --- | ||
|
|
||
| Returns the sample count for a loaded audio resource. | ||
|
|
||
| ```cpp | ||
| int cf_audio_sample_count(CF_Audio audio); | ||
| ``` | ||
| ## Related Pages | ||
| [CF_Audio](/audio/cf_audio.md) | ||
| [cf_audio_sample_rate](/audio/cf_audio_sample_rate.md) | ||
| [cf_audio_channel_count](/audio/cf_audio_channel_count.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| [](../header.md ':include') | ||
|
|
||
| # cf_audio_sample_rate | ||
|
|
||
| Category: [audio](/api_reference?id=audio) | ||
| GitHub: [cute_audio.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_audio.h) | ||
| --- | ||
|
|
||
| Returns the sample rate for a loaded audio resource. | ||
|
|
||
| ```cpp | ||
| int cf_audio_sample_rate(CF_Audio audio); | ||
| ``` | ||
| ## Related Pages | ||
| [CF_Audio](/audio/cf_audio.md) | ||
| [cf_audio_channel_count](/audio/cf_audio_channel_count.md) | ||
| [cf_audio_sample_count](/audio/cf_audio_sample_count.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| [](../header.md ':include') | ||
|
|
||
| # cf_sound_stop | ||
|
|
||
| Category: [audio](/api_reference?id=audio) | ||
| GitHub: [cute_audio.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_audio.h) | ||
| --- | ||
|
|
||
| Stops the sound instance so it no longer plays. | ||
|
|
||
| ```cpp | ||
| void cf_sound_stop(CF_Sound sound); | ||
| ``` | ||
| ## Related Pages | ||
| [CF_SoundParams](/audio/cf_soundparams.md) | ||
| [CF_Sound](/audio/cf_sound.md) | ||
| [cf_sound_params_defaults](/audio/cf_sound_params_defaults.md) | ||
| [cf_play_sound](/audio/cf_play_sound.md) | ||
| [cf_sound_is_active](/audio/cf_sound_is_active.md) | ||
| [cf_sound_get_is_paused](/audio/cf_sound_get_is_paused.md) | ||
| [cf_sound_get_is_looped](/audio/cf_sound_get_is_looped.md) | ||
| [cf_sound_get_volume](/audio/cf_sound_get_volume.md) | ||
| [cf_sound_get_sample_index](/audio/cf_sound_get_sample_index.md) | ||
| [cf_sound_set_sample_index](/audio/cf_sound_set_sample_index.md) | ||
| [cf_sound_set_is_paused](/audio/cf_sound_set_is_paused.md) | ||
| [cf_sound_set_is_looped](/audio/cf_sound_set_is_looped.md) | ||
| [cf_sound_set_volume](/audio/cf_sound_set_volume.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| [](../header.md ':include') | ||
|
|
||
| # cf_mouse_hidden | ||
|
|
||
| Category: [input](/api_reference?id=input) | ||
| GitHub: [cute_input.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_input.h) | ||
| --- | ||
|
|
||
| Returns whether the mouse is hidden. | ||
|
|
||
| ```cpp | ||
| bool cf_mouse_hidden(); | ||
| ``` | ||
|
|
||
| ## Return Value | ||
|
|
||
| True means hidden, false means not hidden. | ||
|
|
||
| ## Related Pages | ||
|
|
||
| [cf_mouse_hide](/input/cf_mouse_hide.md) | ||
| [cf_mouse_lock_inside_window](/input/cf_mouse_lock_inside_window.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| [](../header.md ':include') | ||
|
|
||
| # cf_mouse_hide | ||
|
|
||
| Category: [input](/api_reference?id=input) | ||
| GitHub: [cute_input.h](https://github.com/RandyGaul/cute_framework/blob/master/include/cute_input.h) | ||
| --- | ||
|
|
||
| Hides or shows the mouse. | ||
|
|
||
| ```cpp | ||
| void cf_mouse_hide(bool true_to_hide); | ||
| ``` | ||
| ## Related Pages | ||
| [cf_mouse_lock_inside_window](/input/cf_mouse_lock_inside_window.md) | ||
| [cf_mouse_hidden](/input/cf_mouse_hidden.md) |
Oops, something went wrong.