caca.c File Reference

Main libcaca functions. More...

Functions
int	caca_init (void)
	Initialise libcaca.
unsigned int	caca_get_width (void)
	Get the screen width.
unsigned int	caca_get_height (void)
	Get the screen height.
char const *	caca_get_color_name (enum caca_color color)
	Translate a colour index into the colour's name.
enum caca_feature	caca_get_feature (enum caca_feature feature)
	Get the current value of a feature.
void	caca_set_feature (enum caca_feature feature)
	Set a feature.
char const *	caca_get_feature_name (enum caca_feature feature)
	Translate a feature value into the feature's name.
void	caca_end (void)
	Uninitialise libcaca.

---

Detailed Description

Version:

$Id: caca.c 258 2004-01-26 10:52:30Z sam $

Author:

Sam Hocevar <sam@zoy.org> This file contains the main functions used by libcaca applications to initialise the library, get the screen properties, set the framerate and so on.

---

Function Documentation

char const* caca_get_color_name (  enum caca_color  color  )

This function translates a caca_color enum into a human-readable description string of the associated colour. Parameters: color  The colour value. Returns: A static string containing the colour's name.

enum caca_feature caca_get_feature (  enum caca_feature  feature  )

This function retrieves the value of an internal libcaca feature. A generic feature value is expected, such as CACA_ANTIALIASING. Parameters: feature  The requested feature. Returns: The current value of the feature or CACA_FEATURE_UNKNOWN if an error occurred..

char const* caca_get_feature_name (  enum caca_feature  feature  )

This function translates a caca_feature enum into a human-readable description string of the associated feature. Parameters: feature  The feature value. Returns: A static string containing the feature's name.

void caca_set_feature (  enum caca_feature  feature  )

This function sets an internal libcaca feature such as the antialiasing or dithering modes. If a specific feature such as CACA_DITHERING_RANDOM, caca_set_feature() will set it immediately. If a generic feature is given instead, such as CACA_DITHERING, the default value will be used instead. Parameters: feature  The requested feature.