diff --git a/README.md b/README.md index f209b95..66f91f9 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,119 @@ The documentation is also available online at https://herbemalveillante.github.i ## Roadmap -1. Port all of Raylib's examples to Axle +Note : the following features will be implemented **LAST** : + +- Touch and gestures +- VR +- Automation and Event management + +The following features may be implemented in the near future : + +- Automatic generation of macOS apps +- Resource management for standalone executables +- Cross-platform toolchain shell script + +### Features + +#### Primitives + +- Rectangle +- Vector2 / Point +- Vector3 +- Matrixes +- Shaders + +#### Window and screen + +- Get window state (fullscreen, hidden, minimized, maximized, focused, resized, etc.) +- Set window state +- Set window icon +- Set window properties (title, position, monitor, min/max size, opacity, etc.) +- Get screen size and render size +- Get monitor information (count, size, position, etc.) +- Manage clipboard (set / get, text and images) +- Manage cursor (show, hide, get visibility, enable, disable, detect if on screen) +- Manage FPS (get current FPS, get deltatime, get time since start of the program, etc.) + +#### Drawing and shaders + +- Implement camera (2D and 3D) with transformation matrixes. Add option to switch drawing mode to a camera. +- Get and set camera information +- Implement Screen-space related functions (screen to world, world to screen, 2D and 3D, manage camera matrixes, etc.) +- Implement drawing to render texture +- Implement shader drawing (load shader, access uniforms, etc.) +- Implement blending mode +- Implement scissor mode + +#### Input functions + +- Get keyboard state (once, again, released, etc.) +- Set exit key +- Get gamepad information +- Get gamepad state +- Manage gamepad (vibrations, etc.) +- Change input mappings +- Get mouse position and buttons +- Move the mouse + +#### Primitives + +- Draw pixels +- Draw lines +- Draw splines and bezier curves +- Draw circles +- Draw circle sectors +- Draw ellipses +- Draw rings +- Draw rectangles +- Draw triangles +- Draw polygons +- Check collisions between each aforementioned shape + +#### Textures + +- Load images into CPU memory (RAM) +- Generate images programatically (noise, etc.) +- Edit images (crop, filters, etc.) +- Draw images +- Load textures into GPU memory (VRAM) +- Draw textures +- Edit / Compare colors + +#### Text + +- Load fonts from ttf files +- Load fonts from image files +- Draw text +- Edit text +- Measure text + +#### 3D + +- Draw primitives +- Load models +- Load materials +- Load animations +- Load meshes +- Generate meshes programmatically +- Draw models +- Draw meshes +- Draw billboards +- Check for collisions + +#### Audio + +- Load audio data +- Play audio data + +#### Utils and misc + +- Add random number / seed generation +- Add perlin / simplex noise generation +- Implement screenshots and video recording +- Interact with the machine (open URL, file management, etc.) + +### Examples ## Credits diff --git a/docs/_r_e_a_d_m_e_8md.html b/docs/_r_e_a_d_m_e_8md.html new file mode 100644 index 0000000..c503746 --- /dev/null +++ b/docs/_r_e_a_d_m_e_8md.html @@ -0,0 +1,121 @@ + + + + + + + +Axle: axle/README.md File Reference + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + +
+
Axle 0.1.0 +
+
A simple, lightweight C++ game framework built on top of Raylib.
+
+ +   + + + + +
+
+
+ + + + +
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
axle/README.md File Reference
+
+
+
+
+ + + + diff --git a/docs/axle_8h.html b/docs/axle_8h.html new file mode 100644 index 0000000..cd10a36 --- /dev/null +++ b/docs/axle_8h.html @@ -0,0 +1,135 @@ + + + + + + + +Axle: axle/include/axle.h File Reference + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + +
+
Axle 0.1.0 +
+
A simple, lightweight C++ game framework built on top of Raylib.
+
+ +   + + + + +
+
+
+ + + + +
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Namespaces
+
axle.h File Reference
+
+
+
#include "examples.h"
+#include "window.h"
+
+ + + + + + + +

+Namespaces

namespace  Axle
 The main namespace of the Axle engine. All the features of the engine are contained within this namespace.
 
namespace  Axle::Examples
 The Example namespace contains ports of the examples from the Raylib library.
 
+
+
+ + + + diff --git a/docs/basic_window_8cpp.html b/docs/basic_window_8cpp.html new file mode 100644 index 0000000..22015c0 --- /dev/null +++ b/docs/basic_window_8cpp.html @@ -0,0 +1,141 @@ + + + + + + + +Axle: axle/src/examples/basicWindow.cpp File Reference + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + +
+
Axle 0.1.0 +
+
A simple, lightweight C++ game framework built on top of Raylib.
+
+ +   + + + + +
+
+
+ + + + +
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Namespaces | +Functions
+
basicWindow.cpp File Reference
+
+
+
#include "axle.h"
+
+ + + + + + + +

+Namespaces

namespace  Axle
 The main namespace of the Axle engine. All the features of the engine are contained within this namespace.
 
namespace  Axle::Examples
 The Example namespace contains ports of the examples from the Raylib library.
 
+ + + + +

+Functions

void Axle::Examples::basicWindow ()
 Basic window example.
 
+
+
+ + + + diff --git a/docs/basic_window_8cpp.js b/docs/basic_window_8cpp.js new file mode 100644 index 0000000..8b3fc94 --- /dev/null +++ b/docs/basic_window_8cpp.js @@ -0,0 +1,4 @@ +var basic_window_8cpp = +[ + [ "Axle::Examples::basicWindow", "namespace_axle_1_1_examples.html#aad61ebdcb0a57c9108ed77ed607844b6", null ] +]; \ No newline at end of file diff --git a/docs/color_8cpp.html b/docs/color_8cpp.html new file mode 100644 index 0000000..afe79a7 --- /dev/null +++ b/docs/color_8cpp.html @@ -0,0 +1,131 @@ + + + + + + + +Axle: axle/src/color.cpp File Reference + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + +
+
Axle 0.1.0 +
+
A simple, lightweight C++ game framework built on top of Raylib.
+
+ +   + + + + +
+
+
+ + + + +
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Namespaces
+
color.cpp File Reference
+
+
+
#include "color.h"
+
+ + + + +

+Namespaces

namespace  Axle
 The main namespace of the Axle engine. All the features of the engine are contained within this namespace.
 
+
+
+ + + + diff --git a/docs/color_8h.html b/docs/color_8h.html new file mode 100644 index 0000000..308d33c --- /dev/null +++ b/docs/color_8h.html @@ -0,0 +1,177 @@ + + + + + + + +Axle: axle/include/color.h File Reference + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + +
+
Axle 0.1.0 +
+
A simple, lightweight C++ game framework built on top of Raylib.
+
+ +   + + + + +
+
+
+ + + + +
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Classes | +Namespaces | +Enumerations
+
color.h File Reference
+
+
+ + + + + +

+Classes

class  Axle::Color
 This class is used to represent a color in the RGBA format. More...
 
+ + + + +

+Namespaces

namespace  Axle
 The main namespace of the Axle engine. All the features of the engine are contained within this namespace.
 
+ + + + +

+Enumerations

enum class  Axle::ColorPreset {
+  Axle::LIGHTGRAY +, Axle::GRAY +, Axle::DARKGRAY +, Axle::YELLOW +,
+  Axle::GOLD +, Axle::ORANGE +, Axle::PINK +, Axle::RED +,
+  Axle::MAROON +, Axle::GREEN +, Axle::LIME +, Axle::DARKGREEN +,
+  Axle::SKYBLUE +, Axle::BLUE +, Axle::DARKBLUE +, Axle::PURPLE +,
+  Axle::VIOLET +, Axle::DARKPURPLE +, Axle::BEIGE +, Axle::BROWN +,
+  Axle::DARKBROWN +, Axle::WHITE +, Axle::BLACK +, Axle::BLANK +,
+  Axle::MAGENTA +
+ }
 This enum is used to represent a color preset that can later be used to replace a color object in many places. More...
 
+
+
+ + + + diff --git a/docs/color_8h.js b/docs/color_8h.js new file mode 100644 index 0000000..f55ca5f --- /dev/null +++ b/docs/color_8h.js @@ -0,0 +1,31 @@ +var color_8h = +[ + [ "Axle::Color", "class_axle_1_1_color.html", "class_axle_1_1_color" ], + [ "Axle::ColorPreset", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8", [ + [ "Axle::ColorPreset::LIGHTGRAY", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a046c542c1879961609e6d616fdf383f6", null ], + [ "Axle::ColorPreset::GRAY", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a48bf014c704c9eaae100a98006a37bf7", null ], + [ "Axle::ColorPreset::DARKGRAY", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a0e1e6fddb3b7f6b796fd388b27dc02ab", null ], + [ "Axle::ColorPreset::YELLOW", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a8a568e5f41b7e4da88fe5c4a00aad34e", null ], + [ "Axle::ColorPreset::GOLD", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a2c0898822ab3baf7f93bea86648adb26", null ], + [ "Axle::ColorPreset::ORANGE", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a5b6490317b6f7270bc3ab5ffd07c1f52", null ], + [ "Axle::ColorPreset::PINK", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a2536bd3910cf3069e2cd184e614ea97d", null ], + [ "Axle::ColorPreset::RED", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8aa2d9547b5d3dd9f05984475f7c926da0", null ], + [ "Axle::ColorPreset::MAROON", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8ab0459ecc882a7ea7cc98dd4275d5d181", null ], + [ "Axle::ColorPreset::GREEN", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a9de0e5dd94e861317e74964bed179fa0", null ], + [ "Axle::ColorPreset::LIME", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a2cf3a2965e9238d68222de372e70e935", null ], + [ "Axle::ColorPreset::DARKGREEN", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a0375de91b1558838e15231ca2a939f84", null ], + [ "Axle::ColorPreset::SKYBLUE", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a0c82ca04b8123fae4a3d14d3ac9dbbd5", null ], + [ "Axle::ColorPreset::BLUE", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a1b3e1ee9bff86431dea6b181365ba65f", null ], + [ "Axle::ColorPreset::DARKBLUE", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a06e2fdcb92e9bdbc9075c0d8365f453f", null ], + [ "Axle::ColorPreset::PURPLE", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8aec9c138095a352a9b7ef9ca5363b14d9", null ], + [ "Axle::ColorPreset::VIOLET", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a3df9f09dbf0774e4edf801e77aea339b", null ], + [ "Axle::ColorPreset::DARKPURPLE", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a2bfe1e1c35bb64f961908243773b9aa1", null ], + [ "Axle::ColorPreset::BEIGE", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a837b1cca89daac46ffecac7bd4923779", null ], + [ "Axle::ColorPreset::BROWN", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a493cacf6f6a2ae4798b319b8b9ba9488", null ], + [ "Axle::ColorPreset::DARKBROWN", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8ade1f378f72c71113be9329a741547c8b", null ], + [ "Axle::ColorPreset::WHITE", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8ab5bf627e448384cf3a4c35121ca6008d", null ], + [ "Axle::ColorPreset::BLACK", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a08d0012388564e95c3b4a7407cf04965", null ], + [ "Axle::ColorPreset::BLANK", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a56f031dd03707d695f76c63ddbf40bd7", null ], + [ "Axle::ColorPreset::MAGENTA", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8ac634ffea7195608364671ac52ee59a61", null ] + ] ] +]; \ No newline at end of file diff --git a/docs/custom_8cpp.html b/docs/custom_8cpp.html new file mode 100644 index 0000000..2ba92b8 --- /dev/null +++ b/docs/custom_8cpp.html @@ -0,0 +1,142 @@ + + + + + + + +Axle: axle/src/examples/custom.cpp File Reference + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + +
+
Axle 0.1.0 +
+
A simple, lightweight C++ game framework built on top of Raylib.
+
+ +   + + + + +
+
+
+ + + + +
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Namespaces | +Functions
+
custom.cpp File Reference
+
+
+
#include <iostream>
+#include "axle.h"
+
+ + + + + + + +

+Namespaces

namespace  Axle
 The main namespace of the Axle engine. All the features of the engine are contained within this namespace.
 
namespace  Axle::Examples
 The Example namespace contains ports of the examples from the Raylib library.
 
+ + + + +

+Functions

void Axle::Examples::custom ()
 Custom example.
 
+
+
+ + + + diff --git a/docs/custom_8cpp.js b/docs/custom_8cpp.js new file mode 100644 index 0000000..b0e5c2d --- /dev/null +++ b/docs/custom_8cpp.js @@ -0,0 +1,4 @@ +var custom_8cpp = +[ + [ "Axle::Examples::custom", "namespace_axle_1_1_examples.html#ad92427e86e27c90a1d0a1df42b28b596", null ] +]; \ No newline at end of file diff --git a/docs/custom_example_8cpp.html b/docs/custom_example_8cpp.html new file mode 100644 index 0000000..3468057 --- /dev/null +++ b/docs/custom_example_8cpp.html @@ -0,0 +1,142 @@ + + + + + + + +Axle: axle/src/examples/customExample.cpp File Reference + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + +
+
Axle 0.1.0 +
+
A simple, lightweight C++ game framework built on top of Raylib.
+
+ +   + + + + +
+
+
+ + + + +
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Namespaces | +Functions
+
customExample.cpp File Reference
+
+
+
#include <iostream>
+#include "axle.h"
+
+ + + + + + + +

+Namespaces

namespace  Axle
 The main namespace of the Axle engine. All the features of the engine are contained within this namespace.
 
namespace  Axle::Examples
 The Example namespace contains ports of the examples from the Raylib library.
 
+ + + + +

+Functions

void Axle::Examples::customExample ()
 Custom example.
 
+
+
+ + + + diff --git a/docs/custom_example_8cpp.js b/docs/custom_example_8cpp.js new file mode 100644 index 0000000..65bf851 --- /dev/null +++ b/docs/custom_example_8cpp.js @@ -0,0 +1,4 @@ +var custom_example_8cpp = +[ + [ "Axle::Examples::customExample", "namespace_axle_1_1_examples.html#a731085a0d1039cffe4b9bf6e63f7690d", null ] +]; \ No newline at end of file diff --git a/docs/dir_19daba6fae3977e99e0655060830ad45.js b/docs/dir_19daba6fae3977e99e0655060830ad45.js new file mode 100644 index 0000000..368c655 --- /dev/null +++ b/docs/dir_19daba6fae3977e99e0655060830ad45.js @@ -0,0 +1,6 @@ +var dir_19daba6fae3977e99e0655060830ad45 = +[ + [ "examples", "dir_69edf7c553be4ed473868ede980e4319.html", "dir_69edf7c553be4ed473868ede980e4319" ], + [ "color.cpp", "color_8cpp.html", null ], + [ "window.cpp", "window_8cpp.html", null ] +]; \ No newline at end of file diff --git a/docs/dir_3f6cc9b83d858a55628490f4f6238619.js b/docs/dir_3f6cc9b83d858a55628490f4f6238619.js new file mode 100644 index 0000000..8f75d8d --- /dev/null +++ b/docs/dir_3f6cc9b83d858a55628490f4f6238619.js @@ -0,0 +1,7 @@ +var dir_3f6cc9b83d858a55628490f4f6238619 = +[ + [ "axle.h", "axle_8h.html", null ], + [ "color.h", "color_8h.html", "color_8h" ], + [ "examples.h", "examples_8h.html", "examples_8h" ], + [ "window.h", "window_8h.html", "window_8h" ] +]; \ No newline at end of file diff --git a/docs/dir_69edf7c553be4ed473868ede980e4319.js b/docs/dir_69edf7c553be4ed473868ede980e4319.js new file mode 100644 index 0000000..f4de43a --- /dev/null +++ b/docs/dir_69edf7c553be4ed473868ede980e4319.js @@ -0,0 +1,5 @@ +var dir_69edf7c553be4ed473868ede980e4319 = +[ + [ "basicWindow.cpp", "basic_window_8cpp.html", "basic_window_8cpp" ], + [ "customExample.cpp", "custom_example_8cpp.html", "custom_example_8cpp" ] +]; \ No newline at end of file diff --git a/docs/dir_885299776d2396c578407cfaa9b476b1.js b/docs/dir_885299776d2396c578407cfaa9b476b1.js new file mode 100644 index 0000000..a47a1f4 --- /dev/null +++ b/docs/dir_885299776d2396c578407cfaa9b476b1.js @@ -0,0 +1,5 @@ +var dir_885299776d2396c578407cfaa9b476b1 = +[ + [ "include", "dir_3f6cc9b83d858a55628490f4f6238619.html", "dir_3f6cc9b83d858a55628490f4f6238619" ], + [ "src", "dir_19daba6fae3977e99e0655060830ad45.html", "dir_19daba6fae3977e99e0655060830ad45" ] +]; \ No newline at end of file diff --git a/docs/doxygen_crawl.html b/docs/doxygen_crawl.html index 2c2ce23..e41aedc 100644 --- a/docs/doxygen_crawl.html +++ b/docs/doxygen_crawl.html @@ -48,9 +48,21 @@ + + + + + + + + + + + + @@ -78,9 +90,12 @@ - + + + + diff --git a/docs/examples_8h.html b/docs/examples_8h.html new file mode 100644 index 0000000..3bae792 --- /dev/null +++ b/docs/examples_8h.html @@ -0,0 +1,143 @@ + + + + + + + +Axle: axle/include/examples.h File Reference + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + +
+
Axle 0.1.0 +
+
A simple, lightweight C++ game framework built on top of Raylib.
+
+ +   + + + + +
+
+
+ + + + +
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+Namespaces | +Functions
+
examples.h File Reference
+
+
+ + + + + + + + +

+Namespaces

namespace  Axle
 The main namespace of the Axle engine. All the features of the engine are contained within this namespace.
 
namespace  Axle::Examples
 The Example namespace contains ports of the examples from the Raylib library.
 
+ + + + + + + +

+Functions

void Axle::Examples::basicWindow ()
 Basic window example.
 
void Axle::Examples::customExample ()
 Custom example.
 
+
+
+ + + + diff --git a/docs/examples_8h.js b/docs/examples_8h.js new file mode 100644 index 0000000..59406a2 --- /dev/null +++ b/docs/examples_8h.js @@ -0,0 +1,5 @@ +var examples_8h = +[ + [ "Axle::Examples::basicWindow", "namespace_axle_1_1_examples.html#aad61ebdcb0a57c9108ed77ed607844b6", null ], + [ "Axle::Examples::customExample", "namespace_axle_1_1_examples.html#a731085a0d1039cffe4b9bf6e63f7690d", null ] +]; \ No newline at end of file diff --git a/docs/files.html b/docs/files.html new file mode 100644 index 0000000..b1583cf --- /dev/null +++ b/docs/files.html @@ -0,0 +1,136 @@ + + + + + + + +Axle: File List + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + +
+
Axle 0.1.0 +
+
A simple, lightweight C++ game framework built on top of Raylib.
+
+ +   + + + + +
+
+
+ + + + +
+ +
+
+
+ +
+ +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
File List
+
+
+
Here is a list of all files with brief descriptions:
+
[detail level 1234]
+ + + + + + + + + + + + +
 ▼ axle
 ▼ include
 axle.h
 color.h
 examples.h
 window.h
 ▼ src
 ▼ examples
 basicWindow.cpp
 customExample.cpp
 color.cpp
 window.cpp
+
+
+
+ + + + diff --git a/docs/files_dup.js b/docs/files_dup.js new file mode 100644 index 0000000..2a304d1 --- /dev/null +++ b/docs/files_dup.js @@ -0,0 +1,4 @@ +var files_dup = +[ + [ "axle", "dir_885299776d2396c578407cfaa9b476b1.html", "dir_885299776d2396c578407cfaa9b476b1" ] +]; \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 88810eb..644d564 100644 --- a/docs/index.html +++ b/docs/index.html @@ -126,8 +126,9 @@

int main()
{
// Run the basic window example
-
Axle::Examples::basicWindow();
+
Axle::Examples::basicWindow();
}
+
Axle::Examples::basicWindow
void basicWindow()
Basic window example.
Definition basicWindow.cpp:5

  • Build and run the project :

    ./axle.sh run
    @@ -141,10 +142,131 @@

    The documentation is also available online at https://herbemalveillante.github.io/axle/ .

    Roadmap

    -
      -
    1. Port all of Raylib's examples to Axle
      2. -
    -

    +

    Note : the following features will be implemented LAST :

    +
      +
    • Touch and gestures
      • +
    • VR
      • +
    • Automation and Event management
      • +
    +

    The following features may be implemented in the near future :

    +
      +
    • Automatic generation of macOS apps
      • +
    • Resource management for standalone executables
      • +
    • Cross-platform toolchain shell script
      • +
    +

    +Features

    +

    +Primitives

    +
      +
    • Rectangle
      • +
    • Vector2 / Point
      • +
    • Vector3
      • +
    • Matrixes
      • +
    • Shaders
      • +
    +

    +Window and screen

    +
      +
    • Get window state (fullscreen, hidden, minimized, maximized, focused, resized, etc.)
      • +
    • Set window state
      • +
    • Set window icon
      • +
    • Set window properties (title, position, monitor, min/max size, opacity, etc.)
      • +
    • Get screen size and render size
      • +
    • Get monitor information (count, size, position, etc.)
      • +
    • Manage clipboard (set / get, text and images)
      • +
    • Manage cursor (show, hide, get visibility, enable, disable, detect if on screen)
      • +
    • Manage FPS (get current FPS, get deltatime, get time since start of the program, etc.)
      • +
    +

    +Drawing and shaders

    +
      +
    • Implement camera (2D and 3D) with transformation matrixes. Add option to switch drawing mode to a camera.
      • +
    • Get and set camera information
      • +
    • Implement Screen-space related functions (screen to world, world to screen, 2D and 3D, manage camera matrixes, etc.)
      • +
    • Implement drawing to render texture
      • +
    • Implement shader drawing (load shader, access uniforms, etc.)
      • +
    • Implement blending mode
      • +
    • Implement scissor mode
      • +
    +

    +Input functions

    +
      +
    • Get keyboard state (once, again, released, etc.)
      • +
    • Set exit key
      • +
    • Get gamepad information
      • +
    • Get gamepad state
      • +
    • Manage gamepad (vibrations, etc.)
      • +
    • Change input mappings
      • +
    • Get mouse position and buttons
      • +
    • Move the mouse
      • +
    +

    +Primitives

    +
      +
    • Draw pixels
      • +
    • Draw lines
      • +
    • Draw splines and bezier curves
      • +
    • Draw circles
      • +
    • Draw circle sectors
      • +
    • Draw ellipses
      • +
    • Draw rings
      • +
    • Draw rectangles
      • +
    • Draw triangles
      • +
    • Draw polygons
      • +
    • Check collisions between each aforementioned shape
      • +
    +

    +Textures

    +
      +
    • Load images into CPU memory (RAM)
      • +
    • Generate images programatically (noise, etc.)
      • +
    • Edit images (crop, filters, etc.)
      • +
    • Draw images
      • +
    • Load textures into GPU memory (VRAM)
      • +
    • Draw textures
      • +
    • Edit / Compare colors
      • +
    +

    +Text

    +
      +
    • Load fonts from ttf files
      • +
    • Load fonts from image files
      • +
    • Draw text
      • +
    • Edit text
      • +
    • Measure text
      • +
    +

    +3D

    +
      +
    • Draw primitives
      • +
    • Load models
      • +
    • Load materials
      • +
    • Load animations
      • +
    • Load meshes
      • +
    • Generate meshes programmatically
      • +
    • Draw models
      • +
    • Draw meshes
      • +
    • Draw billboards
      • +
    • Check for collisions
      • +
    +

    +Audio

    +
      +
    • Load audio data
      • +
    • Play audio data
      • +
    +

    +Utils and misc

    +
      +
    • Add random number / seed generation
      • +
    • Add perlin / simplex noise generation
      • +
    • Implement screenshots and video recording
      • +
    • Interact with the machine (open URL, file management, etc.)
      • +
    +

    +Examples

    +

    Credits

    • This library is based on Raylib (https://github.com/raysan5/raylib)
      • diff --git a/docs/namespace_axle.html b/docs/namespace_axle.html index afa5ee2..7ea51d9 100644 --- a/docs/namespace_axle.html +++ b/docs/namespace_axle.html @@ -118,8 +118,8 @@ - - + +

      Namespaces

      namespace  Example
       The Example namespace contains ports of the examples from the Raylib library.
      namespace  Examples
       The Example namespace contains ports of the examples from the Raylib library.
       

      diff --git a/docs/namespace_axle.js b/docs/namespace_axle.js index bdce4f8..b5735e1 100644 --- a/docs/namespace_axle.js +++ b/docs/namespace_axle.js @@ -1,6 +1,9 @@ var namespace_axle = [ - [ "Example", "namespace_axle_1_1_example.html", null ], + [ "Examples", "namespace_axle_1_1_examples.html", [ + [ "basicWindow", "namespace_axle_1_1_examples.html#aad61ebdcb0a57c9108ed77ed607844b6", null ], + [ "customExample", "namespace_axle_1_1_examples.html#a731085a0d1039cffe4b9bf6e63f7690d", null ] + ] ], [ "Color", "class_axle_1_1_color.html", "class_axle_1_1_color" ], [ "Window", "class_axle_1_1_window.html", "class_axle_1_1_window" ], [ "ColorPreset", "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8", [ diff --git a/docs/namespace_axle_1_1_example.html b/docs/namespace_axle_1_1_example.html index 5661786..bd6e097 100644 --- a/docs/namespace_axle_1_1_example.html +++ b/docs/namespace_axle_1_1_example.html @@ -113,7 +113,14 @@ More...

      Detailed Description

      The Example namespace contains ports of the examples from the Raylib library.

      -

      The original examples can be found at https://www.raylib.com/examples.html

      +

      To run an example, simply call the corresponding function from this namespace :

      +
      #include <axle.h>
      +
      int main()
      +
      {
      +
      Axle::Examples::basicWindow();
      +
      return 0;
      +
      }
      +
      Note
      The original examples can be found at https://www.raylib.com/examples.html
      diff --git a/docs/namespace_axle_1_1_examples.html b/docs/namespace_axle_1_1_examples.html new file mode 100644 index 0000000..b88a442 --- /dev/null +++ b/docs/namespace_axle_1_1_examples.html @@ -0,0 +1,189 @@ + + + + + + + +Axle: Axle::Examples Namespace Reference + + + + + + + + + + + + + + + + + + +
      +
      +
      + + + + + + + +
      +
      Axle 0.1.0 +
      +
      A simple, lightweight C++ game framework built on top of Raylib.
      +
      + +   + + + + +
      +
      +
      + + + + +
      + +
      +
      +
      + +
      + +
      +
      + + +
      +
      +
      +
      +
      +
      Loading...
      +
      Searching...
      +
      No Matches
      +
      +
      +
      +
      + +
      +
      +Functions
      +
      Axle::Examples Namespace Reference
      +
      +
      + +

      The Example namespace contains ports of the examples from the Raylib library. +More...

      + + + + + + + + +

      +Functions

      void basicWindow ()
       Basic window example.
       
      void customExample ()
       Custom example.
       
      +

      Detailed Description

      +

      The Example namespace contains ports of the examples from the Raylib library.

      +

      To run an example, simply call the corresponding function from this namespace :

      +
      #include <axle.h>
      +
      int main()
      +
      {
      +
      Axle::Examples::basicWindow();
      +
      return 0;
      +
      }
      +
      Axle::Examples::basicWindow
      void basicWindow()
      Basic window example.
      Definition basicWindow.cpp:5
      +
      Note
      The original examples can be found at https://www.raylib.com/examples.html
      +

      Function Documentation

      + +

      ◆ basicWindow()

      + +
      +
      + + + + + + + +
      void Axle::Examples::basicWindow ()
      +
      + +

      Basic window example.

      +

      This example creates a basic window with a title and a size.

      +

      A basic game loop is also implemented, which will simply keep the window open until the user closes it, clear the background to a color, and then draw some text.

      + +
      +
      + +

      ◆ customExample()

      + +
      +
      + + + + + + + +
      void Axle::Examples::customExample ()
      +
      + +

      Custom example.

      +

      This example is a custom example that you can use to test your own code.

      + +
      +
      +
      +
      + + + + diff --git a/docs/namespacemembers.html b/docs/namespacemembers.html index 2e764a7..bfe78f0 100644 --- a/docs/namespacemembers.html +++ b/docs/namespacemembers.html @@ -106,7 +106,9 @@
      Here is a list of all documented namespace members with links to the namespaces they belong to:
      diff --git a/docs/namespacemembers_func.html b/docs/namespacemembers_func.html new file mode 100644 index 0000000..6d0ffd3 --- /dev/null +++ b/docs/namespacemembers_func.html @@ -0,0 +1,121 @@ + + + + + + + +Axle: Namespace Members + + + + + + + + + + + + + + + + + + +
      +
      +
      + + + + + + + +
      +
      Axle 0.1.0 +
      +
      A simple, lightweight C++ game framework built on top of Raylib.
      +
      + +   + + + + +
      +
      +
      + + + + +
      + +
      +
      +
      + +
      + +
      +
      + + +
      +
      +
      +
      +
      +
      Loading...
      +
      Searching...
      +
      No Matches
      +
      +
      +
      +
      + +
      +
      Here is a list of all documented namespace functions with links to the namespaces they belong to:
      +
      +
      + + + + diff --git a/docs/namespaces.html b/docs/namespaces.html index 980535b..98b59a7 100644 --- a/docs/namespaces.html +++ b/docs/namespaces.html @@ -111,7 +111,7 @@
      Here is a list of all documented namespaces with brief descriptions:
      [detail level 12]
      - +
       ▼NAxleThe main namespace of the Axle engine. All the features of the engine are contained within this namespace
       NExampleThe Example namespace contains ports of the examples from the Raylib library
       NExamplesThe Example namespace contains ports of the examples from the Raylib library
      diff --git a/docs/navtreedata.js b/docs/navtreedata.js index 87003e5..4110890 100644 --- a/docs/navtreedata.js +++ b/docs/navtreedata.js @@ -27,12 +27,27 @@ var NAVTREE = [ "Axle", "index.html", [ [ "Usage", "index.html#autotoc_md1", null ], [ "Documentation", "index.html#autotoc_md2", null ], - [ "Roadmap", "index.html#autotoc_md3", null ], - [ "Credits", "index.html#autotoc_md4", null ], + [ "Roadmap", "index.html#autotoc_md3", [ + [ "Features", "index.html#autotoc_md4", [ + [ "Primitives", "index.html#autotoc_md5", null ], + [ "Window and screen", "index.html#autotoc_md6", null ], + [ "Drawing and shaders", "index.html#autotoc_md7", null ], + [ "Input functions", "index.html#autotoc_md8", null ], + [ "Primitives", "index.html#autotoc_md9", null ], + [ "Textures", "index.html#autotoc_md10", null ], + [ "Text", "index.html#autotoc_md11", null ], + [ "3D", "index.html#autotoc_md12", null ], + [ "Audio", "index.html#autotoc_md13", null ], + [ "Utils and misc", "index.html#autotoc_md14", null ] + ] ], + [ "Examples", "index.html#autotoc_md15", null ] + ] ], + [ "Credits", "index.html#autotoc_md16", null ], [ "Namespaces", "namespaces.html", [ [ "Namespace List", "namespaces.html", "namespaces_dup" ], [ "Namespace Members", "namespacemembers.html", [ [ "All", "namespacemembers.html", null ], + [ "Functions", "namespacemembers_func.html", null ], [ "Enumerations", "namespacemembers_enum.html", null ] ] ] ] ], diff --git a/docs/navtreeindex0.js b/docs/navtreeindex0.js index 249c17b..569f488 100644 --- a/docs/navtreeindex0.js +++ b/docs/navtreeindex0.js @@ -60,9 +60,21 @@ var NAVTREEINDEX0 = "functions_func.html":[5,2,1], "index.html":[], "index.html#autotoc_md1":[0], +"index.html#autotoc_md10":[2,0,5], +"index.html#autotoc_md11":[2,0,6], +"index.html#autotoc_md12":[2,0,7], +"index.html#autotoc_md13":[2,0,8], +"index.html#autotoc_md14":[2,0,9], +"index.html#autotoc_md15":[2,1], +"index.html#autotoc_md16":[3], "index.html#autotoc_md2":[1], "index.html#autotoc_md3":[2], -"index.html#autotoc_md4":[3], +"index.html#autotoc_md4":[2,0], +"index.html#autotoc_md5":[2,0,0], +"index.html#autotoc_md6":[2,0,1], +"index.html#autotoc_md7":[2,0,2], +"index.html#autotoc_md8":[2,0,3], +"index.html#autotoc_md9":[2,0,4], "namespace_axle.html":[4,0,0], "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8":[4,0,0,3], "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a0375de91b1558838e15231ca2a939f84":[4,0,0,3,11], @@ -90,9 +102,12 @@ var NAVTREEINDEX0 = "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8ac634ffea7195608364671ac52ee59a61":[4,0,0,3,24], "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8ade1f378f72c71113be9329a741547c8b":[4,0,0,3,20], "namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8aec9c138095a352a9b7ef9ca5363b14d9":[4,0,0,3,15], -"namespace_axle_1_1_example.html":[4,0,0,0], +"namespace_axle_1_1_examples.html":[4,0,0,0], +"namespace_axle_1_1_examples.html#a731085a0d1039cffe4b9bf6e63f7690d":[4,0,0,0,1], +"namespace_axle_1_1_examples.html#aad61ebdcb0a57c9108ed77ed607844b6":[4,0,0,0,0], "namespacemembers.html":[4,1,0], -"namespacemembers_enum.html":[4,1,1], +"namespacemembers_enum.html":[4,1,2], +"namespacemembers_func.html":[4,1,1], "namespaces.html":[4,0], "pages.html":[] }; diff --git a/docs/search/all_0.js b/docs/search/all_0.js index da3c814..4d7728a 100644 --- a/docs/search/all_0.js +++ b/docs/search/all_0.js @@ -1,6 +1,4 @@ var searchData= [ - ['axle_0',['Axle',['../namespace_axle.html',1,'']]], - ['axle_1',['axle',['../index.html',1,'']]], - ['axle_3a_3aexample_2',['Example',['../namespace_axle_1_1_example.html',1,'Axle']]] + ['3d_0',['3D',['../index.html#autotoc_md12',1,'']]] ]; diff --git a/docs/search/all_1.js b/docs/search/all_1.js index a9aa2ac..2f788ba 100644 --- a/docs/search/all_1.js +++ b/docs/search/all_1.js @@ -1,9 +1,10 @@ var searchData= [ - ['begindrawing_0',['beginDrawing',['../class_axle_1_1_window.html#a49066f8583d4ae9e47308db6b615f6de',1,'Axle::Window']]], - ['beige_1',['BEIGE',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a837b1cca89daac46ffecac7bd4923779',1,'Axle']]], - ['black_2',['BLACK',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a08d0012388564e95c3b4a7407cf04965',1,'Axle']]], - ['blank_3',['BLANK',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a56f031dd03707d695f76c63ddbf40bd7',1,'Axle']]], - ['blue_4',['BLUE',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a1b3e1ee9bff86431dea6b181365ba65f',1,'Axle']]], - ['brown_5',['BROWN',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a493cacf6f6a2ae4798b319b8b9ba9488',1,'Axle']]] + ['and_20misc_0',['Utils and misc',['../index.html#autotoc_md14',1,'']]], + ['and_20screen_1',['Window and screen',['../index.html#autotoc_md6',1,'']]], + ['and_20shaders_2',['Drawing and shaders',['../index.html#autotoc_md7',1,'']]], + ['audio_3',['Audio',['../index.html#autotoc_md13',1,'']]], + ['axle_4',['Axle',['../namespace_axle.html',1,'']]], + ['axle_5',['axle',['../index.html',1,'']]], + ['axle_3a_3aexamples_6',['Examples',['../namespace_axle_1_1_examples.html',1,'Axle']]] ]; diff --git a/docs/search/all_10.js b/docs/search/all_10.js new file mode 100644 index 0000000..7bc6590 --- /dev/null +++ b/docs/search/all_10.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['usage_0',['Usage',['../index.html#autotoc_md1',1,'']]], + ['utils_20and_20misc_1',['Utils and misc',['../index.html#autotoc_md14',1,'']]] +]; diff --git a/docs/search/all_11.js b/docs/search/all_11.js new file mode 100644 index 0000000..3305e3c --- /dev/null +++ b/docs/search/all_11.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['violet_0',['VIOLET',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a3df9f09dbf0774e4edf801e77aea339b',1,'Axle']]] +]; diff --git a/docs/search/all_12.js b/docs/search/all_12.js new file mode 100644 index 0000000..3487b24 --- /dev/null +++ b/docs/search/all_12.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['white_0',['WHITE',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8ab5bf627e448384cf3a4c35121ca6008d',1,'Axle']]], + ['window_1',['Window',['../class_axle_1_1_window.html',1,'Axle::Window'],['../class_axle_1_1_window.html#a634fad92ac13508a1523aefb01884399',1,'Axle::Window::Window()']]], + ['window_20and_20screen_2',['Window and screen',['../index.html#autotoc_md6',1,'']]] +]; diff --git a/docs/search/all_13.js b/docs/search/all_13.js new file mode 100644 index 0000000..44fb84b --- /dev/null +++ b/docs/search/all_13.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['yellow_0',['YELLOW',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a8a568e5f41b7e4da88fe5c4a00aad34e',1,'Axle']]] +]; diff --git a/docs/search/all_2.js b/docs/search/all_2.js index 0ef5df8..4fc3bf9 100644 --- a/docs/search/all_2.js +++ b/docs/search/all_2.js @@ -1,8 +1,10 @@ var searchData= [ - ['clearbackground_0',['clearBackground',['../class_axle_1_1_window.html#abe8b1a9bb6defd5b2493f42fe6614e9b',1,'Axle::Window::clearBackground(unsigned char r, unsigned char g, unsigned char b, unsigned char a)'],['../class_axle_1_1_window.html#a6cdfe5c675be902e2baa223d28647ebb',1,'Axle::Window::clearBackground(Color color)']]], - ['close_1',['close',['../class_axle_1_1_window.html#a080610ed85c477a4e6f4822a1981c1fd',1,'Axle::Window']]], - ['color_2',['Color',['../class_axle_1_1_color.html',1,'Axle::Color'],['../class_axle_1_1_color.html#a7545bc794697e0f1faecf60cad629442',1,'Axle::Color::Color(unsigned char r, unsigned char g, unsigned char b, unsigned char a)'],['../class_axle_1_1_color.html#a6e4a7f4c3acb7354dafcd88061566b83',1,'Axle::Color::Color(unsigned char r, unsigned char g, unsigned char b)'],['../class_axle_1_1_color.html#a6646442de1e7fd752d28e46f233e1e45',1,'Axle::Color::Color()'],['../class_axle_1_1_color.html#ad3f5cd9c2ef5e65b50bee32b0778fe4f',1,'Axle::Color::Color(ColorPreset preset)']]], - ['colorpreset_3',['ColorPreset',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8',1,'Axle']]], - ['credits_4',['Credits',['../index.html#autotoc_md4',1,'']]] + ['basicwindow_0',['basicWindow',['../namespace_axle_1_1_examples.html#aad61ebdcb0a57c9108ed77ed607844b6',1,'Axle::Examples']]], + ['begindrawing_1',['beginDrawing',['../class_axle_1_1_window.html#a49066f8583d4ae9e47308db6b615f6de',1,'Axle::Window']]], + ['beige_2',['BEIGE',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a837b1cca89daac46ffecac7bd4923779',1,'Axle']]], + ['black_3',['BLACK',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a08d0012388564e95c3b4a7407cf04965',1,'Axle']]], + ['blank_4',['BLANK',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a56f031dd03707d695f76c63ddbf40bd7',1,'Axle']]], + ['blue_5',['BLUE',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a1b3e1ee9bff86431dea6b181365ba65f',1,'Axle']]], + ['brown_6',['BROWN',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a493cacf6f6a2ae4798b319b8b9ba9488',1,'Axle']]] ]; diff --git a/docs/search/all_3.js b/docs/search/all_3.js index 7aab1f5..05c4d16 100644 --- a/docs/search/all_3.js +++ b/docs/search/all_3.js @@ -1,10 +1,9 @@ var searchData= [ - ['darkblue_0',['DARKBLUE',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a06e2fdcb92e9bdbc9075c0d8365f453f',1,'Axle']]], - ['darkbrown_1',['DARKBROWN',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8ade1f378f72c71113be9329a741547c8b',1,'Axle']]], - ['darkgray_2',['DARKGRAY',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a0e1e6fddb3b7f6b796fd388b27dc02ab',1,'Axle']]], - ['darkgreen_3',['DARKGREEN',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a0375de91b1558838e15231ca2a939f84',1,'Axle']]], - ['darkpurple_4',['DARKPURPLE',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a2bfe1e1c35bb64f961908243773b9aa1',1,'Axle']]], - ['documentation_5',['Documentation',['../index.html#autotoc_md2',1,'']]], - ['drawtext_6',['drawText',['../class_axle_1_1_window.html#aa8eedc71ca796cc8e16759dc2e23aecf',1,'Axle::Window::drawText(const char *text, int x, int y, int fontSize, unsigned char r, unsigned char g, unsigned char b, unsigned char a)'],['../class_axle_1_1_window.html#ab4fe9de83e2c7aebe976ba1cab8575b9',1,'Axle::Window::drawText(const char *text, int x, int y, int fontSize, Color color)']]] + ['clearbackground_0',['clearBackground',['../class_axle_1_1_window.html#abe8b1a9bb6defd5b2493f42fe6614e9b',1,'Axle::Window::clearBackground(unsigned char r, unsigned char g, unsigned char b, unsigned char a)'],['../class_axle_1_1_window.html#a6cdfe5c675be902e2baa223d28647ebb',1,'Axle::Window::clearBackground(Color color)']]], + ['close_1',['close',['../class_axle_1_1_window.html#a080610ed85c477a4e6f4822a1981c1fd',1,'Axle::Window']]], + ['color_2',['Color',['../class_axle_1_1_color.html',1,'Axle::Color'],['../class_axle_1_1_color.html#a7545bc794697e0f1faecf60cad629442',1,'Axle::Color::Color(unsigned char r, unsigned char g, unsigned char b, unsigned char a)'],['../class_axle_1_1_color.html#a6e4a7f4c3acb7354dafcd88061566b83',1,'Axle::Color::Color(unsigned char r, unsigned char g, unsigned char b)'],['../class_axle_1_1_color.html#a6646442de1e7fd752d28e46f233e1e45',1,'Axle::Color::Color()'],['../class_axle_1_1_color.html#ad3f5cd9c2ef5e65b50bee32b0778fe4f',1,'Axle::Color::Color(ColorPreset preset)']]], + ['colorpreset_3',['ColorPreset',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8',1,'Axle']]], + ['credits_4',['Credits',['../index.html#autotoc_md16',1,'']]], + ['customexample_5',['customExample',['../namespace_axle_1_1_examples.html#a731085a0d1039cffe4b9bf6e63f7690d',1,'Axle::Examples']]] ]; diff --git a/docs/search/all_4.js b/docs/search/all_4.js index 80ce327..26a4f77 100644 --- a/docs/search/all_4.js +++ b/docs/search/all_4.js @@ -1,4 +1,11 @@ var searchData= [ - ['enddrawing_0',['endDrawing',['../class_axle_1_1_window.html#afe289de65b3d8fa69ee5838c0a47e0fc',1,'Axle::Window']]] + ['darkblue_0',['DARKBLUE',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a06e2fdcb92e9bdbc9075c0d8365f453f',1,'Axle']]], + ['darkbrown_1',['DARKBROWN',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8ade1f378f72c71113be9329a741547c8b',1,'Axle']]], + ['darkgray_2',['DARKGRAY',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a0e1e6fddb3b7f6b796fd388b27dc02ab',1,'Axle']]], + ['darkgreen_3',['DARKGREEN',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a0375de91b1558838e15231ca2a939f84',1,'Axle']]], + ['darkpurple_4',['DARKPURPLE',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a2bfe1e1c35bb64f961908243773b9aa1',1,'Axle']]], + ['documentation_5',['Documentation',['../index.html#autotoc_md2',1,'']]], + ['drawing_20and_20shaders_6',['Drawing and shaders',['../index.html#autotoc_md7',1,'']]], + ['drawtext_7',['drawText',['../class_axle_1_1_window.html#aa8eedc71ca796cc8e16759dc2e23aecf',1,'Axle::Window::drawText(const char *text, int x, int y, int fontSize, unsigned char r, unsigned char g, unsigned char b, unsigned char a)'],['../class_axle_1_1_window.html#ab4fe9de83e2c7aebe976ba1cab8575b9',1,'Axle::Window::drawText(const char *text, int x, int y, int fontSize, Color color)']]] ]; diff --git a/docs/search/all_5.js b/docs/search/all_5.js index d65d427..60287c5 100644 --- a/docs/search/all_5.js +++ b/docs/search/all_5.js @@ -1,11 +1,5 @@ var searchData= [ - ['geta_0',['getA',['../class_axle_1_1_color.html#a064cba1497d3670aa855f96499811af3',1,'Axle::Color']]], - ['getb_1',['getB',['../class_axle_1_1_color.html#ab3d322199c63475d535ac7db3438c6f0',1,'Axle::Color']]], - ['getg_2',['getG',['../class_axle_1_1_color.html#a2a021f25beddda204d2729273a14a081',1,'Axle::Color']]], - ['getr_3',['getR',['../class_axle_1_1_color.html#a097644458b7f8559c460582a22e3631c',1,'Axle::Color']]], - ['gettargetfps_4',['getTargetFPS',['../class_axle_1_1_window.html#addd5cd7eff7b6a86bebf39b1d3f63cf8',1,'Axle::Window']]], - ['gold_5',['GOLD',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a2c0898822ab3baf7f93bea86648adb26',1,'Axle']]], - ['gray_6',['GRAY',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a48bf014c704c9eaae100a98006a37bf7',1,'Axle']]], - ['green_7',['GREEN',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a9de0e5dd94e861317e74964bed179fa0',1,'Axle']]] + ['enddrawing_0',['endDrawing',['../class_axle_1_1_window.html#afe289de65b3d8fa69ee5838c0a47e0fc',1,'Axle::Window']]], + ['examples_1',['Examples',['../index.html#autotoc_md15',1,'']]] ]; diff --git a/docs/search/all_6.js b/docs/search/all_6.js index d63cedd..f9d9dbb 100644 --- a/docs/search/all_6.js +++ b/docs/search/all_6.js @@ -1,5 +1,5 @@ var searchData= [ - ['lightgray_0',['LIGHTGRAY',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a046c542c1879961609e6d616fdf383f6',1,'Axle']]], - ['lime_1',['LIME',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a2cf3a2965e9238d68222de372e70e935',1,'Axle']]] + ['features_0',['Features',['../index.html#autotoc_md4',1,'']]], + ['functions_1',['Input functions',['../index.html#autotoc_md8',1,'']]] ]; diff --git a/docs/search/all_7.js b/docs/search/all_7.js index 0dd593f..d65d427 100644 --- a/docs/search/all_7.js +++ b/docs/search/all_7.js @@ -1,5 +1,11 @@ var searchData= [ - ['magenta_0',['MAGENTA',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8ac634ffea7195608364671ac52ee59a61',1,'Axle']]], - ['maroon_1',['MAROON',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8ab0459ecc882a7ea7cc98dd4275d5d181',1,'Axle']]] + ['geta_0',['getA',['../class_axle_1_1_color.html#a064cba1497d3670aa855f96499811af3',1,'Axle::Color']]], + ['getb_1',['getB',['../class_axle_1_1_color.html#ab3d322199c63475d535ac7db3438c6f0',1,'Axle::Color']]], + ['getg_2',['getG',['../class_axle_1_1_color.html#a2a021f25beddda204d2729273a14a081',1,'Axle::Color']]], + ['getr_3',['getR',['../class_axle_1_1_color.html#a097644458b7f8559c460582a22e3631c',1,'Axle::Color']]], + ['gettargetfps_4',['getTargetFPS',['../class_axle_1_1_window.html#addd5cd7eff7b6a86bebf39b1d3f63cf8',1,'Axle::Window']]], + ['gold_5',['GOLD',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a2c0898822ab3baf7f93bea86648adb26',1,'Axle']]], + ['gray_6',['GRAY',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a48bf014c704c9eaae100a98006a37bf7',1,'Axle']]], + ['green_7',['GREEN',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a9de0e5dd94e861317e74964bed179fa0',1,'Axle']]] ]; diff --git a/docs/search/all_8.js b/docs/search/all_8.js index 0bee8f2..1f7fbbb 100644 --- a/docs/search/all_8.js +++ b/docs/search/all_8.js @@ -1,4 +1,4 @@ var searchData= [ - ['orange_0',['ORANGE',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a5b6490317b6f7270bc3ab5ffd07c1f52',1,'Axle']]] + ['input_20functions_0',['Input functions',['../index.html#autotoc_md8',1,'']]] ]; diff --git a/docs/search/all_9.js b/docs/search/all_9.js index 7f850ec..d63cedd 100644 --- a/docs/search/all_9.js +++ b/docs/search/all_9.js @@ -1,5 +1,5 @@ var searchData= [ - ['pink_0',['PINK',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a2536bd3910cf3069e2cd184e614ea97d',1,'Axle']]], - ['purple_1',['PURPLE',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8aec9c138095a352a9b7ef9ca5363b14d9',1,'Axle']]] + ['lightgray_0',['LIGHTGRAY',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a046c542c1879961609e6d616fdf383f6',1,'Axle']]], + ['lime_1',['LIME',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a2cf3a2965e9238d68222de372e70e935',1,'Axle']]] ]; diff --git a/docs/search/all_a.js b/docs/search/all_a.js index bbd0085..6627d3f 100644 --- a/docs/search/all_a.js +++ b/docs/search/all_a.js @@ -1,5 +1,6 @@ var searchData= [ - ['red_0',['RED',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8aa2d9547b5d3dd9f05984475f7c926da0',1,'Axle']]], - ['roadmap_1',['Roadmap',['../index.html#autotoc_md3',1,'']]] + ['magenta_0',['MAGENTA',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8ac634ffea7195608364671ac52ee59a61',1,'Axle']]], + ['maroon_1',['MAROON',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8ab0459ecc882a7ea7cc98dd4275d5d181',1,'Axle']]], + ['misc_2',['Utils and misc',['../index.html#autotoc_md14',1,'']]] ]; diff --git a/docs/search/all_b.js b/docs/search/all_b.js index 445a4eb..0bee8f2 100644 --- a/docs/search/all_b.js +++ b/docs/search/all_b.js @@ -1,11 +1,4 @@ var searchData= [ - ['seta_0',['setA',['../class_axle_1_1_color.html#a369d4b960fd5733e44ff60ee7fb3b096',1,'Axle::Color']]], - ['setb_1',['setB',['../class_axle_1_1_color.html#a746eef5195cb4ae6d52e5751520ec1ae',1,'Axle::Color']]], - ['setcolor_2',['setColor',['../class_axle_1_1_color.html#adc025e1c3a9a6a4088c6383139d4e280',1,'Axle::Color::setColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a)'],['../class_axle_1_1_color.html#a94f0e9306386fcf5d7c257ca26a20b75',1,'Axle::Color::setColor(ColorPreset preset)']]], - ['setg_3',['setG',['../class_axle_1_1_color.html#ad127d23c4f569559b5b32144c10e64c5',1,'Axle::Color']]], - ['setr_4',['setR',['../class_axle_1_1_color.html#a5a6c886ebb2bb8977f4479f88eea7e74',1,'Axle::Color']]], - ['settargetfps_5',['setTargetFPS',['../class_axle_1_1_window.html#af755b6e55182114423cdbe94f27401c0',1,'Axle::Window']]], - ['shouldclose_6',['shouldClose',['../class_axle_1_1_window.html#ae5a705f88e46ee5cba60dc960528427c',1,'Axle::Window']]], - ['skyblue_7',['SKYBLUE',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a0c82ca04b8123fae4a3d14d3ac9dbbd5',1,'Axle']]] + ['orange_0',['ORANGE',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a5b6490317b6f7270bc3ab5ffd07c1f52',1,'Axle']]] ]; diff --git a/docs/search/all_c.js b/docs/search/all_c.js index 54feff6..903037b 100644 --- a/docs/search/all_c.js +++ b/docs/search/all_c.js @@ -1,4 +1,6 @@ var searchData= [ - ['usage_0',['Usage',['../index.html#autotoc_md1',1,'']]] + ['pink_0',['PINK',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a2536bd3910cf3069e2cd184e614ea97d',1,'Axle']]], + ['primitives_1',['Primitives',['../index.html#autotoc_md5',1,'Primitives'],['../index.html#autotoc_md9',1,'Primitives']]], + ['purple_2',['PURPLE',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8aec9c138095a352a9b7ef9ca5363b14d9',1,'Axle']]] ]; diff --git a/docs/search/all_d.js b/docs/search/all_d.js index 3305e3c..bbd0085 100644 --- a/docs/search/all_d.js +++ b/docs/search/all_d.js @@ -1,4 +1,5 @@ var searchData= [ - ['violet_0',['VIOLET',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a3df9f09dbf0774e4edf801e77aea339b',1,'Axle']]] + ['red_0',['RED',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8aa2d9547b5d3dd9f05984475f7c926da0',1,'Axle']]], + ['roadmap_1',['Roadmap',['../index.html#autotoc_md3',1,'']]] ]; diff --git a/docs/search/all_e.js b/docs/search/all_e.js index f5152b8..3285972 100644 --- a/docs/search/all_e.js +++ b/docs/search/all_e.js @@ -1,5 +1,13 @@ var searchData= [ - ['white_0',['WHITE',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8ab5bf627e448384cf3a4c35121ca6008d',1,'Axle']]], - ['window_1',['Window',['../class_axle_1_1_window.html',1,'Axle::Window'],['../class_axle_1_1_window.html#a634fad92ac13508a1523aefb01884399',1,'Axle::Window::Window()']]] + ['screen_0',['Window and screen',['../index.html#autotoc_md6',1,'']]], + ['seta_1',['setA',['../class_axle_1_1_color.html#a369d4b960fd5733e44ff60ee7fb3b096',1,'Axle::Color']]], + ['setb_2',['setB',['../class_axle_1_1_color.html#a746eef5195cb4ae6d52e5751520ec1ae',1,'Axle::Color']]], + ['setcolor_3',['setColor',['../class_axle_1_1_color.html#adc025e1c3a9a6a4088c6383139d4e280',1,'Axle::Color::setColor(unsigned char r, unsigned char g, unsigned char b, unsigned char a)'],['../class_axle_1_1_color.html#a94f0e9306386fcf5d7c257ca26a20b75',1,'Axle::Color::setColor(ColorPreset preset)']]], + ['setg_4',['setG',['../class_axle_1_1_color.html#ad127d23c4f569559b5b32144c10e64c5',1,'Axle::Color']]], + ['setr_5',['setR',['../class_axle_1_1_color.html#a5a6c886ebb2bb8977f4479f88eea7e74',1,'Axle::Color']]], + ['settargetfps_6',['setTargetFPS',['../class_axle_1_1_window.html#af755b6e55182114423cdbe94f27401c0',1,'Axle::Window']]], + ['shaders_7',['Drawing and shaders',['../index.html#autotoc_md7',1,'']]], + ['shouldclose_8',['shouldClose',['../class_axle_1_1_window.html#ae5a705f88e46ee5cba60dc960528427c',1,'Axle::Window']]], + ['skyblue_9',['SKYBLUE',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a0c82ca04b8123fae4a3d14d3ac9dbbd5',1,'Axle']]] ]; diff --git a/docs/search/all_f.js b/docs/search/all_f.js index 44fb84b..833735c 100644 --- a/docs/search/all_f.js +++ b/docs/search/all_f.js @@ -1,4 +1,5 @@ var searchData= [ - ['yellow_0',['YELLOW',['../namespace_axle.html#a8a8f7110cf295b29d4bfbcbd7b131ca8a8a568e5f41b7e4da88fe5c4a00aad34e',1,'Axle']]] + ['text_0',['Text',['../index.html#autotoc_md11',1,'']]], + ['textures_1',['Textures',['../index.html#autotoc_md10',1,'']]] ]; diff --git a/docs/search/files_0.js b/docs/search/files_0.js new file mode 100644 index 0000000..dfebb0d --- /dev/null +++ b/docs/search/files_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['axle_2eh_0',['axle.h',['../axle_8h.html',1,'']]] +]; diff --git a/docs/search/files_1.js b/docs/search/files_1.js new file mode 100644 index 0000000..a36489e --- /dev/null +++ b/docs/search/files_1.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['basicwindow_2ecpp_0',['basicWindow.cpp',['../basic_window_8cpp.html',1,'']]] +]; diff --git a/docs/search/files_2.js b/docs/search/files_2.js new file mode 100644 index 0000000..552f045 --- /dev/null +++ b/docs/search/files_2.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['color_2ecpp_0',['color.cpp',['../color_8cpp.html',1,'']]], + ['color_2eh_1',['color.h',['../color_8h.html',1,'']]], + ['customexample_2ecpp_2',['customExample.cpp',['../custom_example_8cpp.html',1,'']]] +]; diff --git a/docs/search/files_3.js b/docs/search/files_3.js new file mode 100644 index 0000000..a08d35d --- /dev/null +++ b/docs/search/files_3.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['examples_2eh_0',['examples.h',['../examples_8h.html',1,'']]] +]; diff --git a/docs/search/files_4.js b/docs/search/files_4.js new file mode 100644 index 0000000..4accdc1 --- /dev/null +++ b/docs/search/files_4.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['readme_2emd_0',['README.md',['../_r_e_a_d_m_e_8md.html',1,'']]] +]; diff --git a/docs/search/files_5.js b/docs/search/files_5.js new file mode 100644 index 0000000..9ce1961 --- /dev/null +++ b/docs/search/files_5.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['window_2ecpp_0',['window.cpp',['../window_8cpp.html',1,'']]], + ['window_2eh_1',['window.h',['../window_8h.html',1,'']]] +]; diff --git a/docs/search/functions_0.js b/docs/search/functions_0.js index 5ebd88d..99ca2cf 100644 --- a/docs/search/functions_0.js +++ b/docs/search/functions_0.js @@ -1,4 +1,5 @@ var searchData= [ - ['begindrawing_0',['beginDrawing',['../class_axle_1_1_window.html#a49066f8583d4ae9e47308db6b615f6de',1,'Axle::Window']]] + ['basicwindow_0',['basicWindow',['../namespace_axle_1_1_examples.html#aad61ebdcb0a57c9108ed77ed607844b6',1,'Axle::Examples']]], + ['begindrawing_1',['beginDrawing',['../class_axle_1_1_window.html#a49066f8583d4ae9e47308db6b615f6de',1,'Axle::Window']]] ]; diff --git a/docs/search/functions_1.js b/docs/search/functions_1.js index 6cca118..52f0a43 100644 --- a/docs/search/functions_1.js +++ b/docs/search/functions_1.js @@ -2,5 +2,6 @@ var searchData= [ ['clearbackground_0',['clearBackground',['../class_axle_1_1_window.html#abe8b1a9bb6defd5b2493f42fe6614e9b',1,'Axle::Window::clearBackground(unsigned char r, unsigned char g, unsigned char b, unsigned char a)'],['../class_axle_1_1_window.html#a6cdfe5c675be902e2baa223d28647ebb',1,'Axle::Window::clearBackground(Color color)']]], ['close_1',['close',['../class_axle_1_1_window.html#a080610ed85c477a4e6f4822a1981c1fd',1,'Axle::Window']]], - ['color_2',['Color',['../class_axle_1_1_color.html#a7545bc794697e0f1faecf60cad629442',1,'Axle::Color::Color(unsigned char r, unsigned char g, unsigned char b, unsigned char a)'],['../class_axle_1_1_color.html#a6e4a7f4c3acb7354dafcd88061566b83',1,'Axle::Color::Color(unsigned char r, unsigned char g, unsigned char b)'],['../class_axle_1_1_color.html#a6646442de1e7fd752d28e46f233e1e45',1,'Axle::Color::Color()'],['../class_axle_1_1_color.html#ad3f5cd9c2ef5e65b50bee32b0778fe4f',1,'Axle::Color::Color(ColorPreset preset)']]] + ['color_2',['Color',['../class_axle_1_1_color.html#a7545bc794697e0f1faecf60cad629442',1,'Axle::Color::Color(unsigned char r, unsigned char g, unsigned char b, unsigned char a)'],['../class_axle_1_1_color.html#a6e4a7f4c3acb7354dafcd88061566b83',1,'Axle::Color::Color(unsigned char r, unsigned char g, unsigned char b)'],['../class_axle_1_1_color.html#a6646442de1e7fd752d28e46f233e1e45',1,'Axle::Color::Color()'],['../class_axle_1_1_color.html#ad3f5cd9c2ef5e65b50bee32b0778fe4f',1,'Axle::Color::Color(ColorPreset preset)']]], + ['customexample_3',['customExample',['../namespace_axle_1_1_examples.html#a731085a0d1039cffe4b9bf6e63f7690d',1,'Axle::Examples']]] ]; diff --git a/docs/search/namespaces_0.js b/docs/search/namespaces_0.js index 39a7234..87a5ef2 100644 --- a/docs/search/namespaces_0.js +++ b/docs/search/namespaces_0.js @@ -1,5 +1,5 @@ var searchData= [ ['axle_0',['Axle',['../namespace_axle.html',1,'']]], - ['axle_3a_3aexample_1',['Example',['../namespace_axle_1_1_example.html',1,'Axle']]] + ['axle_3a_3aexamples_1',['Examples',['../namespace_axle_1_1_examples.html',1,'Axle']]] ]; diff --git a/docs/search/searchdata.js b/docs/search/searchdata.js index f286e16..4d30f8e 100644 --- a/docs/search/searchdata.js +++ b/docs/search/searchdata.js @@ -1,6 +1,6 @@ var indexSectionsWithContent = { - 0: "abcdeglmoprsuvwy", + 0: "3abcdefgilmoprstuvwy", 1: "cw", 2: "a", 3: "bcdegsw", diff --git a/docs/window_8cpp.html b/docs/window_8cpp.html new file mode 100644 index 0000000..ee99b03 --- /dev/null +++ b/docs/window_8cpp.html @@ -0,0 +1,133 @@ + + + + + + + +Axle: axle/src/window.cpp File Reference + + + + + + + + + + + + + + + + + + +
      +
      +
      + + + + + + + +
      +
      Axle 0.1.0 +
      +
      A simple, lightweight C++ game framework built on top of Raylib.
      +
      + +   + + + + +
      +
      +
      + + + + +
      + +
      +
      +
      + +
      + +
      +
      + + +
      +
      +
      +
      +
      +
      Loading...
      +
      Searching...
      +
      No Matches
      +
      +
      +
      +
      + +
      +
      +Namespaces
      +
      window.cpp File Reference
      +
      +
      +
      #include "window.h"
      +#include "raylib.h"
      +#include "color.h"
      +
      + + + + +

      +Namespaces

      namespace  Axle
       The main namespace of the Axle engine. All the features of the engine are contained within this namespace.
       
      +
      +
      + + + + diff --git a/docs/window_8h.html b/docs/window_8h.html new file mode 100644 index 0000000..3a576ea --- /dev/null +++ b/docs/window_8h.html @@ -0,0 +1,138 @@ + + + + + + + +Axle: axle/include/window.h File Reference + + + + + + + + + + + + + + + + + + +
      +
      +
      + + + + + + + +
      +
      Axle 0.1.0 +
      +
      A simple, lightweight C++ game framework built on top of Raylib.
      +
      + +   + + + + +
      +
      +
      + + + + +
      + +
      +
      +
      + +
      + +
      +
      + + +
      +
      +
      +
      +
      +
      Loading...
      +
      Searching...
      +
      No Matches
      +
      +
      +
      +
      + +
      +
      +Classes | +Namespaces
      +
      window.h File Reference
      +
      +
      +
      #include "color.h"
      +
      + + + + +

      +Classes

      class  Axle::Window
       Represents a window that can be created and managed by the engine. More...
       
      + + + + +

      +Namespaces

      namespace  Axle
       The main namespace of the Axle engine. All the features of the engine are contained within this namespace.
       
      +
      +
      + + + + diff --git a/docs/window_8h.js b/docs/window_8h.js new file mode 100644 index 0000000..253dd03 --- /dev/null +++ b/docs/window_8h.js @@ -0,0 +1,4 @@ +var window_8h = +[ + [ "Axle::Window", "class_axle_1_1_window.html", "class_axle_1_1_window" ] +]; \ No newline at end of file diff --git a/include/axle.h b/include/axle.h index 97cc331..3b56a66 100644 --- a/include/axle.h +++ b/include/axle.h @@ -14,9 +14,20 @@ namespace Axle /** * @brief The Example namespace contains ports of the examples from the Raylib library. * - * The original examples can be found at https://www.raylib.com/examples.html + * To run an example, simply call the corresponding function from this namespace : + * + *```cpp + * #include + * int main() + * { + * Axle::Examples::basicWindow(); + * return 0; + * } + *``` + * + * @note The original examples can be found at https://www.raylib.com/examples.html */ -namespace Axle::Example +namespace Axle::Examples { } diff --git a/include/examples.h b/include/examples.h index 2f95380..6539b51 100644 --- a/include/examples.h +++ b/include/examples.h @@ -3,9 +3,21 @@ namespace Axle::Examples { + /** + * @brief Basic window example + * + * This example creates a basic window with a title and a size. + * + * A basic game loop is also implemented, which will simply keep the window open until the user closes it, clear the background to a color, and then draw some text. + */ void basicWindow(); - void custom(); + /** + * @brief Custom example + * + * This example is a custom example that you can use to test your own code. + */ + void customExample(); } #endif // AXLE_EXAMPLES_H diff --git a/src/examples/custom.cpp b/src/examples/customExample.cpp similarity index 85% rename from src/examples/custom.cpp rename to src/examples/customExample.cpp index f4a2e2e..a7c5a3a 100644 --- a/src/examples/custom.cpp +++ b/src/examples/customExample.cpp @@ -1,9 +1,9 @@ -#include "axle.h" #include +#include "axle.h" namespace Axle::Examples { - void custom() + void customExample() { Axle::Window window(800, 450, "Axle example - custom"); window.setTargetFPS(60); @@ -12,4 +12,4 @@ namespace Axle::Examples std::cout << "Target FPS: " << window.getTargetFPS() << std::endl; window.close(); } -} +} // namespace Axle::Examples