.TH "MLV_mouse.h" 3 "Mardi 1 Janvier 2019" "MLV-3.1.0" \" -*- nroff -*-
.ad l
.nh
.SH NAME
MLV_mouse.h \- Ce fichier définit les prototypes des fonctions qui permettent d'utiliser la souris\&.  

.SH SYNOPSIS
.br
.PP
.SS "Énumérations"

.in +1c
.ti -1c
.RI "enum \fBMLV_Mouse_button\fP { \fBMLV_BUTTON_LEFT\fP = SDL_BUTTON_LEFT, \fBMLV_BUTTON_MIDDLE\fP = SDL_BUTTON_MIDDLE, \fBMLV_BUTTON_RIGHT\fP = SDL_BUTTON_RIGHT }
.RI "Énumère les différents bouttons de la souris\&. ""
.br
.in -1c
.SS "Fonctions"

.in +1c
.ti -1c
.RI "void \fBMLV_wait_mouse\fP (int *x, int *y)"
.br
.RI "Suspend l'exécution jusqu'à ce que l'utilisateur clique sur le bouton gauche de la souris\&. "
.ti -1c
.RI "const char * \fBMLV_convert_mouse_button_to_string\fP (\fBMLV_Mouse_button\fP button_code)"
.br
.RI "Convertit le code associé à un boutton de la souris (MLV_Mouse_button) en chaîne de caratères\&. "
.ti -1c
.RI "\fBMLV_Mouse_button\fP \fBMLV_convert_string_to_mouse_button\fP (const char *button_string)"
.br
.RI "Convertit une chaîne de caractères en un code bouton\&. "
.ti -1c
.RI "void \fBMLV_get_mouse_position\fP (int *x, int *y)"
.br
.RI "Renvoie la position courante de la souris\&. "
.ti -1c
.RI "\fBMLV_Button_state\fP \fBMLV_get_mouse_button_state\fP (\fBMLV_Mouse_button\fP mouse_button)"
.br
.RI "Renvoie l'état (préssé ou relaché) d'un bouton de la souris\&. "
.in -1c
.SH "Description détaillée"
.PP 
Ce fichier définit les prototypes des fonctions qui permettent d'utiliser la souris\&. 


.PP
\fBAuteur:\fP
.RS 4
Adrien Boussicault 
.PP
Marc Zipstein 
.RE
.PP

.SH "Documentation du type de l'énumération"
.PP 
.SS "enum \fBMLV_Mouse_button\fP"

.PP
Énumère les différents bouttons de la souris\&. 
.PP
\fBValeurs énumérées\fP
.in +1c
.TP
\fB\fIMLV_BUTTON_LEFT \fP\fP
Bouton gauche de la souris 
.TP
\fB\fIMLV_BUTTON_MIDDLE \fP\fP
Bouton du milieu de la souris 
.TP
\fB\fIMLV_BUTTON_RIGHT \fP\fP
Bouton droit de la souris 
.SH "Documentation des fonctions"
.PP 
.SS "const char* MLV_convert_mouse_button_to_string (\fBMLV_Mouse_button\fP button_code)"

.PP
Convertit le code associé à un boutton de la souris (MLV_Mouse_button) en chaîne de caratères\&. 
.PP
\fBParamètres:\fP
.RS 4
\fIbutton_code\fP Le code du bouton\&. 
.RE
.PP
\fBRenvoie:\fP
.RS 4
La chaîne de caratères correspondant au code du boutton de la souris passé en paramètre\&. 
.RE
.PP

.SS "\fBMLV_Mouse_button\fP MLV_convert_string_to_mouse_button (const char * button_string)"

.PP
Convertit une chaîne de caractères en un code bouton\&. 
.PP
\fBParamètres:\fP
.RS 4
\fIbutton_string\fP La chaîne de caractères à convertir\&. 
.RE
.PP
\fBRenvoie:\fP
.RS 4
Le code bouton associé à la chaîne de caractères\&. 
.RE
.PP

.SS "\fBMLV_Button_state\fP MLV_get_mouse_button_state (\fBMLV_Mouse_button\fP mouse_button)"

.PP
Renvoie l'état (préssé ou relaché) d'un bouton de la souris\&. 
.PP
\fBParamètres:\fP
.RS 4
\fImouse_button\fP Le code du bouton de la souris 
.RE
.PP
\fBRenvoie:\fP
.RS 4
L'état du bouton\&. 
.RE
.PP

.PP
\fBExemples: \fP
.in +1c
\fBmedium/10_mouse_or_keyboard_access\&.c\fP\&.
.SS "void MLV_get_mouse_position (int * x, int * y)"

.PP
Renvoie la position courante de la souris\&. 
.PP
\fBParamètres:\fP
.RS 4
\fIx\fP Coordonnée en X de la position de la souris dans la fenêtre\&. 
.br
\fIy\fP Coordonnée en Y de la position de la souris dans la fenêtre\&. 
.RE
.PP

.PP
\fBExemples: \fP
.in +1c
\fBmedium/10_mouse_or_keyboard_access\&.c\fP\&.
.SS "void MLV_wait_mouse (int * x, int * y)"

.PP
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\&.
.PP
\fBParamètres:\fP
.RS 4
\fIx\fP Coordonnée en X de la position de la souris dans la fenêtre\&. 
.br
\fIy\fP Coordonnée en Y de la position de la souris dans la fenêtre\&. 
.RE
.PP

.PP
\fBExemples: \fP
.in +1c
\fBbeginner/05_mouse\&.c\fP, et \fBbeginner/09_colors\&.c\fP\&.
.SH "Auteur"
.PP 
Généré automatiquement par Doxygen pour MLV-3\&.1\&.0 à partir du code source\&.