MLV_text.h - Ce fichier définit les différents prototypes des fonctions permmettant d'afficher du texte

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

MLV-3.1.0                                    Samedi 29 Janvier 2022                                MLV_text.h(3)

       Ce fichier définit les différents prototypes des fonctions permmettant d'afficher du texte et des boîtes
       de dialogues.

       Auteur
           Adrien Boussicault

           Marc Zipstein

typedefstruct_MLV_FontMLV_Font
       Ce type code une fonte de caractères.

char*MLV_convert_unicode_to_string(intunicode)
       Transforme un caractère en format unicode en chaîne de caractères compatible avec le codage local (codage
       utilisé  par la machine qui exécute le programme). Après utilisation, vous devez libérer l'espace mémoire
       de la chaîne de caractères renvoyée par la fonction.

       Paramètresunicode Le caractère en format unicode.

       Renvoie
           Un pointeur vers une nouvelle chaîne de caractères.

       Exemplesmedium/09_keyboard_accents.c, et medium/11_keys_codes.c.

   voidMLV_draw_adapted_text_box(intx,inty,constchar*message,intsizeInterligne,MLV_ColorborderColor,MLV_ColortextColor,MLV_ColorbackgroundColor,MLV_Text_justificationtext_justification,...)
       Dessine une boîte contenant du texte. La taille de la boîte dessinée s'adapte à la taille du  texte.  Les
       différentes  couleurs  de  la  boîte  et  du  texte,  ainsi  que  la taille de l'interligne du texte sont
       paramétrables.

       Il est possible de préciser la justification du texte à l'aide du paramètre 'text_justification'.

       Paramètresx La coordonnée en X de la position du coin Nord-Ouest de la boîte.
           y La coordonnée en Y de la position du coin Nord-Ouest de la boîte.
           message Le texte à afficher.
           borderColor La couleur des bordures.
           sizeInterligne La taille de l'interligne.
           textColor La couleur du texte.
           backgroundColor La couleur du fond de la boîte.
           text_justification La justification du texte.

       Exemplesadvanced/01_texts_and_boxes.c,       advanced/07_transparency.c,       beginner/04_texts_and_boxes.c,
           beginner/08_mouse_keyboard_input_box_timer.c,                                   beginner/09_colors.c,
           beginner/10_library_informations.c,         medium/03_input_box_events.c,         medium/04_events.c,
           medium/05_exit.c, et medium/11_keys_codes.c.

   voidMLV_draw_adapted_text_box_on_image(intx,inty,constchar*message,intsizeInterligne,MLV_ColorborderColor,MLV_ColortextColor,MLV_ColorbackgroundColor,MLV_Text_justificationtext_justification,MLV_Image*image,...)
       Même chose que MLV_draw_adapted_text_box() mis à part que le texte est rendu avec une fonte de caractères
       donnée en paramètre.

       Paramètresx La coordonnée en X de la position du coin Nord-Ouest de la boîte.
           y La coordonnée en Y de la position du coin Nord-Ouest de la boîte.
           message Le texte à afficher.
           borderColor La couleur des bordures.
           sizeInterligne La taille de l'interligne.
           textColor La couleur du texte.
           backgroundColor La couleur du fond de la boîte.
           text_justification La justification du texte.
           image L'image sur laquel le texte doit être ecrit.

   voidMLV_draw_adapted_text_box_with_font(intx,inty,constchar*message,constMLV_Font*font,intsizeInterligne,MLV_ColorborderColor,MLV_ColortextColor,MLV_ColorbackgroundColor,MLV_Text_justificationtext_justification,...)
       Même chose que MLV_draw_adapted_text_box() mis à part que le texte est rendu avec une fonte de caractères
       donnée en paramètre.

       Paramètresx La coordonnée en X de la position du coin Nord-Ouest de la boîte.
           y La coordonnée en Y de la position du coin Nord-Ouest de la boîte.
           message Le texte à afficher.
           font La fonte de caractères utilisée pour dessiner le texte.
           borderColor La couleur des bordures.
           sizeInterligne La taille de l'interligne.
           textColor La couleur du texte.
           backgroundColor La couleur du fond de la boîte.
           text_justification La justification du texte.

   voidMLV_draw_adapted_text_box_with_font_on_image(intx,inty,constchar*message,constMLV_Font*font,intsizeInterligne,MLV_ColorborderColor,MLV_ColortextColor,MLV_ColorbackgroundColor,MLV_Text_justificationtext_justification,MLV_Image*image,...)
       Même chose que MLV_draw_adapted_text_box_with_font() mis à part que le texte est rendu sur une  image  et
       non directement à l'écran.

       Paramètresx La coordonnée en X de la position du coin Nord-Ouest de la boîte.
           y La coordonnée en Y de la position du coin Nord-Ouest de la boîte.
           message Le texte à afficher.
           font La fonte de caractères utilisée pour dessiner le texte.
           borderColor La couleur des bordures.
           sizeInterligne Le taille de l'interligne.
           textColor La couleur du texte.
           backgroundColor La couleur du fond de la boîte.
           text_justification La justification du texte.
           image L'image sur laquel le texte doit être ecrit.

   voidMLV_draw_text(intx,inty,constchar*text,MLV_Colorcolor,...)
       Imprime  un  texte donné à une position et une couleur données. Le texte est imprimé à l'aide de la fonte
       de caractères par default de la bibliothèque MLV.

       Paramètresx Coordonnée en X du coin Nord-Ouest du texte
           y Coordonnée en Y du coin Nord-Ouest du texte
           text texte à afficher
           color couleur du tracé

       Exemplesadvanced/01_texts_and_boxes.c, advanced/04_sound.c, advanced/05_playlist.c, advanced/08_zone_click.c,
           advanced/11_animation_book.c,            beginner/01_hello_world.c,             beginner/02_shapes.c,
           beginner/04_texts_and_boxes.c,  beginner/05_mouse.c, beginner/06_keyboard.c, beginner/07_input_box.c,
           medium/01_keyboard_events.c,         medium/02_mouse_events.c,          medium/03_input_box_events.c,
           medium/04_events.c,  medium/05_exit.c, medium/06_colors.c, medium/07_time.c, medium/08_full_screen.c,
           medium/09_keyboard_accents.c, medium/10_mouse_or_keyboard_access.c, et medium/12_desktop_size.c.

   voidMLV_draw_text_box(intx,inty,intwidth,intheight,constchar*message,intsizeInterligne,MLV_ColorborderColor,MLV_ColortextColor,MLV_ColorbackgroundColor,MLV_Text_justificationtext_justification,MLV_Horizontal_positionhorizontal_position,MLV_Vertical_positionvertical_position,...)
       Dessine une boîte de taille donnée par l'utilisateur et contenant un texte donné  par  l'utilisateur.  Le
       texte  est déssiné à l'interieur d'une boîte. Le texte est imprimé sur plusieurs lignes en respectant les
       retours à la ligne présents dans le texte.

       Les différentes couleurs de la boîte et du texte, ainsi que la  taille  de  l'interligne  du  texte  sont
       paramétrables.

       Il est possible de préciser la justification du texte contenu dans la boîte.

       De même , il est possible de préciser la position du texte à l'intérieur de la boîte.

       Cette  fonction  ne  remet pas en forme le texte. Cela veux dire que si le texte est trop grand, alors il
       dépassera de la boîte et les parties qui depassent ne seront pas affichées.

       Paramètresx La coordonnée en X de la position du coin Nord-Ouest de la boîte.
           y La coordonnée en Y de la position du coin Nord-Ouest de la boîte.
           width La largeur de la boîte.
           height La hauteur de la boîte.
           message Le texte à afficher.
           sizeInterligne La taille de l'interligne.
           borderColor La couleur des bordures.
           textColor La couleur du texte.
           backgroundColor La couleur du fond de la boîte.
           text_justification La justification du texte.
           horizontal_position La position horizontale du texte dans la boîte.
           vertical_position La position verticale du texte dans la boîte.

       Exemplesbeginner/04_texts_and_boxes.c.

   voidMLV_draw_text_box_on_image(intx,inty,intwidth,intheight,constchar*message,intsizeInterligne,MLV_ColorborderColor,MLV_ColortextColor,MLV_ColorbackgroundColor,MLV_Text_justificationtext_justification,MLV_Horizontal_positionhorizontal_position,MLV_Vertical_positionvertical_position,MLV_Image*image,...)
       Même  chose que MLV_draw_text_box() mis à part que le texte n'est pas écrit directement sur l'écran, mais
       sur une image à la place.

       Paramètresx La coordonnée en X de la position du coin Nord-Ouest de la boîte.
           y La coordonnée en Y de la position du coin Nord-Ouest de la boîte.
           width La largeur de la boîte.
           height La hauteur de la boîte.
           message Le texte à afficher.
           sizeInterligne La taille de l'interligne.
           borderColor La couleur des bordures.
           textColor La couleur du texte.
           backgroundColor La couleur du fond de la boîte.
           text_justification La justification du texte.
           horizontal_position La position horizontale du texte dans la boîte.
           vertical_position La position verticale du texte dans la boîte.
           image L'image sur laquel le texte doit être ecrit.

   voidMLV_draw_text_box_with_font(intx,inty,intwidth,intheight,constchar*message,constMLV_Font*font,intsizeInterligne,MLV_ColorborderColor,MLV_ColortextColor,MLV_ColorbackgroundColor,MLV_Text_justificationtext_justification,MLV_Horizontal_positionhorizontal_position,MLV_Vertical_positionvertical_position,...)
       Même chose que la fonction MLV_draw_text_box() mis à part que le  texte  est  rendu  avec  une  fonte  de
       caractères donnée en paramètre par l'utilisateur.

       Paramètresx La coordonnée en X de la position du coin Nord-Ouest de la boîte.
           y La coordonnée en Y de la position du coin Nord-Ouest de la boîte.
           width La largeur de la boîte.
           height La hauteur de la boîte.
           message Le texte à afficher.
           font La fonte de caractères utilisée pour dessiner le texte.
           sizeInterligne La taille de l'interligne.
           borderColor La couleur des bordures.
           textColor La couleur du texte.
           backgroundColor La couleur du fond de la boîte.
           text_justification La justification du texte.
           horizontal_position La position horizontale du texte dans la boîte.
           vertical_position La position verticale du texte dans la boîte.

   voidMLV_draw_text_box_with_font_on_image(intx,inty,intwidth,intheight,constchar*message,MLV_Font*font,intsizeInterligne,MLV_ColorborderColor,MLV_ColortextColor,MLV_ColorbackgroundColor,MLV_Text_justificationtext_justification,MLV_Horizontal_positionhorizontal_position,MLV_Vertical_positionvertical_position,MLV_Image*image,...)
       Même chose que la fonction MLV_draw_text_box_with_font() mis à part  que  le  texte  n'est  pas  dessinné
       directement sur l'ecran, mais sur une une image.

       Paramètresx La coordonnée en X de la position du coin Nord-Ouest de la boîte.
           y La coordonnée en Y de la position du coin Nord-Ouest de la boîte.
           width La largeur de la boîte.
           height La hauteur de la boîte.
           message Le texte à afficher.
           font La fonte caractères utilisée pour dessiner le texte.
           sizeInterligne La taille de l'interligne.
           borderColor La couleur des bordures.
           textColor La couleur du texte.
           backgroundColor La couleur du fond de la boîte.
           text_justification La justification du texte.
           horizontal_position La position horizontale du texte dans la boîte.
           vertical_position La position verticale du texte dans la boîte.
           image L'image sur laquel le texte doit être ecrit.

   voidMLV_draw_text_on_image(intx,inty,constchar*text,MLV_Colorcolor,MLV_Image*image,...)
       Écrit  sur  une image un texte donné à une position et une couleur données. Le texte est imprimé à l'aide
       de la fonte de caractères par default de la bibliothèque MLV.

       Paramètresx La coordonnée en X du coin Nord-Ouest du texte.
           y La coordonnée en Y du coin Nord-Ouest du texte.
           text Le texte à afficher.
           color La couleur du tracé.
           image L'image sur laquel le texte doit être ecrit.

   voidMLV_draw_text_with_font(intx,inty,constchar*text,constMLV_Font*font,MLV_Colorcolor,...)

       Écrit du texte sur l'écran en utilisant une couleur et une fonte de caractères données en paramètres.

       Paramètresx La coordonnée en X du coin Nord-Ouest du texte.
           y La coordonnée en Y du coin Nord-Ouest du texte.
           text Le texte à afficher.
           color La couleur du tracé.
           font La fonte de caractères utilisée pour dessiner le texte.

       Exemplesadvanced/02_font.c.

   voidMLV_draw_text_with_font_on_image(intx,inty,constchar*text,constMLV_Font*font,MLV_Colorcolor,MLV_Image*image,...)
       Écrit du texte sur une image en utilisant une couleur et une fonte de caractères données en paramètres.

       Paramètresx La coordonnée en X du coin Nord-Ouest du texte.
           y La coordonnée en Y du coin Nord-Ouest du texte.
           text Le texte à afficher.
           color La couleur du tracé.
           font La fonte de caractères utilisée pour dessiner le texte.
           image L'image sur laquel le texte doit être ecrit.

   voidMLV_free_font(MLV_Font*font)
       Cette fonction libère la mémoire d'une fonte de caractères précédement chargée.

       Paramètresfont L'adresse de la fonte de caractères à libérer.

       Exemplesadvanced/02_font.c.

   intMLV_get_size_of_adapted_text_box(constchar*message,intsizeInterligne,int*result_width,int*result_height,...)
       Cette  fonction  calcule la taille de la boîte de texte qui serait obtenue si vous utilisez la fonction :
       MLV_draw_adapted_text_box().

       Paramètresmessage Le texte qui sera affiché lorsque vous utiliserez MLV_draw_adapted_text_box().
           sizeInterligne La taille de l'interligne.
           result_width La largeur de la boîte que vous obtiendrez en utilisant MLV_draw_adapted_text_box().
           result_height La hauteur de la boîte que vous obtiendrez en utilisant MLV_draw_adapted_text_box().

       Renvoie
           La fonction renvoie la taille de la boîte de texte.

       Exemplesadvanced/01_texts_and_boxes.c.

   intMLV_get_size_of_adapted_text_box_with_font(constchar*message,constMLV_Font*font,intsizeInterligne,int*result_width,int*result_height,...)
       Cette  fonction  calcule la taille de la boîte de texte qui serait obtenue si vous utilisez la fonction :
       MLV_draw_adapted_text_box_with_font().

       Paramètresmessage Le texte qui sera affiché lorsque vous utiliserez MLV_draw_adapted_text_box_with_font().
           font La fonte de caractères utilisée pour dessiner le texte.
           sizeInterligne La taille de l'interligne.
           result_width    La    largeur    de    la    boîte    que    vous     obtiendrez     en     utilisant
           MLV_draw_adapted_text_box_with_font().
           result_height     La     hauteur    de    la    boîte    que    vous    obtiendrez    en    utilisant
           MLV_draw_adapted_text_box_with_font().

       Renvoie
           La fonction renvoie la taille de la boîte de texte.

   voidMLV_get_size_of_text(constchar*text,int*width,int*height,...)
       Cette fonction calcule la taille du  texte  qui  sera  affiché  sur  l'écran  à  l'aide  de  la  fonction
       MLV_draw_text().

       Paramètrestext Le texte qui doit être affiché.
           width La largeur du texte.
           height La hauteur du texte.

       Exemplesadvanced/01_texts_and_boxes.c, et medium/06_colors.c.

   voidMLV_get_size_of_text_with_font(constchar*text,int*width,int*height,constMLV_Font*font,...)
       Cette fonction calcule la taille du  texte  qui  sera  affiché  sur  l'écran  à  l'aide  de  la  fonction
       MLV_draw_text_with_font().

       Paramètrestext Le texte qui doit être affiché.
           width La largeur du texte.
           height La hauteur du texte.
           font La fonte de caractères utilisée pour afficher le texte.

   MLV_Font*MLV_load_font(constchar*file_font,intsize)
       Cette  fonction  charge  en  mémoire  une  fonte de caractères de standard 'TrueType' (fichiers ayant une
       extension .ttf). La fonte de caractères chargée est  configurée  avec  une  taille  de  fonte  donnée  en
       paramètre.

       Paramètresfile_font Le chemin d'accés où se trouve le fichier contenant la fonte de caractères.
           size La taille de la fonte de caractères.

       Renvoie
           La structure de donnée MLV contenant la fonte de caractères.

       Exemplesadvanced/02_font.c.

enumMLV_Horizontal_position
       Énumère les différents types de position horizontale du texte dans une boîte.

       ValeursénuméréesMLV_HORIZONTAL_CENTER
              Le texte est centrée horizontalement dans la boîte.

       MLV_HORIZONTAL_LEFT
              Le texte est positioné sur la droite de la boîte.

       MLV_HORIZONTAL_RIGHT
              Le texte est positioné sur la gauche de la boîte.

   enumMLV_Text_justification
       Énumère les différents types de justification du texte.

       ValeursénuméréesMLV_TEXT_CENTER
              Le texte est justifié au centre.

       MLV_TEXT_LEFT
              Le texte est justifié sur la gauche.

       MLV_TEXT_RIGHT
              Le texte est justifié sur la doite.

   enumMLV_Vertical_position
       Énumère les différents types de positions verticales du texte dans une boîte.

       ValeursénuméréesMLV_VERTICAL_CENTER
              Le texte est centré horizonatalement dans la boîte.

       MLV_VERTICAL_TOP
              Le texte est positionné en haut de la boîte.

       MLV_VERTICAL_BOTTOM
              Le texte est positionné en bas de la boîte.

       MLV_text.h - Ce fichier définit les différents prototypes des fonctions permmettant d'afficher du texte
       et des boîtes de dialogues.

Définitionsdetype
       typedef struct _MLV_Font MLV_FontÉnumérations
       enum MLV_Text_justification { MLV_TEXT_CENTER, MLV_TEXT_LEFT, MLV_TEXT_RIGHT }
           Énumère les différents types de justification du texte.
       enum MLV_Horizontal_position { MLV_HORIZONTAL_CENTER, MLV_HORIZONTAL_LEFT, MLV_HORIZONTAL_RIGHT }
           Énumère les différents types de position horizontale du texte dans une boîte.
       enum MLV_Vertical_position { MLV_VERTICAL_CENTER, MLV_VERTICAL_TOP, MLV_VERTICAL_BOTTOM }
           Énumère les différents types de positions verticales du texte dans une boîte.

   FonctionsMLV_Font * MLV_load_font (const char *file_font, int size)
           Cette fonction charge en mémoire une fonte de caractères de standard 'TrueType' (fichiers ayant une
           extension .ttf).
       void MLV_free_font (MLV_Font *font)
           Cette fonction libère la mémoire d'une fonte de caractères précédement chargée.
       void MLV_get_size_of_text (const char *text, int *width, int *height,...)
           Cette fonction calcule la taille du texte qui sera affiché sur l'écran à l'aide de la fonction
           MLV_draw_text().
       void MLV_get_size_of_text_with_font (const char *text, int *width, int *height, const MLV_Font *font,...)
           Cette fonction calcule la taille du texte qui sera affiché sur l'écran à l'aide de la fonction
           MLV_draw_text_with_font().
       void MLV_draw_text (int x, int y, const char *text, MLV_Color color,...)
           Imprime un texte donné à une position et une couleur données.
       void MLV_draw_text_with_font (int x, int y, const char *text, const MLV_Font *font, MLV_Color color,...)
           Écrit du texte sur l'écran en utilisant une couleur et une fonte de caractères données en paramètres.
       void MLV_draw_text_on_image (int x, int y, const char *text, MLV_Color color, MLV_Image *image,...)
           Écrit sur une image un texte donné à une position et une couleur données.
       void MLV_draw_text_with_font_on_image (int x, int y, const char *text, const MLV_Font *font, MLV_Color
           color, MLV_Image *image,...)
           Écrit du texte sur une image en utilisant une couleur et une fonte de caractères données en
           paramètres.
       void MLV_draw_adapted_text_box (int x, int y, const char *message, int sizeInterligne, MLV_Color
           borderColor, MLV_Color textColor, MLV_Color backgroundColor, MLV_Text_justification
           text_justification,...)
           Dessine une boîte contenant du texte.
       void MLV_draw_adapted_text_box_on_image (int x, int y, const char *message, int sizeInterligne, MLV_Color
           borderColor, MLV_Color textColor, MLV_Color backgroundColor, MLV_Text_justification
           text_justification, MLV_Image *image,...)
           Même chose que MLV_draw_adapted_text_box() mis à part que le texte est rendu avec une fonte de
           caractères donnée en paramètre.
       int MLV_get_size_of_adapted_text_box (const char *message, int sizeInterligne, int *result_width, int
           *result_height,...)
           Cette fonction calcule la taille de la boîte de texte qui serait obtenue si vous utilisez la fonction
           : MLV_draw_adapted_text_box().
       void MLV_draw_adapted_text_box_with_font (int x, int y, const char *message, const MLV_Font *font, int
           sizeInterligne, MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor,
           MLV_Text_justification text_justification,...)
           Même chose que MLV_draw_adapted_text_box() mis à part que le texte est rendu avec une fonte de
           caractères donnée en paramètre.
       void MLV_draw_adapted_text_box_with_font_on_image (int x, int y, const char *message, const MLV_Font
           *font, int sizeInterligne, MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor,
           MLV_Text_justification text_justification, MLV_Image *image,...)
           Même chose que MLV_draw_adapted_text_box_with_font() mis à part que le texte est rendu sur une image
           et non directement à l'écran.
       int MLV_get_size_of_adapted_text_box_with_font (const char *message, const MLV_Font *font, int
           sizeInterligne, int *result_width, int *result_height,...)
           Cette fonction calcule la taille de la boîte de texte qui serait obtenue si vous utilisez la fonction
           : MLV_draw_adapted_text_box_with_font().
       void MLV_draw_text_box (int x, int y, int width, int height, const char *message, int sizeInterligne,
           MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor, MLV_Text_justification
           text_justification, MLV_Horizontal_position horizontal_position, MLV_Vertical_position
           vertical_position,...)
           Dessine une boîte de taille donnée par l'utilisateur et contenant un texte donné par l'utilisateur.
       void MLV_draw_text_box_on_image (int x, int y, int width, int height, const char *message, int
           sizeInterligne, MLV_Color borderColor, MLV_Color textColor, MLV_Color backgroundColor,
           MLV_Text_justification text_justification, MLV_Horizontal_position horizontal_position,
           MLV_Vertical_position vertical_position, MLV_Image *image,...)
           Même chose que MLV_draw_text_box() mis à part que le texte n'est pas écrit directement sur l'écran,
           mais sur une image à la place.
       void MLV_draw_text_box_with_font (int x, int y, int width, int height, const char *message, const
           MLV_Font *font, int sizeInterligne, MLV_Color borderColor, MLV_Color textColor, MLV_Color
           backgroundColor, MLV_Text_justification text_justification, MLV_Horizontal_position
           horizontal_position, MLV_Vertical_position vertical_position,...)
           Même chose que la fonction MLV_draw_text_box() mis à part que le texte est rendu avec une fonte de
           caractères donnée en paramètre par l'utilisateur.
       void MLV_draw_text_box_with_font_on_image (int x, int y, int width, int height, const char *message,
           MLV_Font *font, int sizeInterligne, MLV_Color borderColor, MLV_Color textColor, MLV_Color
           backgroundColor, MLV_Text_justification text_justification, MLV_Horizontal_position
           horizontal_position, MLV_Vertical_position vertical_position, MLV_Image *image,...)
           Même chose que la fonction MLV_draw_text_box_with_font() mis à part que le texte n'est pas dessinné
           directement sur l'ecran, mais sur une une image.
       char * MLV_convert_unicode_to_string (int unicode)
           Transforme un caractère en format unicode en chaîne de caractères compatible avec le codage local
           (codage utilisé par la machine qui exécute le programme).