Macros
serdisp_control.h File Reference

Functions for accessing and controlling a display. More...

#include "serdisp_connect.h"
#include <inttypes.h>
Include dependency graph for serdisp_control.h:
This graph shows which files directly or indirectly include this file:

Macros

#define SERDISP_VERSION_MAJOR
 major version of serdisplib
 
#define SERDISP_VERSION_MINOR
 minor version of serdisplib
 
#define SERDISP_VERSION_EXTRA
 extra version postfix (ignored)
 
#define SERDISP_VERSION(_major, _minor)
 calculates a serdisplib version code returns the version code which is calculated using major and minor version information More...
 
#define SERDISP_VERSION_GET_MAJOR(_code)
 
#define SERDISP_VERSION_GET_MINOR(_code)
 

Functions

Device handling functions
serdisp_t * serdisp_init (serdisp_CONN_t *, const char dispname[], const char optionstring[])
 initialises a display More...
 
void serdisp_close (serdisp_t *dd)
 closes display without erasing it More...
 
void serdisp_quit (serdisp_t *dd)
 closes display More...
 
int serdisp_reset (serdisp_t *dd)
 re-initialises the display More...
 
serdisp_t * serdisp_fullreset (serdisp_t *dd)
 resets the display More...
 
serdisp_CONN_t * serdisp_getSDCONN (serdisp_t *dd)
 gets serdisp connect descriptor More...
 
const char * serdisp_defaultdevice (const char *dispname)
 get default device expression More...
 
Library version
long serdisp_getversioncode (void)
 gets version code More...
 
Drawing functions
void serdisp_setsdpixel (serdisp_t *dd, int x, int y, SDCol sdcol)
 changes a pixel in the display buffer More...
 
SDCol serdisp_getsdpixel (serdisp_t *dd, int x, int y)
 gets pixel at position (x/y) More...
 
void serdisp_clearbuffer (serdisp_t *dd)
 resets the display buffer More...
 
void serdisp_clear (serdisp_t *dd)
 clears whole display More...
 
void serdisp_rewrite (serdisp_t *dd)
 rewrites whole display More...
 
void serdisp_update (serdisp_t *dd)
 updates whole display More...
 
void serdisp_blink (serdisp_t *dd, int what, int cnt, int delta)
 flashes the display or the background light More...
 
Get/Set display settings and informations
int serdisp_getwidth (serdisp_t *dd)
 gets width of display More...
 
int serdisp_getheight (serdisp_t *dd)
 gets height of display More...
 
int serdisp_getcolours (serdisp_t *dd)
 gets amount of colours More...
 
int serdisp_getdepth (serdisp_t *dd)
 gets colour depth More...
 
int serdisp_getpixelaspect (serdisp_t *dd)
 gets pixel aspect ratio More...
 
const char * serdisp_getdisplayname (serdisp_t *dd)
 gets unprocessed display name More...
 
void serdisp_currdisplaydescription (serdisp_t *dd, serdisp_display_t *displaydesc)
 gets display description for the display given by a device descriptor More...
 
int serdisp_nextdisplaydescription (serdisp_display_t *displaydesc)
 iterates through supported displays More...
 
int serdisp_isdisplay (const char *displayname)
 tests if display is supported More...
 
int serdisp_getdisplaydescription (const char *displayname, serdisp_display_t *displaydesc)
 gets description to a display More...
 
int serdisp_nextwiringdescription (const char *displayname, serdisp_wiredef_t *wiredesc)
 iterates through wiring descriptions for a display More...
 
Display options
void serdisp_setoption (serdisp_t *dd, const char *optionname, long value)
 changes a display option More...
 
long serdisp_getoption (serdisp_t *dd, const char *optionname, int *typesize)
 gets the value of a display option More...
 
int serdisp_isoption (serdisp_t *dd, const char *optionname)
 tests if option is supported More...
 
int serdisp_getoptiondescription (serdisp_t *dd, const char *optionname, serdisp_options_t *optiondesc)
 gets a description to a given option More...
 
int serdisp_nextoptiondescription (serdisp_t *dd, serdisp_options_t *optiondesc)
 gets the next option description More...
 
int serdisp_nextstaticoptiondesc (const char *displayname, serdisp_options_t *optiondesc)
 gets the next option description More...
 
Backward Compatibility functions
void serdisp_setpixel (serdisp_t *dd, int x, int y, long colour)
 changes a pixel in the display buffer More...
 
long serdisp_getpixel (serdisp_t *dd, int x, int y)
 gets pixel at position (x/y) More...
 
Deprecated functions
void serdisp_feature (serdisp_t *dd, int feature, int value)
 changes a display feature More...
 
void serdisp_setpixels (serdisp_t *dd, int x, int y, int w, int h, byte *data)
 changes an area in the display buffer More...
 

Detailed Description

Date
(C) 2003-2014
Author
wolfgang astleitner (mrwas.nosp@m.tl@u.nosp@m.sers..nosp@m.sour.nosp@m.cefor.nosp@m.ge.n.nosp@m.et)