X-Git-Url: http://git.demorecorder.com/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=doc%2Ftutorial%2Findex.html;h=94b59a52bd8737e894ced8c7a3094a02e7aa199f;hb=771761ccaad31d029d470dde84279e94494310b6;hp=ac6e502dad843dd81111984bfe577c4bfcc2296a;hpb=47ceed78612d48dcda62cc2686fc527d61abe38b;p=free-sw%2Fxcb%2Flibxcb diff --git a/doc/tutorial/index.html b/doc/tutorial/index.html index ac6e502..94b59a5 100755 --- a/doc/tutorial/index.html +++ b/doc/tutorial/index.html @@ -5,7 +5,8 @@ Basic Graphics Programming With The XCB Library - + + @@ -14,149 +15,150 @@
    -
  1. Introduction
  2. -
  3. The client and server model of the X window system
  4. -
  5. GUI programming: the asynchronous model
  6. -
  7. Basic XCB notions
  8. +
  9. Introduction +
  10. The client and server model of the X window system +
  11. GUI programming: the asynchronous model +
  12. Basic XCB notions
      -
    1. The X Connection
    2. -
    3. Requests and replies: the Xlib killers
    4. -
    5. The Graphics Context
    6. -
    7. Object handles
    8. -
    9. Memory allocation for XCB structures
    10. -
    11. Events
    12. +
    13. The X Connection +
    14. Requests and replies: the Xlib killers +
    15. The Graphics Context +
    16. Object handles +
    17. Memory allocation for XCB structures +
    18. Events
    -
  13. Using XCB-based programs
  14. +
  15. Using XCB-based programs
      -
    1. Installation of XCB
    2. -
    3. Compiling XCB-based programs
    4. +
    5. Installation of XCB +
    6. Compiling XCB-based programs
    -
  16. Opening and closing the connection to an X server
  17. -
  18. Checking basic information about a connection
  19. -
  20. Creating a basic window - the "hello world" program
  21. -
  22. Drawing in a window
  23. +
  24. Opening and closing the connection to an X server +
  25. Checking basic information about a connection +
  26. Creating a basic window - the "hello world" program +
  27. Drawing in a window
      -
    1. Allocating a Graphics Context
    2. -
    3. Changing the attributes of a Graphics Context
    4. -
    5. Drawing primitives: point, line, box, circle,...
    6. +
    7. Allocating a Graphics Context +
    8. Changing the attributes of a Graphics Context +
    9. Drawing primitives: point, line, box, circle,...
    -
  28. X Events
  29. +
  30. X Events
      -
    1. Registering for event types using event masks
    2. -
    3. Receiving events: writing the events loop
    4. -
    5. Expose events
    6. -
    7. Getting user input
    8. -
        -
      1. Mouse button press and release events
      2. -
      3. Mouse movement events
      4. -
      5. Mouse pointer enter and leave events
      6. -
      7. The keyboard focus
      8. -
      9. Keyboard press and release events
      10. -
      -
    9. X events: a complete example
    10. +
    11. Registering for event types using event masks +
    12. Receiving events: writing the events loop +
    13. Expose events +
    14. Getting user input +
        +
      1. Mouse button press and release events +
      2. Mouse movement events +
      3. Mouse pointer enter and leave events +
      4. The keyboard focus +
      5. Keyboard press and release events +
      +
    15. X events: a complete example
    -
  31. Handling text and fonts
  32. +
  33. Handling text and fonts
      -
    1. The Font structure
    2. -
    3. Loading a Font
    4. -
    5. Assigning a Font to a Graphic Context
    6. -
    7. Drawing text in a window
    8. +
    9. The Font structure +
    10. Loading a Font +
    11. Assigning a Font to a Graphic Context +
    12. Drawing text in a window
    -
  34. Windows hierarchy
  35. +
  36. Windows hierarchy
      -
    1. Root, parent and child windows
    2. -
    3. Events propagation
    4. +
    5. Root, parent and child windows +
    6. Events propagation
    -
  37. Interacting with the window manager
  38. +
  39. Interacting with the window manager
      -
    1. Window properties
    2. -
    3. Setting the window name and icon name
    4. -
    5. Setting preferred window size(s)
    6. -
    7. Setting miscellaneous window manager hints
    8. -
    9. Setting an application's icon
    10. +
    11. Window properties +
    12. Setting the window name and icon name +
    13. Setting preferred window size(s) +
    14. Setting miscellaneous window manager hints +
    15. Setting an application's icon +
    16. Obeying the delete-window protocol
    -
  40. Simple window operations
  41. +
  42. Simple window operations
      -
    1. Mapping and un-mapping a window
    2. -
    3. Configuring a window
    4. -
    5. Moving a window around the screen
    6. -
    7. Resizing a window
    8. -
    9. Changing windows stacking order: raise and lower
    10. -
    11. Iconifying and de-iconifying a window
    12. -
    13. Getting informations about a window
    14. +
    15. Mapping and unmapping a window +
    16. Configuring a window +
    17. Moving a window around the screen +
    18. Resizing a window +
    19. Changing windows stacking order: raise and lower +
    20. Iconifying and de-iconifying a window +
    21. Getting informations about a window
    -
  43. Using colors to paint the rainbow
  44. +
  45. Using colors to paint the rainbow
      -
    1. Color maps
    2. -
    3. Allocating and freeing Color Maps
    4. -
    5. Allocating and freeing a color entry
    6. -
    7. Drawing with a color
    8. +
    9. Color maps +
    10. Allocating and freeing Color Maps +
    11. Allocating and freeing a color entry +
    12. Drawing with a color
    -
  46. X Bitmaps and Pixmaps
  47. +
  48. X Bitmaps and Pixmaps
      -
    1. What is a X Bitmap ? An X Pixmap ?
    2. -
    3. Loading a bitmap from a file
    4. -
    5. Drawing a bitmap in a window
    6. -
    7. Creating a pixmap
    8. -
    9. Drawing a pixmap in a window
    10. -
    11. Freeing a pixmap
    12. +
    13. What is a X Bitmap ? An X Pixmap ? +
    14. Loading a bitmap from a file +
    15. Drawing a bitmap in a window +
    16. Creating a pixmap +
    17. Drawing a pixmap in a window +
    18. Freeing a pixmap
    -
  49. Messing with the mouse cursor
  50. +
  51. Messing with the mouse cursor
      -
    1. Creating and destroying a mouse cursor
    2. -
    3. Setting a window's mouse cursor
    4. +
    5. Creating and destroying a mouse cursor +
    6. Setting a window's mouse cursor
    -
  52. Translation of basic Xlib functions and macros
  53. +
  54. Translation of basic Xlib functions and macros
      -
    1. Members of the Display structure
    2. +
    3. Members of the Display structure
        -
      1. ConnectionNumber
      2. -
      3. DefaultScreen
      4. -
      5. QLength
      6. -
      7. ScreenCount
      8. -
      9. ServerVendor
      10. -
      11. ProtocolVersion
      12. -
      13. ProtocolRevision
      14. -
      15. VendorRelease
      16. -
      17. DisplayString
      18. -
      19. BitmapUnit
      20. -
      21. BitmapBitOrder
      22. -
      23. BitmapPad
      24. -
      25. ImageByteOrder
      26. +
      27. ConnectionNumber +
      28. DefaultScreen +
      29. QLength +
      30. ScreenCount +
      31. ServerVendor +
      32. ProtocolVersion +
      33. ProtocolRevision +
      34. VendorRelease +
      35. DisplayString +
      36. BitmapUnit +
      37. BitmapBitOrder +
      38. BitmapPad +
      39. ImageByteOrder
      -
    4. ScreenOfDisplay related functions
    5. +
    6. ScreenOfDisplay related functions
        -
      1. ScreenOfDisplay
      2. -
      3. DefaultScreenOfDisplay
      4. -
      5. RootWindow / RootWindowOfScreen
      6. -
      7. DefaultRootWindow
      8. -
      9. DefaultVisual / DefaultVisualOfScreen
      10. -
      11. DefaultGC / DefaultGCOfScreen
      12. -
      13. BlackPixel / BlackPixelOfScreen
      14. -
      15. WhitePixel / WhitePixelOfScreen
      16. -
      17. DisplayWidth / WidthOfScreen
      18. -
      19. DisplayHeight / HeightOfScreen
      20. -
      21. DisplayWidthMM / WidthMMOfScreen
      22. -
      23. DisplayHeightMM / HeightMMOfScreen
      24. -
      25. DisplayPlanes / DefaultDepth / DefaultDepthOfScreen / PlanesOfScreen
      26. -
      27. DefaultColormap / DefaultColormapOfScreen
      28. -
      29. MinCmapsOfScreen
      30. -
      31. MaxCmapsOfScreen
      32. -
      33. DoesSaveUnders
      34. -
      35. DoesBackingStore
      36. -
      37. EventMaskOfScreen
      38. +
      39. ScreenOfDisplay +
      40. DefaultScreenOfDisplay +
      41. RootWindow / RootWindowOfScreen +
      42. DefaultRootWindow +
      43. DefaultVisual / DefaultVisualOfScreen +
      44. DefaultGC / DefaultGCOfScreen +
      45. BlackPixel / BlackPixelOfScreen +
      46. WhitePixel / WhitePixelOfScreen +
      47. DisplayWidth / WidthOfScreen +
      48. DisplayHeight / HeightOfScreen +
      49. DisplayWidthMM / WidthMMOfScreen +
      50. DisplayHeightMM / HeightMMOfScreen +
      51. DisplayPlanes / DefaultDepth / DefaultDepthOfScreen / PlanesOfScreen +
      52. DefaultColormap / DefaultColormapOfScreen +
      53. MinCmapsOfScreen +
      54. MaxCmapsOfScreen +
      55. DoesSaveUnders +
      56. DoesBackingStore +
      57. EventMaskOfScreen
      -
    7. Miscellaneaous macros
    8. +
    9. Miscellaneaous macros
        -
      1. DisplayOfScreen
      2. -
      3. DisplayCells / CellsOfScreen
      4. +
      5. DisplayOfScreen +
      6. DisplayCells / CellsOfScreen
    -
  1. Introduction
  2. +
  3. Introduction

    This tutorial is based on the Xlib Tutorial @@ -165,62 +167,65 @@ deals with the X Windows generality.

    - This tutorial is intended to people who want to start to program + This tutorial is intended for people who want to start to program with the XCB - library. As for the Xlib - library, it is useless and a real X - programmer should use a much higher level of abstraction, such - as using Motif, + library. keep in mind that XCB, like the + Xlib + library, isn't what post programmers wanting to write X + applications are looking for. They should use a much higher + level GUI toolkit like Motif, LessTiff, GTK, QT or - EWL. However, + EWL, or use + Cairo. + However, we need to start somewhere. More than this, knowing how things work down below is never a bad idea.

    After reading this tutorial, one should be able to write very - simple graphical programs, but not programs with a descent user - interface. For such programs, one of the previously mentioned - library should be used. + simple graphical programs, but not programs with decent user + interfaces. For such programs, one of the previously mentioned + libraries should be used.

    - But what is XCB ? Xlib has been - the standard C binding for the X + But what is XCB? Xlib has been + the standard C binding for the X Window System protocol for many years now. It is an excellent piece of work, but there are applications for which it - is not ideal, for example + is not ideal, for example: +

    • Small platforms: Xlib is a large piece of code, and - it's difficult to make it smaller
    • + it's difficult to make it smaller
    • Latency hiding: Xlib requests requiring a reply are - effectively synchronous: they block until the reply appears, - whether the result is needed immediately or not.
    • -
    • Direct access to the protocol: Xlib does quite a - bit of caching, layering, and similar optimizations. While this - is normally a feature, it makes it difficult to simply emit - specified X protocol requests and process specific - responses.
    • -
    • Threaded applications: While Xlib does attempt to - support multithreading, the API makes this difficult and - error-prone.
    • -
    • New extensions: The Xlib infrastructure provides - limited support for the new creation of X extension client side - code.
    • + effectively synchronous: they block until the reply appears, + whether the result is needed immediately or not. +
    • Direct access to the protocol: Xlib does quite a + bit of caching, layering, and similar optimizations. While this + is normally a feature, it makes it difficult to simply emit + specified X protocol requests and process specific + responses. +
    • Threaded applications: While Xlib does attempt to + support multithreading, the API makes this difficult and + error-prone. +
    • New extensions: The Xlib infrastructure provides + limited support for the new creation of X extension client side + code.
    -

    For these reasons, among others, XCB, an X C binding, has been designed to solve the above problems and thus provide a base for +

      -
    • Toolkit implementation.
    • -
    • Direct protocol-level programming.
    • -
    • Lightweight emulation of commonly used portions of the - Xlib API (in progress)
    • +
    • Toolkit implementation. +
    • Direct protocol-level programming. +
    • Lightweight emulation of commonly used portions of the + Xlib API.
    -

    -

    -
  4. The client and server model of the X window system
  5. +
    +
  6. The client and server model of the X window system

    The X Window System was developed with one major goal: flexibility. The idea was that the way things look is one thing, @@ -234,14 +239,14 @@

    This model is the complete opposite of what is used to when - dealing with clients and servers. In our case, the user seats + dealing with clients and servers. In our case, the user sits near the machine controlled by the server, while the client might be running on a remote machine. The server controls the screens, mouse and keyboard. A client may connect to the server, request that it draws a window (or several windows), and ask the server to send it any input the user sends to these windows. Thus, several clients may connect to a single X server - (one might be running an mail software, one running a WWW + (one might be running mail software, one running a WWW browser, etc). When input is sent by the user to some window, the server sends a message to the client controlling this window for processing. The client decides what to do with this input, @@ -255,10 +260,10 @@ X servers were extended to allow clients running on the local machine with more optimized access to the server (note that an X protocol message may be several hundreds of KB in size), such as - using shred memory, or using Unix domain sockets (a method for - creating a logical channel on a Unix system between two processors). + using shared memory, or using Unix domain sockets (a method for + creating a logical channel on a Unix system between two processes).

    -
  7. GUI programming: the asynchronous model
  8. +
  9. GUI programming: the asynchronous model

    Unlike conventional computer programs, that carry some serial nature, a GUI program usually uses an asynchronous programming @@ -266,7 +271,7 @@ that program mostly sits idle, waiting for events sent by the X server, and then acts upon these events. An event may say "The user pressed the 1st button mouse in spot (x,y)", or "The window - you control needs to be redrawn". In order for the program to e + you control needs to be redrawn". In order for the program to be responsive to the user input, as well as to refresh requests, it needs to handle each event in a rather short period of time (e.g. less that 200 milliseconds, as a rule of thumb). @@ -283,25 +288,25 @@

    So the way a GUI program looks is something like that: +

      -
    1. Perform initialization routines.
    2. -
    3. Connect to the X server.
    4. -
    5. Perform X-related initialization.
    6. -
    7. While not finished:
    8. -
        -
      1. Receive the next event from the X server.
      2. -
      3. Handle the event, possibly sending various drawing - requests to the X server.
      4. -
      5. If the event was a quit message, exit the loop.
      6. -
      -
    9. Close down the connection to the X server.
    10. -
    11. Perform cleanup operations.
    12. +
    13. Perform initialization routines. +
    14. Connect to the X server. +
    15. Perform X-related initialization. +
    16. While not finished: +
        +
      1. Receive the next event from the X server. +
      2. Handle the event, possibly sending various drawing + requests to the X server. +
      3. If the event was a quit message, exit the loop. +
      +
    17. Close down the connection to the X server. +
    18. Perform cleanup operations.
    -

    -

    -
  10. Basic XCB notions
  11. +
    +
  12. Basic XCB notions

    - XCB has been created to eliminate the needs of + XCB has been created to eliminate the need for programs to actually implement the X protocol layer. This library gives a program a very low-level access to any X server. Since the protocol is standardized, a client using any @@ -310,22 +315,23 @@ the basic XCB notions. They will be detailed later.

      -
    1. The X Connection
    2. -

      - The major notion of using XCB is the X Connection. This is a - structure representing the connection we have open with a - given X server. It hides a queue of messages coming from the - server, and a queue of pending requests that our client - intends to send to the server. In XCB, this structure is named - 'XCBConnection'. When we open a connection to an X server, the - library returns a pointer to such a structure. Later, we - supply this pointer to any XCB function that should send - messages to the X server or receive messages from this server. -

      +
    3. The X Connection +

      + The major notion of using XCB is the X Connection. This is a + structure representing the connection we have open with a + given X server. It hides a queue of messages coming from the + server, and a queue of pending requests that our client + intends to send to the server. In XCB, this structure is named + 'XCBConnection'. It is analogous to the Xlib Display. + When we open a connection to an X server, the + library returns a pointer to such a structure. Later, we + supply this pointer to any XCB function that should send + messages to the X server or receive messages from this server. +

    4. Requests and - replies: the Xlib killers
    5. -

      - To ask informations to the X server, we have to make a request + replies: the Xlib killers +

      + To ask for information from the X server, we have to make a request and ask for a reply. With Xlib, these two tasks are automatically done: Xlib locks the system, sends a request, waits for a reply from the X server and unlocks. This is @@ -336,14 +342,14 @@ requests/replies with Xlib, with a round-trip latency T_round_trip that is 5 times long as the time required to write or read a request/reply (T_write/T_read): -

      -
      +        

      +
         W-----RW-----RW-----RW-----R
       
        -
      • W: Writing request
      • -
      • -: Stalled, waiting for data
      • -
      • R: Reading reply
      • +
      • W: Writing request +
      • -: Stalled, waiting for data +
      • R: Reading reply

      The total time is N * (T_write + T_round_trip + T_read). @@ -359,7 +365,7 @@ when we need them. Here is the time-line for 4 requests/replies when we use this property of XCB:

      -
      +        
         WWWW--RRRR
       

      @@ -388,7 +394,7 @@ get_time(void) { struct timeval timev; - gettimeofday(&timev, NULL); + gettimeofday(&timev, NULL); return (double)timev.tv_sec + (((double)timev.tv_usec) / 1000000); } @@ -496,80 +502,87 @@ main () return 1; }

      -
    6. The Graphic Context
    7. -

      - When we perform various drawing operations (graphics, text, - etc), we may specify various options for controlling how the - data will be drawn (what foreground and background colors to - use, how line edges will be connected, what font to use when - drawing some text, etc). In order to avoid the need to supply - hundreds of parameters to each drawing function, a graphical - context structure is used. We set the various drawing options - in this structure, and then, we pass a pointer to this - structure to any drawing routines. This is rather handy, as we - often need to perform several drawing requests with the same - options. Thus, we would initialize a graphical context, set - the desired options, and pass this structure to all drawing - functions. -

      +
    8. The Graphic Context +

      + When we perform various drawing operations (graphics, text, + etc), we may specify various options for controlling how the + data will be drawn (what foreground and background colors to + use, how line edges will be connected, what font to use when + drawing some text, etc). In order to avoid the need to supply + hundreds of parameters to each drawing function, a graphical + context structure is used. We set the various drawing options + in this structure, and then we pass a pointer to this + structure to any drawing routines. This is rather handy, as we + often need to perform several drawing requests with the same + options. Thus, we would initialize a graphical context, set + the desired options, and pass this structure to all drawing + functions. +

      Note that graphic contexts have no client-side structure in XCB, they're just XIDs. Xlib has a client-side structure because it caches the GC contents so it can avoid making redundant requests, but of course XCB doesn't do that.

      -
    9. Events
    10. -

      - A structure is used to pass events received from the X - server. XCB supports exactly the events specified in the - protocol (33 events). This structure contains the type - of event received, as well as the data associated with the - event (e.g. position on the screen where the event was - generated, mouse button associated with the event, region of - the screen associated with a "redraw" event, etc). The way to - read the event's data epends on the event type. -

      +
    11. Events +

      + A structure is used to pass events received from the X + server. XCB supports exactly the events specified in the + protocol (33 events). This structure contains the type + of event received (including a bit for whether it came + from the server or another client), as well as the data associated with the + event (e.g. position on the screen where the event was + generated, mouse button associated with the event, region of + the screen associated with a "redraw" event, etc). The way to + read the event's data depends on the event type. +

    -

    -
  13. Using XCB-based programs
  14. -

    +
    +
  15. Using XCB-based programs +
      -
    1. Installation of XCB
    2. -

      - To build XCB from source, you need to have installed at - least: -

      -
        -
      • pkgconfig 0.15.0
      • -
      • automake 1.7
      • -
      • autoconf 2.50
      • -
      • check
      • -
      • xsltproc
      • -
      -

      - You have to checkout in CVS the following modules: -

      -
        -
      • Xproto from xlibs
      • -
      • Xau from xlibs
      • -
      • xcb-proto
      • -
      • xcb
      • -
      -

      - Note that Xproto and xcb-proto exist only to install header - files, so typing 'make' or 'make all' will produce the message - "Nothing to be done for 'all'". That's normal. -

      -
    3. Compiling XCB-based programs
    4. -

      - Compiling XCB-based programs requires linking them with the XCB - library. This is easily done thanks to pkgconfig: -

      -
      +        
    5. Installation of XCB +

      + TODO: These instructions are out of date. + Just reference the main XCB page + so we don't have to maintain these instructions in more than + one place. +

      +

      + To build XCB from source, you need to have installed at + least: +

      +
        +
      • pkgconfig 0.15.0 +
      • automake 1.7 +
      • autoconf 2.50 +
      • check +
      • xsltproc +
      +

      + You have to checkout in CVS the following modules: +

      +
        +
      • Xproto from xlibs +
      • Xau from xlibs +
      • xcb-proto +
      • xcb +
      +

      + Note that Xproto and xcb-proto exist only to install header + files, so typing 'make' or 'make all' will produce the message + "Nothing to be done for 'all'". That's normal. +

      +
    6. Compiling XCB-based programs +

      + Compiling XCB-based programs requires linking them with the XCB + library. This is easily done thanks to pkgconfig: +

      +
       gcc -Wall prog.c -o prog `pkg-config --cflags --libs xcb`
       
    -
  16. Opening and closing the connection to an X server
  17. +
  18. Opening and closing the connection to an X server

    An X program first needs to open the connection to the X server. There is a function that opens a connection. It requires @@ -593,7 +606,7 @@ main (int argc, char *argv[]) { XCBConnection *c; - /* Open the connection to the X server. use the DISPLAY environment variable as the default display name */ + /* Open the connection to the X server. Use the DISPLAY environment variable as the default display name */ c = XCBConnect (NULL, NULL); return 1; @@ -607,38 +620,38 @@ void XCBDisconnect (XCBConnection *c);

    - Comparison Xlib/XCB -
    -
    -
      -
    • XOpenDisplay ()
    • -
    -
    -
    -
      -
    • XCBConnect ()
    • -
    -
    -
    -
      -
    • XCloseDisplay ()
    • -
    -
    -
    -
      -
    • XCBDisconnect ()
    • -
    -
    + Comparison Xlib/XCB +
    +
    +
      +
    • XOpenDisplay () +
    +
    +
    +
      +
    • XCBConnect () +
    +
    +
    +
      +
    • XCloseDisplay () +
    +
    +
    +
      +
    • XCBDisconnect () +
    +

-
  • Checking basic information about a connection
  • +
  • Checking basic information about a connection

    - Once we opened a connection to an X server, we should check some - basic informations about it: what screens it has, what is the + Once we have opened a connection to an X server, we should check some + basic information about it: what screens it has, what is the size (width and height) of the screen, how many colors it supports (black and white ? grey scale ?, 256 colors ? more ?), - and so on. We get such informations from the XCBSCREEN + and so on. We get such information from the XCBSCREEN structure:

    @@ -685,11 +698,11 @@ main (int argc, char *argv[])
       XCBSCREENIter  iter;
       
       /* Open the connection to the X server. Use the DISPLAY environment variable */
    -  c = XCBConnect (NULL, &screen_nbr);
    +  c = XCBConnect (NULL, &screen_nbr);
       
       /* Get the screen #screen_nbr */
       iter = XCBConnSetupSuccessRepRootsIter (XCBGetSetup (c));
    -  for (; iter.rem; --screen_nbr, XCBSCREENNext (&iter))
    +  for (; iter.rem; --screen_nbr, XCBSCREENNext (&iter))
         if (screen_nbr == 0)
           {
             screen = iter.data;
    @@ -707,9 +720,9 @@ main (int argc, char *argv[])
       return 1;
     }
     
    -
  • Creating a basic window - the "hello world" program
  • +
  • Creating a basic window - the "hello world" program

    - After we got some basic informations about our screen, we can + After we got some basic information about our screen, we can create our first window. In the X Window System, a window is characterized by an Id. So, in XCB, a window is of type:

    @@ -731,16 +744,16 @@ XCBWINDOW XCBWINDOWNew(XCBConnection *c); XCBVoidCookie XCBCreateWindow (XCBConnection *c, /* Pointer to the XCBConnection structure */ CARD8 depth, /* Depth of the screen */ XCBWINDOW wid, /* Id of the window */ - XCBWINDOW parent, /* Id of an existing window that should be the parent of the new window */ - INT16 x, /* X position of the top-left corner of the window (in pixels) */ - INT16 y, /* Y position of the top-left corner of the window (in pixels) */ - CARD16 width, /* Width of the window (in pixels) */ - CARD16 height, /* Height of the window (in pixels) */ - CARD16 border_width, /* Width of the window's border (in pixels) */ - CARD16 _class, - XCBVISUALID visual, - CARD32 value_mask, - const CARD32 *value_list); + XCBWINDOW parent, /* Id of an existing window that should be the parent of the new window */ + INT16 x, /* X position of the top-left corner of the window (in pixels) */ + INT16 y, /* Y position of the top-left corner of the window (in pixels) */ + CARD16 width, /* Width of the window (in pixels) */ + CARD16 height, /* Height of the window (in pixels) */ + CARD16 border_width, /* Width of the window's border (in pixels) */ + CARD16 _class, + XCBVISUALID visual, + CARD32 value_mask, + const CARD32 *value_list);

    The fact that we created the window does not mean that it will @@ -757,7 +770,7 @@ XCBVoidCookie XCBMapWindow (XCBConnection *c, XCBWINDOW window); 150x150 pixels, positioned at the top-left corner of the screen:

    -#include <unistd.h>
    +#include <unistd.h>      /* pause() */
     
     #include <X11/XCB/xcb.h>
     
    @@ -779,28 +792,29 @@ main (int argc, char *argv[])
     
       /* Create the window */
       XCBCreateWindow (c,                        /* Connection          */
    - 		   0,                        /* depth               */
    -		   win.window,               /* window Id           */
    -		   screen->root,             /* parent window       */
    -		   0, 0,                     /* x, y                */
    -		   150, 150,                 /* width, height       */
    -		   10,                       /* border_width        */
    -		   InputOutput,              /* class               */
    -		   screen->root_visual,      /* visual              */
    -		   0, NULL);                 /* masks, not used yet */
    +                   XCBCopyFromParent,        /* depth (same as root)*/
    +                   win.window,               /* window Id           */
    +                   screen->root,             /* parent window       */
    +                   0, 0,                     /* x, y                */
    +                   150, 150,                 /* width, height       */
    +                   10,                       /* border_width        */
    +                   XCBWindowClassInputOutput,/* class               */
    +                   screen->root_visual,      /* visual              */
    +                   0, NULL);                 /* masks, not used yet */
     
       /* Map the window on the screen */
       XCBMapWindow (c, win.window);
     
    -  XCBSync (c, 0);
    +  /* Make sure commands are sent before we pause, so window is shown */
    +  XCBFlush (c);
       
    -  pause ();
    +  pause ();    /* hold client until Ctrl-C */
     
       return 1;
     }
     

    - In this code, you see one more function - XCBSync(), not explained + In this code, you see one more function - XCBFlush(), not explained yet. It is used to flush all the pending requests. More precisely, there are 2 functions that do such things. The first one is XCBFlush(): @@ -832,7 +846,7 @@ int XCBSync(XCBConnection *c, XCBGenericError **e); described yet. See the subsections Configuring a window or Registering for event types using event masks - for exemples on how to use these parameters. In addition, as no + for examples on how to use these parameters. In addition, as no events are handled, you have to make a Ctrl-C to interrupt the program.

    @@ -842,22 +856,22 @@ int XCBSync(XCBConnection *c, XCBGenericError **e);

    - Comparison Xlib/XCB -
    -
    -
      -
    • XCreateWindow ()
    • -
    -
    -
    -
      -
    • XCBWINDOWNew ()
    • -
    • XCBCreateWindow ()
    • -
    -
    + Comparison Xlib/XCB +
    +
    +
      +
    • XCreateWindow () +
    +
    +
    +
      +
    • XCBWINDOWNew () +
    • XCBCreateWindow () +
    +
    -

    -
  • Drawing in a window
  • +
    +
  • Drawing in a window

    Drawing in a window can be done using various graphical functions (drawing pixels, lines, rectangles, etc). In order to @@ -866,42 +880,42 @@ int XCBSync(XCBConnection *c, XCBGenericError **e); with, etc). This is done using a graphical context.

      -
    1. Allocating a Graphics Context
    2. +
    3. Allocating a Graphics Context

      - As we said, a graphical context defines several attributes to - be used with the various drawing functions. For this, we - define a graphical context. We can use more than one graphical - context with a single window, in order to draw in multiple - styles (different colors, different line widths, etc). In XCB, - a Graphics Context is, as a window, characterized by an Id: + As we said, a graphical context defines several attributes to + be used with the various drawing functions. For this, we + define a graphical context. We can use more than one graphical + context with a single window, in order to draw in multiple + styles (different colors, different line widths, etc). In XCB, + a Graphics Context is, as a window, characterized by an Id:

      -
      +        
       typedef struct {
           CARD32 xid;
       } XCBGCONTEXT;
       

      We first ask the X server to attribute an Id to our graphic - context with this function: + context with this function:

      -
      +        
       XCBGCONTEXT XCBGCONTEXTNew (XCBConnection *c);
       

      Then, we set the attributes of the graphic context with this function:

      -
      +        
       XCBVoidCookie XCBCreateGC (XCBConnection *c,
                                  XCBGCONTEXT    cid,
      -			   XCBDRAWABLE    drawable,
      -			   CARD32         value_mask,
      -			   const CARD32  *value_list);
      +                           XCBDRAWABLE    drawable,
      +                           CARD32         value_mask,
      +                           const CARD32  *value_list);
       

      - We give now an example on how to allocate a graphic context - that specifies that each drawing functions that use it will - draw in foreground with a black color. -

      + We give now an example on how to allocate a graphic context + that specifies that each drawing function that uses it will + draw in foreground with a black color. +

       #include <X11/XCB/xcb.h>
       
      @@ -922,7 +936,7 @@ main (int argc, char *argv[])
         /* Create a black graphic context for drawing in the foreground */
         win.window = screen->root;
         black = XCBGCONTEXTNew (c);
      -  mask = GCForeground;
      +  mask = XCBGCForeground;
         value[0] = screen->black_pixel;
         XCBCreateGC (c, black, win, mask, value);
       
      @@ -931,171 +945,176 @@ main (int argc, char *argv[])
       

      Note should be taken regarding the role of "value_mask" and - "value_list" in the prototype of XCBCreateGC(). Since a - graphic context has many attributes, and since we often just - want to define a few of them, we need to be able to tell the - XCBCreateGC() which attributes we - want to set. This is what the "value_mask" parameter is - for. We then use the "value_list" parameter to specify actual - values for the attribute we defined in "value_mask". Thus, for - each constant used in "value_list", we will use the matching - constant in "value_mask". In this case, we define a graphic - context with one attribute: when drawing (a point, a line, - etc), the foreground color will be black. The rest of the - attributes of this graphic context will be set to their - default values. -

      -

      - See the next Subsection for more details. -

      + "value_list" in the prototype of XCBCreateGC(). Since a + graphic context has many attributes, and since we often just + want to define a few of them, we need to be able to tell the + XCBCreateGC() which attributes we + want to set. This is what the "value_mask" parameter is + for. We then use the "value_list" parameter to specify actual + values for the attribute we defined in "value_mask". Thus, for + each constant used in "value_list", we will use the matching + constant in "value_mask". In this case, we define a graphic + context with one attribute: when drawing (a point, a line, + etc), the foreground color will be black. The rest of the + attributes of this graphic context will be set to their + default values. +

      +

      + See the next Subsection for more details. +

      - Comparison Xlib/XCB -
      -
      -
        -
      • XCreateGC ()
      • -
      -
      -
      -
        -
      • XCBGCONTEXTNew ()
      • -
      • XCBCreateGC ()
      • -
      -
      + Comparison Xlib/XCB +
      +
      +
        +
      • XCreateGC () +
      +
      +
      +
        +
      • XCBGCONTEXTNew () +
      • XCBCreateGC () +
      +
      -

      -
    4. Changing the attributes of a Graphics Context
    5. -

      - Once we have allocated a Graphic Context, we may need to - change its attributes (for example, changing the foreground - color we use to draw a line, or changing the attributes of the - font we use to display strings. See Subsections Drawing with a - color and Assigning a Font to a Graphic Context). This is done - by using this function: -

      -
      +        
      +
    6. Changing the attributes of a Graphics Context +

      + Once we have allocated a Graphic Context, we may need to + change its attributes (for example, changing the foreground + color we use to draw a line, or changing the attributes of the + font we use to display strings. See Subsections Drawing with a + color and Assigning a Font to a Graphic Context). This is done + by using this function: +

      +
       XCBVoidCookie XCBChangeGC (XCBConnection *c,           /* The XCB Connection */
                                  XCBGCONTEXT    gc,          /* The Graphic Context */
      -			   CARD32         value_mask,  /* Components of the Graphic Context that have to be set */
      -			   const CARD32  *value_list); /* Value as specified by value_mask */
      -
      -

      - The value_mask parameter could take - these values: -

      -
        -
      • GCFunction
      • -
      • GCPlaneMask
      • -
      • GCForeground
      • -
      • GCBackground
      • -
      • GCLineWidth
      • -
      • GCLineStyle
      • -
      • GCCapStyle
      • -
      • GCJoinStyle
      • -
      • GCFillStyle
      • -
      • GCFillRule
      • -
      • GCTile
      • -
      • GCStipple
      • -
      • GCTileStipXOrigin
      • -
      • GCTileStipYOrigin
      • -
      • GCFont
      • -
      • GCSubwindowMode
      • -
      • GCGraphicsExposures
      • -
      • GCClipXOrigin
      • -
      • GCClipYOrigin
      • -
      • GCClipMask
      • -
      • GCDashOffset
      • -
      • GCDashList
      • -
      • GCArcMode
      • -
      -

      - It is possible to set several attributes at the same - time (for example setting the attributes of a font and the - color which will be used to display a string), by OR'ing these - values in value_mask. Then - value_list has to be an array which - lists the value for the respective attributes. See Subsection - Drawing with a color to have an example. -

      -

      - TODO: set the links of the 3 subsections, once they will - be written :) -

      -

      - TODO: give an example which sets several attributes. -

      -
    7. Drawing primitives: point, line, box, circle,...
    8. -

      - After we have created a Graphic Context, we can draw on a - window using this Graphic Context, with a set of XCB - functions, collectively called "drawing primitive". Let see - how they are used. -

      -

      - To draw a point, or several points, we use -

      -
      +                           CARD32         value_mask,  /* Components of the Graphic Context that have to be set */
      +                           const CARD32  *value_list); /* Value as specified by value_mask */
      +
      +

      + The value_mask parameter could take + any combination of these masks from the XCBGC enumeration: +

      +
        +
      • XCBGCFunction +
      • XCBGCPlaneMask +
      • XCBGCForeground +
      • XCBGCBackground +
      • XCBGCLineWidth +
      • XCBGCLineStyle +
      • XCBGCCapStyle +
      • XCBGCJoinStyle +
      • XCBGCFillStyle +
      • XCBGCFillRule +
      • XCBGCTile +
      • XCBGCStipple +
      • XCBGCTileStippleOriginX +
      • XCBGCTileStippleOriginY +
      • XCBGCFont +
      • XCBGCSubwindowMode +
      • XCBGCGraphicsExposures +
      • XCBGCClipOriginX +
      • XCBGCClipOriginY +
      • XCBGCClipMask +
      • XCBGCDashOffset +
      • XCBGCDashList +
      • XCBGCArcMode +
      +

      + It is possible to set several attributes at the same + time (for example setting the attributes of a font and the + color which will be used to display a string), by OR'ing these + values in value_mask. Then + value_list has to be an array which + lists the value for the respective attributes. These values + must be in the same order as masks listed above. See Subsection + Drawing with a color to have an example. +

      +

      + TODO: set the links of the 3 subsections, once they will + be written :) +

      +

      + TODO: give an example which sets several attributes. +

      +
    9. Drawing primitives: point, line, box, circle,... +

      + After we have created a Graphic Context, we can draw on a + window using this Graphic Context, with a set of XCB + functions, collectively called "drawing primitives". Let see + how they are used. +

      +

      + To draw a point, or several points, we use +

      +
       XCBVoidCookie XCBPolyPoint (XCBConnection  *c,               /* The connection to the X server */
      -                            BYTE            coordinate_mode, /* Coordinate mode, usually set to CoordModeOrigin */
      -			    XCBDRAWABLE     drawable,        /* The drawable on which we want to draw the point(s) */
      -			    XCBGCONTEXT     gc,              /* The Graphic Context we use to draw the point(s) */
      -			    CARD32          points_len,      /* The number of points */
      -			    const XCBPOINT *points);         /* An array of points */
      -
      -

      - The coordinate_mode parameter - specifies the coordinate mode. Available values are -

      -
        -
      • CoordModeOrigin
      • -
      • CoordModePrevious
      • -
      -

      - The XCBPOINT type is just a - structure with two fields (the coordinates of the point): -

      -
      +                            BYTE            coordinate_mode, /* Coordinate mode, usually set to XCBCoordModeOrigin */
      +                            XCBDRAWABLE     drawable,        /* The drawable on which we want to draw the point(s) */
      +                            XCBGCONTEXT     gc,              /* The Graphic Context we use to draw the point(s) */
      +                            CARD32          points_len,      /* The number of points */
      +                            const XCBPOINT *points);         /* An array of points */
      +
      +

      + The coordinate_mode parameter + specifies the coordinate mode. Available values are +

      +
        +
      • XCBCoordModeOrigin +
      • XCBCoordModePrevious +
      +

      + If XCBCoordModePrevious is used, then all points but the first one + are relative to the immediately previous point. +

      +

      + The XCBPOINT type is just a + structure with two fields (the coordinates of the point): +

      +
       typedef struct {
           INT16 x;
           INT16 y;
       } XCBPOINT;
       

      - You could see an example in xpoints.c. TODO Set the link. -

      -

      - To draw a line, or a polygonal line, we use -

      -
      +        You could see an example in xpoints.c. TODO Set the link.
      +        

      +

      + To draw a line, or a polygonal line, we use +

      +
       XCBVoidCookie XCBPolyLine (XCBConnection  *c,               /* The connection to the X server */
      -                           BYTE            coordinate_mode, /* Coordinate mode, usually set to CoordModeOrigin */
      -			   XCBDRAWABLE     drawable,        /* The drawable on which we want to draw the line(s) */
      -			   XCBGCONTEXT     gc,              /* The Graphic Context we use to draw the line(s) */
      -			   CARD32          points_len,      /* The number of points in the polygonal line */
      -			   const XCBPOINT *points);         /* An array of points */
      -
      -

      - This function will draw the line between the first and the - second points, then the line between the second and the third - points, and so on. -

      -

      - To draw a segment, or several segments, we use -

      -
      +                           BYTE            coordinate_mode, /* Coordinate mode, usually set to XCBCoordModeOrigin */
      +                           XCBDRAWABLE     drawable,        /* The drawable on which we want to draw the line(s) */
      +                           XCBGCONTEXT     gc,              /* The Graphic Context we use to draw the line(s) */
      +                           CARD32          points_len,      /* The number of points in the polygonal line */
      +                           const XCBPOINT *points);         /* An array of points */
      +
      +

      + This function will draw the line between the first and the + second points, then the line between the second and the third + points, and so on. +

      +

      + To draw a segment, or several segments, we use +

      +
       XCBVoidCookie XCBPolySegment (XCBConnection    *c,              /* The connection to the X server */
                                     XCBDRAWABLE       drawable,       /* The drawable on which we want to draw the segment(s) */
      -			      XCBGCONTEXT       gc,             /* The Graphic Context we use to draw the segment(s) */
      -			      CARD32            segments_len,   /* The number of segments */
      -			      const XCBSEGMENT *segments);      /* An array of segments */
      -
      -

      - The XCBSEGMENT type is just a - structure with four fields (the coordinates of the two points - that define the segment): -

      -
      +                              XCBGCONTEXT       gc,             /* The Graphic Context we use to draw the segment(s) */
      +                              CARD32            segments_len,   /* The number of segments */
      +                              const XCBSEGMENT *segments);      /* An array of segments */
      +
      +

      + The XCBSEGMENT type is just a + structure with four fields (the coordinates of the two points + that define the segment): +

      +
       typedef struct {
           INT16 x1;
           INT16 y1;
      @@ -1103,22 +1122,22 @@ typedef struct {
           INT16 y2;
       } XCBSEGMENT;
       
      -

      - To draw a rectangle, or several rectangles, we use -

      -
      +        

      + To draw a rectangle, or several rectangles, we use +

      +
       XCBVoidCookie XCBPolyRectangle (XCBConnection      *c,              /* The connection to the X server */
      -				XCBDRAWABLE         drawable,       /* The drawable on which we want to draw the rectangle(s) */
      -				XCBGCONTEXT         gc,             /* The Graphic Context we use to draw the rectangle(s) */
      -				CARD32              rectangles_len, /* The number of rectangles */
      -				const XCBRECTANGLE *rectangles);    /* An array of rectangles */
      -
      -

      - The XCBRECTANGLE type is just a - structure with four fields (the coordinates of the top-left - corner of the rectangle, and its width and height): -

      -
      +                                XCBDRAWABLE         drawable,       /* The drawable on which we want to draw the rectangle(s) */
      +                                XCBGCONTEXT         gc,             /* The Graphic Context we use to draw the rectangle(s) */
      +                                CARD32              rectangles_len, /* The number of rectangles */
      +                                const XCBRECTANGLE *rectangles);    /* An array of rectangles */
      +
      +

      + The XCBRECTANGLE type is just a + structure with four fields (the coordinates of the top-left + corner of the rectangle, and its width and height): +

      +
       typedef struct {
           INT16 x;
           INT16 y;
      @@ -1126,24 +1145,23 @@ typedef struct {
           CARD16 height;
       } XCBRECTANGLE;
       
      -

      - TODO: there's no coordinate_mode. Is it normal ? -

      -

      - To draw an elliptical arc, or several elliptical arcs, we use -

      -
      +        
      +        
      +        

      + To draw an elliptical arc, or several elliptical arcs, we use +

      +
       XCBVoidCookie XCBPolyArc (XCBConnection *c,          /* The connection to the X server */
                                 XCBDRAWABLE    drawable,   /* The drawable on which we want to draw the arc(s) */
      -			  XCBGCONTEXT    gc,         /* The Graphic Context we use to draw the arc(s) */
      -			  CARD32         arcs_len,   /* The number of arcs */
      -			  const XCBARC  *arcs);      /* An array of arcs */
      -
      -

      - The XCBARC type is a structure with - six fields: -

      -
      +                          XCBGCONTEXT    gc,         /* The Graphic Context we use to draw the arc(s) */
      +                          CARD32         arcs_len,   /* The number of arcs */
      +                          const XCBARC  *arcs);      /* An array of arcs */
      +
      +

      + The XCBARC type is a structure with + six fields: +

      +
       typedef struct {
           INT16 x;        /* Top left x coordinate of the rectangle surrounding the ellipse */
           INT16 y;        /* Top left y coordinate of the rectangle surrounding the ellipse */
      @@ -1153,79 +1171,84 @@ typedef struct {
           INT16 angle2;   /* Angle at which the arc ends */
       } XCBARC;
       
      -
      -

      - Note: the angles are expressed in units of 1/64 of a degree, - so to have an angle of 90 degrees, starting at 0, - angle1 = 0 and - angle2 = 90 << 6. Positive angles - indicate counterclockwise motion, while negative angles - indicate clockwise motion. -

      -
      -

      - TODO: there's no coordinate_mode. Is it normal ? -

      -

      - TODO: I think that (x,y) should be the center of the - ellipse, and (width, height) the radius. It's more logical. -

      -

      - The corresponding function which fill inside the geometrical - object are listed below, without further explanation, as they - are used as the above functions. -

      -

      - To Fill a polygon defined by the points given as arguments , - we use -

      -
      +        
      +

      + Note: the angles are expressed in units of 1/64 of a degree, + so to have an angle of 90 degrees, starting at 0, + angle1 = 0 and + angle2 = 90 << 6. Positive angles + indicate counterclockwise motion, while negative angles + indicate clockwise motion. +

      +
      + + +

      + The corresponding function which fill inside the geometrical + object are listed below, without further explanation, as they + are used as the above functions. +

      +

      + To Fill a polygon defined by the points given as arguments , + we use +

      +
       XCBVoidCookie XCBFillPoly (XCBConnection  *c,
                                  XCBDRAWABLE     drawable,
      -			   XCBGCONTEXT     gc,
      -			   CARD8           shape,
      -			   CARD8           coordinate_mode,
      -			   CARD32          points_len,
      -			   const XCBPOINT *points);
      -
      -

      - The shape parameter specifies a - shape that helps the server to improve performance. Available - values are -

      -
        -
      • Complex
      • -
      • Convex
      • -
      • Nonconvex
      • -
      -

      - To fill one or several rectangles, we use -

      -
      +                           XCBGCONTEXT     gc,
      +                           CARD8           shape,
      +                           CARD8           coordinate_mode,
      +                           CARD32          points_len,
      +                           const XCBPOINT *points);
      +
      +

      + The shape parameter specifies a + shape that helps the server to improve performance. Available + values are +

      +
        +
      • XCBPolyShapeComplex +
      • XCBPolyShapeNonconvex +
      • XCBPolyShapeConvex +
      +

      + To fill one or several rectangles, we use +

      +
       XCBVoidCookie XCBPolyFillRectangle (XCBConnection      *c,
                                           XCBDRAWABLE         drawable,
      -				    XCBGCONTEXT         gc,
      -				    CARD32              rectangles_len,
      -				    const XCBRECTANGLE *rectangles);
      -
      -

      - To fill one or several arcs, we use -

      -
      +                                    XCBGCONTEXT         gc,
      +                                    CARD32              rectangles_len,
      +                                    const XCBRECTANGLE *rectangles);
      +
      +

      + To fill one or several arcs, we use +

      +
       XCBVoidCookie XCBPolyFillArc (XCBConnection *c,
                                     XCBDRAWABLE    drawable,
      -			      XCBGCONTEXT    gc,
      -			      CARD32         arcs_len,
      -			      const XCBARC  *arcs);
      -
      -

      -

      - To illustrate these functions, here is an example that draws - four points, a polygonal line, two segments, two rectangles - and two arcs. Remark that we use events for the first time, as - an introduction to the next section. -

      -
      +                              XCBGCONTEXT    gc,
      +                              CARD32         arcs_len,
      +                              const XCBARC  *arcs);
      +
      +
      + +

      + To illustrate these functions, here is an example that draws + four points, a polygonal line, two segments, two rectangles + and two arcs. Remark that we use events for the first time, as + an introduction to the next section. +

      +

      + TODO: Use screen->root_depth for depth parameter. +

      +

      + TODO: Remove get_depth(). It isn't used! +

      +
       #include <stdlib.h>
       #include <stdio.h>
       
      @@ -1234,7 +1257,7 @@ XCBVoidCookie XCBPolyFillArc (XCBConnection *c,
       /* Get the depth of the screen. Needed in order to draw something */
       int
       get_depth(XCBConnection *c,
      -	  XCBSCREEN     *root)
      +          XCBSCREEN     *root)
       {
         XCBDRAWABLE        drawable;
         XCBGetGeometryRep *geom;
      @@ -1275,9 +1298,9 @@ main (int argc, char *argv[])
       
         XCBPOINT         polyline[] = {
           {50, 10},
      -    {55, 30},
      -    {80, 10},
      -    {90, 20}};
      +    { 5, 20},     /* rest of points are relative */
      +    {25,-20},
      +    {10, 10}};
       
         XCBSEGMENT       segments[] = {
           {100, 10, 140, 30},
      @@ -1288,8 +1311,8 @@ main (int argc, char *argv[])
           { 80, 50, 10, 40}};
       
         XCBARC           arcs[] = {
      -    {10, 100, 60, 40, 0, 90 << 6},
      -    {90, 100, 55, 40, 0, 270 << 6}};
      +    {10, 100, 60, 40, 0, 90 << 6},
      +    {90, 100, 55, 40, 0, 270 << 6}};
         
         /* Open the connection to the X server */
         c = XCBConnect (NULL, NULL);
      @@ -1297,11 +1320,11 @@ main (int argc, char *argv[])
         /* Get the first screen */
         screen = XCBConnSetupSuccessRepRootsIter (XCBGetSetup (c)).data;
       
      -  /* Create black (foregroung) graphic context */
      +  /* Create black (foreground) graphic context */
         win.window = screen->root;
       
         foreground = XCBGCONTEXTNew (c);
      -  mask = GCForeground | GCGraphicsExposures;
      +  mask = XCBGCForeground | XCBGCGraphicsExposures;
         values[0] = screen->black_pixel;
         values[1] = 0;
         XCBCreateGC (c, foreground, win, mask, values);
      @@ -1312,57 +1335,57 @@ main (int argc, char *argv[])
         /* Create the window */
         mask = XCBCWBackPixel | XCBCWEventMask;
         values[0] = screen->white_pixel;
      -  values[1] = ExposureMask;
      +  values[1] = XCBEventMaskExposure;
         XCBCreateWindow (c,                        /* Connection          */
      - 		   0,                        /* depth               */
      -		   win.window,               /* window Id           */
      -		   screen->root,             /* parent window       */
      -		   0, 0,                     /* x, y                */
      -		   150, 150,                 /* width, height       */
      -		   10,                       /* border_width        */
      -		   InputOutput,              /* class               */
      -		   screen->root_visual,      /* visual              */
      -		   mask, values);            /* masks */
      +                   XCBCopyFromParent,        /* depth               */
      +                   win.window,               /* window Id           */
      +                   screen->root,             /* parent window       */
      +                   0, 0,                     /* x, y                */
      +                   150, 150,                 /* width, height       */
      +                   10,                       /* border_width        */
      +                   XCBWindowClassInputOutput,/* class               */
      +                   screen->root_visual,      /* visual              */
      +                   mask, values);            /* masks */
       
         /* Map the window on the screen */
         XCBMapWindow (c, win.window);
       
       
         /* We flush the request */
      -  XCBSync (c, 0);
      +  XCBFlush (c);
       
      -  while ((e = XCBWaitEvent (c)))
      +  while ((e = XCBWaitForEvent (c)))
           {
      -      switch (e->response_type)
      -	{
      -	case XCBExpose:
      -	  {
      -	    /* We draw the points */
      -	    XCBPolyPoint (c, CoordModeOrigin, win, foreground, 4, points);
      -	    
      -	    /* We draw the polygonal line */
      -	    XCBPolyLine (c, CoordModeOrigin, win, foreground, 4, polyline);
      -	    
      -	    /* We draw the segements */
      -	    XCBPolySegment (c, win, foreground, 2, segments);
      -	    
      -	    /* We draw the rectangles */
      -	    XCBPolyRectangle (c, win, foreground, 2, rectangles);
      -	    
      -	    /* We draw the arcs */
      -	    XCBPolyArc (c, win, foreground, 2, arcs);
      -
      -	    /* We flush the request */
      -	    XCBSync (c, 0);
      -	    
      -	    break;
      -	  }
      -	default:
      -	  {
      -	    /* Unknown event type, ignore it */
      -	    break;
      -	  }
      -	}
      +      switch (e->response_type & ~0x80)
      +        {
      +        case XCBExpose:
      +          {
      +            /* We draw the points */
      +            XCBPolyPoint (c, XCBCoordModeOrigin, win, foreground, 4, points);
      +            
      +            /* We draw the polygonal line */
      +            XCBPolyLine (c, XCBCoordModePrevious, win, foreground, 4, polyline);
      +            
      +            /* We draw the segements */
      +            XCBPolySegment (c, win, foreground, 2, segments);
      +            
      +            /* We draw the rectangles */
      +            XCBPolyRectangle (c, win, foreground, 2, rectangles);
      +            
      +            /* We draw the arcs */
      +            XCBPolyArc (c, win, foreground, 2, arcs);
      +
      +            /* We flush the request */
      +            XCBFlush (c);
      +            
      +            break;
      +          }
      +        default:
      +          {
      +            /* Unknown event type, ignore it */
      +            break;
      +          }
      +        }
             /* Free the Generic Event */
             free (e);
           }
      @@ -1371,7 +1394,7 @@ main (int argc, char *argv[])
       }
       
    -
  • X Events
  • +
  • X Events

    In an X program, everything is driven by events. Event painting on the screen is sometimes done as a response to an event (an @@ -1383,56 +1406,56 @@ main (int argc, char *argv[]) received as a set of events.

      -
    1. Registering for event types using event masks
    2. -

      - During the creation of a window, you should give it what kind - of events it wishes to receive. Thus, you may register for - various mouse (also called pointer) events, keyboard events, - expose events, and so on. This is done for optimizing the - server-to-client connection (i.e. why send a program (that - might even be running at the other side of the globe) an event - it is not interested in ?) -

      -

      - In XCB, you use the "value_mask" and "value_list" data in the - XCBCreateWindow() function to - register for events. Here is how we register for - Expose event when creating a window: -

      -
      +        
    3. Registering for event types using event masks +

      + During the creation of a window, you should give it what kind + of events it wishes to receive. Thus, you may register for + various mouse (also called pointer) events, keyboard events, + expose events, and so on. This is done for optimizing the + server-to-client connection (i.e. why send a program (that + might even be running at the other side of the globe) an event + it is not interested in ?) +

      +

      + In XCB, you use the "value_mask" and "value_list" data in the + XCBCreateWindow() function to + register for events. Here is how we register for + Expose event when creating a window: +

      +
         mask = XCBCWEventMask;
      -  valwin[0] = ExposureMask;
      +  valwin[0] = XCBEventMaskExposure;
         win.window = XCBWINDOWNew (c);
         XCBCreateWindow (c, depth, win.window, root->root,
      -		   0, 0, 150, 150, 10,
      -		   InputOutput, root->root_visual,
      -		   mask, valwin);
      +                   0, 0, 150, 150, 10,
      +                   XCBWindowClassInputOutput, root->root_visual,
      +                   mask, valwin);
       

      - ExposureMask is a constant defined - in the "X.h" header file. If we wanted to register to several - event types, we can logically "or" them, as follows: -

      -
      +        XCBEventMaskExposure is a constant defined
      +        in the XCBEventMask enumeration in the "xproto.h" header file. If we wanted to register for several
      +        event types, we can logically "or" them, as follows:
      +        

      +
         mask = XCBCWEventMask;
      -  valwin[0] = ExposureMask | ButtonPressMask;
      +  valwin[0] = XCBEventMaskExposure | XCBEventMaskButtonPress;
         win.window = XCBWINDOWNew (c);
         XCBCreateWindow (c, depth, win.window, root->root,
      -		   0, 0, 150, 150, 10,
      -		   InputOutput, root->root_visual,
      -		   mask, valwin);
      -
      -

      - This registers for Expose events as - well as for mouse button presses insode the created - window. You should note that a mask may represent several - event sub-types. -

      -

      - The values that a mask could take are given - by the XCBCW enumeration: -

      -
      +                   0, 0, 150, 150, 10,
      +                   XCBWindowClassInputOutput, root->root_visual,
      +                   mask, valwin);
      +
      +

      + This registers for Expose events as + well as for mouse button presses inside the created + window. You should note that a mask may represent several + event sub-types. +

      +

      + The values that a mask could take are given + by the XCBCW enumeration: +

      +
       typedef enum {
           XCBCWBackPixmap       = 1L<<0,
           XCBCWBackPixel        = 1L<<1,
      @@ -1451,137 +1474,137 @@ typedef enum {
           XCBCWCursor           = 1L<<14
       } XCBCW;
       
      -
      +

      Note: we must be careful when setting the values of the valwin parameter, as they have to follow the order the - XCBCW enumeration. Here is an + XCBCW enumeration. Here is an example: -

      -
      -
      +        

      +
      +
         mask = XCBCWEventMask | XCBCWBackPixmap;
      -  valwin[0] = None;                           /* for XCBCWBackPixmap (whose value is 1)    */
      -  valwin[1] = ExposureMask | ButtonPressMask; /* for XCBCWEventMask, whose value (2048)    */
      -                                              /* is superior to the one of XCBCWBackPixmap */
      -
      -

      - If the window has already been created, we can use the - XCBConfigureWindow() function to set - the events that the window will receive. The subsection - Configuring a window shows its - prototype. As an example, here is a piece of code that - configures the window to receive the - Expose and - ButtonPressMask events: -

      -
      -const static CARD32 values[] = { ExposureMask | ButtonPressMask };
      +  valwin[0] = XCBNone;                           /* for XCBCWBackPixmap (whose value is 1)    */
      +  valwin[1] = XCBEventMaskExposure | XCBEventMaskButtonPress; /* for XCBCWEventMask, whose value (2048)    */
      +                                              /* is greater than the one of XCBCWBackPixmap */
      +
      +

      + If the window has already been created, we can use the + XCBConfigureWindow() function to set + the events that the window will receive. The subsection + Configuring a window shows its + prototype. As an example, here is a piece of code that + configures the window to receive the + Expose and + ButtonPress events: +

      +
      +const static CARD32 values[] = { XCBEventMaskExposure | XCBEventMaskButtonPress };
       
       /* The connection c and the window win are supposed to be defined */
       
       XCBConfigureWindow (c, win, XCBCWEventMask, values);
       
      -
      -

      - Note: A common bug programmers do is adding code to handle new - event types in their program, while forgetting to add the - masks for these events in the creation of the window. Such a - programmer then should sit down for hours debugging his - program, wondering "Why doesn't my program notice that I - released the button?", only to find that they registered for - button press events but not for button release events. -

      -
      -
    4. Receiving events: writing the events loop
    5. -

      - After we have registered for the event types we are interested - in, we need to enter a loop of receiving events and handling - them. There are two ways to receive events: a blocking way and - a non blocking way: -

      -
        -
      • - XCBWaitEvent (XCBConnection *c) - is the blocking way. It waits (so blocks...) until an event is - queued in the X server. Then it retrieves it into a newly - allocated structure (it dequeues it from the queue) and returns - it. This structure has to be freed. The function returns - NULL if an error occurs. -
      • -
        -
      • - XCBPollForEvent (XCBConnection *c, int - *error) is the non blocking way. It looks at the event - queue and returns (and dequeues too) an existing event into - a newly allocated structure. This structure has to be - freed. It returns NULL if there is - no event. If an error occurs, the parameter error will be filled with the error - status. -
      • -
      -

      - There are various ways to write such a loop. We present two - ways to write such a loop, with the two functions above. The - first one uses XCBWaitEvent, which - is similar to an event Xlib loop using only XNextEvent: -

      -
      +        
      +

      + Note: A common bug programmers do is adding code to handle new + event types in their program, while forgetting to add the + masks for these events in the creation of the window. Such a + programmer then should sit down for hours debugging his + program, wondering "Why doesn't my program notice that I + released the button?", only to find that they registered for + button press events but not for button release events. +

      +
      +
    6. Receiving events: writing the events loop +

      + After we have registered for the event types we are interested + in, we need to enter a loop of receiving events and handling + them. There are two ways to receive events: a blocking way and + a non-blocking way: +

      +
        +
      • + XCBWaitForEvent (XCBConnection *c) + is the blocking way. It waits (so blocks...) until an event is + queued in the X server. Then it retrieves it into a newly + allocated structure (it dequeues it from the queue) and returns + it. This structure has to be freed. The function returns + NULL if an error occurs. + +
        +
      • + XCBPollForEvent (XCBConnection *c, int + *error) is the non-blocking way. It looks at the event + queue and returns (and dequeues too) an existing event into + a newly allocated structure. This structure has to be + freed. It returns NULL if there is + no event. If an error occurs, the parameter error will be filled with the error + status. +
      +

      + There are various ways to write such a loop. We present two + ways to write such a loop, with the two functions above. The + first one uses XCBWaitForEvent, which + is similar to an event Xlib loop using only XNextEvent: +

      +
         XCBGenericEvent *e;
       
      -  while ((e = XCBWaitEvent (c)))
      +  while ((e = XCBWaitForEvent (c)))
           {
      -      switch (e->response_type)
      -	{
      -	case XCBExpose:
      -	  {
      -	    /* Handle the Expose event type */
      -	    XCBExposeEvent *ev = (XCBExposeEvent *)e;
      -
      -	    /* ... */
      -
      -	    break;
      -	  }
      -	case XCBButtonPress: 
      -	  {
      -	    /* Handle the ButtonPress event type */
      -	    XCBButtonPressEvent *ev = (XCBButtonPressEvent *)e;
      -
      -	    /* ... */
      -
      -	    break;
      -	  }
      -	default:
      -	  {
      -	    /* Unknown event type, ignore it */
      -	    break;
      -	  }
      -	}
      +      switch (e->response_type & ~0x80)
      +        {
      +        case XCBExpose:
      +          {
      +            /* Handle the Expose event type */
      +            XCBExposeEvent *ev = (XCBExposeEvent *)e;
      +
      +            /* ... */
      +
      +            break;
      +          }
      +        case XCBButtonPress: 
      +          {
      +            /* Handle the ButtonPress event type */
      +            XCBButtonPressEvent *ev = (XCBButtonPressEvent *)e;
      +
      +            /* ... */
      +
      +            break;
      +          }
      +        default:
      +          {
      +            /* Unknown event type, ignore it */
      +            break;
      +          }
      +        }
             /* Free the Generic Event */
             free (e);
           }
       
      -

      - You will certainly want to use XCBPollForEvent(XCBConnection *c, int - *error) if, in Xlib, you use XPending: -

      -
      +        

      + You will certainly want to use XCBPollForEvent(XCBConnection *c, int + *error) if, in Xlib, you use XPending or + XCheckMaskEvent: +

      +
         while (XPending (display))
           {
             XEvent ev;
       
      -      XNextEvent(d, &ev);
      +      XNextEvent(d, &ev);
             
             /* Manage your event */
           }
       

      - Such a loop in XCB looks like: -

      -
      +        Such a loop in XCB looks like:
      +        

      +
         XCBGenericEvent *ev;
       
         while ((ev = XCBPollForEvent (conn, 0)))
      @@ -1589,71 +1612,70 @@ XCBConfigureWindow (c, win, XCBCWEventMask, values);
             /* Manage your event */
           }
       
      -

      - The events are managed in the same way as with XCBWaitEvent. - Obviously, we will need to give the user some way of - terminating the program. This is usually done by handling a - special "quit" event, as we will soon see. -

      -
      -
      - Comparison Xlib/XCB -
      -
      -
        -
      • XNextEvent ()
      • -
      -
      -
      -
        -
      • XCBWaitEvent ()
      • -
      -
      -
      -
        -
      • XPending ()
      • -
      • XNextEvent ()
      • -
      -
      -
      -
        -
      • XCBPollForEvent ()
      • -
        -
      -
      -
      -

      -

    7. Expose events
    8. -

      - The Expose event is one of the most - basic (and most used) events an application may receive. It - will be sent to us in one of several cases: -

        -
      • A window that covered part of our window has moved - away, exposing part (or all) of our window.
      • -
      • Our window was raised above other windows.
      • -
      • Our window mapped for the first time.
      • -
      • Our window was de-iconified.
      • -
      -

      -

      - You should note the implicit assumption hidden here: the - contents of our window is lost when it is being obscured - (covered) by either windows. One may wonder why the X server - does not save this contents. The answer is: to save - memory. After all, the number of windows on a display at a - given time may be very large, and storing the contents of all - of them might require a lot of memory. Actually, there is a - way to tell the X server to store the contents of a window in - special cases, as we will see later. -

      -

      - When we get an Expose event, we - should take the event's data from the members of the following - structure: -

      -
      +        

      + The events are managed in the same way as with XCBWaitForEvent. + Obviously, we will need to give the user some way of + terminating the program. This is usually done by handling a + special "quit" event, as we will soon see. +

      +
      +
      + Comparison Xlib/XCB +
      +
      +
        +
      • XNextEvent () +
      +
      +
      +
        +
      • XCBWaitForEvent () +
      +
      +
      +
        +
      • XPending ()
      • +
      • XCheckMaskEvent ()
      • +
      +
      +
      +
        +
      • XCBPollForEvent () +
      +
      +
      +
      +
    9. Expose events +

      + The Expose event is one of the most + basic (and most used) events an application may receive. It + will be sent to us in one of several cases: +

      +
        +
      • A window that covered part of our window has moved + away, exposing part (or all) of our window. +
      • Our window was raised above other windows. +
      • Our window mapped for the first time. +
      • Our window was de-iconified. +
      +

      + You should note the implicit assumption hidden here: the + contents of our window is lost when it is being obscured + (covered) by either windows. One may wonder why the X server + does not save this contents. The answer is: to save + memory. After all, the number of windows on a display at a + given time may be very large, and storing the contents of all + of them might require a lot of memory. Actually, there is a + way to tell the X server to store the contents of a window in + special cases, as we will see later. +

      +

      + When we get an Expose event, we + should take the event's data from the members of the following + structure: +

      +
       typedef struct {
           BYTE response_type;  /* The type of the event, here it is XCBExpose */
           CARD8 pad0;
      @@ -1667,33 +1689,33 @@ typedef struct {
           CARD16 count;
       } XCBExposeEvent;
       
      -
    10. Getting user input
    11. -

      - User input traditionally comes from two sources: the mouse - and the keyboard. Various event types exist to notify us of - user input (a key being presses on the keyboard, a key being - released on the keyboard, the mouse moving over our window, - the mouse entering (or leaving) our window, and so on. -

      -
        -
      1. Mouse button press and release events
      2. -

        - The first event type we will deal with is a mouse - button-press (or button-release) event in our window. In - order to register to such an event type, we should add one - (or more) of the following masks when we create our window: -

        -
          -
        • ButtonPressMask: notify us - of any button that was pressed in one of our windows.
        • -
        • ButtonReleaseMask: notify us - of any button that was released in one of our windows.
        • -
        -

        - The structure to be checked for in our events loop is the - same for these two events, and is the following: -

        -
        +        
      3. Getting user input +

        + User input traditionally comes from two sources: the mouse + and the keyboard. Various event types exist to notify us of + user input (a key being presses on the keyboard, a key being + released on the keyboard, the mouse moving over our window, + the mouse entering (or leaving) our window, and so on. +

        +
          +
        1. Mouse button press and release events +

          + The first event type we will deal with is a mouse + button-press (or button-release) event in our window. In + order to register to such an event type, we should add one + (or more) of the following masks when we create our window: +

          +
            +
          • XCBEventMaskButtonPress: notify us + of any button that was pressed in one of our windows. +
          • XCBEventMaskButtonRelease: notify us + of any button that was released in one of our windows. +
          +

          + The structure to be checked for in our events loop is the + same for these two events, and is the following: +

          +
           typedef struct {
               BYTE response_type;  /* The type of the event, here it is XCBButtonPressEvent or XCBButtonReleaseEvent */
               XCBBUTTON detail;
          @@ -1713,73 +1735,74 @@ typedef struct {
           typedef XCBButtonPressEvent XCBButtonReleaseEvent;
           

          - The time field may be used to calculate "double-click" - situations by an application (e.g. if the mouse button was - clicked two times in a duration shorter than a given amount - of time, assume this was a double click). -

          + The time field may be used to calculate "double-click" + situations by an application (e.g. if the mouse button was + clicked two times in a duration shorter than a given amount + of time, assume this was a double click). +

          +

          + The state field is a mask of the buttons held down during + the event. It is a bitwise OR of any of the following (from the XCBButtonMask and + XCBModMask enumerations): +

          +
            +
          • XCBButtonMask1 +
          • XCBButtonMask2 +
          • XCBButtonMask3 +
          • XCBButtonMask4 +
          • XCBButtonMask5 +
          • XCBModMaskShift +
          • XCBModMaskLock +
          • XCBModMaskControl +
          • XCBModMask1 +
          • XCBModMask2 +
          • XCBModMask3 +
          • XCBModMask4 +
          • XCBModMask5 +
          +

          + Their names are self explanatory, where the first 5 refer to + the mouse buttons that are being pressed, while the rest + refer to various "special keys" that are being pressed (Mod1 + is usually the 'Alt' key or the 'Meta' key). +

          +

          + TODO: Problem: it seems that the state does not + change when clicking with various buttons. +

          +
        2. Mouse movement events +

          + Similar to mouse button press and release events, we also + can be notified of various mouse movement events. These can + be split into two families. One is of mouse pointer + movement while no buttons are pressed, and the second is a + mouse pointer motion while one (or more) of the buttons are + pressed (this is sometimes called "a mouse drag operation", + or just "dragging"). The following event masks may be added + during the creation of our window: +

          +
            +
          • XCBEventMaskPointerMotion: events of + the pointer moving in one of the windows controlled by our + application, while no mouse button is held pressed. +
          • XCBEventMaskButtonMotion: Events of + the pointer moving while one or more of the mouse buttons + is held pressed. +
          • XCBEventMaskButton1Motion: same as + XCBEventMaskButtonMotion, but only when + the 1st mouse button is held pressed. +
          • XCBEventMaskButton2Motion, + XCBEventMaskButton3Motion, + XCBEventMaskButton4Motion, + XCBEventMaskButton5Motion: same as + XCBEventMaskButton1Motion, but + respectively for 2nd, 3rd, 4th and 5th mouse button. +

          - The state field is a mask of the buttons held down during - the event. It is a bitwise OR of any of the following: -

          -
            -
          • Button1Mask
          • -
          • Button2Mask
          • -
          • Button3Mask
          • -
          • Button4Mask
          • -
          • Button5Mask
          • -
          • ShiftMask
          • -
          • LockMask
          • -
          • ControlMask
          • -
          • Mod1Mask
          • -
          • Mod2Mask
          • -
          • Mod3Mask
          • -
          • Mod4Mask
          • -
          • Mod5Mask
          • -
          -

          - Their names are self explanatory, where the first 5 refer to - the mouse buttons that are being pressed, while the rest - refer to various "special keys" that are being pressed (Mod1 - is usually the 'Alt' key or the 'Meta' key). -

          -

          - TODO: Problem: it seems that the state does not - change when clicking with various buttons. -

          -
        3. Mouse movement events
        4. -

          - Similar to mouse button press and release events, we also - can be notified of various mouse movement events. These can - be split into two families. One is of mouse pointer - movement while no buttons are pressed, and the second is a - mouse pointer motion while one (or more) of the buttons are - pressed (this is sometimes called "a mouse drag operation", - or just "dragging"). The following event masks may be added - during the creation of our window: -

          -
            -
          • PointerMotionMask: events of - the pointer moving in one of the windows controlled by our - application, while no mouse button is held pressed.
          • -
          • ButtonMotionMask: Events of - the pointer moving while one or more of the mouse buttons - is held pressed.
          • -
          • Button1MotionMask: same as - ButtonMotionMask, but only when - the 1st mouse button is held pressed.
          • -
          • Button2MotionMask, - Button3MotionMask, - Button4MotionMask, - Button5MotionMask: same as - Button1MotionMask, but - respectively for 2nd, 3rd, 4th and 5th mouse button.
          • -
          -

          - The structure to be checked for in our events loop is the - same for these events, and is the following: -

          -
          +          The structure to be checked for in our events loop is the
          +          same for these events, and is the following:
          +          

          +
           typedef struct {
               BYTE response_type;  /* The type of the event */
               BYTE detail;
          @@ -1796,29 +1819,29 @@ typedef struct {
               BOOL same_screen;
           } XCBMotionNotifyEvent;
           
          -
        5. Mouse pointer enter and leave events
        6. -

          - Another type of event that applications might be interested - at, is a mouse pointer entering a window the program - controls, or leaving such a window. Some programs use these - events to show the user tht the applications is now in - focus. In order to register for such an event type, we - should add one (or more) of the following masks when we - create our window: -

          -
            -
          • EnterWindowMask: notify us - when the mouse pointer enters any of our controlled - windows.
          • -
          • LeaveWindowMask: notify us - when the mouse pointer leaves any of our controlled - windows.
          • -
          -

          - The structure to be checked for in our events loop is the - same for these two events, and is the following: -

          -
          +            
        7. Mouse pointer enter and leave events +

          + Another type of event that applications might be interested + in, is a mouse pointer entering a window the program + controls, or leaving such a window. Some programs use these + events to show the user that the application is now in + focus. In order to register for such an event type, we + should add one (or more) of the following masks when we + create our window: +

          +
            +
          • XCBEventEnterWindow: notify us + when the mouse pointer enters any of our controlled + windows. +
          • XCBEventLeaveWindow: notify us + when the mouse pointer leaves any of our controlled + windows. +
          +

          + The structure to be checked for in our events loop is the + same for these two events, and is the following: +

          +
           typedef struct {
               BYTE response_type;  /* The type of the event */
               BYTE detail;
          @@ -1838,41 +1861,41 @@ typedef struct {
           
           typedef XCBEnterNotifyEvent XCBLeaveNotifyEvent;
           
          -
        8. The keyboard focus
        9. -

          - There may be many windows on a screen, but only a single - keyboard attached to them. How does the X server then know - which window should be sent a given keyboard input ? This is - done using the keyboard focus. Only a single window on the - screen may have the keyboard focus at a given time. There - is a XCB function that allow a program to set the keyboard - focus to a given window. The user can usually set the - keyboard ficus using the window manager (often by clicking - on the title bar of the desired window). Once our window - has the keyboard focus, every key press or key release will - cause an event to be sent to our program (if it regsitered - for these event types...). -

          -
        10. Keyboard press and release events
        11. -

          - If a window controlled by our program currently holds the - keyboard focus, it can receive key press and key release - events. So, we should add one (or more) of the following - masks when we create our window: -

          -
            -
          • KeyPressMask: notify us when - a key was pressed while any of our controlled windows had - the keyboard focus.
          • -
          • KeyReleaseMask: notify us - when a key was released while any of our controlled - windows had the keyboard focus.
          • -
          -

          - The structure to be checked for in our events loop is the - same for these two events, and is the following: -

          -
          +          
        12. The keyboard focus +

          + There may be many windows on a screen, but only a single + keyboard attached to them. How does the X server then know + which window should be sent a given keyboard input ? This is + done using the keyboard focus. Only a single window on the + screen may have the keyboard focus at a given time. There + is a XCB function that allows a program to set the keyboard + focus to a given window. The user can usually set the + keyboard focus using the window manager (often by clicking + on the title bar of the desired window). Once our window + has the keyboard focus, every key press or key release will + cause an event to be sent to our program (if it regsitered + for these event types...). +

          +
        13. Keyboard press and release events +

          + If a window controlled by our program currently holds the + keyboard focus, it can receive key press and key release + events. So, we should add one (or more) of the following + masks when we create our window: +

          +
            +
          • XCBEventMaskKeyPress: notify us when + a key was pressed while any of our controlled windows had + the keyboard focus. +
          • XCBEventMaskKeyRelease: notify us + when a key was released while any of our controlled + windows had the keyboard focus. +
          +

          + The structure to be checked for in our events loop is the + same for these two events, and is the following: +

          +
           typedef struct {
               BYTE response_type;  /* The type of the event */
               XCBKEYCODE detail;
          @@ -1892,28 +1915,43 @@ typedef struct {
           typedef XCBKeyPressEvent XCBKeyReleaseEvent;
           

          - The detail field refer to the - physical key on the keyboard. -

          -

          + The detail field refers to the + physical key on the keyboard. +

          +

          TODO: Talk about getting the ASCII code from the key code. -

          -
        -
      4. X events: a complete example
      5. -

        - As an example for handling events, we show a program that - creates a window, enter an events loop and check for all the - events described above, and write on the terminal the relevant - characteristics of the event. With this code, it should be - easy to add drawing operations, like those which have been - described above. -

        +

        +
      +
    12. X events: a complete example +

      + As an example for handling events, we show a program that + creates a window, enters an events loop and checks for all the + events described above, and writes on the terminal the relevant + characteristics of the event. With this code, it should be + easy to add drawing operations, like those which have been + described above. +

      -#include <malloc.h>
      +#include <stdlib.h>
       #include <stdio.h>
       
       #include <X11/XCB/xcb.h>
       
      +void
      +print_modifiers(CARD32 mask)
      +{
      +  const char **mod, *mods[] = {
      +    "Shift", "Lock", "Ctrl", "Alt",
      +    "Mod2", "Mod3", "Mod4", "Mod5",
      +    "Button1", "Button2", "Button3", "Button4", "Button5"
      +  };
      +  printf("Modifier mask: ");
      +  for (mod = mods ; mask; mask >>= 1, mod++)
      +    if (mask & 1)
      +      printf(*mod);
      +  putchar('\n');
      +}
      +
       int
       main (int argc, char *argv[])
       {
      @@ -1936,138 +1974,121 @@ main (int argc, char *argv[])
         /* Create the window */
         mask = XCBCWBackPixel | XCBCWEventMask;
         values[0] = screen->white_pixel;
      -  values[1] = ExposureMask      | ButtonPressMask  | ButtonReleaseMask |
      -              PointerMotionMask | EnterWindowMask  | LeaveWindowMask   |
      -               KeyPressMask     | KeyReleaseMask;
      +  values[1] = XCBEventMaskExposure      | XCBEventMaskButtonPress
      +            | XCBEventMaskButtonRelease | XCBEventMaskPointerMotion
      +            | XCBEventMaskEnterWindow   | XCBEventMaskLeaveWindow
      +            | XCBEventMaskKeyPress      | XCBEventMaskKeyRelease;
         XCBCreateWindow (c,                        /* Connection          */
      - 		   0,                        /* depth               */
      -		   win.window,               /* window Id           */
      -		   screen->root,             /* parent window       */
      -		   0, 0,                     /* x, y                */
      -		   150, 150,                 /* width, height       */
      -		   10,                       /* border_width        */
      -		   InputOutput,              /* class               */
      -		   screen->root_visual,      /* visual              */
      -		   mask, values);            /* masks */
      +                   0,                        /* depth               */
      +                   win.window,               /* window Id           */
      +                   screen->root,             /* parent window       */
      +                   0, 0,                     /* x, y                */
      +                   150, 150,                 /* width, height       */
      +                   10,                       /* border_width        */
      +                   XCBWindowClassInputOutput,/* class               */
      +                   screen->root_visual,      /* visual              */
      +                   mask, values);            /* masks */
       
         /* Map the window on the screen */
         XCBMapWindow (c, win.window);
       
      -  XCBSync (c, 0);
      -  while ((e = XCBWaitEvent (c)))
      +  XCBFlush (c);
      +
      +  while ((e = XCBWaitForEvent (c)))
           {
      -      switch (e->response_type)
      -	{
      -	case XCBExpose:
      -	  {
      -	    XCBExposeEvent *ev = (XCBExposeEvent *)e;
      -	    
      -	    printf ("Window %ld exposed. Region to be redrawn at location (%d,%d), with dimension (%d,%d)\n",
      -	            ev->window.xid, ev->x, ev->y, ev->width, ev->height);
      -	    break;
      -	  }
      -	case XCBButtonPress: 
      -	  {
      -	    XCBButtonPressEvent *ev = (XCBButtonPressEvent *)e;
      -	    int                  button_num = 0;
      -	    
      -	    if ((ev->state | Button1Mask) == Button1Mask)
      -	      button_num = 1;
      -	    if ((ev->state | Button2Mask) == Button2Mask)
      -	      button_num = 2;
      -	    if ((ev->state | Button3Mask) == Button3Mask)
      -	      button_num = 3;
      -	    if ((ev->state | Button4Mask) == Button4Mask)
      -	      button_num = 4;
      -	    if ((ev->state | Button5Mask) == Button5Mask)
      -	      button_num = 5;
      -	      
      -	    switch (ev->detail.id)
      -	      {
      -	      case 4:
      -	        {
      -		printf ("Wheel Button up in window %ld, at coordinates (%d,%d)\n",
      +      switch (e->response_type & ~0x80)
      +        {
      +        case XCBExpose:
      +          {
      +            XCBExposeEvent *ev = (XCBExposeEvent *)e;
      +            
      +            printf ("Window %ld exposed. Region to be redrawn at location (%d,%d), with dimension (%d,%d)\n",
      +                    ev->window.xid, ev->x, ev->y, ev->width, ev->height);
      +            break;
      +          }
      +        case XCBButtonPress: 
      +          {
      +            XCBButtonPressEvent *ev = (XCBButtonPressEvent *)e;
      +            print_modifiers(ev->state);
      +              
      +            switch (ev->detail.id)
      +              {
      +              case 4:
      +                {
      +                printf ("Wheel Button up in window %ld, at coordinates (%d,%d)\n",
                               ev->event.xid, ev->event_x, ev->event_y);
      -		break;
      -		}
      -	      case 5:
      -	        {
      -		printf ("Wheel Button down in window %ld, at coordinates (%d,%d)\n",
      +                break;
      +                }
      +              case 5:
      +                {
      +                printf ("Wheel Button down in window %ld, at coordinates (%d,%d)\n",
                               ev->event.xid, ev->event_x, ev->event_y);
      -		break;
      -		}
      -	      default:
      -	        printf ("Button %d pressed in window %ld, at coordinates (%d,%d)\n",
      +                break;
      +                }
      +              default:
      +                printf ("Button %d pressed in window %ld, at coordinates (%d,%d)\n",
                               ev->detail.id, ev->event.xid, ev->event_x, ev->event_y);
      -	      }
      -	    break;
      -	  }
      -	case XCBButtonRelease: 
      -	  {
      -	    XCBButtonReleaseEvent *ev = (XCBButtonReleaseEvent *)e;
      -	    int                  button_num = 0;
      -	    
      -	    if ((ev->state | Button1Mask) == Button1Mask)
      -	      button_num = 1;
      -	    if ((ev->state | Button2Mask) == Button2Mask)
      -	      button_num = 2;
      -	    if ((ev->state | Button3Mask) == Button3Mask)
      -	      button_num = 3;
      -	    if ((ev->state | Button4Mask) == Button4Mask)
      -	      button_num = 4;
      -	    if ((ev->state | Button5Mask) == Button5Mask)
      -	      button_num = 5;
      -	    
      -	    printf ("Button %d released in window %ld, at coordinates (%d,%d)\n",
      +              }
      +            break;
      +          }
      +        case XCBButtonRelease: 
      +          {
      +            XCBButtonReleaseEvent *ev = (XCBButtonReleaseEvent *)e;
      +            print_modifiers(ev->state);
      +            
      +            printf ("Button %d released in window %ld, at coordinates (%d,%d)\n",
                           ev->detail.id, ev->event.xid, ev->event_x, ev->event_y);
      -	    break;
      -	  }
      -	case XCBMotionNotify:
      -	  {
      -	    XCBMotionNotifyEvent *ev = (XCBMotionNotifyEvent *)e;
      -	    
      -	    printf ("Mouse moved in window %ld, at coordinates (%d,%d)\n",
      +            break;
      +          }
      +        case XCBMotionNotify:
      +          {
      +            XCBMotionNotifyEvent *ev = (XCBMotionNotifyEvent *)e;
      +            
      +            printf ("Mouse moved in window %ld, at coordinates (%d,%d)\n",
                           ev->event.xid, ev->event_x, ev->event_y);
      -	    break;
      -	  }
      -	case XCBEnterNotify:
      -	  {
      -	    XCBEnterNotifyEvent *ev = (XCBEnterNotifyEvent *)e;
      -	    
      -	    printf ("Mouse entered window %ld, at coordinates (%d,%d)\n",
      +            break;
      +          }
      +        case XCBEnterNotify:
      +          {
      +            XCBEnterNotifyEvent *ev = (XCBEnterNotifyEvent *)e;
      +            
      +            printf ("Mouse entered window %ld, at coordinates (%d,%d)\n",
                           ev->event.xid, ev->event_x, ev->event_y);
      -	    break;
      -	  }
      -	case XCBLeaveNotify:
      -	  {
      -	    XCBLeaveNotifyEvent *ev = (XCBLeaveNotifyEvent *)e;
      -	    
      -	    printf ("Mouse leaved window %ld, at coordinates (%d,%d)\n",
      +            break;
      +          }
      +        case XCBLeaveNotify:
      +          {
      +            XCBLeaveNotifyEvent *ev = (XCBLeaveNotifyEvent *)e;
      +            
      +            printf ("Mouse left window %ld, at coordinates (%d,%d)\n",
                           ev->event.xid, ev->event_x, ev->event_y);
      -	    break;
      -	  }
      -	case XCBKeyPress: 
      -	  {
      -	    XCBKeyPressEvent *ev = (XCBKeyPressEvent *)e;
      +            break;
      +          }
      +        case XCBKeyPress: 
      +          {
      +            XCBKeyPressEvent *ev = (XCBKeyPressEvent *)e;
      +            print_modifiers(ev->state);
       
      -	    printf ("Key pressed in window %ld\n",
      +            printf ("Key pressed in window %ld\n",
                           ev->event.xid);
      -	    break;
      -	  }
      -	case XCBKeyRelease: 
      -	  {
      -	    XCBKeyReleaseEvent *ev = (XCBKeyReleaseEvent *)e;
      +            break;
      +          }
      +        case XCBKeyRelease: 
      +          {
      +            XCBKeyReleaseEvent *ev = (XCBKeyReleaseEvent *)e;
      +            print_modifiers(ev->state);
       
      -	    printf ("Key releaseed in window %ld\n",
      +            printf ("Key released in window %ld\n",
                           ev->event.xid);
      -	    break;
      -	  }
      -	default:
      -	  {
      -	    /* Unknown event type, ignore it */
      -	    break;
      -	  }
      -	}
      +            break;
      +          }
      +        default:
      +          {
      +            /* Unknown event type, ignore it */
      +            printf("Unknown event: %d\n", e->response_type);
      +            break;
      +          }
      +        }
             /* Free the Generic Event */
             free (e);
           }
      @@ -2076,32 +2097,36 @@ main (int argc, char *argv[])
       }
       
    -
  • Handling text and fonts
  • +
  • Handling text and fonts

    Besides drawing graphics on a window, we often want to draw text. Text strings have two major properties: the characters to be drawn and the font with which they are drawn. In order to draw text, we need to first request the X server to load a - font. We the assign a font to a Graphic Context, and finally, we + font. We then assign a font to a Graphic Context, and finally, we draw the text in a window, using the Graphic Context.

      -
    1. The Font structure
    2. -

      - In order to support flexible fonts, a font structure is - defined. You know what ? Its an Id: -

      -
      +        
    3. The Font structure +

      + In order to support flexible fonts, a font structure is + defined. You know what ? It's an Id: +

      +
       typedef struct {
           CARD32 xid;
       } XCBFONT;
       
      -

      - It is used to contain information about a font, and is passed - to several functions that handle fonts selection and text drawing. -

      +

      + It is used to contain information about a font, and is passed + to several functions that handle fonts selection and text drawing. +

      +

      + TODO: example for picking a font and displaying some text. + Even better, also demonstrate translating keypresses to text. +

    -
  • Interacting with the window manager
  • +
  • Interacting with the window manager

    After we have seen how to create windows and draw on them, we take one step back, and look at how our windows are interacting @@ -2116,62 +2141,63 @@ typedef struct { treat our application's windows.

      -
    1. Window properties
    2. -

      - Many of the parameters communicated to the window manager are - passed using data called "properties". These properties are - attached by the X server to different windows, and are stores - in a format that makes it possible to read them from different - machines that may use different architectures (remember that - an X client program may run on a remote machine). -

      -

      - The property and its type (a string, an integer, etc) are - Id. Their type are XCBATOM: -

      -
      +        
    3. Window properties +

      + Many of the parameters communicated to the window manager are + passed using data called "properties". These properties are + attached by the X server to different windows, and are stored + in a format that makes it possible to read them from different + machines that may use different architectures (remember that + an X client program may run on a remote machine). +

      +

      + The property and its type (a string, an integer, etc) are + Id. Their type are XCBATOM: +

      +
       typedef struct {
           CARD32 xid;
       } XCBATOM;
       
      -

      - To change the property of a window, we use the following - function: -

      -
      +        

      + To change the property of a window, we use the following + function: +

      +
       XCBVoidCookie XCBChangeProperty (XCBConnection *c,  /* Connection to the X server */
                                        CARD8 mode,        /* Property mode */
      -				 XCBWINDOW window,  /* Window */
      -				 XCBATOM property,  /* Property to change */
      -				 XCBATOM type,      /* Type of the property */
      -				 CARD8 format,      /* Format of the property (8, 16, 32) */
      -				 CARD32 data_len,   /* Length of the data parameter */
      -				 const void *data); /* Data */
      -
      -

      - The mode parameter coud be one of - the following value (defined in the X.h header file): -

      -
        -
      • PropModeReplace
      • -
      • PropModePrepend
      • -
      • PropModeAppend
      • -
      -

      -
    4. Setting the window name and icon name
    5. -

      - The firt thing we want to do would be to set the name for our - window. This is done using the - XCBChangeProperty() function. This - name may be used by the window manager as the title of the - window (in the title bar), in a task list, etc. The property - atom to use to set the name of a window is - WM_NAME (and - WM_ICON_NAME for the iconified - window) and its type is STRING. Here - is an example of utilization: -

      -
      +                                 XCBWINDOW window,  /* Window */
      +                                 XCBATOM property,  /* Property to change */
      +                                 XCBATOM type,      /* Type of the property */
      +                                 CARD8 format,      /* Format of the property (8, 16, 32) */
      +                                 CARD32 data_len,   /* Length of the data parameter */
      +                                 const void *data); /* Data */
      +
      +

      + The mode parameter coud be one of + the following values (defined in enumeration XCBPropMode in + the xproto.h header file): +

      +
        +
      • XCBPropModeReplace +
      • XCBPropModePrepend +
      • XCBPropModeAppend +
      +
      +
    6. Setting the window name and icon name +

      + The first thing we want to do would be to set the name for our + window. This is done using the + XCBChangeProperty() function. This + name may be used by the window manager as the title of the + window (in the title bar), in a task list, etc. The property + atom to use to set the name of a window is + WM_NAME (and + WM_ICON_NAME for the iconified + window) and its type is STRING. Here + is an example of utilization: +

      +
       #include <string.h>
       
       #include <X11/XCB/xcb.h>
      @@ -2199,51 +2225,51 @@ main (int argc, char *argv[])
       
         /* Create the window */
         XCBCreateWindow (c,                        /* Connection          */
      - 		   0,                        /* depth               */
      -		   win.window,               /* window Id           */
      -		   screen->root,             /* parent window       */
      -		   0, 0,                     /* x, y                */
      -		   250, 150,                 /* width, height       */
      -		   10,                       /* border_width        */
      -		   InputOutput,              /* class               */
      -		   screen->root_visual,      /* visual              */
      -		   0, NULL);                 /* masks, not used     */
      +                   0,                        /* depth               */
      +                   win.window,               /* window Id           */
      +                   screen->root,             /* parent window       */
      +                   0, 0,                     /* x, y                */
      +                   250, 150,                 /* width, height       */
      +                   10,                       /* border_width        */
      +                   XCBWindowClassInputOutput,/* class               */
      +                   screen->root_visual,      /* visual              */
      +                   0, NULL);                 /* masks, not used     */
       
         /* Set the title of the window */
      -  XCBChangeProperty(c, PropModeReplace, win.window,
      -		    WM_NAME, STRING, 8,
      -		    strlen(title), title);
      +  XCBChangeProperty(c, XCBPropModeReplace, win.window,
      +                    WM_NAME, STRING, 8,
      +                    strlen(title), title);
       
         /* Set the title of the window icon */
      -  XCBChangeProperty(c, PropModeReplace, win.window,
      -		    WM_ICON_NAME, STRING, 8,
      -		    strlen(title_icon), title_icon);
      +  XCBChangeProperty(c, XCBPropModeReplace, win.window,
      +                    WM_ICON_NAME, STRING, 8,
      +                    strlen(title_icon), title_icon);
       
         /* Map the window on the screen */
         XCBMapWindow (c, win.window);
       
      -  XCBSync (c, 0);
      +  XCBFlush (c);
         
         while (1) {}
       
         return 1;
       }
       
      -
      +

      Note: the use of the atoms needs our program to be compiled and linked against xcb_atom, so that we have to use -

      -
      -
      +        

      +
      +
       gcc prog.c -o prog `pkg-config --cflags --libs xcb_atom`
       
      -
      +

      - for the program to compile fine. -

      -
      + for the program to compile fine. +

      +
    -
  • Simple window operations
  • +
  • Simple window operations

    One more thing we can do to our window is manipulate them on the screen (resize them, move them, raise or lower them, iconify @@ -2251,162 +2277,162 @@ gcc prog.c -o prog `pkg-config --cflags --libs xcb_atom` by XCB for this purpose.

      -
    1. Mapping and un-mapping a window
    2. -

      - The first pair of operations we can apply on a window is - mapping it, or un-mapping it. Mapping a window causes the - window to appear on the screen, as we have seen in our simple - window program example. Un-mapping it causes it to be removed - from the screen (although the window as a logical entity still - exists). This gives the effect of making a window hidden - (unmapped) and shown again (mapped). For example, if we have a - dialog box window in our program, instead of creating it every - time the user asks to open it, we can create the window once, - in an un-mapped mode, and when the user asks to open it, we - simply map the window on the screen. When the user clicked the - 'OK' or 'Cancel' button, we simply un-map the window. This is - much faster than creating and destroying the window, however, - the cost is wasted resources, both on the client side, and on - the X server side. -

      -

      - To map a window, you use the following function: -

      -
      +        
    3. Mapping and un-mapping a window +

      + The first pair of operations we can apply on a window is + mapping it, or un-mapping it. Mapping a window causes the + window to appear on the screen, as we have seen in our simple + window program example. Un-mapping it causes it to be removed + from the screen (although the window as a logical entity still + exists). This gives the effect of making a window hidden + (unmapped) and shown again (mapped). For example, if we have a + dialog box window in our program, instead of creating it every + time the user asks to open it, we can create the window once, + in an un-mapped mode, and when the user asks to open it, we + simply map the window on the screen. When the user clicked the + 'OK' or 'Cancel' button, we simply un-map the window. This is + much faster than creating and destroying the window, however, + the cost is wasted resources, both on the client side, and on + the X server side. +

      +

      + To map a window, you use the following function: +

      +
       XCBVoidCookie XCBMapWindow(XCBConnection *c, XCBWINDOW window);
       

      - To have a simple example, see the example - above. The mapping operation will cause an - Expose event to be sent to our - application, unless the window is completely covered by other - windows. -

      -

      - Un-mapping a window is also simple. You use the function -

      -
      +        To have a simple example, see the example
      +        above. The mapping operation will cause an
      +        Expose event to be sent to our
      +        application, unless the window is completely covered by other
      +        windows.
      +        

      +

      + Un-mapping a window is also simple. You use the function +

      +
       XCBVoidCookie XCBUnmapWindow(XCBConnection *c, XCBWINDOW window);
       
      -

      - The utilization of this function is the same as - XCBMapWindow(). -

      -
    4. Configuring a window
    5. -

      - As we have seen when we have created our first window, in the - X Events subsection, we can set some attributes to the window - (that is, the position, the size, the events the window will - receive, etc). If we want to modify them, but the window is - already created, we can change them by using hte following - function: -

      -
      +        

      + The utilization of this function is the same as + XCBMapWindow(). +

      +
    6. Configuring a window +

      + As we have seen when we have created our first window, in the + X Events subsection, we can set some attributes for the window + (that is, the position, the size, the events the window will + receive, etc). If we want to modify them, but the window is + already created, we can change them by using the following + function: +

      +
       XCBVoidCookie XCBConfigureWindow (XCBConnection *c,            /* The connection to the X server*/
                                         XCBWINDOW      window,       /* The window to configure */
      -				  CARD16         value_mask,   /* The mask */
      -				  const CARD32  *value_list);  /* The values to set */
      -
      -

      - We set the value_mask to one or - several mask values that are in the X.h header: -

        -
      • CWX: new x coordinate of the window's top left corner
      • -
      • CWY: new y coordinate of the window's top left corner
      • -
      • CWWidth: new width of the window
      • -
      • CWHeight: new height of the window
      • -
      • CWBorderWidth: new width of the border of the window
      • -
      • CWSibling
      • -
      • CWStackMode: the new stacking order
      • -
      -

      -

      - We then give to value_mask the new - value. We now describe how to use - XCBConfigureWindow in some useful - situations. -

      -
    7. Moving a window around the screen
    8. -

      - An operation we might want to do with windows is to move them - to a different location. This can be done like this: -

      -
      +                                  CARD16         value_mask,   /* The mask */
      +                                  const CARD32  *value_list);  /* The values to set */
      +
      +

      + We set the value_mask to one or + several mask values that are in the XCBConfigWindow enumeration in the xproto.h header: +

      +
        +
      • XCBConfigWindowX: new x coordinate of the window's top left corner +
      • XCBConfigWindowY: new y coordinate of the window's top left corner +
      • XCBConfigWindowWidth: new width of the window +
      • XCBConfigWindowHeight: new height of the window +
      • XCBConfigWindowBorderWidth: new width of the border of the window +
      • XCBConfigWindowSibling +
      • XCBConfigWindowStackMode: the new stacking order +
      +

      + We then give to value_mask the new + value. We now describe how to use + XCBConfigureWindow in some useful + situations. +

      +
    9. Moving a window around the screen +

      + An operation we might want to do with windows is to move them + to a different location. This can be done like this: +

      +
       const static CARD32 values[] = { 10, 20 };
       
       /* The connection c and the window win are supposed to be defined */
       
       /* Move the window to coordinates x = 10 and y = 20 */
      -XCBConfigureWindow (c, win, CWX | CWY, values);
      -
      -

      - Note that when the window is moved, it might get partially - exposed or partially hidden by other windows, and thus we - might get Expose events due to this - operation. -

      -
    10. Resizing a window
    11. -

      - Yet another operation we can do is to change the size of a - window. This is done using the following code: -

      -
      +XCBConfigureWindow (c, win, XCBConfigWindowX | XCBConfigWindowY, values);
      +
      +

      + Note that when the window is moved, it might get partially + exposed or partially hidden by other windows, and thus we + might get Expose events due to this + operation. +

      +
    12. Resizing a window +

      + Yet another operation we can do is to change the size of a + window. This is done using the following code: +

      +
       const static CARD32 values[] = { 200, 300 };
       
       /* The connection c and the window win are supposed to be defined */
       
       /* Resize the window to width = 10 and height = 20 */
      -XCBConfigureWindow (c, win, CWWidth | CWHeight, values);
      +XCBConfigureWindow (c, win, XCBConfigWindowWidth | XCBConfigWindowHeight, values);
       
      -

      - We can also combine the move and resize operations using one - single call to XCBConfigureWindow: -

      -
      +        

      + We can also combine the move and resize operations using one + single call to XCBConfigureWindow: +

      +
       const static CARD32 values[] = { 10, 20, 200, 300 };
       
       /* The connection c and the window win are supposed to be defined */
       
       /* Move the window to coordinates x = 10 and y = 20 */
       /* and resize the window to width = 10 and height = 20 */
      -XCBConfigureWindow (c, win, CWX | CWY | CWWidth | CWHeight, values);
      -
      -
    13. Changing windows stacking order: raise and lower
    14. -

      - Until now, we changed properties of a single window. We'll see - that there are properties that relate to the window and other - windows. One of hem is the stacking order. That is, the order - in which the windows are layered on top of each other. The - front-most window is said to be on the top of the stack, while - the back-most window is at the bottom of the stack. Here is - how to manipulate our windows stack order: -

      -
      -const static CARD32 values[] = { Above };
      +XCBConfigureWindow (c, win, XCBConfigWindowX | XCBConfigWindowY | XCBConfigWindowWidth | XCBConfigWindowHeight, values);
      +
      +
    15. Changing windows stacking order: raise and lower +

      + Until now, we changed properties of a single window. We'll see + that there are properties that relate to the window and other + windows. One of them is the stacking order. That is, the order + in which the windows are layered on top of each other. The + front-most window is said to be on the top of the stack, while + the back-most window is at the bottom of the stack. Here is + how to manipulate our windows stack order: +

      +
      +const static CARD32 values[] = { XCBStackModeAbove };
       
       /* The connection c and the window win are supposed to be defined */
       
       /* Move the window on the top of the stack */
      -XCBConfigureWindow (c, win, CWStackMode, values);
      +XCBConfigureWindow (c, win, XCBConfigWindowStackMode, values);
       
      -
      -const static CARD32 values[] = { Below };
      +        
      +const static CARD32 values[] = { XCBStackModeBelow };
       
       /* The connection c and the window win are supposed to be defined */
       
       /* Move the window on the bottom of the stack */
      -XCBConfigureWindow (c, win, CWStackMode, values);
      -
      -
    16. Getting information about a window
    17. -

      - Just like we can set various attributes of our windows, we can - also ask the X server supply the current values of these - attributes. For example, we can chewk where a window is - located on the screen, what is its current size, wheter it is - mapped or not, etc. The structure that contains some of this - information is -

      -
      +XCBConfigureWindow (c, win, XCBConfigWindowStackMode, values);
      +
      +
    18. Getting information about a window +

      + Just like we can set various attributes of our windows, we can + also ask the X server supply the current values of these + attributes. For example, we can check where a window is + located on the screen, what is its current size, whether it is + mapped or not, etc. The structure that contains some of this + information is +

      +
       typedef struct {
           BYTE response_type;
           CARD8 depth;            /* depth of the window */
      @@ -2421,9 +2447,9 @@ typedef struct {
       } XCBGetGeometryRep;
       

      - XCB fill this structure with two functions: -

      -
      +        XCB fill this structure with two functions:
      +        

      +
       XCBGetGeometryCookie  XCBGetGeometry      (XCBConnection         *c,
                                                  XCBDRAWABLE            drawable);
       XCBGetGeometryRep    *XCBGetGeometryReply (XCBConnection         *c,
      @@ -2431,9 +2457,9 @@ XCBGetGeometryRep    *XCBGetGeometryReply (XCBConnection         *c,
                                                  XCBGenericError      **e);
       

      - You use them as follows: -

      -
      +        You use them as follows:
      +        

      +
         XCBConnection     *c;
         XCBDRAWABLE        win;
         XCBGetGeometryRep *geom;
      @@ -2447,23 +2473,23 @@ XCBGetGeometryRep    *XCBGetGeometryReply (XCBConnection         *c,
         free (geom);
       

      - Remark that you have to free the structure, as - XCBGetGeometryReply allocates a - newly one. -

      -

      - One problem is that the returned location of the window is - relative to its parent window. This makes these coordinates - rather useless for any window manipulation functions, like - moving it on the screen. In order to overcome this problem, we - need to take a two-step operation. First, we find out the Id - of the parent window of our window. We then translate the - above relative coordinates to the screen coordinates. -

      -

      - To get the Id of the parent window, we need this structure: -

      -
      +        Remark that you have to free the structure, as
      +        XCBGetGeometryReply allocates a
      +        newly one.
      +        

      +

      + One problem is that the returned location of the window is + relative to its parent window. This makes these coordinates + rather useless for any window manipulation functions, like + moving it on the screen. In order to overcome this problem, we + need to take a two-step operation. First, we find out the Id + of the parent window of our window. We then translate the + above relative coordinates to the screen coordinates. +

      +

      + To get the Id of the parent window, we need this structure: +

      +
       typedef struct {
           BYTE response_type;
           CARD8 pad0;
      @@ -2476,19 +2502,19 @@ typedef struct {
       } XCBQueryTreeRep;
       

      - To fill this structure, we use these two functions: -

      -
      +        To fill this structure, we use these two functions:
      +        

      +
       XCBQueryTreeCookie XCBQueryTree      (XCBConnection       *c,
                                             XCBWINDOW            window);
       XCBQueryTreeRep   *XCBQueryTreeReply (XCBConnection       *c,
                                             XCBQueryTreeCookie   cookie,
      -				      XCBGenericError    **e);
      +                                      XCBGenericError    **e);
       

      - The translated coordinates will be found in this structure: -

      -
      +        The translated coordinates will be found in this structure:
      +        

      +
       typedef struct {
           BYTE response_type;
           BOOL same_screen;
      @@ -2500,22 +2526,22 @@ typedef struct {
       } XCBTranslateCoordinatesRep;
       

      - As usual, we need two functions to fill this structure: -

      -
      +        As usual, we need two functions to fill this structure:
      +        

      +
       XCBTranslateCoordinatesCookie XCBTranslateCoordinates      (XCBConnection                  *c,
                                                                   XCBWINDOW                       src_window,
      -							    XCBWINDOW                       dst_window,
      -							    INT16                           src_x,
      -							    INT16                           src_y);
      +                                                            XCBWINDOW                       dst_window,
      +                                                            INT16                           src_x,
      +                                                            INT16                           src_y);
       XCBTranslateCoordinatesRep   *XCBTranslateCoordinatesReply (XCBConnection                 *c,
      -							    XCBTranslateCoordinatesCookie   cookie,
      -							    XCBGenericError               **e);
      +                                                            XCBTranslateCoordinatesCookie   cookie,
      +                                                            XCBGenericError               **e);
       

      - We use them as follows: -

      -
      +        We use them as follows:
      +        

      +
         XCBConnection              *c;
         XCBDRAWABLE                 win;
         XCBGetGeometryRep          *geom;
      @@ -2535,8 +2561,8 @@ XCBTranslateCoordinatesRep   *XCBTranslateCoordinatesReply (XCBConnection
         trans = XCBTranslateCoordinatesReply (c,
                                               XCBTranslateCoordinates (c,
                                                                        win,
      -								 tree->parent,
      -								 geom->x, geom->y),
      +                                                                 tree->parent,
      +                                                                 geom->x, geom->y),
                                               0);
         if (!trans)
           return 0;
      @@ -2548,21 +2574,21 @@ XCBTranslateCoordinatesRep   *XCBTranslateCoordinatesReply (XCBConnection
         free (geom);
       

      - Of course, as for geom, - tree and - trans have to be freed. -

      -

      - The work is a bit hard, but XCB is a very low-level library. -

      -

      - TODO: the utilization of these functions should be a - prog, which displays the coordinates of the window. -

      -

      - There is another structure that gives informations about our window: -

      -
      +        Of course, as for geom,
      +        tree and
      +        trans have to be freed.
      +        

      +

      + The work is a bit hard, but XCB is a very low-level library. +

      +

      + TODO: the utilization of these functions should be a + prog, which displays the coordinates of the window. +

      +

      + There is another structure that gives informations about our window: +

      +
       typedef struct {
           BYTE response_type;
           CARD8 backing_store;
      @@ -2585,19 +2611,19 @@ typedef struct {
       } XCBGetWindowAttributesRep;
       

      - XCB supplies these two functions to fill it: -

      -
      +        XCB supplies these two functions to fill it:
      +        

      +
       XCBGetWindowAttributesCookie XCBGetWindowAttributes      (XCBConnection                 *c, 
                                                                 XCBWINDOW                      window);
       XCBGetWindowAttributesRep   *XCBGetWindowAttributesReply (XCBConnection                 *c, 
                                                                 XCBGetWindowAttributesCookie   cookie,
      -							  XCBGenericError              **e);
      +                                                          XCBGenericError              **e);
       

      - You use them as follows: -

      -
      +        You use them as follows:
      +        

      +
         XCBConnection             *c;
         XCBDRAWABLE                win;
         XCBGetWindowAttributesRep *attr;
      @@ -2614,93 +2640,93 @@ XCBGetWindowAttributesRep   *XCBGetWindowAttributesReply (XCBConnection
         free (attr);
       

      - As for geom, - attr has to be freed. -

      + As for geom, + attr has to be freed. +

    -
  • Using colors to paint the rainbow
  • +
  • Using colors to paint the rainbow

    Up until now, all our painting operation were done using black and white. We will (finally) see now how to draw using colors.

      -
    1. Color maps
    2. -

      - In the beginning, there were not enough colors. Screen - controllers could only support a limited number of colors - simultaneously (initially 2, then 4, 16 and 256). Because of - this, an application could not just ask to draw in a "light - purple-red" color, and expect that color to be available. Each - application allocated the colors it needed, and when all the - color entries (4, 16, 256 colors) were in use, the next color - allocation would fail. -

      -

      - Thus, the notion of "a color map" was introduced. A color map - is a table whose size is the same as the number of - simultaneous colors a given screen controller. Each entry - contained the RGB (Red, Green and Blue) values of a different - color (all colors can be drawn using some combination of red, - green and blue). When an application wants to draw on the - screen, it does not specify which color to use. Rather, it - specifies which color entry of some color map to be used - during this drawing. Change the value in this color map entry - and the drawing will use a different color. -

      -

      - In order to be able to draw using colors that got something to - do with what the programmer intended, color map allocation - functions are supplied. You could ask to allocate entry for a - color with a set of RGB values. If one already existed, you - would get its index in the table. If none existed, and the - table was not full, a new cell would be allocated to contain - the given RGB values, and its index returned. If the table was - full, the procedure would fail. You could then ask to get a - color map entry with a color that is closest to the one you - were asking for. This would mean that the actual drawing on - the screen would be done using colors similar to what you - wanted, but not the same. -

      -

      - On today's more modern screens where one runs an X server with - support for 16 million colors, this limitation looks a little - silly, but remember that there are still older computers with - older graphics cards out there. Using color map, support for - these screen becomes transparent to you. On a display - supporting 16 million colors, any color entry allocation - request would succeed. On a display supporting a limited - number of colors, some color allocation requests would return - similar colors. It won't look as good, but your application - would still work. -

      -
    3. Allocating and freeing Color Maps
    4. -

      - When you draw using XCB, you can choose to use the standard - color map of the screen your window is displayed on, or you - can allocate a new color map and apply it to a window. In the - latter case, each time the mouse moves onto your window, the - screen color map will be replaced by your window's color map, - and you'll see all the other windows on screen change their - colors into something quite bizzare. In fact, this is the - effect you get with X applications that use the "-install" - command line option. -

      -

      - In XCB, a color map is (as often in X) an Id: -

      -
      +        
    5. Color maps +

      + In the beginning, there were not enough colors. Screen + controllers could only support a limited number of colors + simultaneously (initially 2, then 4, 16 and 256). Because of + this, an application could not just ask to draw in a "light + purple-red" color, and expect that color to be available. Each + application allocated the colors it needed, and when all the + color entries (4, 16, 256 colors) were in use, the next color + allocation would fail. +

      +

      + Thus, the notion of "a color map" was introduced. A color map + is a table whose size is the same as the number of + simultaneous colors a given screen controller. Each entry + contained the RGB (Red, Green and Blue) values of a different + color (all colors can be drawn using some combination of red, + green and blue). When an application wants to draw on the + screen, it does not specify which color to use. Rather, it + specifies which color entry of some color map to be used + during this drawing. Change the value in this color map entry + and the drawing will use a different color. +

      +

      + In order to be able to draw using colors that got something to + do with what the programmer intended, color map allocation + functions are supplied. You could ask to allocate entry for a + color with a set of RGB values. If one already existed, you + would get its index in the table. If none existed, and the + table was not full, a new cell would be allocated to contain + the given RGB values, and its index returned. If the table was + full, the procedure would fail. You could then ask to get a + color map entry with a color that is closest to the one you + were asking for. This would mean that the actual drawing on + the screen would be done using colors similar to what you + wanted, but not the same. +

      +

      + On today's more modern screens where one runs an X server with + support for 16 million colors, this limitation looks a little + silly, but remember that there are still older computers with + older graphics cards out there. Using color map, support for + these screen becomes transparent to you. On a display + supporting 16 million colors, any color entry allocation + request would succeed. On a display supporting a limited + number of colors, some color allocation requests would return + similar colors. It won't look as good, but your application + would still work. +

      +
    6. Allocating and freeing Color Maps +

      + When you draw using XCB, you can choose to use the standard + color map of the screen your window is displayed on, or you + can allocate a new color map and apply it to a window. In the + latter case, each time the mouse moves onto your window, the + screen color map will be replaced by your window's color map, + and you'll see all the other windows on screen change their + colors into something quite bizzare. In fact, this is the + effect you get with X applications that use the "-install" + command line option. +

      +

      + In XCB, a color map is (as often in X) an Id: +

      +
       typedef struct {
           CARD32 xid;
       } XCBCOLORMAP;
       
      -

      - In order to access the screen's default color map, you just - have to retrieve the default_colormap - field of the XCBSCREEN structure - (see Section - Checking basic information about a connection): -

      -
      +        

      + In order to access the screen's default color map, you just + have to retrieve the default_colormap + field of the XCBSCREEN structure + (see Section + Checking basic information about a connection): +

      +
       #include <stdio.h>
       
       #include <X11/XCB/xcb.h>
      @@ -2721,33 +2747,33 @@ main (int argc, char *argv[])
         return 1;
       }
       
      -

      - This will return the color map used by default on the first - screen (again, remember that an X server may support several - different screens, each of which might have its own resources). -

      -

      - The other option, that of allocating a new colormap, works as - follows. We first ask the X server to give an Id to our color - map, with this function: -

      -
      +        

      + This will return the color map used by default on the first + screen (again, remember that an X server may support several + different screens, each of which might have its own resources). +

      +

      + The other option, that of allocating a new colormap, works as + follows. We first ask the X server to give an Id to our color + map, with this function: +

      +
       XCBCOLORMAP XCBCOLORMAPNew (XCBConnection *c);
       
      -

      - Then, we create the color map with -

      -
      +        

      + Then, we create the color map with +

      +
       XCBVoidCookie XCBCreateColormap (XCBConnection *c,       /* Pointer to the XCBConnection structure */
                                        BYTE           alloc,   /* Colormap entries to be allocated (AllocNone or AllocAll) */
      -				 XCBCOLORMAP    mid,     /* Id of the color map */
      -				 XCBWINDOW      window,  /* Window on whose screen the colormap will be created */
      -				 XCBVISUALID    visual); /* Id of the visual supported by the screen */
      -
      -

      - Here is an example of creation of a new color map: -

      -
      +                                 XCBCOLORMAP    mid,     /* Id of the color map */
      +                                 XCBWINDOW      window,  /* Window on whose screen the colormap will be created */
      +                                 XCBVISUALID    visual); /* Id of the visual supported by the screen */
      +
      +

      + Here is an example of creation of a new color map: +

      +
       #include <X11/XCB/xcb.h>
       
       int
      @@ -2765,57 +2791,57 @@ main (int argc, char *argv[])
         /* We create the window win here*/
       
         cmap = XCBCOLORMAPNew (c);
      -  XCBCreateColormap (c, AllocNone, cmap, win, screen->root_visual);
      +  XCBCreateColormap (c, XCBColormapAllocNone, cmap, win, screen->root_visual);
       
         return 1;
       }
       

      - Note that the window parameter is only used to allow the X - server to create the color map for the given screen. We can - then use this color map for any window drawn on the same screen. -

      -

      - To free a color map, it suffices to use this function: -

      -
      +        Note that the window parameter is only used to allow the X
      +        server to create the color map for the given screen. We can
      +        then use this color map for any window drawn on the same screen.
      +        

      +

      + To free a color map, it suffices to use this function: +

      +
       XCBVoidCookie XCBFreeColormap (XCBConnection *c,   /* The connection */
                                      XCBCOLORMAP cmap);  /* The color map */
       
      - Comparison Xlib/XCB + Comparison Xlib/XCB +
      +
      +
        +
      • XCreateColormap () +
      +
      +
      +
        +
      • XCBCOLORMAPNew () +
      • XCBCreateColormap () +
      +
      +
      +
        +
      • XFreeColormap () +
      +
      +
      +
        +
      • XCBFreeColormap () +
      -
      -
        -
      • XCreateColormap ()
      • -
      -
      -
      -
        -
      • XCBCOLORMAPNew ()
      • -
      • XCBCreateColormap ()
      • -
      -
      -
      -
        -
      • XFreeColormap ()
      • -
      -
      -
      -
        -
      • XCBFreeColormap ()
      • -
      -
      -

      -
    7. Allocating and freeing a color entry
    8. -

      - Once we got access to some color map, we can strat allocating - colors. The informations related to a color are stored in the - following structure: -

      -
      +        
      +
    9. Allocating and freeing a color entry +

      + Once we got access to some color map, we can start allocating + colors. The informations related to a color are stored in the + following structure: +

      +
       typedef struct {
           BYTE response_type;
           CARD8 pad0;
      @@ -2834,12 +2860,12 @@ typedef struct {
             
       XCBAllocColorCookie XCBAllocColor      (XCBConnection *c,
                                               XCBCOLORMAP    cmap,
      -				        CARD16         red,
      -			                CARD16         green,
      -				        CARD16         blue);
      +                                        CARD16         red,
      +                                        CARD16         green,
      +                                        CARD16         blue);
       XCBAllocColorRep   *XCBAllocColorReply (XCBConnection        *c,
                                               XCBAllocColorCookie   cookie,
      -					XCBGenericError     **e);
      +                                        XCBGenericError     **e);
       

      The fuction XCBAllocColor() takes the @@ -2867,7 +2893,7 @@ main (int argc, char *argv[]) /* We create the window win here*/ cmap = XCBCOLORMAPNew (c); - XCBCreateColormap (c, AllocNone, cmap, win, screen->root_visual); + XCBCreateColormap (c, XCBColormapAllocNone, cmap, win, screen->root_visual); rep = XCBAllocColorReply (c, XCBAllocColor (c, cmap, 65535, 0, 0), 0); @@ -2889,9 +2915,9 @@ main (int argc, char *argv[]) TODO: Talk about freeing colors.

    -
  • X Bitmaps and Pixmaps
  • +
  • X Bitmaps and Pixmaps

    - One thing many so-called "Multi-Media" applications need to od, + One thing many so-called "Multi-Media" applications need to do, is display images. In the X world, this is done using bitmaps and pixmaps. We have already seen some usage of them when setting an icon for our application. Lets study them further, @@ -2907,146 +2933,148 @@ main (int argc, char *argv[]) pixmaps).

      -
    1. What is a X Bitmap ? An X Pixmap ?
    2. -

      - An X bitmap is a two-color image stored in a format specific - to the X window system. When stored in a file, the bitmap data - looks like a C source file. It contains variables defining the - width and the height of the bitmap, an array containing the - bit values of the bitmap (the size of the array is - weight*height), and an optional hot-spot location (that will - be explained later, when discussing mouse cursors). -

      -

      - An X pixmap is a format used to stored images in the memory of - an X server. This format can store both black and white images - (such as x bitmaps) as well as color images. It is the only - image format supported by the X protocol, and any image to be - drawn on screen, should be first translated into this format. -

      -

      - In actuality, an X pixmap can be thought of as a window that - does not appear on the screen. Many graphics operations that - work on windows, will also work on pixmaps. Indeed, the type - of X pixmap in XCB is an Id like a window: -

      -
      +        
    3. What is a X Bitmap? An X Pixmap? +

      + An X bitmap is a two-color image stored in a format specific + to the X window system. When stored in a file, the bitmap data + looks like a C source file. It contains variables defining the + width and the height of the bitmap, an array containing the + bit values of the bitmap (the size of the array is + (width+7)/8*height and the bit and byte order are LSB), and + an optional hot-spot location (that will + be explained later, when discussing mouse cursors). +

      +

      + An X pixmap is a format used to stored images in the memory of + an X server. This format can store both black and white images + (such as x bitmaps) as well as color images. It is the only + image format supported by the X protocol, and any image to be + drawn on screen, should be first translated into this format. +

      +

      + In actuality, an X pixmap can be thought of as a window that + does not appear on the screen. Many graphics operations that + work on windows, will also work on pixmaps. Indeed, the type + of X pixmap in XCB is an Id like a window: +

      +
       typedef struct {
           CARD32 xid;
       } XCBPIXMAP;
       
      -

      - In order to make the difference between a window and a pixmap, - XCB introduces a drawable type, which is a union -

      -
      +        

      + In order to make the difference between a window and a pixmap, + XCB introduces a drawable type, which is a union +

      +
       typedef union {
           XCBWINDOW window;
           XCBPIXMAP pixmap;
       } XCBDRAWABLE;
       

      - in order to avoid confusion between a window and a pixmap.The - operations that will work indifferently on a window or a pixmap - will require a XCBDRAWABLE -

      -
      -

      - Remark: In Xlib, there is no specific difference between a - Drawable, a - Pixmap or a - Window: all are 32 bit long - integer. -

      -
      -
    4. Creating a pixmap
    5. -

      - Sometimes we want to create an un-initialized pixmap, so we - can later draw into it. This is useful for image drawing - programs (creating a new empty canvas will cause the creation - of a new pixmap on which the drawing can be stored). It is - also useful when reading various image formats: we load the - image data into memory, create a pixmap on the server, and - then draw the decoded image data onto that pixmap. -

      -

      - To create a new pixmap, we first ask the X server to give an - Id to our pixmap, with this function: -

      -
      +        in order to avoid confusion between a window and a pixmap. The
      +        operations that will work the same on a window or a pixmap
      +        will require a XCBDRAWABLE
      +        

      +
      +

      + Remark: In Xlib, there is no specific difference between a + Drawable, a + Pixmap or a + Window: all are 32 bit long + integer. XCB wraps all these different IDs in structures to + provide some measure of type-safety. +

      +
      +
    6. Creating a pixmap +

      + Sometimes we want to create an un-initialized pixmap, so we + can later draw into it. This is useful for image drawing + programs (creating a new empty canvas will cause the creation + of a new pixmap on which the drawing can be stored). It is + also useful when reading various image formats: we load the + image data into memory, create a pixmap on the server, and + then draw the decoded image data onto that pixmap. +

      +

      + To create a new pixmap, we first ask the X server to give an + Id to our pixmap, with this function: +

      +
       XCBPIXMAP XCBPIXMAPNew (XCBConnection *c);
       

      - Then, XCB supplies the following function to create new pixmaps: -

      -
      +         Then, XCB supplies the following function to create new pixmaps:
      +        

      +
       XCBVoidCookie XCBCreatePixmap (XCBConnection *c,         /* Pointer to the XCBConnection structure */
                                      CARD8          depth,     /* Depth of the screen */
      -			       XCBPIXMAP      pid,       /* Id of the pixmap */
      -			       XCBDRAWABLE    drawable,
      -			       CARD16         width,     /* Width of the window (in pixels) */
      -			       CARD16         height);   /* Height of the window (in pixels) */
      -
      -

      - TODO: Explain the drawable parameter, and give an - example (like xpoints.c) -

      -
    7. Drawing a pixmap in a window
    8. -

      - Once we got a handle to a pixmap, we can draw it on some - window, using the following function: -

      -
      +                               XCBPIXMAP      pid,       /* Id of the pixmap */
      +                               XCBDRAWABLE    drawable,
      +                               CARD16         width,     /* Width of the window (in pixels) */
      +                               CARD16         height);   /* Height of the window (in pixels) */
      +
      +

      + TODO: Explain the drawable parameter, and give an + example (like xpoints.c) +

      +
    9. Drawing a pixmap in a window +

      + Once we got a handle to a pixmap, we can draw it on some + window, using the following function: +

      +
       XCBVoidCookie XCBCopyArea (XCBConnection *c,             /* Pointer to the XCBConnection structure */
                                  XCBDRAWABLE    src_drawable,  /* The Drawable we want to paste */
      -			   XCBDRAWABLE    dst_drawable,  /* The Drawable on which we copy the previous Drawable */
      -			   XCBGCONTEXT    gc,            /* A Graphic Context */
      -			   INT16          src_x,         /* Top left x coordinate of the region we want to copy */
      -			   INT16          src_y,         /* Top left y coordinate of the region we want to copy */
      -			   INT16          dst_x,         /* Top left x coordinate of the region where we want to copy */
      -			   INT16          dst_y,         /* Top left y coordinate of the region where we want to copy */
      -			   CARD16         width,         /* Width of the region we want to copy */
      -			   CARD16         height);       /* Height of the region we want to copy */
      -
      -

      - As you can see, we could copy the whole pixmap, as well as - only a given rectangle of the pixmap. This is useful to - optimize the drawing speed: we could copy only what we have - modified in the pixmap. -

      -

      - One important note should be made: it is possible to - create pixmaps with different depths on the same screen. When - we perform copy operations (a pixmaap onto a window, etc), we - should make sure that both source and target have the same - depth. If they have a different depth, the operation would - fail. The exception to this is if we copy a specific bit plane - of the source pixmap using the - XCBCopyPlane function. In such an - event, we can copy a specific plain to the target window (in - actuality, setting a specific bit in the color of each pixel - copied). This can be used to generate strange graphic effects - in widow, but beyond the scope of this tutorial. -

      -
    10. Freeing a pixmap
    11. -

      - Finally, when we are done using a given pixmap, we should free - it, in order to free resources of the X server. This is done - using this function: -

      -
      +                           XCBDRAWABLE    dst_drawable,  /* The Drawable on which we copy the previous Drawable */
      +                           XCBGCONTEXT    gc,            /* A Graphic Context */
      +                           INT16          src_x,         /* Top left x coordinate of the region we want to copy */
      +                           INT16          src_y,         /* Top left y coordinate of the region we want to copy */
      +                           INT16          dst_x,         /* Top left x coordinate of the region where we want to copy */
      +                           INT16          dst_y,         /* Top left y coordinate of the region where we want to copy */
      +                           CARD16         width,         /* Width of the region we want to copy */
      +                           CARD16         height);       /* Height of the region we want to copy */
      +
      +

      + As you can see, we could copy the whole pixmap, as well as + only a given rectangle of the pixmap. This is useful to + optimize the drawing speed: we could copy only what we have + modified in the pixmap. +

      +

      + One important note should be made: it is possible to + create pixmaps with different depths on the same screen. When + we perform copy operations (a pixmap onto a window, etc), we + should make sure that both source and target have the same + depth. If they have a different depth, the operation would + fail. The exception to this is if we copy a specific bit plane + of the source pixmap using the + XCBCopyPlane function. In such an + event, we can copy a specific plane to the target window (in + actuality, setting a specific bit in the color of each pixel + copied). This can be used to generate strange graphic effects + in a window, but that is beyond the scope of this tutorial. +

      +
    12. Freeing a pixmap +

      + Finally, when we are done using a given pixmap, we should free + it, in order to free resources of the X server. This is done + using this function: +

      +
       XCBVoidCookie XCBFreePixmap (XCBConnection *c,        /* Pointer to the XCBConnection structure */
                                    XCBPIXMAP      pixmap);  /* A given pixmap */
       
      -

      - Of course, after having freed it, we must not try accessing - the pixmap again. -

      -

      - TODO: Give an example, or a link to xpoints.c -

      +

      + Of course, after having freed it, we must not try accessing + the pixmap again. +

      +

      + TODO: Give an example, or a link to xpoints.c +

    -
  • Translation of basic Xlib functions and macros
  • +
  • Translation of basic Xlib functions and macros

    The problem when you want to port an Xlib program to XCB is that you don't know if the Xlib function that you want to "translate" @@ -3055,16 +3083,16 @@ XCBVoidCookie XCBFreePixmap (XCBConnection *c, /* Pointer to the XCBConne provides. It's usually just a member of a structure.

      -
    1. Members of the Display structure
    2. +
    3. Members of the Display structure In this section, we look at how to translate the macros that - returns some members of the Display - structure. They are obtain by using a function that requires a + return some members of the Display + structure. They are obtained by using a function that requires a XCBConnection * or a member of the XCBConnSetupSuccessRep structure (via the function XCBGetSetup), or a function that requires that structure.
        -
      1. ConnectionNumber
      2. +
      3. ConnectionNumber

        This number is the file descriptor that connects the client to the server. You just have to use that function: @@ -3072,7 +3100,7 @@ XCBVoidCookie XCBFreePixmap (XCBConnection *c, /* Pointer to the XCBConne

         int XCBGetFileDescriptor(XCBConnection *c);
         
        -
      4. DefaultScreen
      5. +
      6. DefaultScreen

        That number is not stored by XCB. It is returned in the second parameter of the function XCBConnect. @@ -3081,7 +3109,8 @@ int XCBGetFileDescriptor(XCBConnection *c); structure, you have to iterate on the screens. The equivalent function of the Xlib's ScreenOfDisplay function can be - found below. OK, here is the + found below. This is also provided in the + XCBAux library as XCBAuxGetScreen(). OK, here is the small piece of code to get that number:

        @@ -3090,15 +3119,22 @@ int            screen_default_nbr;
         
         /* you pass the name of the display you want to XCBConnect */
         
        -c = XCBConnect (display_name, &screen_default_nbr);
        +c = XCBConnect (display_name, &screen_default_nbr);
         
         /* screen_default_nbr contains now the number of the default screen */
         
        -
      7. QLength
      8. +
      9. QLength

        Not documented yet.

        -
      10. ScreenCount
      11. +

        + However, this points out a basic difference in philosophy between + Xlib and XCB. Xlib has several functions for filtering and + manipulating the incoming and outgoing X message queues. XCB + wishes to hide this as much as possible from the user, which + allows for more freedom in implementation strategies. +

        +
      12. ScreenCount

        You get the count of screens with the functions XCBGetSetup @@ -3131,7 +3167,7 @@ screen_count = XCBConnSetupSuccessRepRootsLength (XCBGetSetup (c)); /* screen_count contains now the count of screens */ -

      13. ServerVendor
      14. +
      15. ServerVendor

        You get the name of the vendor of the server hardware with the functions XCBGetSetup @@ -3155,7 +3191,7 @@ vendor[length] = '\0'; /* vendor contains now the name of the vendor. Must be freed when not used anymore */ -

      16. ProtocolVersion
      17. +
      18. ProtocolVersion

        You get the major version of the protocol in the XCBConnSetupSuccessRep @@ -3171,7 +3207,7 @@ protocol_major_version = XCBGetSetup (c)->protocol_major_version; /* protocol_major_version contains now the major version of the protocol */ -

      19. ProtocolRevision
      20. +
      21. ProtocolRevision

        You get the minor version of the protocol in the XCBConnSetupSuccessRep @@ -3187,7 +3223,7 @@ protocol_minor_version = XCBGetSetup (c)->protocol_minor_version; /* protocol_minor_version contains now the minor version of the protocol */ -

      22. VendorRelease
      23. +
      24. VendorRelease

        You get the number of the release of the server hardware in the XCBConnSetupSuccessRep @@ -3203,12 +3239,12 @@ release_number = XCBGetSetup (c)->release_number; /* release_number contains now the number of the release of the server hardware */ -

      25. DisplayString
      26. +
      27. DisplayString

        The name of the display is not stored in XCB. You have to store it by yourself.

        -
      28. BitmapUnit
      29. +
      30. BitmapUnit

        You get the bitmap scanline unit in the XCBConnSetupSuccessRep @@ -3224,7 +3260,7 @@ bitmap_format_scanline_unit = XCBGetSetup (c)->bitmap_format_scanline_unit; /* bitmap_format_scanline_unit contains now the bitmap scanline unit */ -

      31. BitmapBitOrder
      32. +
      33. BitmapBitOrder

        You get the bitmap bit order in the XCBConnSetupSuccessRep @@ -3240,7 +3276,7 @@ bitmap_format_bit_order = XCBGetSetup (c)->bitmap_format_bit_order; /* bitmap_format_bit_order contains now the bitmap bit order */ -

      34. BitmapPad
      35. +
      36. BitmapPad

        You get the bitmap scanline pad in the XCBConnSetupSuccessRep @@ -3256,7 +3292,7 @@ bitmap_format_scanline_pad = XCBGetSetup (c)->bitmap_format_scanline_pad; /* bitmap_format_scanline_pad contains now the bitmap scanline pad */ -

      37. ImageByteOrder
      38. +
      39. ImageByteOrder

        You get the image byte order in the XCBConnSetupSuccessRep @@ -3273,7 +3309,7 @@ image_byte_order = XCBGetSetup (c)->image_byte_order; /* image_byte_order contains now the image byte order */

      -
    4. ScreenOfDisplay related functions
    5. +
    6. ScreenOfDisplay related functions

      in Xlib, ScreenOfDisplay returns a Screen structure that contains @@ -3283,8 +3319,8 @@ image_byte_order = XCBGetSetup (c)->image_byte_order; Xlib, you just provide the number of the screen and you grab it from an array. With XCB, you iterate over all the screens to obtain the one you want. The complexity of this operation is - O(n). So the best is to store this structure if you often use - it. See ScreenOfDisplay just below. + O(n). So the best is to store this structure if you use + it often. See ScreenOfDisplay just below.

      Xlib provides generally two functions to obtain the characteristics @@ -3298,10 +3334,10 @@ image_byte_order = XCBGetSetup (c)->image_byte_order; more) as, with XCB, you will use the same code.

        -
      1. ScreenOfDisplay
      2. +
      3. ScreenOfDisplay

        This function returns the Xlib Screen - structure. With XCB, you iterate over all thee screens and + structure. With XCB, you iterate over all the screens and once you get the one you want, you return it:

        
        @@ -3311,7 +3347,7 @@ XCBSCREEN *ScreenOfDisplay (XCBConnection *c,
           XCBSCREENIter iter;
         
           iter = XCBConnSetupSuccessRepRootsIter (XCBGetSetup (c));
        -  for (; iter.rem; --screen, XCBSCREENNext (&iter))
        +  for (; iter.rem; --screen, XCBSCREENNext (&iter))
             if (screen == 0)
               return iter.data;
         
        @@ -3324,10 +3360,10 @@ XCBSCREEN *ScreenOfDisplay (XCBConnection *c,
                   

        All the functions below will use the result of that - fonction, as they just grab a specific member of the + function, as they just grab a specific member of the XCBSCREEN structure.

        -
      4. DefaultScreenOfDisplay
      5. +
      6. DefaultScreenOfDisplay

        It is the default screen that you obtain when you connect to the X server. It suffices to call the ScreenOfDisplay @@ -3341,12 +3377,12 @@ XCBSCREEN *default_screen; /* the returned default screen */ /* you pass the name of the display you want to XCBConnect */ -c = XCBConnect (display_name, &screen_default_nbr); +c = XCBConnect (display_name, &screen_default_nbr); default_screen = ScreenOfDisplay (c, screen_default_nbr); /* default_screen contains now the default root window, or a NULL window if no screen is found */

      7. -
      8. RootWindow / RootWindowOfScreen
      9. +
      10. RootWindow / RootWindowOfScreen

        @@ -3363,7 +3399,7 @@ if (screen)
         
         /* root_window contains now the root window, or a NULL window if no screen is found */
         
        -
      11. DefaultRootWindow
      12. +
      13. DefaultRootWindow

        It is the root window of the default screen. So, you call ScreenOfDisplay with the @@ -3378,14 +3414,14 @@ XCBWINDOW root_window = { 0 }; /* the returned root window */ /* you pass the name of the display you want to XCBConnect */ -c = XCBConnect (display_name, &screen_default_nbr); +c = XCBConnect (display_name, &screen_default_nbr); screen = ScreenOfDisplay (c, screen_default_nbr); if (screen) root_window = screen->root; /* root_window contains now the default root window, or a NULL window if no screen is found */ -

      14. DefaultVisual / DefaultVisualOfScreen
      15. +
      16. DefaultVisual / DefaultVisualOfScreen

        While a Visual is, in Xlib, a structure, in XCB, there are two types: XCBVISUALID, which is @@ -3411,10 +3447,10 @@ if (screen)

        To get the XCBVISUALTYPE - structure, it's a bit less easier. You have to get the + structure, it's a bit less easy. You have to get the XCBSCREEN structure that you want, get its root_visual member, - then iterate on the XCBDEPTHs + then iterate over the XCBDEPTHs and the XCBVISUALTYPEs, and compare the XCBVISUALID of these XCBVISUALTYPEs: with root_visual: @@ -3434,12 +3470,12 @@ if (screen) XCBDEPTHIter depth_iter; depth_iter = XCBSCREENAllowedDepthsIter (screen); - for (; depth_iter.rem; XCBDEPTHNext (&depth_iter)) + for (; depth_iter.rem; XCBDEPTHNext (&depth_iter)) { XCBVISUALTYPEIter visual_iter; visual_iter = XCBDEPTHVisualsIter (depth_iter.data); - for (; visual_iter.rem; XCBVISUALTYPENext (&visual_iter)) + for (; visual_iter.rem; XCBVISUALTYPENext (&visual_iter)) { if (screen->root_visual.id == visual_iter.data->visual_id.id) { @@ -3452,7 +3488,7 @@ if (screen) /* visual_type contains now the visual structure, or a NULL visual structure if no screen is found */ -

      17. DefaultGC / DefaultGCOfScreen
      18. +
      19. DefaultGC / DefaultGCOfScreen

        This default Graphic Context is just a newly created Graphic Context, associated to the root window of a @@ -3476,7 +3512,7 @@ if (screen) gc = XCBGCONTEXTNew (c); draw.window = screen->root; - mask = GCForeground | GCBackground; + mask = XCBGCForeground | XCBGCBackground; values[0] = screen->black_pixel; values[1] = screen->white_pixel; XCBCreateGC (c, gc, draw, mask, values); @@ -3484,7 +3520,7 @@ if (screen) /* gc contains now the default graphic context */ -

      20. BlackPixel / BlackPixelOfScreen
      21. +
      22. BlackPixel / BlackPixelOfScreen

        It is the Id of the black pixel, which is in the structure of an XCBSCREEN. @@ -3503,7 +3539,7 @@ if (screen) /* black_pixel contains now the value of the black pixel, or 0 if no screen is found */ -

      23. WhitePixel / WhitePixelOfScreen
      24. +
      25. WhitePixel / WhitePixelOfScreen

        It is the Id of the white pixel, which is in the structure of an XCBSCREEN. @@ -3522,7 +3558,7 @@ if (screen) /* white_pixel contains now the value of the white pixel, or 0 if no screen is found */ -

      26. DisplayWidth / WidthOfScreen
      27. +
      28. DisplayWidth / WidthOfScreen

        It is the width in pixels of the screen that you want, and which is in the structure of the corresponding @@ -3542,7 +3578,7 @@ if (screen) /* width_in_pixels contains now the width in pixels, or 0 if no screen is found */ -

      29. DisplayHeight / HeightOfScreen
      30. +
      31. DisplayHeight / HeightOfScreen

        It is the height in pixels of the screen that you want, and which is in the structure of the corresponding @@ -3562,7 +3598,7 @@ if (screen) /* height_in_pixels contains now the height in pixels, or 0 if no screen is found */ -

      32. DisplayWidthMM / WidthMMOfScreen
      33. +
      34. DisplayWidthMM / WidthMMOfScreen

        It is the width in millimeters of the screen that you want, and which is in the structure of the corresponding @@ -3582,7 +3618,7 @@ if (screen) /* width_in_millimeters contains now the width in millimeters, or 0 if no screen is found */ -

      35. DisplayHeightMM / HeightMMOfScreen
      36. +
      37. DisplayHeightMM / HeightMMOfScreen

        It is the height in millimeters of the screen that you want, and which is in the structure of the corresponding @@ -3602,7 +3638,7 @@ if (screen) /* height_in_millimeters contains now the height in millimeters, or 0 if no screen is found */ -

      38. DisplayPlanes / DefaultDepth / DefaultDepthOfScreen / PlanesOfScreen
      39. +
      40. DisplayPlanes / DefaultDepth / DefaultDepthOfScreen / PlanesOfScreen

        It is the depth (in bits) of the root window of the screen. You get it from the XCBSCREEN structure. @@ -3621,7 +3657,7 @@ if (screen) /* root_depth contains now the depth of the root window, or 0 if no screen is found */ -

      41. DefaultColormap / DefaultColormapOfScreen
      42. +
      43. DefaultColormap / DefaultColormapOfScreen

        This is the default colormap of the screen (and not the (default) colormap of the default screen !). As usual, you @@ -3641,7 +3677,7 @@ if (screen) /* default_colormap contains now the default colormap, or a NULL colormap if no screen is found */ -

      44. MinCmapsOfScreen
      45. +
      46. MinCmapsOfScreen

        You get the minimum installed colormaps in the XCBSCREEN structure:

        @@ -3659,7 +3695,7 @@ if (screen) /* min_installed_maps contains now the minimum installed colormaps, or 0 if no screen is found */ -
      47. MaxCmapsOfScreen
      48. +
      49. MaxCmapsOfScreen

        You get the maximum installed colormaps in the XCBSCREEN structure:

        @@ -3677,7 +3713,7 @@ if (screen) /* max_installed_maps contains now the maximum installed colormaps, or 0 if no screen is found */ -
      50. DoesSaveUnders
      51. +
      52. DoesSaveUnders

        You know if save_unders is set, by looking in the XCBSCREEN structure: @@ -3696,7 +3732,7 @@ if (screen) /* save_unders contains now the value of save_unders, or FALSE if no screen is found */ -

      53. DoesBackingStore
      54. +
      55. DoesBackingStore

        You know the value of backing_stores, by looking in the XCBSCREEN structure: @@ -3715,7 +3751,7 @@ if (screen) /* backing_stores contains now the value of backing_stores, or FALSE if no screen is found */ -

      56. EventMaskOfScreen
      57. +
      58. EventMaskOfScreen

        To get the current input masks, you look in the XCBSCREEN structure: @@ -3735,9 +3771,9 @@ if (screen) /* current_input_masks contains now the value of the current input masks, or FALSE if no screen is found */

      -
    7. Miscellaneous macros
    8. +
    9. Miscellaneous macros
        -
      1. DisplayOfScreen
      2. +
      3. DisplayOfScreen

        in Xlib, the Screen structure stores its associated Display @@ -3745,7 +3781,7 @@ if (screen) hence, it's also not the case in XCB. So you have to store it by yourself.

        -
      4. DisplayCells / CellsOfScreen
      5. +
      6. DisplayCells / CellsOfScreen

        To get the colormap entries, you look in the XCBVISUALTYPE