X11 client-side library. High level API.

API changes

Display is pointer
type attribute name has been renamed to typ

Example code

You can also use low level API. Use low level API at your own risk.

import pkg/dynlibx11

proc main() =
  # Initialize X11 library. This must be the very first thing to do.
  if not open_x11_library():
    echo "Failed to open X11 library: ", last_x11_error()
    quit QuitFailure
  defer:
    close_x11_library()
  
  # Initialize the display.
  let display = open_display()
  if display == nil:
    echo "Can't connect to X server ", display_name()
    quit QuitFailure
  defer:
    display.close
  
  let screen = default_screen display
  let root = root_window(display, screen)
  let white = white_pixel(display, screen)
  let black = black_pixel(display, screen)
  
  # Create the window.
  let window = create_simple_window(display, root, 0, 0, 640, 480, 0,
                                    white, black)
  defer:
    destroy(display, window)
  
  map(display, window)
  
  select_input(display, window, ButtonPressMask or ExposureMask or KeyPressMask)
  
  var event: XEvent
  
  # Event loop.
  while true:
    next_event(display, event)
    case event.typ
    of Expose:
      echo "Expose event"
    of ButtonPress:
      echo "Button pressed"
    of KeyPress:
      echo "Key pressed"
    else:
      discard

when isMainModule:
  main()

Imports

dynlibx11/x11/xatom, dynlibx11/x11/xlib, dynlibx11/x11/xresource, dynlibx11/x11/xutil, dynlibx11/errutils, dynlibx11/libx11

Procs

proc alloc_class_hint(): ptr XClassHint {....raises: [], tags: [RootEffect], forbids: [].}: XAllocClassHint.
proc alloc_color(display: Display; colormap: Colormap; screen_in_out: var XColor): bool {. ...raises: [], tags: [RootEffect], forbids: [].}: XAllocColor.
proc auto_repeat(display: Display; on: bool): bool {.discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XAutoRepeatOff, XAutoRepeatOn.
proc bell(display: Display; percent: range[-100 .. 100]): int {....raises: [], tags: [RootEffect], forbids: [].}
proc black_pixel(display: Display; screen_number: int): culong {....raises: [], tags: [RootEffect], forbids: [].}: XBlackPixel.
proc black_pixel(screen: ptr Screen): culong {....raises: [], tags: [RootEffect], forbids: [].}: XBlackPixelOfScreen.
proc black_pixel_of_screen(screen: ptr Screen): culong {....raises: [], tags: [RootEffect], forbids: [].}: Alias of XBlackPixelOfScreen.
proc change_property(display: Display; window: Window; property, typ: Atom; format: int; mode: int; data: pointer; nelements: int): bool {. ...raises: [], tags: [RootEffect], forbids: [].}: XChangeProperty.
proc change_property(display: Display; window: Window; property, typ: Atom; format: int; mode: int; data: string): bool {....raises: [], tags: [RootEffect], forbids: [].}: XChangeProperty.
proc clear_window(display: Display; window: Window): bool {.discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XClearWindow.
proc close(display: Display): bool {.discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XCloseDisplay.
proc create_gc(display: Display; drawable: Drawable; valuemask: culong; values: ptr XGCValues): GC {....raises: [], tags: [RootEffect], forbids: [].}: XCreateGC.
proc create_pixmap(display: Display; drawable: Drawable; width, height: uint; depth: uint): Pixmap {....raises: [], tags: [RootEffect], forbids: [].}: XCreatePixmap.
proc create_simple_window(display: Display; parent: Window; x, y: int; width, height: uint; border_width: uint; border: culong; background: culong): Window {. ...raises: [], tags: [RootEffect], forbids: [].}: XCreateSimpleWindow.
proc create_window(display: Display; parent: Window; x, y: int; width, height: cuint; border_width: cuint; depth: cint; class: WindowClass = CopyFromParent; visual: VisualPtr = nil; valuemask: WindowAttributeMask = WindowAttributeMask 0; attributes: ptr XSetWindowAttributes = nil): Window {. ...raises: [], tags: [RootEffect], forbids: [].}: XCreateWindow.
proc default_colormap(display: Display; screen_number: int): Colormap {. ...raises: [], tags: [RootEffect], forbids: [].}: XDefaultColormap.
proc default_depth(display: Display; screen_number: int): int {....raises: [], tags: [RootEffect], forbids: [].}
proc default_root_window(display: Display): Window {....raises: [], tags: [RootEffect], forbids: [].}: XDefaultRootWindow.
proc default_screen(display: Display): int {....raises: [], tags: [RootEffect], forbids: [].}
proc default_visual(display: Display; screen_number: int): VisualPtr {. ...raises: [], tags: [RootEffect], forbids: [].}: XDefaultVisual.
proc destroy(display: Display; window: Window): bool {.discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XDestroyWindow.
proc display_name(display_name: string = ""): string {....raises: [], tags: [RootEffect], forbids: [].}: XDisplayName
proc draw_arc(display: Display; drawable: Drawable; gc: GC; x: int; y: int; width: uint; height: uint; angle1: int; angle2: int): bool {. discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XDrawArc.
proc draw_line(display: Display; drawable: Drawable; gc: GC; x1, y1: int; x2, y2: int): bool {.discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XDrawLine.
proc draw_point(display: Display; drawable: Drawable; gc: GC; x: int; y: int): bool {. discardable, ...raises: [], tags: [RootEffect], forbids: [].}
proc draw_segments(display: Display; drawable: Drawable; gc: GC; segments: openArray[XSegment]; nsegments: int): bool {. discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XDrawSegments
proc draw_string(display: Display; drawable: Drawable; gc: GC; x, y: int; str: string): bool {....raises: [], tags: [RootEffect], forbids: [].}: XDrawString.
proc fill_rectangle(display: Display; drawable: Drawable; gc: GC; x, y: int; width, height: uint): bool {.discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XFillRectangle.
proc flush(display: Display): bool {.discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XFlush.
proc free(data: ptr XClassHint): bool {.discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XFree.
proc free(display: Display; colormap: Colormap): bool {.discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XFreeColormap.
proc free(display: Display; font_struct: ptr XFontStruct): bool {.discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XFreeFont.
proc free(display: Display; gc: GC): bool {.discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XFreeGC.
proc free(display: Display; pixmap: Pixmap): bool {....raises: [], tags: [RootEffect], forbids: [].}: XFreePixmap.
proc get_error_database_text(display: Display; name: cstring; message: cstring; default_string: cstring; buffer_return: ptr char; length: cint): bool {....raises: [], tags: [RootEffect], forbids: [].}: XGetErrorDatabaseText.
proc get_error_text(display: Display; code: int): string {....raises: [], tags: [RootEffect], forbids: [].}
proc get_error_text(display: Display; event: ptr XErrorEvent): string {. ...raises: [], tags: [RootEffect], forbids: [].}
proc height(screen: ptr Screen): int {....raises: [], tags: [RootEffect], forbids: [].}
proc height_of_screen(screen: ptr Screen): int {....raises: [], tags: [RootEffect], forbids: [].}
proc intern_atom(display: Display; atom_name: string; only_if_exists: bool = false): Atom {....raises: [], tags: [RootEffect], forbids: [].}: XInternAtom.
proc keysym_to_keycode(display: Display; keysym: KeySym): KeyCode {....raises: [], tags: [RootEffect], forbids: [].}: XKeysymToKeycode.
proc load_query_font(display: Display; name: string): ptr XFontStruct {. ...raises: [], tags: [RootEffect], forbids: [].}: XLoadQueryFont.
proc map(display: Display; window: Window): bool {.discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XMapWindow.
proc map_raised(display: Display; window: Window): bool {.discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XMapRaised.
proc next_event(display: Display; event_return: var XEvent): int {.discardable, ...raises: [], tags: [RootEffect], forbids: [].}
proc open_display(display_name: string = ""): Display {....raises: [], tags: [RootEffect], forbids: [].}: Connect to X server.
Note: This proc sets own error and IO error handlers before connecting.

XOpenDisplay.
proc pending(display: Display): int {....raises: [], tags: [RootEffect], forbids: [].}
proc protocol_revision(display: Display): int {....raises: [], tags: [RootEffect], forbids: [].}
proc protocol_version(display: Display): int {....raises: [], tags: [RootEffect], forbids: [].}
proc resize_window(display: Display; window: Window; width, height: uint): bool {. ...raises: [], tags: [RootEffect], forbids: [].}: XResizeWindow.
proc root_window(display: Display; screen_number: int): Window {....raises: [], tags: [RootEffect], forbids: [].}: XRootWindow.
proc select_input(display: Display; window: Window; event_mask: EventMask): bool {. discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XSelectInput.
proc send_event(display: Display; window: Window; propagate: bool; event_mask: EventMask; event_send: var XEvent): bool {. ...raises: [], tags: [RootEffect], forbids: [].}: XSendEvent.
proc set_background(display: Display; gc: GC; background: culong): bool {. discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XSetBackground.
proc set_class_hint(display: Display; window: Window; class_hints: ptr XClassHint): bool {....raises: [], tags: [RootEffect], forbids: [].}
proc set_error_handler(handler: XErrorHandler): XErrorHandler {.discardable, ...raises: [], tags: [RootEffect], forbids: [].}
proc set_foreground(display: Display; gc: GC; foreground: culong): bool {. discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XSetForeground.
proc set_icon_name(display: Display; window: Window; name: string): bool {. ...raises: [], tags: [RootEffect], forbids: [].}: XSetIconName.
proc set_io_error_handler(handler: XIOErrorHandler): XIOErrorHandler {. discardable, ...raises: [], tags: [RootEffect], forbids: [].}
proc set_window_border(display: Display; window: Window; border_pixel: culong): bool {. discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XSetWindowBorder
proc set_window_border_width(display: Display; window: Window; width: uint): bool {. discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XSetWindowBorderWidth.
proc set_wm_protocols(display: Display; window: Window; protocols: Atom; count: int): bool {.discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XSetWMProtocols.
proc store_name(display: Display; window: Window; name: string): bool {. discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XStoreName.
proc synchronize(display: Display; onoff: bool): bool {....raises: [], tags: [RootEffect], forbids: [].}: XSynchronize.
proc unmap(display: Display; window: Window): bool {.discardable, ...raises: [], tags: [RootEffect], forbids: [].}: XUnmapWindow.
proc vendor_release(display: Display): int {....raises: [], tags: [RootEffect], forbids: [].}
proc white_pixel(display: Display; screen_number: int): culong {....raises: [], tags: [RootEffect], forbids: [].}: XWhitePixel.
proc white_pixel(screen: ptr Screen): culong {....raises: [], tags: [RootEffect], forbids: [].}: XWhitePixelOfScreen.
proc white_pixel_of_screen(screen: ptr Screen): culong {....raises: [], tags: [RootEffect], forbids: [].}: Alias of white_pixel.
proc width(screen: ptr Screen): int {....raises: [], tags: [RootEffect], forbids: [].}
proc width_of_screen(screen: ptr Screen): int {....raises: [], tags: [RootEffect], forbids: [].}
proc x11_available(unload: bool = true): bool {....raises: [], tags: [], forbids: [].}: Check whether X11 client library is available.
proc x11_usable(unload: bool = true; width: uint = 800; height: uint = 600): bool {. ...raises: [], tags: [RootEffect], forbids: [].}: Check whether X11 client library is available and XXX.

Exports