doc: more details on the Linux API

Author: BoboTiG

docs/source/api.rst

@@ -43,19 +43,33 @@ GNU/Linux
 
 .. class:: Display
 
+    Structure that serves as the connection to the X server, and that contains all the information about that X server.
+
 .. class:: Event
 
+    XErrorEvent to debug eventual errors.
+
 .. class:: XFixesCursorImage
 
-.. class:: XWindowAttributes
+    Cursor structure
 
 .. class:: XImage
 
+    Description of an image as it exists in the client's memory.
+
+.. class:: XRRCrtcInfo
+
+    Structure that contains CRTC information.
+
 .. class:: XRRModeInfo
 
 .. class:: XRRScreenResources
 
-.. class:: XRRCrtcInfo
+    Structure that contains arrays of XIDs that point to the available outputs and associated CRTCs.
+
+.. class:: XWindowAttributes
+
+    Attributes for the specified window.
 
 .. class:: MSS
 

mss/linux.py

@@ -66,8 +66,9 @@ class Event(Structure):
 
 class XFixesCursorImage(Structure):
     """
-    XFixes is an X Window System extension.
-    See /usr/include/X11/extensions/Xfixes.h
+    Cursor structure.
+    /usr/include/X11/extensions/Xfixes.h
+    https://github.com/freedesktop/xorg-libXfixes/blob/libXfixes-6.0.0/include/X11/extensions/Xfixes.h#L96
     """
 
     _fields_ = [
@@ -84,36 +85,6 @@ class XFixesCursorImage(Structure):
     ]
 
 
-class XWindowAttributes(Structure):
-    """Attributes for the specified window."""
-
-    _fields_ = [
-        ("x", c_int32),
-        ("y", c_int32),
-        ("width", c_int32),
-        ("height", c_int32),
-        ("border_width", c_int32),
-        ("depth", c_int32),
-        ("visual", c_ulong),
-        ("root", c_ulong),
-        ("class", c_int32),
-        ("bit_gravity", c_int32),
-        ("win_gravity", c_int32),
-        ("backing_store", c_int32),
-        ("backing_planes", c_ulong),
-        ("backing_pixel", c_ulong),
-        ("save_under", c_int32),
-        ("colourmap", c_ulong),
-        ("mapinstalled", c_uint32),
-        ("map_state", c_uint32),
-        ("all_event_masks", c_ulong),
-        ("your_event_mask", c_ulong),
-        ("do_not_propagate_mask", c_ulong),
-        ("override_redirect", c_int32),
-        ("screen", c_ulong),
-    ]
-
-
 class XImage(Structure):
     """
     Description of an image as it exists in the client's memory.
@@ -139,6 +110,25 @@ class XImage(Structure):
     ]
 
 
+class XRRCrtcInfo(Structure):
+    """Structure that contains CRTC information."""
+
+    _fields_ = [
+        ("timestamp", c_ulong),
+        ("x", c_int),
+        ("y", c_int),
+        ("width", c_int),
+        ("height", c_int),
+        ("mode", c_long),
+        ("rotation", c_int),
+        ("noutput", c_int),
+        ("outputs", POINTER(c_long)),
+        ("rotations", c_ushort),
+        ("npossible", c_int),
+        ("possible", POINTER(c_long)),
+    ]
+
+
 class XRRModeInfo(Structure):
     """Voilà, voilà."""
 
@@ -161,22 +151,33 @@ class XRRScreenResources(Structure):
     ]
 
 
-class XRRCrtcInfo(Structure):
-    """Structure that contains CRTC information."""
+class XWindowAttributes(Structure):
+    """Attributes for the specified window."""
 
     _fields_ = [
-        ("timestamp", c_ulong),
-        ("x", c_int),
-        ("y", c_int),
-        ("width", c_int),
-        ("height", c_int),
-        ("mode", c_long),
-        ("rotation", c_int),
-        ("noutput", c_int),
-        ("outputs", POINTER(c_long)),
-        ("rotations", c_ushort),
-        ("npossible", c_int),
-        ("possible", POINTER(c_long)),
+        ("x", c_int32),
+        ("y", c_int32),
+        ("width", c_int32),
+        ("height", c_int32),
+        ("border_width", c_int32),
+        ("depth", c_int32),
+        ("visual", c_ulong),
+        ("root", c_ulong),
+        ("class", c_int32),
+        ("bit_gravity", c_int32),
+        ("win_gravity", c_int32),
+        ("backing_store", c_int32),
+        ("backing_planes", c_ulong),
+        ("backing_pixel", c_ulong),
+        ("save_under", c_int32),
+        ("colourmap", c_ulong),
+        ("mapinstalled", c_uint32),
+        ("map_state", c_uint32),
+        ("all_event_masks", c_ulong),
+        ("your_event_mask", c_ulong),
+        ("do_not_propagate_mask", c_ulong),
+        ("override_redirect", c_int32),
+        ("screen", c_ulong),
     ]
 
 
@@ -226,7 +227,7 @@ def _validate(retval: int, func: Any, args: Tuple[Any, Any]) -> Tuple[Any, Any]:
 # This is a dict:
 #    cfunction: (attr, argtypes, restype)
 #
-# Available attr: xlib, xrandr.
+# Available attr: xfixes, xlib, xrandr.
 #
 # Note: keep it sorted by cfunction.
 CFUNCTIONS: CFunctions = {
@@ -292,7 +293,7 @@ class MSS(MSSBase):
     It uses intensively the Xlib and its Xrandr extension.
     """
 
-    __slots__ = {"xlib", "xrandr", "xfixes", "_handles"}
+    __slots__ = {"xfixes", "xlib", "xrandr", "_handles"}
 
     def __init__(self, **kwargs: Any) -> None:
         """GNU/Linux initialisations."""