Code comments review

BoboTiG · BoboTiG · commit 4e97da13fd0c · 2016-04-29T18:12:50.000+02:00
diff --git a/mss/base.py b/mss/base.py
@@ -43,6 +43,7 @@ def enum_display_monitors(self, screen=0):
                 'height': the height
             }
         '''
+
         raise NotImplementedError('Subclasses need to implement this!')
 
     def get_pixels(self, monitor):
@@ -56,6 +57,7 @@ def get_pixels(self, monitor):
                 'heigth': the height
             }
         '''
+
         raise NotImplementedError('Subclasses need to implement this!')
 
     def save(self,
diff --git a/mss/darwin.py b/mss/darwin.py
@@ -21,7 +21,7 @@
 
 
 class MSS(MSSBase):
-    ''' Mutliple ScreenShots implementation for Mac OS X.
+    ''' Mutliple ScreenShots implementation for MacOS X.
         It uses intensively the Quartz.
     '''
 
diff --git a/mss/linux.py b/mss/linux.py
@@ -136,7 +136,7 @@ def _cleanup(self):
     def _set_argtypes(self):
         ''' Functions arguments.
 
-            Curiously, if we set up self.xlib.XGetPixel.argtypes,
+            Curiously, if we set up XGetPixel arguments type,
             the entire process takes twice more time.
             So, no need to waste this precious time :)
             Note: this issue does not occur when using libmss.
@@ -191,8 +191,6 @@ def validate(value):
         self.xlib.XDestroyImage.restype = c_void_p
         self.xlib.XCloseDisplay.restype = c_void_p
         self.xlib.XDefaultRootWindow.restype = POINTER(XWindowAttributes)
-        # self.xrandr.XRRGetScreenResources.restype = \
-        #     POINTER(XRRScreenResources)
         self.xrandr.XRRGetScreenResources.restype = validate
         self.xrandr.XRRGetCrtcInfo.restype = POINTER(XRRCrtcInfo)
         self.xrandr.XRRFreeScreenResources.restype = c_void_p
@@ -202,7 +200,7 @@ def validate(value):
 
     def enum_display_monitors(self, screen=0):
         ''' Get positions of one or more monitors.
-            Returns a dict with minimal requirements (see MSS class).
+            Returns a dict with minimal requirements (see parent class).
         '''
 
         if screen == -1:
diff --git a/mss/windows.py b/mss/windows.py
@@ -74,7 +74,7 @@ def _set_restypes(self):
 
     def enum_display_monitors(self, screen=-1):
         ''' Get positions of one or more monitors.
-            Returns a dict with minimal requirements (see MSS class).
+            Returns a dict with minimal requirements (see parent class).
         '''
 
         if screen == -1:
@@ -96,6 +96,7 @@ def _callback(monitor, data, rect, dc_):
                 ''' Callback for monitorenumproc() function, it will return
                     a RECT with appropriate values.
                 '''
+
                 del monitor
                 del data
                 del dc_
@@ -117,17 +118,30 @@ def _callback(monitor, data, rect, dc_):
     def get_pixels(self, monitor):
         ''' Retrieve all pixels from a monitor. Pixels have to be RGB.
 
-            [1] A bottom-up DIB is specified by setting the height to a
+            In the code, there are few interesting things:
+
+            [1] bmi.bmiHeader.biHeight = -height
+
+            A bottom-up DIB is specified by setting the height to a
             positive number, while a top-down DIB is specified by
             setting the height to a negative number.
             https://msdn.microsoft.com/en-us/library/ms787796.aspx
             https://msdn.microsoft.com/en-us/library/dd144879%28v=vs.85%29.aspx
 
-            [2] We grab the image in RGBX mode, so that each word is 32bit
+
+            [2] bmi.bmiHeader.biBitCount = 32
+                image_data = create_string_buffer(height * width * 4)
+                # and later, the BGRX to RGB conversion
+
+            We grab the image in RGBX mode, so that each word is 32bit
             and we have no striding, then we transform to RGB.
             Inspired by https://github.com/zoofIO/flexx
 
-            [3] When biClrUsed and biClrImportant are set to zero, there
+
+            [3] bmi.bmiHeader.biClrUsed = 0
+                bmi.bmiHeader.biClrImportant = 0
+
+            When biClrUsed and biClrImportant are set to zero, there
             is "no" color table, so we can read the pixels of the bitmap
             retrieved by gdi32.GetDIBits() as a sequence of RGB values.
             Thanks to http://stackoverflow.com/a/3688682
@@ -148,7 +162,7 @@ def get_pixels(self, monitor):
             bmi = BITMAPINFO()
             bmi.bmiHeader.biSize = sizeof(BITMAPINFOHEADER)
             bmi.bmiHeader.biWidth = width
-            bmi.bmiHeader.biHeight = -height  # Why minus? See [1]
+            bmi.bmiHeader.biHeight = -height  # Why minux? See [1]
             bmi.bmiHeader.biPlanes = 1  # Always 1
             bmi.bmiHeader.biBitCount = 32  # See [2]
             bmi.bmiHeader.biCompression = bi_rgb

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,7 @@ def enum_display_monitors(self, screen=0):`
`43`	`43`	`'height': the height`
`44`	`44`	`}`
`45`	`45`	`'''`
	`46`	`+`
`46`	`47`	`raise NotImplementedError('Subclasses need to implement this!')`
`47`	`48`
`48`	`49`	`def get_pixels(self, monitor):`
`@@ -56,6 +57,7 @@ def get_pixels(self, monitor):`
`56`	`57`	`'heigth': the height`
`57`	`58`	`}`
`58`	`59`	`'''`
	`60`	`+`
`59`	`61`	`raise NotImplementedError('Subclasses need to implement this!')`
`60`	`62`
`61`	`63`	`def save(self,`