win32screenshot 3.1.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af9b9611193b8f4cc8d98745a6130cf16fe6fb2674e26e76a3745e34cf8de959
-  data.tar.gz: 278502bd7bc360a2813db04f590ee82b706eaee894cd6ce252227acb0765676e
+  metadata.gz: 20fb85f0a8a6db55a03ef208225cb7a0f081b704f41abf405b39e63283c2c7ea
+  data.tar.gz: bfeb14a87af3452d3bd39b37edfd13733a940657e671e4e038a1ec06775aa858
 SHA512:
-  metadata.gz: 636cfeb1613a8b84a000b1c5b449168cf398306bfbe47de4ac882ad6bfbb5e461055e921b63cc17ad4bd1f915fc6e13c582158da5518f835813f41b55662f947
-  data.tar.gz: 1209209433553596e94ed0a65c67becbb652756eca79ac3ff00777e5cc8b29ea8faa9eea42312303d048bd5121a985622e5aac93db1a55e86242f3fa196d92a4
+  metadata.gz: 75b4b936b11909e01426ee6ae23a8885106c594a8585372e9e8d7cef59c739d0ce5b7369173b1ae28484559637466f2d22774b0d29a487df13dca8011ed1464d
+  data.tar.gz: e428a2fdcaa46dd961f351000af951d4c4ffa8f556e1b8b9befb7e09dd99eb7c3412d950f9e4122301d6ebc99009cda805eb7343c0772bb14ac0b152fcd4163c

data/CHANGES.md

@@ -1,11 +1,26 @@
+# 4.1.0 2023-02-05
+* Add support for Ruby 3.2 (by @kaiwaredaikon009 via PR #36)
+
+
+# 4.0.0 2022-06-18
+* Add support for taking screenchots of non-native Windows (e.g. Google Chrome).
+* When taking screenshot of `:desktop` then all monitors will be included if they exist.
+* Remove `:area` option - instead whole windows will be screenshotted (for browser windows, the whole page will be saved).
+* Remove `context: :client` option.
+
+Changes done by @bensandland via PR #34.
+
+
 # 3.1.0 2022-02-05
 *   Update dependencies
 
+
 # 3.0.0 2019-12-11
 *   Use RAutomation 1.0.0 as its dependency to be able to use newer ffi.
 *   Update bundled ImageMagick to 7.0.9-8.
 *   Update MiniMagick dependency.
 
+
 # 2.1.0 2016-01-09
 *   Add Image#write! for overwriting images.
 *   Update MiniMagick dependency.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    win32screenshot (3.1.0)
+    win32screenshot (4.1.0)
       ffi (~> 1.15.0)
       mini_magick (~> 4.9)
       rautomation (~> 1.1.0)
@@ -42,4 +42,4 @@ DEPENDENCIES
   yard
 
 BUNDLED WITH
-   2.3.3
+   2.3.24

data/README.md

@@ -1,48 +1,54 @@
-# Win32::Screenshot
-
-*   http://github.com/jarmo/win32screenshot
-
-
-## DESCRIPTION
-
-Capture Screenshots on Windows with Ruby to bmp, gif, jpg or png formats!
-
-## INSTALL
-
-    gem install win32screenshot
-
-## SYNOPSIS
-
-    require 'win32/screenshot'
-
-    # Take a screenshot of the window with the specified title
-    Win32::Screenshot::Take.of(:window, title: "Windows Internet Explorer").write("image.bmp")
-
-    # Take a screenshot of the foreground
-    Win32::Screenshot::Take.of(:foreground).write("image.png")
-
-    # Take a screenshot of the foreground, and writing over previous image if it exists
-    Win32::Screenshot::Take.of(:foreground).write!("image.png")
-
-    # Take a screenshot of the specified window's top-left corner's area
-    Win32::Screenshot::Take.of(:window, title: /internet/i, area: [10, 10, 20, 20]).write("image.jpg")
-
-    # Take a screenshot of the window with the specified handle
-    Win32::Screenshot::Take.of(:window, hwnd: 123456).write("image.gif")
-
-    # Take a screenshot of the window's client area (e.g. without title bar) with the specified handle
-    Win32::Screenshot::Take.of(:window, hwnd: 123456, context: :client)
-
-    # Take a screenshot of the child window with the specified internal class name
-    Win32::Screenshot::Take.of(:rautomation, RAutomation::Window.new(hwnd: 123456).
-                              child(class: "Internet Explorer_Server")).write("image.png")
-
-    # Use the bitmap blob for something else
-    image = Win32::Screenshot::Take.of(:window, hwnd: 123456)
-    image.height # => height of the image
-    image.width  # => width of the image
-    image.bitmap # => bitmap blob
-
-## Copyright
-
-Copyright (c) Jarmo Pertman, Aslak Hellesøy. See LICENSE for details.
+# Win32::Screenshot
+
+*  http://github.com/jarmo/win32screenshot
+
+
+## DESCRIPTION
+
+Capture Screenshots on Windows with Ruby to bmp, gif, jpg or png formats!
+
+## INSTALL
+
+```
+gem install win32screenshot
+```
+
+## SYNOPSIS
+
+```ruby
+require 'win32/screenshot'
+
+# Take a screenshot of the window with the specified title
+Win32::Screenshot::Take.of(:window, title: "Windows Internet Explorer").write("image.bmp")
+
+# Take a screenshot of the whole desktop area, including all monitors if multiple are connected
+Win32::Screenshot::Take.of(:desktop).write("image.png")
+
+# Take a screenshot of the foreground window
+Win32::Screenshot::Take.of(:foreground).write("image.png")
+
+# Take a screenshot of the foreground window, and writing over previous image if it exists
+Win32::Screenshot::Take.of(:foreground).write!("image.png")
+
+# Take a screenshot of the specified window with title matching the regular expression
+Win32::Screenshot::Take.of(:window, title: /internet/i).write("image.jpg")
+
+# Take a screenshot of the window with the specified handle
+Win32::Screenshot::Take.of(:window, hwnd: 123456).write("image.gif")
+
+# Take a screenshot of the child window with the specified internal class name
+Win32::Screenshot::Take.of(
+  :rautomation,
+  RAutomation::Window.new(hwnd: 123456).child(class: "Internet Explorer_Server")
+).write("image.png")
+
+# Use the bitmap blob for something else
+image = Win32::Screenshot::Take.of(:window, hwnd: 123456)
+image.height # => height of the image
+image.width  # => width of the image
+image.bitmap # => bitmap blob
+```
+
+## Copyright
+
+Copyright (c) Jarmo Pertman, Aslak Hellesøy. See LICENSE for details.

data/lib/win32/screenshot/bitmap_maker.rb

@@ -1,100 +1,121 @@
-module Win32
-  module Screenshot
-    # @private
-    # This is an internal class for taking the actual screenshots and not part of a public API.
-    class BitmapMaker
-      class << self
-        extend FFI::Library
-
-        ffi_lib 'user32', 'gdi32'
-        ffi_convention :stdcall
-
-        # user32.dll
-        attach_function :window_dc, :GetWindowDC,
-                        [:long], :long
-        attach_function :client_dc, :GetDC,
-                        [:long], :long
-        attach_function :client_rect, :GetClientRect,
-                        [:long, :pointer], :bool
-        attach_function :window_rect, :GetWindowRect,
-                        [:long, :pointer], :bool
-        attach_function :foreground_window, :GetForegroundWindow,
-                        [], :long
-        attach_function :desktop_window, :GetDesktopWindow,
-                        [], :long
-
-        # gdi32.dll
-        attach_function :create_compatible_dc, :CreateCompatibleDC,
-                        [:long], :long
-        attach_function :create_compatible_bitmap, :CreateCompatibleBitmap,
-                        [:long, :int, :int], :long
-        attach_function :select_object, :SelectObject,
-                        [:long, :long], :long
-        attach_function :bit_blt, :BitBlt,
-                        [:long, :int, :int, :int, :int, :long, :int, :int, :long], :bool
-        attach_function :di_bits, :GetDIBits,
-                        [:long, :long, :int, :int, :pointer, :pointer, :int], :int
-        attach_function :delete_object, :DeleteObject,
-                        [:long], :bool
-        attach_function :delete_dc, :DeleteDC,
-                        [:long], :bool
-        attach_function :release_dc, :ReleaseDC,
-                        [:long, :long], :int
-
-        def capture_all(hwnd, context)
-          width, height = dimensions_for(hwnd, context)
-          capture_area(hwnd, context, 0, 0, width, height)
-        end
-
-        SRCCOPY = 0x00CC0020
-        DIB_RGB_COLORS = 0
-
-        def capture_area(hwnd, context, x1, y1, x2, y2)
-          hScreenDC = send("#{context}_dc", hwnd)
-          w = x2-x1
-          h = y2-y1
-
-          hmemDC = create_compatible_dc(hScreenDC)
-          hmemBM = create_compatible_bitmap(hScreenDC, w, h)
-          select_object(hmemDC, hmemBM)
-          bit_blt(hmemDC, 0, 0, w, h, hScreenDC, x1, y1, SRCCOPY)
-          bitmap_size = w * h * 3 + w % 4 * h
-          lpvpxldata = FFI::MemoryPointer.new(bitmap_size)
-
-          # Bitmap header
-          # http://www.fortunecity.com/skyscraper/windows/364/bmpffrmt.html
-          bmInfo = [40, w, h, 1, 24, 0, 0, 0, 0, 0, 0, 0].pack('L3S2L6')
-          di_bits(hmemDC, hmemBM, 0, h, lpvpxldata, bmInfo, DIB_RGB_COLORS)
-
-          bmFileHeader = [
-                  19778,
-                  bitmap_size + 40 + 14,
-                  0,
-                  0,
-                  54
-          ].pack('SLSSL')
-
-          Image.new(bmFileHeader + bmInfo + lpvpxldata.read_string(bitmap_size), w, h)
-        ensure
-          lpvpxldata.free
-          delete_object(hmemBM)
-          delete_dc(hmemDC)
-          release_dc(0, hScreenDC)
-        end
-
-        def dimensions_for(hwnd, context)
-          rect = [0, 0, 0, 0].pack('l4')
-          BitmapMaker.send("#{context}_rect", hwnd.to_i, rect)
-          left, top, width, height = rect.unpack('l4')
-
-          if context == :window
-            [width + 1 - left, height + 1 - top]
-          else
-            [width, height]
-          end
-        end
-
-      end
-    end
-  end
-end
+module Win32
+  module Screenshot
+    # @private
+    # This is an internal class for taking the actual screenshots and not part of a public API.
+    class BitmapMaker
+      class << self
+        extend FFI::Library
+
+        ffi_lib 'user32', 'gdi32'
+        ffi_convention :stdcall
+
+        # user32.dll
+        attach_function :window_dc, :GetWindowDC,
+                        [:long], :long
+        attach_function :window_rect, :GetWindowRect,
+                        [:long, :pointer], :bool
+        attach_function :foreground_window, :GetForegroundWindow,
+                        [], :long
+        attach_function :desktop_window, :GetDesktopWindow,
+                        [], :long
+        attach_function :print_window, :PrintWindow,
+                        [:long, :long, :int], :bool
+        attach_function :get_system_metrics, :GetSystemMetrics,
+                        [:int], :int
+
+        # gdi32.dll
+        attach_function :create_compatible_dc, :CreateCompatibleDC,
+                        [:long], :long
+        attach_function :create_compatible_bitmap, :CreateCompatibleBitmap,
+                        [:long, :int, :int], :long
+        attach_function :select_object, :SelectObject,
+                        [:long, :long], :long
+        attach_function :di_bits, :GetDIBits,
+                        [:long, :long, :int, :int, :pointer, :pointer, :int], :int
+        attach_function :delete_object, :DeleteObject,
+                        [:long], :bool
+        attach_function :delete_dc, :DeleteDC,
+                        [:long], :bool
+        attach_function :release_dc, :ReleaseDC,
+                        [:long, :long], :int
+        attach_function :bit_blt, :BitBlt,
+                        [:long, :int, :int, :int, :int, :long, :int, :int, :long], :bool
+
+        DIB_RGB_COLORS = 0
+        PW_RENDERFULLCONTENT = 0x00000002
+        SRCCOPY = 0x00CC0020
+
+        SM_XVIRTUALSCREEN = 76
+        SM_YVIRTUALSCREEN = 77
+        SM_CXVIRTUALSCREEN = 78
+        SM_CYVIRTUALSCREEN = 79
+
+        def capture_window(hwnd)
+          width, height = dimensions_for(hwnd)
+
+          hScreenDC, hmemDC, hmemBM = prepare_object(hwnd, width, height)
+          print_window(hwnd, hmemDC, PW_RENDERFULLCONTENT)
+          create_bitmap(hScreenDC, hmemDC, hmemBM, width, height)
+        end
+
+        def capture_screen(hwnd)
+          left, top, width, height = desktop.dimensions
+
+          hScreenDC, hmemDC, hmemBM = prepare_object(hwnd, width, height)
+          bit_blt(hmemDC, 0, 0, width, height, hScreenDC, left, top, SRCCOPY)
+          create_bitmap(hScreenDC, hmemDC, hmemBM, width, height)
+        end
+
+        def prepare_object(hwnd, width, height)
+          hScreenDC = window_dc(hwnd)
+          hmemDC = create_compatible_dc(hScreenDC)
+          hmemBM = create_compatible_bitmap(hScreenDC, width, height)
+          select_object(hmemDC, hmemBM)
+          [hScreenDC, hmemDC, hmemBM]
+        end
+
+        def create_bitmap(hScreenDC, hmemDC, hmemBM, width, height)
+          bitmap_size = width * height * 3 + width % 4 * height
+          lpvpxldata = FFI::MemoryPointer.new(bitmap_size)
+
+          # Bitmap header
+          # http://www.fortunecity.com/skyscraper/windows/364/bmpffrmt.html
+          bmInfo = [40, width, height, 1, 24, 0, 0, 0, 0, 0, 0, 0].pack('L3S2L6')
+          di_bits(hmemDC, hmemBM, 0, height, lpvpxldata, bmInfo, DIB_RGB_COLORS)
+
+          bmFileHeader = [
+                  19778,
+                  bitmap_size + 40 + 14,
+                  0,
+                  0,
+                  54
+          ].pack('SLSSL')
+
+          Image.new(bmFileHeader + bmInfo + lpvpxldata.read_string(bitmap_size), width, height)
+        ensure
+          lpvpxldata.free
+          delete_object(hmemBM)
+          delete_dc(hmemDC)
+          release_dc(0, hScreenDC)
+        end
+
+        def desktop
+          Win32::Screenshot::Desktop.new(
+               get_system_metrics(SM_XVIRTUALSCREEN),
+               get_system_metrics(SM_YVIRTUALSCREEN),
+               get_system_metrics(SM_CXVIRTUALSCREEN),
+               get_system_metrics(SM_CYVIRTUALSCREEN)
+          )
+        end
+
+        def dimensions_for(hwnd)
+          rect = [0, 0, 0, 0].pack('l4')
+          window_rect(hwnd.to_i, rect)
+          left, top, width, height = rect.unpack('l4')
+
+          [width - left, height - top]
+        end
+      end
+    end
+  end
+end

data/lib/win32/screenshot/desktop.rb

@@ -0,0 +1,5 @@
+Win32::Screenshot::Desktop = Struct.new(:left, :top, :width, :height) do
+   def dimensions
+      [left, top, width, height]
+   end
+end

data/lib/win32/screenshot/image.rb

@@ -1,48 +1,48 @@
-module Win32
-  module Screenshot
-    # Holds the bitmap data and writes it to the disk
-    class Image
-      # [String] raw bitmap blob
-      attr_reader :bitmap
-
-      # [String] bitmap width
-      attr_reader :width
-
-      # [String] bitmap height
-      attr_reader :height
-
-      # Supported output formats
-      FORMATS = %w{bmp gif jpg png}
-
-      # @private
-      def initialize(blob, width, height)
-        @bitmap = blob
-        @width = width
-        @height = height
-      end
-
-      # Writes image to the disk.
-      # @param [String] file_path writes image to the specified path.
-      # @raise [RuntimeError] when _file_path_ already exists.
-      # @raise [RuntimeError] when _file_path_ is not with the supported output {FORMATS} extension.
-      def write(file_path)
-        raise "File already exists: #{file_path}!" if File.exists? file_path
-        write! file_path
-      end
-      
-      #Writes image to disk, writing over existing copy if it exists.
-      def write!(file_path)
-        ext = File.extname(file_path)[1..-1]
-        raise "File '#{file_path}' has to have one of the following extensions: #{FORMATS.join(", ")}" unless ext && FORMATS.include?(ext.downcase)
-
-        if ext.downcase == "bmp"
-          File.open(file_path, "wb") {|io| io.write @bitmap}
-        else
-          image = ::MiniMagick::Image.read @bitmap
-          image.format ext
-          image.write file_path
-        end        
-      end
-    end
-  end
-end
+module Win32
+  module Screenshot
+    # Holds the bitmap data and writes it to the disk
+    class Image
+      # [String] raw bitmap blob
+      attr_reader :bitmap
+
+      # [String] bitmap width
+      attr_reader :width
+
+      # [String] bitmap height
+      attr_reader :height
+
+      # Supported output formats
+      FORMATS = %w{bmp gif jpg png}
+
+      # @private
+      def initialize(blob, width, height)
+        @bitmap = blob
+        @width = width
+        @height = height
+      end
+
+      # Writes image to the disk.
+      # @param [String] file_path writes image to the specified path.
+      # @raise [RuntimeError] when _file_path_ already exists.
+      # @raise [RuntimeError] when _file_path_ is not with the supported output {FORMATS} extension.
+      def write(file_path)
+        raise "File already exists: #{file_path}!" if File.exist? file_path
+        write! file_path
+      end
+      
+      #Writes image to disk, writing over existing copy if it exists.
+      def write!(file_path)
+        ext = File.extname(file_path)[1..-1]
+        raise "File '#{file_path}' has to have one of the following extensions: #{FORMATS.join(", ")}" unless ext && FORMATS.include?(ext.downcase)
+
+        if ext.downcase == "bmp"
+          File.open(file_path, "wb") {|io| io.write @bitmap}
+        else
+          image = ::MiniMagick::Image.read @bitmap
+          image.format ext
+          image.write file_path
+        end        
+      end
+    end
+  end
+end

data/lib/win32/screenshot/take.rb

@@ -1,109 +1,79 @@
-module Win32
-  module Screenshot
-    # Capture Screenshots on Windows with Ruby
-    class Take
-
-      class << self
-        # Takes a screenshot of the specified object or it's area.
-        #
-        # @example Take a screenshot of the window with the specified title
-        #   Win32::Screenshot::Take.of(:window, :title => "Windows Internet Explorer")
-        #
-        # @example Take a screenshot of the foreground
-        #   Win32::Screenshot::Take.of(:foreground)
-        #
-        # @example Take a screenshot of the specified window's top-left corner's area
-        #   Win32::Screenshot::Take.of(:window, :title => /internet/i, :area => [10, 10, 20, 20])
-        #
-        # @example Take a screenshot of the window with the specified handle
-        #   Win32::Screenshot::Take.of(:window, :hwnd => 123456)
-        #
-        # @example Take a screenshot of the window's client area (e.g. without title bar) with the specified handle
-        #   Win32::Screenshot::Take.of(:window, :hwnd => 123456, :context => :client)
-        #
-        # @example Take a screenshot of the child window with the specified internal class name
-        #   Win32::Screenshot::Take.of(:rautomation, RAutomation::Window.new(:hwnd => 123456).child(:class => "Internet Explorer_Server"))
-        #
-        # @param [Symbol] what the type of the object to take a screenshot of,
-        #   possible values are _:foreground_, _:desktop_ and _:window_.
-        # @param [Hash] opts options are optional for specifying an _:area_ and/or _:context_ to take a screenshot.
-        #   It is possible to specify as many options as are needed for searching for the unique window.
-        #   By default the first window with matching identifiers will be taken screenshot of.
-        #   It is possible to use in addition to other options a 0-based _:index_ option to search for other windows if multiple
-        #   windows match the specified criteria.
-        # @option opts [String, Symbol] :context Context to take a screenshot of. Can be _:window_ or _:client_. Defaults to _:window_
-        # @option opts [String, Regexp] :title Title of the window
-        # @option opts [String, Regexp] :text Visible text of the window
-        # @option opts [String, Regexp] :class Internal class name of the window
-        # @option opts [String, Fixnum] :hwnd Window handle in decimal format
-        # @option opts [String, Fixnum] :pid Window process ID (PID)
-        # @option opts [String, Fixnum] :index 0-based index to specify n-th window to take a screenshot of if
-        #   all other criteria match
-        # @option opts [RAutomation::Window] :rautomation RAutomation::Window object to take a screenshot of. Useful for
-        #   taking screenshots of the child windows
-        # @return [Image] the {Image} of the specified object
-        def of(what, opts = {})
-          valid_whats = [:foreground, :desktop, :window]
-          raise "It is not possible to take a screenshot of '#{what}', possible values are #{valid_whats.join(", ")}" unless valid_whats.include?(what)
-
-          self.send(what, {:context => :window}.merge(opts))
-        end
-
-        alias_method :new, :of
-
-        private
-
-        def foreground(opts)
-          hwnd = BitmapMaker.foreground_window
-          take_screenshot(hwnd, opts)
-        end
-
-        def desktop(opts)
-          hwnd = BitmapMaker.desktop_window
-          take_screenshot(hwnd, opts)
-        end
-
-        def window(opts)
-          area = {:area => opts.delete(:area)}
-          context = {:context => opts.delete(:context)}
-          win = opts[:rautomation] || RAutomation::Window.new(opts)
-          timeout = Time.now + 10
-          until win.active?
-            if Time.now >= timeout
-              Kernel.warn "[WARN] Failed to set window '#{win.locators.inspect}' into focus for taking the screenshot"
-              break
-            end
-            win.activate
-          end
-          take_screenshot(win.hwnd, opts.merge(context).merge(area || {}))
-        end
-
-        def take_screenshot(hwnd, opts)
-          if opts[:area]
-            validate_coordinates(hwnd, opts[:context], *opts[:area])
-            BitmapMaker.capture_area(hwnd, opts[:context], *opts[:area])
-          else
-            BitmapMaker.capture_all(hwnd, opts[:context])
-          end
-        end
-
-        def validate_coordinates(hwnd, context, x1, y1, x2, y2)
-          specified_coordinates = "x1: #{x1}, y1: #{y1}, x2: #{x2}, y2: #{y2}"
-          if [x1, y1, x2, y2].any? {|c| c < 0}
-            raise "specified coordinates (#{specified_coordinates}) are invalid - cannot be negative!"
-          end
-
-          if x1 >= x2 || y1 >= y2
-            raise "specified coordinates (#{specified_coordinates}) are invalid - cannot be x1 >= x2 or y1 >= y2!"
-          end
-
-          max_width, max_height = BitmapMaker.dimensions_for(hwnd, context)
-          if x2 > max_width || y2 > max_height
-            raise "specified coordinates (#{specified_coordinates}) are invalid - maximum x2: #{max_width} and y2: #{max_height}!"
-          end
-        end
-
-      end
-    end
-  end
-end
+module Win32
+  module Screenshot
+    # Capture Screenshots on Windows with Ruby
+    class Take
+
+      class << self
+        # Takes a screenshot of the specified object.
+        #
+        # @example Take a screenshot of the window with the specified title
+        #   Win32::Screenshot::Take.of(:window, :title => "Windows Internet Explorer")
+        #
+        # @example Take a screenshot of the foreground
+        #   Win32::Screenshot::Take.of(:foreground)
+        #
+        # @example Take a screenshot of the desktop
+        #   Win32::Screenshot::Take.of(:desktop)
+        #
+        # @example Take a screenshot of the window with the specified handle
+        #   Win32::Screenshot::Take.of(:window, :hwnd => 123456)
+        #
+        # @example Take a screenshot of the window's client area (e.g. without title bar) with the specified handle
+        #   Win32::Screenshot::Take.of(:window, :hwnd => 123456, :context => :client)
+        #
+        # @example Take a screenshot of the child window with the specified internal class name
+        #   Win32::Screenshot::Take.of(:rautomation, RAutomation::Window.new(:hwnd => 123456).child(:class => "Internet Explorer_Server"))
+        #
+        # @param [Symbol] what the type of the object to take a screenshot of,
+        #   possible values are _:foreground_, _:desktop_ and _:window_.
+        # @param [Hash] opts options are optional for specifying _:context_ to take a screenshot.
+        #   It is possible to specify as many options as are needed for searching for the unique window.
+        #   By default the first window with matching identifiers will be taken screenshot of.
+        #   It is possible to use in addition to other options a 0-based _:index_ option to search for other windows if multiple
+        #   windows match the specified criteria.
+        # @option opts [String, Regexp] :title Title of the window
+        # @option opts [String, Regexp] :text Visible text of the window
+        # @option opts [String, Fixnum] :hwnd Window handle in decimal format
+        # @option opts [String, Fixnum] :pid Window process ID (PID)
+        # @option opts [String, Fixnum] :index 0-based index to specify n-th window to take a screenshot of if
+        #   all other criteria match
+        # @option opts [RAutomation::Window] :rautomation RAutomation::Window object to take a screenshot of. Useful for
+        #   taking screenshots of the child windows
+        # @return [Image] the {Image} of the specified object
+        def of(what, opts = {})
+          valid_whats = [:foreground, :desktop, :window]
+          raise "It is not possible to take a screenshot of '#{what}', possible values are #{valid_whats.join(", ")}" unless valid_whats.include?(what)
+
+          self.send(what, opts)
+        end
+
+        alias_method :new, :of
+
+        private
+
+        def foreground(opts)
+          hwnd = BitmapMaker.foreground_window
+          BitmapMaker.capture_window(hwnd)
+        end
+
+        def desktop(opts)
+          hwnd = BitmapMaker.desktop_window
+          BitmapMaker.capture_screen(hwnd)
+        end
+
+        def window(opts)
+          win = opts[:rautomation] || RAutomation::Window.new(opts)
+          timeout = Time.now + 10
+          until win.active?
+            if Time.now >= timeout
+              Kernel.warn "[WARN] Failed to set window '#{win.locators.inspect}' into focus for taking the screenshot"
+              break
+            end
+            win.activate
+          end
+          BitmapMaker.capture_window(win.hwnd)
+        end
+      end
+    end
+  end
+end

data/lib/win32/screenshot/version.rb

@@ -1,5 +1,5 @@
 module Win32
   module Screenshot
-    VERSION = "3.1.0"
+    VERSION = "4.1.0"
   end
 end

data/lib/win32/screenshot.rb

@@ -1,11 +1,12 @@
-require 'ffi'
-require 'mini_magick'
-require 'rautomation'
-
-require File.dirname(__FILE__) + '/screenshot/version'
-require File.dirname(__FILE__) + '/screenshot/take'
-require File.dirname(__FILE__) + '/screenshot/image'
-require File.dirname(__FILE__) + '/screenshot/bitmap_maker'
-
-# add bundled ImageMagick into path
-ENV["PATH"] = "#{File.dirname(__FILE__) + "/../../ext/ImageMagick-7.0.9-8-portable-Q16-x86"};#{ENV["PATH"]}"
+require 'ffi'
+require 'mini_magick'
+require 'rautomation'
+
+require File.dirname(__FILE__) + '/screenshot/version'
+require File.dirname(__FILE__) + '/screenshot/take'
+require File.dirname(__FILE__) + '/screenshot/image'
+require File.dirname(__FILE__) + '/screenshot/bitmap_maker'
+require File.dirname(__FILE__) + '/screenshot/desktop'
+
+# add bundled ImageMagick into path
+ENV["PATH"] = "#{File.dirname(__FILE__) + "/../../ext/ImageMagick-7.0.9-8-portable-Q16-x86"};#{ENV["PATH"]}"

data/spec/spec_helper.rb

@@ -20,7 +20,7 @@ module SpecHelper
                   [:long, :long, :int, :int, :int, :int, :int], :bool
   
   def save_and_verify_image(img, file=nil)
-    FileUtils.mkdir @temp_dir unless File.exists?(@temp_dir)
+    FileUtils.mkdir @temp_dir unless File.exist?(@temp_dir)
     file_name = File.join @temp_dir, "#{file}.bmp"
     img.write file_name
     expect(img.bitmap[0..1]).to eq('BM')

data/spec/win32/screenshot/take_spec.rb

@@ -13,38 +13,22 @@ describe Win32::Screenshot::Take do
     image = Win32::Screenshot::Take.of(:foreground)
     save_and_verify_image(image, 'foreground')
     hwnd = Win32::Screenshot::BitmapMaker.foreground_window
-    expect([image.width, image.height]).to eq(Win32::Screenshot::BitmapMaker.dimensions_for(hwnd, :window))
-  end
-
-  it "captures an area of the foreground" do
-    image = Win32::Screenshot::Take.of(:foreground, :area => [30, 30, 100, 150])
-    save_and_verify_image(image, 'foreground_area')
-    expect(image.width).to eq(70)
-    expect(image.height).to eq(120)
-  end
-
-  it "doesn't allow to capture an area of the foreground with invalid coordinates" do
-    expect {Win32::Screenshot::Take.of(:foreground, :area => [0, 0, -1, 100])}.
-            to raise_exception("specified coordinates (x1: 0, y1: 0, x2: -1, y2: 100) are invalid - cannot be negative!")
+    expect([image.width, image.height]).to eq(Win32::Screenshot::BitmapMaker.dimensions_for(hwnd))
   end
 
   it "captures the desktop" do
     image = Win32::Screenshot::Take.of(:desktop)
+    desktop_dimensions = Win32::Screenshot::BitmapMaker::desktop
     save_and_verify_image(image, 'desktop')
-    hwnd = Win32::Screenshot::BitmapMaker.desktop_window
-    expect([image.width, image.height]).to eq(Win32::Screenshot::BitmapMaker.dimensions_for(hwnd, :window))
-  end
 
-  it "captures an area of the desktop" do
-    image = Win32::Screenshot::Take.of(:desktop, :area => [30, 30, 100, 150])
-    save_and_verify_image(image, 'desktop_area')
-    expect(image.width).to eq(70)
-    expect(image.height).to eq(120)
+    expect([image.width, image.height]).to eq([desktop_dimensions.width, desktop_dimensions.height])
   end
 
-  it "doesn't allow to capture an area of the desktop with invalid coordinates" do
-    expect {Win32::Screenshot::Take.of(:desktop, :area => [0, 0, -1, 100])}.
-            to raise_exception("specified coordinates (x1: 0, y1: 0, x2: -1, y2: 100) are invalid - cannot be negative!")
+  it "captures a window" do
+    image = Win32::Screenshot::Take.of(:window, :pid => @notepad)
+    save_and_verify_image(image, 'notepad_context_window')
+    window = RAutomation::Window.new(:pid => @notepad)
+    expect([image.width, image.height]).to eq(Win32::Screenshot::BitmapMaker.dimensions_for(window.hwnd))
   end
 
   it "captures a maximized window" do
@@ -52,7 +36,7 @@ describe Win32::Screenshot::Take do
     window.maximize
     image = Win32::Screenshot::Take.of(:window, :pid => @iexplore)
     save_and_verify_image(image, 'iexplore_max')
-    expect([image.width, image.height]).to eq(Win32::Screenshot::BitmapMaker.dimensions_for(window.hwnd, :window))
+    expect([image.width, image.height]).to eq(Win32::Screenshot::BitmapMaker.dimensions_for(window.hwnd))
   end
 
   it "captures a minimized window" do
@@ -60,7 +44,7 @@ describe Win32::Screenshot::Take do
     window.minimize
     image = Win32::Screenshot::Take.of(:window, :pid => @notepad)
     save_and_verify_image(image, 'notepad_min')
-    expect([image.width, image.height]).to eq(Win32::Screenshot::BitmapMaker.dimensions_for(window.hwnd, :window))
+    expect([image.width, image.height]).to eq(Win32::Screenshot::BitmapMaker.dimensions_for(window.hwnd))
   end
 
   it "captures a small window" do
@@ -73,73 +57,21 @@ describe Win32::Screenshot::Take do
     # screenshot doesn't include titlebar and the size
     # varies between different themes and Windows versions
     window = RAutomation::Window.new(:pid => @iexplore)
-    expect([image.width, image.height]).to eq(Win32::Screenshot::BitmapMaker.dimensions_for(window.hwnd, :window))
-  end
-
-  it "captures a window context of the window" do
-    image = Win32::Screenshot::Take.of(:window, :pid => @notepad, :context => :window)
-    save_and_verify_image(image, 'notepad_context_window')
-    window = RAutomation::Window.new(:pid => @notepad)
-    expect([image.width, image.height]).to eq(Win32::Screenshot::BitmapMaker.dimensions_for(window.hwnd, :window))
-  end
-
-  it "captures a client context of the window" do
-    image = Win32::Screenshot::Take.of(:window, :pid => @notepad, :context => :client)
-    save_and_verify_image(image, 'notepad_context_client')
-    window = RAutomation::Window.new(:pid => @notepad)
-    expect([image.width, image.height]).to eq(Win32::Screenshot::BitmapMaker.dimensions_for(window.hwnd, :client))
-  end
-
-  it "captures an area of the window" do
-    image = Win32::Screenshot::Take.of(:window, :pid => @notepad, :area => [30, 30, 100, 150])
-    save_and_verify_image(image, 'notepad_area')
-    expect(image.width).to eq(70)
-    expect(image.height).to eq(120)
+    expect([image.width, image.height]).to eq(Win32::Screenshot::BitmapMaker.dimensions_for(window.hwnd))
   end
 
   it "captures by the RAutomation::Window" do
     window = RAutomation::Window.new(:pid => @notepad)
     image = Win32::Screenshot::Take.of(:window, :rautomation => window)
     save_and_verify_image(image, 'notepad_rautomation')
-    expect([image.width, image.height]).to eq(Win32::Screenshot::BitmapMaker.dimensions_for(window.hwnd, :window))
+    expect([image.width, image.height]).to eq(Win32::Screenshot::BitmapMaker.dimensions_for(window.hwnd))
   end
 
-  it "captures a child windows" do
+  it "captures a child window" do
     window = RAutomation::Window.new(:pid => @iexplore).child(:class => "Internet Explorer_Server")
     image = Win32::Screenshot::Take.of(:window, :rautomation => window)
     save_and_verify_image(image, 'iexplore_child')
-    expect([image.width, image.height]).to eq(Win32::Screenshot::BitmapMaker.dimensions_for(window.hwnd, :window))
-  end
-
-  it "captures a whole window if window size is specified as coordinates" do
-    window = RAutomation::Window.new(:pid => @notepad)
-    expected_width, expected_height = Win32::Screenshot::BitmapMaker.dimensions_for(window.hwnd, :window)
-    image = Win32::Screenshot::Take.of(:window, :rautomation => window, :area => [0, 0, expected_width, expected_height])
-    save_and_verify_image(image, 'notepad_area_full_window')
-    expect(image.width).to eq(expected_width)
-    expect(image.height).to eq(expected_height)
-  end
-
-  it "doesn't allow to capture an area of the window with negative coordinates" do
-    expect {Win32::Screenshot::Take.of(:window, :pid => @notepad, :area => [0, 0, -1, 100])}.
-            to raise_exception("specified coordinates (x1: 0, y1: 0, x2: -1, y2: 100) are invalid - cannot be negative!")
-  end
-
-  it "doesn't allow to capture an area of the window if coordinates are the same" do
-    expect {Win32::Screenshot::Take.of(:window, :pid => @notepad, :area => [10, 0, 10, 20])}.
-            to raise_exception("specified coordinates (x1: 10, y1: 0, x2: 10, y2: 20) are invalid - cannot be x1 >= x2 or y1 >= y2!")
-  end
-
-  it "doesn't allow to capture an area of the window if second coordinate is smaller than first one" do
-    expect {Win32::Screenshot::Take.of(:window, :pid => @notepad, :area => [0, 10, 10, 9])}.
-            to raise_exception("specified coordinates (x1: 0, y1: 10, x2: 10, y2: 9) are invalid - cannot be x1 >= x2 or y1 >= y2!")
-  end
-
-  it "doesn't allow to capture an area of the window with too big coordinates" do
-    window = RAutomation::Window.new(:pid => @notepad)
-    expected_width, expected_height = Win32::Screenshot::BitmapMaker.dimensions_for(window.hwnd, :window)
-    expect {Win32::Screenshot::Take.of(:window, :pid => @notepad, :area => [0, 0, 10, 100000])}.
-            to raise_exception("specified coordinates (x1: 0, y1: 0, x2: 10, y2: 100000) are invalid - maximum x2: #{expected_width} and y2: #{expected_height}!")
+    expect([image.width, image.height]).to eq(Win32::Screenshot::BitmapMaker.dimensions_for(window.hwnd))
   end
 
   after :all do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: win32screenshot
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Jarmo Pertman
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-05 00:00:00.000000000 Z
+date: 2023-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -118,6 +118,7 @@ files:
 - ext/ImageMagick-7.0.9-8-portable-Q16-x86/mogrify.exe
 - lib/win32/screenshot.rb
 - lib/win32/screenshot/bitmap_maker.rb
+- lib/win32/screenshot/desktop.rb
 - lib/win32/screenshot/image.rb
 - lib/win32/screenshot/take.rb
 - lib/win32/screenshot/version.rb
@@ -144,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.3.24
 signing_key: 
 specification_version: 4
 summary: Capture Screenshots on Windows with Ruby to bmp, gif, jpg or png formats.