1. module robotjs
   1. function robotjs.captureScreen ()
   2. function robotjs.dragMouse ()
   3. function robotjs.getColor ()
   4. function robotjs.getMousePos ()
   5. function robotjs.getPixelColor ()
   6. function robotjs.getScreenSize ()
   7. function robotjs.getXDisplayName ()
   8. function robotjs.keyTap ()
   9. function robotjs.keyToggle ()
   10. function robotjs.mouseClick ()
   11. function robotjs.mouseToggle ()
   12. function robotjs.moveMouse ()
   13. function robotjs.moveMouseSmooth ()
   14. function robotjs.scrollMouse ()
   15. function robotjs.setKeyboardDelay ()
   16. function robotjs.setMouseDelay ()
   17. function robotjs.setXDisplayName ()
   18. function robotjs.typeString ()
   19. function robotjs.typeStringDelayed ()
   20. object robotjs.screen
2. module robotjs.screen
   1. function robotjs.screen.capture (x, y, width, height)

module robotjs

function robotjs.captureScreen ()

• description and source-code

  captureScreen = function () { [native code] }

• example usage

  ...
  }
  
  module.exports.screen.capture = function(x, y, width, height)
  {
  //If coords have been passed, use them.
  if (typeof x !== "undefined" && typeof y !== "undefined" && typeof width !== "undefined
  " && typeof height !== "undefined")
  {
      b = robotjs.captureScreen(x, y, width, height);
  }
  else
  {
      b = robotjs.captureScreen();
  }
  
  return new bitmap(b.width, b.height, b.byteWidth, b.bitsPerPixel, b.bytesPerPixel, b.image);
  ...

function robotjs.dragMouse ()

• description and source-code

  dragMouse = function () { [native code] }

• example usage

  ...
  	
  });
  
  test('Drag the mouse.', function(t)
  {
  	t.plan(4);
  	
  	t.ok(robot.dragMouse(5, 5) === 1, 'successfully dragged the mouse.');
  	
  	t.throws(function()
  	{
  		robot.dragMouse(0);
  	}, /Invalid number/, 'drag mouse to (0).');
  	
  	t.throws(function()
  ...

function robotjs.getColor ()

• description and source-code

  getColor = function () { [native code] }

• example usage

  ...
  this.byteWidth = byteWidth;
  this.bitsPerPixel = bitsPerPixel;
  this.bytesPerPixel = bytesPerPixel;
  this.image = image;
  
  this.colorAt = function(x, y)
  {
      return robotjs.getColor(this, x, y);
  };
  
  }
  
  module.exports.screen.capture = function(x, y, width, height)
  {
  //If coords have been passed, use them.
  ...

function robotjs.getMousePos ()

• description and source-code

  getMousePos = function () { [native code] }

• example usage

  ...
  ##### [Screen](https://github.com/octalmage/robotjs/wiki/Syntax#screen)
  
  ```JavaScript
  // Get pixel color under the mouse.
  var robot = require("robotjs");
  
  // Get mouse position.
  var mouse = robot.getMousePos();
  
  // Get pixel color in hex format.
  var hex = robot.getPixelColor(mouse.x, mouse.y);
  console.log("#" + hex + " at x:" + mouse.x + " y:" + mouse.y);
  ```
  Read the [Wiki](https://github.com/octalmage/robotjs/wiki) for more information!
  ...

function robotjs.getPixelColor ()

• description and source-code

  getPixelColor = function () { [native code] }

• example usage

  ...
  // Get pixel color under the mouse.
  var robot = require("robotjs");
  
  // Get mouse position.
  var mouse = robot.getMousePos();
  
  // Get pixel color in hex format.
  var hex = robot.getPixelColor(mouse.x, mouse.y);
  console.log("#" + hex + " at x:" + mouse.x + " y:" + mouse.y);
  ```
  Read the [Wiki](https://github.com/octalmage/robotjs/wiki) for more information!
  
  ## [API](https://github.com/octalmage/robotjs/wiki/Syntax)
  
  The [RobotJS API](https://github.com/octalmage/robotjs/wiki/Syntax) is contained in the [Wiki](https://github.com/octalmage/robotjs
  /wiki).
  ...

function robotjs.getScreenSize ()

• description and source-code

  getScreenSize = function () { [native code] }

• example usage

  ...
  // Move the mouse across the screen as a sine wave.
  var robot = require("robotjs");
  
  // Speed up the mouse.
  robot.setMouseDelay(2);
  
  var twoPI = Math.PI * 2.0;
  var screenSize = robot.getScreenSize();
  var height = (screenSize.height / 2) - 10;
  var width = screenSize.width;
  
  for (var x = 0; x < width; x++)
  {
  	y = height * Math.sin((twoPI * x) / width) + height;
  	robot.moveMouse(x, y);
  ...

function robotjs.getXDisplayName ()

• description and source-code

  getXDisplayName = function () { [native code] }

• example usage

  n/a

function robotjs.keyTap ()

• description and source-code

  keyTap = function () { [native code] }

• example usage

  ...
  // Type "Hello World" then press enter.
  var robot = require("robotjs");
  
  // Type "Hello World".
  robot.typeString("Hello World");
  
  // Press enter.
  robot.keyTap("enter");
  ```
  
  ##### [Screen](https://github.com/octalmage/robotjs/wiki/Syntax#screen)
  
  ```JavaScript
  // Get pixel color under the mouse.
  var robot = require("robotjs");
  ...

function robotjs.keyToggle ()

• description and source-code

  keyToggle = function () { [native code] }

• example usage

  n/a

function robotjs.mouseClick ()

• description and source-code

  mouseClick = function () { [native code] }

• example usage

  ...
  	t.ok(robot.moveMouseSmooth("0", "0") === 1, 'move mouse to ("0", "0").');
  
  });
  
  test('Click the mouse.', function(t)
  {
  	t.plan(8);
  	t.ok(robot.mouseClick(), 'click the mouse (no button specified).');
  	t.ok(robot.mouseClick("left") === 1, 'click the left mouse button.');
  	t.ok(robot.mouseClick("middle") === 1, 'click the middle mouse button.');
  	t.ok(robot.mouseClick("right") === 1, 'click the right mouse button.');
  	
  	t.ok(robot.mouseClick("left", 1), 'double click the left mouse button.');
  	
  	t.throws(function()
  ...

function robotjs.mouseToggle ()

• description and source-code

  mouseToggle = function () { [native code] }

• example usage

  n/a

function robotjs.moveMouse ()

• description and source-code

  moveMouse = function () { [native code] }

• example usage

  ...
  var screenSize = robot.getScreenSize();
  var height = (screenSize.height / 2) - 10;
  var width = screenSize.width;
  
  for (var x = 0; x < width; x++)
  {
  	y = height * Math.sin((twoPI * x) / width) + height;
  	robot.moveMouse(x, y);
  }
  ```
  
  ##### [Keyboard](https://github.com/octalmage/robotjs/wiki/Syntax#keyboard)
  
  ```JavaScript
  // Type "Hello World" then press enter.
  ...

function robotjs.moveMouseSmooth ()

• description and source-code

  moveMouseSmooth = function () { [native code] }

• example usage

  ...
  	t.ok(robot.moveMouse("0", "0") === 1, 'move mouse to ("0", "0").');
  
  });
  
  test('Move the mouse smoothly.', function(t)
  {
  	t.plan(6);
  	lastKnownPos = robot.moveMouseSmooth(0, 0);
  	t.ok(robot.moveMouseSmooth(100, 100) === 1, 'successfully moved the mouse.');
  	currentPos = robot.getMousePos();
  	t.ok(currentPos.x === 100, 'mousepos.x is correct.');
  	t.ok(currentPos.y === 100, 'mousepos.y is correct.');
  	
  	t.throws(function()
  	{
  ...

function robotjs.scrollMouse ()

• description and source-code

  scrollMouse = function () { [native code] }

• example usage

  n/a

function robotjs.setKeyboardDelay ()

• description and source-code

  setKeyboardDelay = function () { [native code] }

• example usage

  n/a

function robotjs.setMouseDelay ()

• description and source-code

  setMouseDelay = function () { [native code] }

• example usage

  ...
  <p align="center"><img src="https://cldup.com/lugVjjAkEi.gif"></p>
  
  ```JavaScript
  // Move the mouse across the screen as a sine wave.
  var robot = require("robotjs");
  
  // Speed up the mouse.
  robot.setMouseDelay(2);
  
  var twoPI = Math.PI * 2.0;
  var screenSize = robot.getScreenSize();
  var height = (screenSize.height / 2) - 10;
  var width = screenSize.width;
  
  for (var x = 0; x < width; x++)
  ...

function robotjs.setXDisplayName ()

• description and source-code

  setXDisplayName = function () { [native code] }

• example usage

  n/a

function robotjs.typeString ()

• description and source-code

  typeString = function () { [native code] }

• example usage

  ...
  ##### [Keyboard](https://github.com/octalmage/robotjs/wiki/Syntax#keyboard)
  
  ```JavaScript
  // Type "Hello World" then press enter.
  var robot = require("robotjs");
  
  // Type "Hello World".
  robot.typeString("Hello World");
  
  // Press enter.
  robot.keyTap("enter");
  ```
  
  ##### [Screen](https://github.com/octalmage/robotjs/wiki/Syntax#screen)
  ...

function robotjs.typeStringDelayed ()

• description and source-code

  typeStringDelayed = function () { [native code] }

• example usage

  n/a

module robotjs.screen

function robotjs.screen.capture (x, y, width, height)

• description and source-code

  capture = function (x, y, width, height)
  {
      //If coords have been passed, use them.
      if (typeof x !== "undefined" && typeof y !== "undefined" && typeof width !== "undefined" && typeof height !== "undefined")
      {
          b = robotjs.captureScreen(x, y, width, height);
      }
      else
      {
          b = robotjs.captureScreen();
      }
  
      return new bitmap(b.width, b.height, b.byteWidth, b.bitsPerPixel, b.bytesPerPixel, b.image);
  }

• example usage

  ...
  	'bytesPerPixel': 'number',
  	'image': 'object'
  };
  
  test('Get a bitmap.', function(t)
  {
  	t.plan(1);
  	t.ok(robot.screen.capture(), 'got a bitmap.');
  });
  
  test('Get a bitmap and check the parameters.', function(t)
  {
  	t.plan(6);
  	var img = robot.screen.capture();
  ...