mirror of
https://github.com/Mintplex-Labs/nut.js.git
synced 2026-07-20 14:33:43 -04:00
Simon Hofmann
484 lines
27 KiB
HTML
484 lines
27 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>VisionAdapter | @nut-tree/nut-js</title>
|
|
<meta name="description" content="Documentation for @nut-tree/nut-js">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
</head>
|
|
<body>
|
|
<header>
|
|
<div class="tsd-page-toolbar">
|
|
<div class="container">
|
|
<div class="table-wrap">
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
<div class="field">
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
<input id="tsd-search-field" type="text" />
|
|
</div>
|
|
<ul class="results">
|
|
<li class="state loading">Preparing search index...</li>
|
|
<li class="state failure">The search index is not available</li>
|
|
</ul>
|
|
<a href="../index.html" class="title">@nut-tree/nut-js</a>
|
|
</div>
|
|
<div class="table-cell" id="tsd-widgets">
|
|
<div id="tsd-filter">
|
|
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
<div class="tsd-filter-group">
|
|
<div class="tsd-select" id="tsd-filter-visibility">
|
|
<span class="tsd-select-label">All</span>
|
|
<ul class="tsd-select-list">
|
|
<li data-value="public">Public</li>
|
|
<li data-value="protected">Public/Protected</li>
|
|
<li data-value="private" class="selected">All</li>
|
|
</ul>
|
|
</div>
|
|
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
</div>
|
|
</div>
|
|
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="tsd-page-title">
|
|
<div class="container">
|
|
<ul class="tsd-breadcrumb">
|
|
<li>
|
|
<a href="../globals.html">Globals</a>
|
|
</li>
|
|
<li>
|
|
<a href="visionadapter.html">VisionAdapter</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class VisionAdapter</h1>
|
|
</div>
|
|
</div>
|
|
</header>
|
|
<div class="container container-main">
|
|
<div class="row">
|
|
<div class="col-8 col-content">
|
|
<section class="tsd-panel tsd-comment">
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p><a href="visionadapter.html">VisionAdapter</a> serves as an abstraction layer for all image based interactions.</p>
|
|
</div>
|
|
<p>This allows to provide a high level interface for image based actions,
|
|
without having to spread (possibly) multiple dependencies all over the code.
|
|
All actions which involve screenshots / images are bundled in this adapter.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">VisionAdapter</span>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
<h2>Index</h2>
|
|
<section class="tsd-panel tsd-index-panel">
|
|
<div class="tsd-index-content">
|
|
<section class="tsd-index-section ">
|
|
<h3>Constructors</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="visionadapter.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-index-section ">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="visionadapter.html#findonscreenregion" class="tsd-kind-icon">find<wbr>OnScreen<wbr>Region</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="visionadapter.html#grabscreen" class="tsd-kind-icon">grab<wbr>Screen</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="visionadapter.html#grabscreenregion" class="tsd-kind-icon">grab<wbr>Screen<wbr>Region</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="visionadapter.html#highlightscreenregion" class="tsd-kind-icon">highlight<wbr>Screen<wbr>Region</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="visionadapter.html#saveimage" class="tsd-kind-icon">save<wbr>Image</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="visionadapter.html#screenheight" class="tsd-kind-icon">screen<wbr>Height</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="visionadapter.html#screensize" class="tsd-kind-icon">screen<wbr>Size</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><a href="visionadapter.html#screenwidth" class="tsd-kind-icon">screen<wbr>Width</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Constructors</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
<h3>constructor</h3>
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Vision<wbr>Adapter<span class="tsd-signature-symbol">(</span>finder<span class="tsd-signature-symbol">?: </span><a href="../interfaces/finderinterface.html" class="tsd-signature-type">FinderInterface</a>, screen<span class="tsd-signature-symbol">?: </span><a href="../interfaces/screenactionprovider.html" class="tsd-signature-type">ScreenActionProvider</a>, dataSink<span class="tsd-signature-symbol">?: </span><a href="../interfaces/datasink.html" class="tsd-signature-type">DataSink</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="visionadapter.html" class="tsd-signature-type">VisionAdapter</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L19">adapter/vision.adapter.class.ts:19</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p><a href="visionadapter.html">VisionAdapter</a> class constructor</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> finder: <a href="../interfaces/finderinterface.html" class="tsd-signature-type">FinderInterface</a><span class="tsd-signature-symbol"> = new TemplateMatchingFinder()</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A <a href="../interfaces/finderinterface.html">FinderInterface</a> instance used for on-screen image detection (Default: <a href="templatematchingfinder.html">TemplateMatchingFinder</a>)</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> screen: <a href="../interfaces/screenactionprovider.html" class="tsd-signature-type">ScreenActionProvider</a><span class="tsd-signature-symbol"> = new ScreenAction()</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A <a href="../interfaces/screenactionprovider.html">ScreenActionProvider</a> instance used to retrieve screen data (Default: <a href="screenaction.html">ScreenAction</a>)</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> dataSink: <a href="../interfaces/datasink.html" class="tsd-signature-type">DataSink</a><span class="tsd-signature-symbol"> = new ImageWriter()</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>A <a href="../interfaces/datasink.html">DataSink</a> instance used to write output data to disk (Default: <a href="imagewriter.html">ImageWriter</a>)</p>
|
|
</div>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="visionadapter.html" class="tsd-signature-type">VisionAdapter</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="findonscreenregion" class="tsd-anchor"></a>
|
|
<h3>find<wbr>OnScreen<wbr>Region</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">find<wbr>OnScreen<wbr>Region<span class="tsd-signature-symbol">(</span>matchRequest<span class="tsd-signature-symbol">: </span><a href="matchrequest.html" class="tsd-signature-type">MatchRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="matchresult.html" class="tsd-signature-type">MatchResult</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L71">adapter/vision.adapter.class.ts:71</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p><a href="visionadapter.html#findonscreenregion">findOnScreenRegion</a> will search for a given pattern inside a <a href="region.html">Region</a> of the main screen
|
|
If multiple possible occurrences are found, the one with the highest probability is returned.
|
|
For matchProbability < 0.99 the search will be performed on grayscale images.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>matchRequest: <a href="matchrequest.html" class="tsd-signature-type">MatchRequest</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A <a href="matchrequest.html">MatchRequest</a> which holds all required matching data</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="matchresult.html" class="tsd-signature-type">MatchResult</a><span class="tsd-signature-symbol">></span></h4>
|
|
<p><a href="matchresult.html">MatchResult</a> containing location and probability of a possible match</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="grabscreen" class="tsd-anchor"></a>
|
|
<h3>grab<wbr>Screen</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">grab<wbr>Screen<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="image.html" class="tsd-signature-type">Image</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L38">adapter/vision.adapter.class.ts:38</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p><a href="visionadapter.html#grabscreen">grabScreen</a> will return an <a href="image.html">Image</a> containing the current screen image</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="image.html" class="tsd-signature-type">Image</a><span class="tsd-signature-symbol">></span></h4>
|
|
<p>An <a href="image.html">Image</a> which will contain screenshot data as well as dimensions</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="grabscreenregion" class="tsd-anchor"></a>
|
|
<h3>grab<wbr>Screen<wbr>Region</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">grab<wbr>Screen<wbr>Region<span class="tsd-signature-symbol">(</span>region<span class="tsd-signature-symbol">: </span><a href="region.html" class="tsd-signature-type">Region</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="image.html" class="tsd-signature-type">Image</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L48">adapter/vision.adapter.class.ts:48</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p><a href="visionadapter.html#grabscreenregion">grabScreenRegion</a> essentially does the same as grabScreen, but only returns a specified <a href="region.html">Region</a></p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>region: <a href="region.html" class="tsd-signature-type">Region</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The screen <a href="region.html">Region</a> we want to grab</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="image.html" class="tsd-signature-type">Image</a><span class="tsd-signature-symbol">></span></h4>
|
|
<p>An <a href="image.html">Image</a> which will contain screenshot data of the specified <a href="region.html">Region</a> as well as dimensions</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="highlightscreenregion" class="tsd-anchor"></a>
|
|
<h3>highlight<wbr>Screen<wbr>Region</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">highlight<wbr>Screen<wbr>Region<span class="tsd-signature-symbol">(</span>region<span class="tsd-signature-symbol">: </span><a href="region.html" class="tsd-signature-type">Region</a>, duration<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, opacity<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L59">adapter/vision.adapter.class.ts:59</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p><a href="visionadapter.html#highlightscreenregion">highlightScreenRegion</a> highlights a screen <a href="region.html">Region</a> for a given duration by overlaying it with an opaque window</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>region: <a href="region.html" class="tsd-signature-type">Region</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The <a href="region.html">Region</a> to highlight</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>duration: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The highlight duration</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>opacity: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Overlay opacity</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="saveimage" class="tsd-anchor"></a>
|
|
<h3>save<wbr>Image</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">save<wbr>Image<span class="tsd-signature-symbol">(</span>image<span class="tsd-signature-symbol">: </span><a href="image.html" class="tsd-signature-type">Image</a>, path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L123">adapter/vision.adapter.class.ts:123</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p><a href="visionadapter.html#saveimage">saveImage</a> saves an <a href="image.html">Image</a> to a given path on disk.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>image: <a href="image.html" class="tsd-signature-type">Image</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The <a href="image.html">Image</a> to store</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>path: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The path where to store the image</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="screenheight" class="tsd-anchor"></a>
|
|
<h3>screen<wbr>Height</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">screen<wbr>Height<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L102">adapter/vision.adapter.class.ts:102</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p><a href="visionadapter.html#screenheight">screenHeight</a> returns the main screens height as reported by the OS.
|
|
Please notice that on e.g. Apples Retina display the reported width
|
|
and the actual pixel size may differ</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>The main screens height as reported by the OS</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="screensize" class="tsd-anchor"></a>
|
|
<h3>screen<wbr>Size</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">screen<wbr>Size<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="region.html" class="tsd-signature-type">Region</a><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L113">adapter/vision.adapter.class.ts:113</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p><a href="visionadapter.html#screensize">screenSize</a> returns a <a href="region.html">Region</a> object with the main screens size.
|
|
Please note that on e.g. Apples Retina display the reported width
|
|
and the actual pixel size may differ</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="region.html" class="tsd-signature-type">Region</a><span class="tsd-signature-symbol">></span></h4>
|
|
<p>A <a href="region.html">Region</a> object representing the size of a systems main screen</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
<a name="screenwidth" class="tsd-anchor"></a>
|
|
<h3>screen<wbr>Width</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
<li class="tsd-signature tsd-kind-icon">screen<wbr>Width<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/nut-tree/nut.js/blob/3aa660c/lib/adapter/vision.adapter.class.ts#L91">adapter/vision.adapter.class.ts:91</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p><a href="visionadapter.html#screenwidth">screenWidth</a> returns the main screens width as reported by the OS.
|
|
Please notice that on e.g. Apples Retina display the reported width
|
|
and the actual pixel size may differ</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h4>
|
|
<p>The main screens width as reported by the OS</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class="globals ">
|
|
<a href="../globals.html"><em>Globals</em></a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
</ul>
|
|
<ul class="current">
|
|
<li class="current tsd-kind-class">
|
|
<a href="visionadapter.html" class="tsd-kind-icon">Vision<wbr>Adapter</a>
|
|
<ul>
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
<a href="visionadapter.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="visionadapter.html#findonscreenregion" class="tsd-kind-icon">find<wbr>OnScreen<wbr>Region</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="visionadapter.html#grabscreen" class="tsd-kind-icon">grab<wbr>Screen</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="visionadapter.html#grabscreenregion" class="tsd-kind-icon">grab<wbr>Screen<wbr>Region</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="visionadapter.html#highlightscreenregion" class="tsd-kind-icon">highlight<wbr>Screen<wbr>Region</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="visionadapter.html#saveimage" class="tsd-kind-icon">save<wbr>Image</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="visionadapter.html#screenheight" class="tsd-kind-icon">screen<wbr>Height</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="visionadapter.html#screensize" class="tsd-kind-icon">screen<wbr>Size</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
<a href="visionadapter.html#screenwidth" class="tsd-kind-icon">screen<wbr>Width</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
|
</body>
|
|
</html> |