---
name: "MLV_mouse.h"
section: "3"
platform: "linux"
package: "libmlv3-dev"
version: "3.1.0-8"
release: "Debian 12 (Bookworm)"
platforms: ["linux"]
url: "https://new.carta.tech/MLV_mouse.h"
---

# MLV\_mouse.h(3)

Ce fichier définit les prototypes des fonctions qui permettent d'utiliser la souris.

## NAME

MLV\_mouse.h - Ce fichier définit les prototypes des fonctions qui permettent d'utiliser la souris.

## 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 }\
 Énumère les différents bouttons de la souris.

### Fonctions

void **MLV\_wait\_mouse** (int \*x, int \*y)\
 Suspend l'exécution jusqu'à ce que l'utilisateur clique sur le bouton gauche de la souris.  const char \* **MLV\_convert\_mouse\_button\_to\_string** (**MLV\_Mouse\_button** button\_code)\
 Convertit le code associé à un boutton de la souris (MLV\_Mouse\_button) en chaîne de caratères.  **MLV\_Mouse\_button** **MLV\_convert\_string\_to\_mouse\_button** (const char \*button\_string)\
 Convertit une chaîne de caractères en un code bouton.  void **MLV\_get\_mouse\_position** (int \*x, int \*y)\
 Renvoie la position courante de la souris.  **MLV\_Button\_state** **MLV\_get\_mouse\_button\_state** (**MLV\_Mouse\_button** mouse\_button)\
 Renvoie l'état (préssé ou relaché) d'un bouton de la souris.

## Description détaillée

Ce fichier définit les prototypes des fonctions qui permettent d'utiliser la souris.

**Auteur**

Adrien Boussicault

Marc Zipstein

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

### enum MLV\_Mouse\_button

Énumère les différents bouttons de la souris.

**Valeurs énumérées**

- *MLV\_BUTTON\_LEFT*

  *Bouton gauche de la souris*

- *MLV\_BUTTON\_MIDDLE*

  *Bouton du milieu de la souris*

- *MLV\_BUTTON\_RIGHT*

  *Bouton droit de la souris*

## Documentation des fonctions

### const char \* MLV\_convert\_mouse\_button\_to\_string (MLV\_Mouse\_button button\_code)

*Convertit le code associé à un boutton de la souris (MLV\_Mouse\_button) en chaîne de caratères.*

**Paramètres**

*button\_code Le code du bouton.*

**Renvoie**

*La chaîne de caratères correspondant au code du boutton de la souris passé en paramètre.*

### MLV\_Mouse\_button MLV\_convert\_string\_to\_mouse\_button (const char \* button\_string)

*Convertit une chaîne de caractères en un code bouton.*

**Paramètres**

*button\_string La chaîne de caractères à convertir.*

**Renvoie**

*Le code bouton associé à la chaîne de caractères.*

### MLV\_Button\_state MLV\_get\_mouse\_button\_state (MLV\_Mouse\_button mouse\_button)

*Renvoie l'état (préssé ou relaché) d'un bouton de la souris.*

**Paramètres**

*mouse\_button Le code du bouton de la souris*

**Renvoie**

*L'état du bouton.*

**Exemples** **medium/10\_mouse\_or\_keyboard\_access.c***.*

### void MLV\_get\_mouse\_position (int \* x, int \* y)

*Renvoie la position courante de la souris.*

**Paramètres**

*x Coordonnée en X de la position de la souris dans la fenêtre.* \
 *y Coordonnée en Y de la position de la souris dans la fenêtre.*

**Exemples** **medium/10\_mouse\_or\_keyboard\_access.c***.*

### void MLV\_wait\_mouse (int \* x, int \* y)

*Suspend l'exécution jusqu'à ce que l'utilisateur clique sur le bouton gauche de la souris. Au moment où l'utilisateur clique, la fonction retourne les coordonnées de la position de la souris dans la fenêtre.*

**Paramètres**

*x Coordonnée en X de la position de la souris dans la fenêtre.* \
 *y Coordonnée en Y de la position de la souris dans la fenêtre.*

**Exemples** **beginner/05\_mouse.c***, et* **beginner/09\_colors.c***.*

## Auteur

*Généré automatiquement par Doxygen pour MLV-3.1.0 à partir du code source.*