Documentation de la bibliothèque MLV-0.5

Définition de type | Énumérations | Fonctions

Référence du fichier MLV_text.h

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

Aller au code source de ce fichier.

Définition de type

typedef struct _MLV_Font MLV_Font

Énumérations

enum  MLV_Text_justification { MLV_TEXT_CENTER, MLV_TEXT_LEFT, MLV_TEXT_RIGHT }
 

Les différents types de justification du texte.

Plus de détails...
enum  MLV_Horizontal_position { MLV_HORIZONTAL_CENTER, MLV_HORIZONTAL_LEFT, MLV_HORIZONTAL_RIGHT }
 

Les différents types de position horizontale du texte dans une boîte.

Plus de détails...
enum  MLV_Vertical_position { MLV_VERTICAL_CENTER, MLV_VERTICAL_TOP, MLV_VERTICAL_BOTTOM }
 

Les différents types de positions verticales du texte dans une boîte.

Plus de détails...

Fonctions

MLV_FontMLV_load_font (const char *file_font, int size)
 Charge en mémoire une police de caractères de type True Type .
void MLV_free_font (MLV_Font *font)
 Libère la mémoire d'une police de caractères précédement chargée.
void MLV_get_size_of_text (const char *text, int *width, int *height)
 Calcule la taille de la ligne qui sera affiché sur l'écran à l'aide de la fonction MLV_text.
void MLV_get_size_of_text_with_font (const char *text, int *width, int *height, MLV_Font *font)
 Calcule la taille du texte qui sera affiché sur l'écran à l'aide de la fonction MLV_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, MLV_Font *font, MLV_Color color)
 Écrit du texte sur l'écran en utilisant une couleur et une police 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)
 Ecrit, 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, MLV_Font *font, MLV_Color color, MLV_Image *image)
 Écrit du texte sur une image en utilisant une couleur et une police 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 police 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)
 Calcul la taille de la boîte de texte qui serait obtenue si vous utilisez la fonction : MLV_adapted_text_box.
void MLV_draw_adapted_text_box_with_font (int x, int y, const char *message, 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 police 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, 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 sur l'écran.
int MLV_get_size_of_adapted_text_box_with_font (const char *message, MLV_Font *font, int sizeInterligne, int *result_width, int *result_height)
 Calcul la taille de la boîte de texte qui serait obtenue si vous utilisez la fonction : MLV_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_boc 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, 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 police 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_fon 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 chaine de caractères compatible avec le codage local.

Description détaillée

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

Documentation des définitions de type

typedef struct _MLV_Font MLV_Font

Type des polices de caractères dans la librairie MLV.


Documentation du type de l'énumération

Les différents types de position horizontale du texte dans une boîte.

Valeurs énumérées:
MLV_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.

Les différents types de justification du texte.

Valeurs énumérées:
MLV_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.

Les différents types de positions verticales du texte dans une boîte.

Valeurs énumérées:
MLV_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.


Documentation des fonctions

char* MLV_convert_unicode_to_string ( int  unicode  ) 

Transforme un caractère en format unicode en chaine de caractères compatible avec le codage local.

Paramètres:
unicode Caractère en format unicode
Renvoie:
Un pointeur vers une nouvelle chaine de caractère. Ne pas oublier de libérer l'espace allouer apès utilisation de la chaîne de caractère.
Exemples:
medium/9_keyboard_accents.c.
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.

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 justiifcation du texte à l'aide du champs : text_justification

Paramètres:
x Coordonnée en X de la position du coin Nord-Ouest de la boîte
y Coordonnée en X de la position du coin Nord-Ouest de la boîte
message Texte à afficher
borderColor Couleur des bordures
sizeInterligne Taille de l'interligne
textColor Couleur du texte
backgroundColor Couleur du fond de la boîte
text_justification Justification du texte.
Exemples:
advanced/1_texts_and_boxes.c, advanced/7_transparency.c, beginner/10_library_informations.c, beginner/4_texts_and_boxes.c, beginner/8_mouse_keyboard_timer.c, beginner/9_colors.c, medium/3_prompt_events.c, medium/4_events.c, et medium/5_exit.c.
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 police de caractères donnée en paramètre.

Paramètres:
x Coordonnée en X de la position du coin Nord-Ouest de la boîte
y Coordonnée en X de la position du coin Nord-Ouest de la boîte
message Texte à afficher
borderColor Couleur des bordures
sizeInterligne Taille de l'interligne
textColor Couleur du texte
backgroundColor Couleur du fond de la boîte
text_justification Justification du texte.
image image sur laquel le texte doit être ecrit
void MLV_draw_adapted_text_box_with_font ( int  x,
int  y,
const char *  message,
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 police de caractères donnée en paramètre.

Paramètres:
x Coordonnée en X de la position du coin Nord-Ouest de la boîte
y Coordonnée en X de la position du coin Nord-Ouest de la boîte
message Texte à afficher
font La police de caractères utilisée pour dessiner le texte.
borderColor Couleur des bordures
sizeInterligne Taille de l'interligne
textColor Couleur du texte
backgroundColor Couleur du fond de la boîte
text_justification Justification du texte.
void MLV_draw_adapted_text_box_with_font_on_image ( int  x,
int  y,
const char *  message,
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 sur l'écran.

Paramètres:
x Coordonnée en X de la position du coin Nord-Ouest de la boîte
y Coordonnée en X de la position du coin Nord-Ouest de la boîte
message Texte à afficher
font La police de caractères utilisée pour dessiner le texte.
borderColor Couleur des bordures
sizeInterligne Taille de l'interligne
textColor Couleur du texte
backgroundColor Couleur du fond de la boîte
text_justification Justification du texte.
image image sur laquel le texte doit être ecrit
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.

Le texte est imprimé à l'aide de la police de caractères par default de la librairie MLV.

Paramètres:
x 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é
Exemples:
advanced/11_animation_book.c, advanced/1_texts_and_boxes.c, advanced/4_sound.c, advanced/8_zone_click.c, beginner/1_hello_world.c, beginner/2_shapes.c, beginner/4_texts_and_boxes.c, beginner/5_mouse.c, beginner/6_keyboard.c, beginner/7_prompt.c, medium/1_keyboard_events.c, medium/2_mouse_events.c, medium/3_prompt_events.c, medium/4_events.c, medium/5_exit.c, medium/6_colors.c, medium/7_time.c, medium/8_full_screen.c, et medium/9_keyboard_accents.c.
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.

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ésent 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 trop grand alors il depassera de la boîte et les parties qui depassent ne seront pas affichées.

Paramètres:
x Coordonnée en X de la position du coin Nord-Ouest de la boîte
y Coordonnée en Y de la position du coin Nord-Ouest de la boîte
width hauteur de la boîte
height largeur de la boîte
message texte à afficher
sizeInterligne taille de l'interligne
borderColor Couleur des bordures
textColor Couleur du texte
backgroundColor Couleur du fond de la boîte.
text_justification Justification du texte.
horizontal_position Position horizontale du texte dans la boîte.
vertical_position Position verticale du texte dans la boîte.
Exemples:
beginner/4_texts_and_boxes.c.
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_boc mis à part que le texte n'est pas écrit directement sur l'écran, mais sur une image à la place.

Paramètres:
x Coordonnée en X de la position du coin Nord-Ouest de la boîte
y Coordonnée en Y de la position du coin Nord-Ouest de la boîte
width hauteur de la boîte
height largeur de la boîte
message texte à afficher
sizeInterligne taille de l'interligne
borderColor Couleur des bordures
textColor Couleur du texte
backgroundColor Couleur du fond de la boîte.
text_justification Justification du texte.
horizontal_position Position horizontale du texte dans la boîte.
vertical_position Position verticale du texte dans la boîte.
image image sur laquel le texte doit être ecrit
void MLV_draw_text_box_with_font ( 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 
)

Même chose que la fonction MLV_draw_text_box mis à part que le texte est rendu avec une police de caractères donnée en paramètre par l'utilisateur.

Paramètres:
x Coordonnée en X de la position du coin Nord-Ouest de la boîte
y Coordonnée en Y de la position du coin Nord-Ouest de la boîte
width hauteur de la boîte
height largeur de la boîte
message texte à afficher
font La police de caractères utilisée pour dessiner le texte.
sizeInterligne taille de l'interligne
borderColor Couleur des bordures
textColor Couleur du texte
backgroundColor Couleur du fond de la boîte.
text_justification Justification du texte.
horizontal_position Position horizontale du texte dans la boîte.
vertical_position Position verticale du texte dans la boîte.
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_fon mis à part que le texte n'est pas dessinné directement sur l'ecran, mais sur une une image.

Paramètres:
x Coordonnée en X de la position du coin Nord-Ouest de la boîte
y Coordonnée en Y de la position du coin Nord-Ouest de la boîte
width hauteur de la boîte
height largeur de la boîte
message texte à afficher
font La police de caractères utilisée pour dessiner le texte.
sizeInterligne taille de l'interligne
borderColor Couleur des bordures
textColor Couleur du texte
backgroundColor Couleur du fond de la boîte.
text_justification Justification du texte.
horizontal_position Position horizontale du texte dans la boîte.
vertical_position Position verticale du texte dans la boîte.
image image sur laquel le texte doit être ecrit
void MLV_draw_text_on_image ( int  x,
int  y,
const char *  text,
MLV_Color  color,
MLV_Image image 
)

Ecrit, sur une image, un texte donné à une position et une couleur données.

Le texte est imprimé à l'aide de la police de caractères par default de la librairie MLV.

Paramètres:
x 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é
image image sur laquel le texte doit être ecrit
void MLV_draw_text_with_font ( int  x,
int  y,
const char *  text,
MLV_Font font,
MLV_Color  color 
)

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

Paramètres:
x 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é
font La police de caractères utilisée pour dessiner le texte.
Exemples:
advanced/2_font.c.
void MLV_draw_text_with_font_on_image ( int  x,
int  y,
const char *  text,
MLV_Font font,
MLV_Color  color,
MLV_Image image 
)

Écrit du texte sur une image en utilisant une couleur et une police de caractères données en paramètres.

Paramètres:
x 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é
font La police de caractères utilisée pour dessiner le texte.
image image sur laquel le texte doit être ecrit
void MLV_free_font ( MLV_Font font  ) 

Libère la mémoire d'une police de caractères précédement chargée.

Paramètres:
font L'adresse de la police de caractères à libérer.
Exemples:
advanced/2_font.c.
int MLV_get_size_of_adapted_text_box ( const char *  message,
int  sizeInterligne,
int *  result_width,
int *  result_height 
)

Calcul la taille de la boîte de texte qui serait obtenue si vous utilisez la fonction : MLV_adapted_text_box.

Paramètres:
message texte qui sera affiché lorsque vous utiliserez MLV_adapted_box.
sizeInterligne Taille de l'interligne
result_width Largeur de la boîte que vous obtiendrez en utilisant MLV_adapted_box.
result_height Hauteur de la boîte que vous obtiendrez en utilisant MLV_adapted_box.
Exemples:
advanced/1_texts_and_boxes.c.
int MLV_get_size_of_adapted_text_box_with_font ( const char *  message,
MLV_Font font,
int  sizeInterligne,
int *  result_width,
int *  result_height 
)

Calcul la taille de la boîte de texte qui serait obtenue si vous utilisez la fonction : MLV_adapted_text_box_with_font.

Paramètres:
message texte qui sera affiché lorsque vous utiliserez MLV_adapted_box.
font La police de caractères utilisée pour dessiner le texte.
sizeInterligne Taille de l'interligne
result_width Largeur de la boîte que vous obtiendrez en utilisant MLV_adapted_box.
result_height Hauteur de la boîte que vous obtiendrez en utilisant MLV_adapted_box.
void MLV_get_size_of_text ( const char *  text,
int *  width,
int *  height 
)

Calcule la taille de la ligne qui sera affiché sur l'écran à l'aide de la fonction MLV_text.

Paramètres:
text Texte qui doit être affiché
width Largeur du texte
height Hauteur du texte
Exemples:
advanced/1_texts_and_boxes.c, et medium/6_colors.c.
void MLV_get_size_of_text_with_font ( const char *  text,
int *  width,
int *  height,
MLV_Font font 
)

Calcule la taille du texte qui sera affiché sur l'écran à l'aide de la fonction MLV_text_with_font.

Paramètres:
text Texte qui doit être affiché
width Largeur du texte
height Hauteur du texte
font La police de caractères utilisée pour afficher le texte.
MLV_Font* MLV_load_font ( const char *  file_font,
int  size 
)

Charge en mémoire une police de caractères de type True Type .

La police chargée est configurée avec une taille de police donnée en paramètre.

Paramètres:
file_font Le chemin d'accès où se trouve le fichier contenant la police de caractères.
size La taille de la police
Renvoie:
La structure de donée MLV contenant la police de caractères.
Exemples:
advanced/2_font.c.