kbz_8/MacroLibX
1
0
Fork 0
mirror of https://github.com/seekrs/MacroLibX.git synced 2026-01-11 14:43:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

added show and hide cursor support, fixing technological debt from original mlx, fixed missaligned comments in mlx.h

Browse Source
This commit is contained in:
kbz_8
2024-10-31 15:16:01 +01:00
parent 6669d78323
commit a662427097
7 changed files with 205 additions and 205 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -97,6 +97,9 @@ And you can enjoy your project
### 📦 Compile mode
By default the mlx is built in release mode but you can switch to debug by using `make DEBUG=true`.
### 🦺 Safety
MacroLibX has a strong safety support, mainly by checking every pointer that you pass to it. But this safety has a cost that can be avoided by enabling `DISABLE_ALL_SAFETIES=true` before compiling but don't be afraid to recieve segmentation faults from the mlx.
### 🛠️ Set the toolchain
If you want to use `GCC` to build the mlx you can use `make TOOLCHAIN=gcc`

3
XMAKE_BUILD.md
View File

@@ -10,6 +10,9 @@ Just as the Makfile build system, you can configure how xmake should build the M
### 📦 Compile mode
You can configure xmake to build the mlx in debug mode or in release mode (release mode is enabled by default). To do so you can use `xmake config --mode=debug` or `xmake config --mode=release`.
### 🦺 Safety
MacroLibX has a strong safety support, mainly by checking every pointer that you pass to it. But this safety has a cost that can be avoided by enabling `xmake config --disable_all_safeties=y` before compiling but don't be afraid to recieve segmentation faults from the mlx.
### 🛠️ Set the toolchain
To change the compilation toolchain you can use `xmake config --toolchain=[gcc|clang|...]`

70
includes/mlx.h
View File

@@ -6,7 +6,7 @@
/* By: maldavid <contact@kbz8.me> +#+ +:+ +#+ */
/* +#+#+#+#+#+ +#+ */
/* Created: 2022/10/04 16:56:35 by maldavid #+# #+# */
/* Updated: 2024/10/22 11:56:44 by maldavid ### ########.fr */
/* Updated: 2024/10/31 15:15:24 by maldavid ### ########.fr */
/* */
/* ************************************************************************** */
@@ -72,9 +72,9 @@ MLX_API void mlx_set_window_position(void *mlx, void *win, int x, int y);
* @param f The function
* @param param Param to give to the function passed
*
* @return (int) Always return 0, made this to copy the behaviour of the original MLX
* @return (void)
*/
MLX_API int mlx_loop_hook(void* mlx, int (*f)(void*), void* param);
MLX_API void mlx_loop_hook(void* mlx, int (*f)(void*), void* param);
/**
@@ -82,9 +82,9 @@ MLX_API int mlx_loop_hook(void* mlx, int (*f)(void*), void* param);
*
* @param mlx Internal MLX application
*
* @return (int) Always return 0, made this to copy the behaviour of the original MLX
* @return (void)
*/
MLX_API int mlx_loop(void* mlx);
MLX_API void mlx_loop(void* mlx);
/**
@@ -92,25 +92,25 @@ MLX_API int mlx_loop(void* mlx);
*
* @param mlx Internal MLX application
*
* @return (int) Always return 0, made this to copy the behaviour of the original MLX
* @return (void)
*/
MLX_API int mlx_loop_end(void* mlx);
MLX_API void mlx_loop_end(void* mlx);
/**
* @brief Shows mouse cursor
*
* @return (int) Always return 0, made this to copy the behaviour of the original MLX
* @return (void)
*/
MLX_API int mlx_mouse_show();
MLX_API void mlx_mouse_show();
/**
* @brief Hides mouse cursor
*
* @return (int) Always return 0, made this to copy the behaviour of the original MLX
* @return (void)
*/
MLX_API int mlx_mouse_hide();
MLX_API void mlx_mouse_hide();
/**
@@ -121,9 +121,9 @@ MLX_API int mlx_mouse_hide();
* @param x X coordinate
* @param y Y coordinate
*
* @return (int) Always return 0, made this to copy the behaviour of the original MLX
* @return (void)
*/
MLX_API int mlx_mouse_move(void* mlx, void* win, int x, int y);
MLX_API void mlx_mouse_move(void* mlx, void* win, int x, int y);
/**
@@ -133,9 +133,9 @@ MLX_API int mlx_mouse_move(void* mlx, void* win, int x, int y);
* @param x Get x coordinate
* @param y Get y coordinate
*
* @return (int) Always return 0, made this to copy the behaviour of the original MLX
* @return (void)
*/
MLX_API int mlx_mouse_get_pos(void* mlx, int* x, int* y);
MLX_API void mlx_mouse_get_pos(void* mlx, int* x, int* y);
/**
@@ -147,9 +147,9 @@ MLX_API int mlx_mouse_get_pos(void* mlx, int* x, int* y);
* @param f Function to be executed
* @param param Parameter given to the function
*
* @return (int) Always return 0, made this to copy the behaviour of the original MLX
* @return (void)
*/
MLX_API int mlx_on_event(void* mlx, void* win, mlx_event_type event, int (*f)(int, void*), void* param);
MLX_API void mlx_on_event(void* mlx, void* win, mlx_event_type event, int (*f)(int, void*), void* param);
/**
@@ -164,9 +164,9 @@ MLX_API int mlx_on_event(void* mlx, void* win, mlx_event_type event, int (*f)(in
* Note : If your're reading pixel colors from an image, don't forget to shift them
* one byte to the right as image pixels are encoded as 0xRRGGBBAA and pixel put takes 0xAARRGGBB.
*
* @return (int) Always return 0, made this to copy the behaviour of the original MLX
* @return (void)
*/
MLX_API int mlx_pixel_put(void* mlx, void* win, int x, int y, int color);
MLX_API void mlx_pixel_put(void* mlx, void* win, int x, int y, int color);
/**
@@ -233,9 +233,9 @@ MLX_API void mlx_set_image_pixel(void* mlx, void* img, int x, int y, int color);
* @param x X coordinate
* @param y Y coordinate
*
* @return (int) Always return 0, made this to copy the behaviour of the original MLX
* @return (void)
*/
MLX_API int mlx_put_image_to_window(void* mlx, void* win, void* img, int x, int y);
MLX_API void mlx_put_image_to_window(void* mlx, void* win, void* img, int x, int y);
/**
@@ -244,9 +244,9 @@ MLX_API int mlx_put_image_to_window(void* mlx, void* win, void* img, int x, int
* @param mlx Internal MLX application
* @param img Internal image
*
* @return (int) Always return 0, made this to copy the behaviour of the original MLX
* @return (void)
*/
MLX_API int mlx_destroy_image(void* mlx, void* img);
MLX_API void mlx_destroy_image(void* mlx, void* img);
/**
@@ -298,9 +298,9 @@ MLX_API void* mlx_bmp_file_to_image(void* mlx, char* filename, int* width, int*
* @param color Color of the pixel (coded on 4 bytes in an int, 0xAARRGGBB)
* @param str Text to put
*
* @return (int) Always return 0, made this to copy the behaviour of the original MLX
* @return (void)
*/
MLX_API int mlx_string_put(void* mlx, void* win, int x, int y, int color, char* str);
MLX_API void mlx_string_put(void* mlx, void* win, int x, int y, int color, char* str);
/**
@@ -334,9 +334,9 @@ MLX_API void mlx_set_font_scale(void* mlx, char* filepath, float scale);
* @param mlx Internal MLX application
* @param win Internal window
*
* @return (int) Always return 0, made this to copy the behaviour of the original MLX
* @return (void)
*/
MLX_API int mlx_clear_window(void* mlx, void* win);
MLX_API void mlx_clear_window(void* mlx, void* win);
/**
@@ -345,18 +345,18 @@ MLX_API int mlx_clear_window(void* mlx, void* win);
* @param mlx Internal MLX application
* @param win Internal window
*
* @return (int) Always return 0, made this to copy the behaviour of the original MLX
* @return (void)
*/
MLX_API int mlx_destroy_window(void* mlx, void* win);
MLX_API void mlx_destroy_window(void* mlx, void* win);
/**
* @brief Destroy internal MLX application
*
* @param mlx Internal MLX application
*
* @return (int) Always return 0, made this to copy the behaviour of the original MLX
* @return (void)
*/
MLX_API int mlx_destroy_display(void* mlx);
MLX_API void mlx_destroy_display(void* mlx);
/**
@@ -367,9 +367,9 @@ MLX_API int mlx_destroy_display(void* mlx);
* @param w Get width size
* @param h Get height size
*
* @return (int) Always return 0, made this to copy the behaviour of the original MLX
* @return (void)
*/
MLX_API int mlx_get_screens_size(void* mlx, void* win, int* w, int* h);
MLX_API void mlx_get_screens_size(void* mlx, void* win, int* w, int* h);
/**
@@ -378,9 +378,9 @@ MLX_API int mlx_get_screens_size(void* mlx, void* win, int* w, int* h);
* @param mlx Internal MLX application
* @param fps The FPS cap
*
* @return (int) Always return 0
* @return (void)
*/
MLX_API int mlx_set_fps_goal(void* mlx, int fps);
MLX_API void mlx_set_fps_goal(void* mlx, int fps);
#ifdef __cplusplus
}

2
runtime/Includes/Core/Application.inl
View File

@@ -137,7 +137,7 @@ namespace mlx
CHECK_WINDOW_PTR(win);
if(str == nullptr)
{
Error("wrong text (NULL)");
Error("invalid text (NULL)");
return;
}
if(std::strlen(str) == 0)

3
runtime/Includes/Core/SDLManager.h
View File

@@ -22,6 +22,9 @@ namespace mlx
void GetScreenSizeWindowIsOn(Handle window, int* x, int* y) const noexcept;
void SetWindowPosition(Handle window, int x, int y) const noexcept;
static void HideCursor() noexcept;
static void ShowCursor() noexcept;
std::int32_t GetX() const noexcept;
std::int32_t GetY() const noexcept;
std::int32_t GetXRel() const noexcept;

61
runtime/Sources/Core/Bridge.cpp
View File

@@ -1,6 +1,7 @@
#include <PreCompiled.h>
#include <Core/Application.h>
#include <Core/SDLManager.h>
#include <Renderer/RenderCore.h>
#include <mlx.h>
#include <Core/Memory.h>
@@ -54,52 +55,46 @@ extern "C"
{
MLX_CHECK_APPLICATION_POINTER(mlx);
static_cast<mlx::Application*>(mlx)->LoopHook(f, param);
return 0;
}
int mlx_loop(void* mlx)
void mlx_loop(void* mlx)
{
MLX_CHECK_APPLICATION_POINTER(mlx);
static_cast<mlx::Application*>(mlx)->Run();
return 0;
}
int mlx_loop_end(void* mlx)
void mlx_loop_end(void* mlx)
{
MLX_CHECK_APPLICATION_POINTER(mlx);
static_cast<mlx::Application*>(mlx)->LoopEnd();
return 0;
}
int mlx_mouse_show()
void mlx_mouse_show()
{
return 0;
mlx::SDLManager::ShowCursor();
}
int mlx_mouse_hide()
void mlx_mouse_hide()
{
return 0;
mlx::SDLManager::HideCursor();
}
int mlx_mouse_move(void* mlx, void* win, int x, int y)
void mlx_mouse_move(void* mlx, void* win, int x, int y)
{
MLX_CHECK_APPLICATION_POINTER(mlx);
static_cast<mlx::Application*>(mlx)->MouseMove(win, x, y);
return 0;
}
int mlx_mouse_get_pos(void* mlx, int* x, int* y)
void mlx_mouse_get_pos(void* mlx, int* x, int* y)
{
MLX_CHECK_APPLICATION_POINTER(mlx);
static_cast<mlx::Application*>(mlx)->GetMousePos(x, y);
return 0;
}
int mlx_on_event(void* mlx, void* win, mlx_event_type event, int (*funct_ptr)(int, void*), void* param)
void mlx_on_event(void* mlx, void* win, mlx_event_type event, int (*funct_ptr)(int, void*), void* param)
{
MLX_CHECK_APPLICATION_POINTER(mlx);
static_cast<mlx::Application*>(mlx)->OnEvent(win, static_cast<int>(event), funct_ptr, param);
return 0;
}
void* mlx_new_image(void* mlx, int width, int height)
@@ -136,18 +131,16 @@ extern "C"
static_cast<mlx::Application*>(mlx)->SetTexturePixel(img, x, y, *reinterpret_cast<unsigned int*>(color_bits));
}
int mlx_put_image_to_window(void* mlx, void* win, void* img, int x, int y)
void mlx_put_image_to_window(void* mlx, void* win, void* img, int x, int y)
{
MLX_CHECK_APPLICATION_POINTER(mlx);
static_cast<mlx::Application*>(mlx)->TexturePut(win, img, x, y);
return 0;
}
int mlx_destroy_image(void* mlx, void* img)
void mlx_destroy_image(void* mlx, void* img)
{
MLX_CHECK_APPLICATION_POINTER(mlx);
static_cast<mlx::Application*>(mlx)->DestroyTexture(img);
return 0;
}
void* mlx_png_file_to_image(void* mlx, char* filename, int* width, int* height)
@@ -201,7 +194,7 @@ extern "C"
return static_cast<mlx::Application*>(mlx)->NewStbTexture(filename, width, height);
}
int mlx_pixel_put(void* mlx, void* win, int x, int y, int color)
void mlx_pixel_put(void* mlx, void* win, int x, int y, int color)
{
MLX_CHECK_APPLICATION_POINTER(mlx);
unsigned char color_bits[4];
@@ -210,10 +203,9 @@ extern "C"
color_bits[2] = (color & 0x000000FF);
color_bits[3] = (color & 0xFF000000) >> 24;
static_cast<mlx::Application*>(mlx)->PixelPut(win, x, y, *reinterpret_cast<unsigned int*>(color_bits));
return 0;
}
int mlx_string_put(void* mlx, void* win, int x, int y, int color, char* str)
void mlx_string_put(void* mlx, void* win, int x, int y, int color, char* str)
{
MLX_CHECK_APPLICATION_POINTER(mlx);
unsigned char color_bits[4];
@@ -222,7 +214,6 @@ extern "C"
color_bits[2] = (color & 0x000000FF);
color_bits[3] = (color & 0xFF000000) >> 24;
static_cast<mlx::Application*>(mlx)->StringPut(win, x, y, *reinterpret_cast<unsigned int*>(color_bits), str);
return 0;
}
void mlx_set_font(void* mlx, char* filepath)
@@ -262,49 +253,39 @@ extern "C"
static_cast<mlx::Application*>(mlx)->LoadFont(file, scale);
}
int mlx_clear_window(void* mlx, void* win)
void mlx_clear_window(void* mlx, void* win)
{
MLX_CHECK_APPLICATION_POINTER(mlx);
static_cast<mlx::Application*>(mlx)->ClearGraphicsSupport(win);
return 0;
}
int mlx_destroy_window(void* mlx, void* win)
void mlx_destroy_window(void* mlx, void* win)
{
MLX_CHECK_APPLICATION_POINTER(mlx);
static_cast<mlx::Application*>(mlx)->DestroyGraphicsSupport(win);
return 0;
}
int mlx_destroy_display(void* mlx)
void mlx_destroy_display(void* mlx)
{
MLX_CHECK_APPLICATION_POINTER(mlx);
delete static_cast<mlx::Application*>(mlx);
__mlx_ptr = nullptr;
return 0;
}
int mlx_get_screens_size(void* mlx, void* win, int* w, int* h)
void mlx_get_screens_size(void* mlx, void* win, int* w, int* h)
{
MLX_CHECK_APPLICATION_POINTER(mlx);
static_cast<mlx::Application*>(mlx)->GetScreenSize(win, w, h);
return 0;
}
int mlx_set_fps_goal(void* mlx, int fps)
void mlx_set_fps_goal(void* mlx, int fps)
{
MLX_CHECK_APPLICATION_POINTER(mlx);
if(fps < 0)
{
mlx::Error("You cannot set a negative FPS cap (nice try)");
return 0;
}
if(fps == 0)
{
else if(fps == 0)
mlx::Error("You cannot set a FPS cap to 0 (nice try)");
return 0;
}
else
static_cast<mlx::Application*>(mlx)->SetFPSCap(static_cast<std::uint32_t>(fps));
return 0;
}
}

10
runtime/Sources/Core/SDLManager.cpp
View File

@@ -125,6 +125,16 @@ namespace mlx
SDL_SetWindowPosition(static_cast<Internal::WindowInfos*>(window)->window, x, y);
}
void SDLManager::HideCursor() noexcept
{
SDL_ShowCursor(SDL_DISABLE);
}
void SDLManager::ShowCursor() noexcept
{
SDL_ShowCursor(SDL_ENABLE);
}
std::int32_t SDLManager::GetX() const noexcept
{
int dummy;