MLV_mouse.h(3)

📦
version 3.1.0 · 2 versions
, in ubuntu jammy

💖 NAME 💖

okay so bestie, welcome to MLV_mouse.h(3) — Library Functions Manual energy 👑

This file (MLV_mouse.h) defines the prototypes of the functions that let you use the mouse. that's it, that's the whole vibe. 🐭✨

✨ SYNOPSIS ✨

🎀 Énumérations 🎀

enum MLV_Mouse_button { MLV_BUTTON_LEFT = SDL_BUTTON_LEFT,
    MLV_BUTTON_MIDDLE = SDL_BUTTON_MIDDLE, MLV_BUTTON_RIGHT =
    SDL_BUTTON_RIGHT }

It enumerates the different mouse buttons. like, all the buttons, listed, iconic. 💅

🦋 Fonctions 🦋

  • void MLV_wait_mouse (int *x, int *y) — pauses execution until the user clicks the left mouse button. it literally just sits there and waits for you, main character behaviour fr fr
  • const char * MLV_convert_mouse_button_to_string (MLV_Mouse_button button_code) — converts the code associated with a mouse button (MLV_Mouse_button) into a string.
  • MLV_Mouse_button MLV_convert_string_to_mouse_button (const char *button_string) — converts a string into a button code.
  • void MLV_get_mouse_position (int *x, int *y) — returns the current position of the mouse. where is she 👀
  • MLV_Button_state MLV_get_mouse_button_state (MLV_Mouse_button mouse_button) — returns the state (pressed or released) of a mouse button.

🌸 Description détaillée 🌸

This file defines the prototypes of the functions that allow you to use the mouse. simple as that, no cap. 🫶

💜 Auteur

  • Adrien Boussicault
  • Marc Zipstein

🎀 Documentation du type de l'énumération 🎀

💫 enum MLV_Mouse_button

It enumerates the different mouse buttons. let's meet the girlies:

Valeurs énumérées

  • MLV_BUTTON_LEFT — left mouse button 🫲
  • MLV_BUTTON_MIDDLE — middle mouse button 🖱️
  • MLV_BUTTON_RIGHT — right mouse button 🫱

💅 Documentation des fonctions 💅

⭐ const char* MLV_convert_mouse_button_to_string (MLV_Mouse_button button_code)

Converts the code associated with a mouse button (MLV_Mouse_button) into a string. code goes in, string comes out, glow up. ✨

Paramètres

  • button_code — the code of the button.

Renvoie

The string corresponding to the code of the mouse button passed as parameter.

🌈 MLV_Mouse_button MLV_convert_string_to_mouse_button (const char * button_string)

Converts a string into a button code. the reverse glow up, we love a two-way street. 💖

Paramètres

  • button_string — the string to convert.

Renvoie

The button code associated with the string.

🔥 MLV_Button_state MLV_get_mouse_button_state (MLV_Mouse_button mouse_button)

Returns the state (pressed or released) of a mouse button. pressed? released? she'll tell you. 💀

Paramètres

  • mouse_button — the code of the mouse button.

Renvoie

The state of the button.

Exemples

medium/10_mouse_or_keyboard_access.c.

🧚 void MLV_get_mouse_position (int * x, int * y)

Returns the current position of the mouse. coordinates check, vibe check, same thing. 📍

Paramètres

  • x — X coordinate of the mouse position in the window.
  • y — Y coordinate of the mouse position in the window.

Exemples

medium/10_mouse_or_keyboard_access.c.

👑 void MLV_wait_mouse (int * x, int * y)

Suspends execution until the user clicks the left mouse button. At the moment the user clicks, the function returns the coordinates of the mouse position in the window. so like, it's napping until you click, and then boom — coordinates. iconic. 🦋

Paramètres

  • x — X coordinate of the mouse position in the window.
  • y — Y coordinate of the mouse position in the window.

Exemples

beginner/05_mouse.c, and beginner/09_colors.c.

🦋 Auteur 🦋

Automatically generated by Doxygen for MLV-3.1.0 from the source code. doxygen did that, not me 💅

and that's the whole page bestie, every option, every param, every example — nothing skipped, periodt. 🫶

okay so this whole thing was served to you by MLV-3.1.0, dated Samedi 29 Janvier 2022 — bye babe, go click something 🎀💖✨

📦 where this page comes from