Scroll to navigation

MLV_mouse.h(3) Library Functions Manual MLV_mouse.h(3)

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.
Mardi 1 Janvier 2019 MLV-3.1.0