caca_event(3caca) [bsd man page]

caca_event(3caca)						      libcaca							 caca_event(3caca)

NAME

       caca_event -

       Handling of user events.

SYNOPSIS

   Data Fields
       enum caca_event_type type
       union {
	  struct {
	     int x
	     int y
	     int button
	  } mouse
	  struct {
	     int w
	     int h
	  } resize
	  struct {
	     int ch
	     uint32_t utf32
	     char utf8 [8]
	  } key
       } data

Detailed Description
       This structure is filled by caca_get_event() when an event is received. It is an opaque structure that should only be accessed through
       caca_event_get_type() and similar functions. The struct members may no longer be directly accessible in future versions.

Field Documentation
   enum caca_event_type caca_event::type The event type.
   union { ... }   caca_event::data The event information data
Author
       Generated automatically by Doxygen for libcaca from the source code.

Version 0.99.beta18						  Fri Apr 6 2012						 caca_event(3caca)

libcaca-canvas(3caca)						      libcaca						     libcaca-canvas(3caca)

NAME

       libcaca-canvas - The libcaca canvas format (version 1) All types are big endian.

       struct
       {
       magic:
	  uint8_t caca_header[2];    // ''
	  uint8_t caca_file_type[2]; // 'CV'

       canvas_header:
	  uint32_t control_size;     // Control size (canvas_data - canvas_header)
	  uint32_t data_size;	     // Data size (EOF - canvas_data)

	  uint16_t version;	     // Canvas format version
				     //  bit 0: set to 1 if canvas is compatible
				     // 	with version 1 of the format
				     //  bits 1-15: unused yet, must be 0

	  uint32_t frames;	     // Frame count

	  uint16_t flags;	     // Feature flags
				     //  bits 0-15: unused yet, must be 0

       frame_info:
	  struct
	  {
	     uint32_t width;	     // Frame width
	     uint32_t height;	     // Frame height
	     uint32_t duration;      // Frame duration in milliseconds, 0 to
				     // not specify a duration
	     uint32_t attr;	     // Graphics context attribute
	     int32_t cursor_x;	     // Cursor X coordinate
	     int32_t cursor_y;	     // Cursor Y coordinate
	     int32_t handle_x;	     // Handle X coordinate
	     int32_t handle_y;	     // Handle Y coordinate
	  }
	  frame_list[frames];

       control_extension_1:
       control_extension_2:
	  ...
       control_extension_N:
	  ...			     // reserved for future use

       canvas_data:
	  uint8_t data[data_size];   // canvas data

       data_extension_1:
       data_extension_2:
	  ...
       data_extension_N:
	  ...			     // reserved for future use
       };

Version 0.99.beta18						  Fri Apr 6 2012					     libcaca-canvas(3caca)