Xcm  0.4.2
Data Structures | Functions
X Color Management Core API's

Data Structures

struct  XcolorProfile
struct  XcolorRegion

Functions

int XcolorProfileUpload (Display *dpy, XcolorProfile *profile)
 Uploads the profile into all screens of the display.
int XcolorProfileDelete (Display *dpy, XcolorProfile *profile)
 Decreases the ref-count of the profile.
int XcolorRegionInsert (Display *dpy, Window win, unsigned long pos, XcolorRegion *region, unsigned long nRegions)
 Inserts the supplied regions into the stack.
XcolorRegionXcolorRegionFetch (Display *dpy, Window win, unsigned long *nRegions)
 Fetches the existing regions.
int XcolorRegionDelete (Display *dpy, Window win, unsigned long start, unsigned long count)
 Deletes regions.
int XcolorRegionActivate (Display *dpy, Window win, unsigned long start, unsigned long count)
 Activates regions.

Function Documentation

int XcolorProfileDelete ( Display *  dpy,
XcolorProfile profile 
)

Decreases the ref-count of the profile.

Function XcolorProfileDelete You shouldn't use the profile anymore after this call because it could have been removed from the internal database in the compositing manager. If you do, nothing bad will happen, just that color management won't work on regions that use this profile.

int XcolorProfileUpload ( Display *  dpy,
XcolorProfile profile 
)

Uploads the profile into all screens of the display.

Function XcolorProfileUpload Uploads the profile into all screens of the display. Profiles are ref-counted inside the compositing manager, so make sure to call XcolorProfileDelete() before your application exits or when you don't need the profile anymore.

int XcolorRegionActivate ( Display *  dpy,
Window  win,
unsigned long  start,
unsigned long  count 
)

Activates regions.

Function XcolorRegionActivate Activates 'count' regions starting at positiong 'start' in the stack. Unlike the other functions it does not check whether 'start + count' extends beyond the stack end. To disable all regions pass zero to 'count'.

int XcolorRegionDelete ( Display *  dpy,
Window  win,
unsigned long  start,
unsigned long  count 
)

Deletes regions.

Function XcolorRegionDelete Deletes 'count' regions starting at 'start' in the stack. If 'start + count' in beyond the stack end, nothing will be done and the function returns '-1'.

XcolorRegion* XcolorRegionFetch ( Display *  dpy,
Window  win,
unsigned long *  nRegions 
)

Fetches the existing regions.

Function XcolorRegionFetch Fetches the existing regions and returns an array of 'XcolorRegion'. After you're done, free the array using XFree(). The number of regions is put into 'nRegions'.

int XcolorRegionInsert ( Display *  dpy,
Window  win,
unsigned long  pos,
XcolorRegion region,
unsigned long  nRegions 
)

Inserts the supplied regions into the stack.

Function XcolorRegionInsert Inserts the supplied regions into the stack at the position 'pos', shifting the existing profiles upwards in the stack. If 'pos' is beyond the stack end, nothing will be done and the function returns '-1'.