1674 lines
104 KiB
HTML
1674 lines
104 KiB
HTML
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>Graphics | openfl</title>
|
|
<meta name="description" content="">
|
|
<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.js" 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">openfl</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>
|
|
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
<input type="checkbox" id="tsd-filter-only-exported" />
|
|
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../index.html">openfl</a>
|
|
</li>
|
|
<li>
|
|
<a href="../modules/openfl.display.html">display</a>
|
|
</li>
|
|
<li>
|
|
<a href="openfl.display.graphics.html">Graphics</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Class Graphics</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>The Graphics class contains a set of methods that you can use to create a
|
|
vector shape. Display objects that support drawing include Sprite and Shape
|
|
objects. Each of these classes includes a <code>graphics</code> property
|
|
that is a Graphics object. The following are among those helper functions
|
|
provided for ease of use: <code>drawRect()</code>,
|
|
<code>drawRoundRect()</code>, <code>drawCircle()</code>, and
|
|
<code>drawEllipse()</code>.</p>
|
|
</div>
|
|
<p>You cannot create a Graphics object directly from ActionScript code. If
|
|
you call <code>new Graphics()</code>, an exception is thrown.</p>
|
|
<p>The Graphics class is final; it cannot be subclassed.</p>
|
|
</div>
|
|
</section>
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
<h3>Hierarchy</h3>
|
|
<ul class="tsd-hierarchy">
|
|
<li>
|
|
<span class="target">Graphics</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 tsd-is-external">
|
|
<h3>Methods</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#beginbitmapfill" class="tsd-kind-icon">begin<wbr>Bitmap<wbr>Fill</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#beginfill" class="tsd-kind-icon">begin<wbr>Fill</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#begingradientfill" class="tsd-kind-icon">begin<wbr>Gradient<wbr>Fill</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#clear" class="tsd-kind-icon">clear</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#copyfrom" class="tsd-kind-icon">copy<wbr>From</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#cubiccurveto" class="tsd-kind-icon">cubic<wbr>Curve<wbr>To</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#curveto" class="tsd-kind-icon">curve<wbr>To</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#drawcircle" class="tsd-kind-icon">draw<wbr>Circle</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#drawellipse" class="tsd-kind-icon">draw<wbr>Ellipse</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#drawgraphicsdata" class="tsd-kind-icon">draw<wbr>Graphics<wbr>Data</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#drawpath" class="tsd-kind-icon">draw<wbr>Path</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#drawrect" class="tsd-kind-icon">draw<wbr>Rect</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#drawroundrect" class="tsd-kind-icon">draw<wbr>Round<wbr>Rect</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#drawroundrectcomplex" class="tsd-kind-icon">draw<wbr>Round<wbr>Rect<wbr>Complex</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#drawtriangles" class="tsd-kind-icon">draw<wbr>Triangles</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#endfill" class="tsd-kind-icon">end<wbr>Fill</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#linebitmapstyle" class="tsd-kind-icon">line<wbr>Bitmap<wbr>Style</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#linegradientstyle" class="tsd-kind-icon">line<wbr>Gradient<wbr>Style</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#linestyle" class="tsd-kind-icon">line<wbr>Style</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#lineto" class="tsd-kind-icon">line<wbr>To</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#moveto" class="tsd-kind-icon">move<wbr>To</a></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-external"><a href="openfl.display.graphics.html#readgraphicsdata" class="tsd-kind-icon">read<wbr>Graphics<wbr>Data</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group tsd-is-external">
|
|
<h2>Methods</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="beginbitmapfill" class="tsd-anchor"></a>
|
|
<h3>begin<wbr>Bitmap<wbr>Fill</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">begin<wbr>Bitmap<wbr>Fill<span class="tsd-signature-symbol">(</span>bitmap<span class="tsd-signature-symbol">: </span><a href="openfl.display.bitmapdata.html" class="tsd-signature-type">BitmapData</a>, matrix<span class="tsd-signature-symbol">?: </span><a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a>, repeat<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, smooth<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L75">lib/openfl/display/Graphics.d.ts:75</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Fills a drawing area with a bitmap image. The bitmap can be repeated or
|
|
tiled to fill the area. The fill remains in effect until you call the
|
|
<code>beginFill()</code>, <code>beginBitmapFill()</code>,
|
|
<code>beginGradientFill()</code>, or <code>beginShaderFill()</code>
|
|
method. Calling the <code>clear()</code> method clears the fill.</p>
|
|
</div>
|
|
<p>The application renders the fill whenever three or more points are
|
|
drawn, or when the <code>endFill()</code> method is called.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bitmap: <a href="openfl.display.bitmapdata.html" class="tsd-signature-type">BitmapData</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A transparent or opaque bitmap image that contains the bits
|
|
to be displayed.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> matrix: <a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A matrix object(of the openfl.geom.Matrix class), which you
|
|
can use to define transformations on the bitmap. For
|
|
example, you can use the following matrix to rotate a bitmap
|
|
by 45 degrees(pi/4 radians):</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> repeat: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>If <code>true</code>, the bitmap image repeats in a tiled
|
|
pattern. If <code>false</code>, the bitmap image does not
|
|
repeat, and the edges of the bitmap are used for any fill
|
|
area that extends beyond the bitmap.</p>
|
|
<pre><code> For example, consider the following bitmap(a 20 x
|
|
20-pixel checkerboard pattern):
|
|
|
|
When `repeat` is set to `true`(as
|
|
in the following example), the bitmap<span class="hljs-built_in"> fill </span>repeats the
|
|
bitmap:
|
|
|
|
When `repeat` is set to `false`,
|
|
the bitmap<span class="hljs-built_in"> fill </span>uses the edge pixels for the<span class="hljs-built_in"> fill </span>area
|
|
outside the bitmap:
|
|
</code></pre>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> smooth: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>If <code>false</code>, upscaled bitmap images are rendered
|
|
by using a nearest-neighbor algorithm and look pixelated. If
|
|
<code>true</code>, upscaled bitmap images are rendered by
|
|
using a bilinear algorithm. Rendering by using the nearest
|
|
neighbor algorithm is faster.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="beginfill" class="tsd-anchor"></a>
|
|
<h3>begin<wbr>Fill</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">begin<wbr>Fill<span class="tsd-signature-symbol">(</span>color<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, alpha<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">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L92">lib/openfl/display/Graphics.d.ts:92</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Specifies a simple one-color fill that subsequent calls to other Graphics
|
|
methods(such as <code>lineTo()</code> or <code>drawCircle()</code>) use
|
|
when drawing. The fill remains in effect until you call the
|
|
<code>beginFill()</code>, <code>beginBitmapFill()</code>,
|
|
<code>beginGradientFill()</code>, or <code>beginShaderFill()</code>
|
|
method. Calling the <code>clear()</code> method clears the fill.</p>
|
|
</div>
|
|
<p>The application renders the fill whenever three or more points are
|
|
drawn, or when the <code>endFill()</code> method is called.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> color: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The color of the fill(0xRRGGBB).</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> alpha: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The alpha value of the fill(0.0 to 1.0).</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="begingradientfill" class="tsd-anchor"></a>
|
|
<h3>begin<wbr>Gradient<wbr>Fill</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">begin<wbr>Gradient<wbr>Fill<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../enums/openfl.display.gradienttype.html" class="tsd-signature-type">GradientType</a>, colors<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span>, alphas<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span>, ratios<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span>, matrix<span class="tsd-signature-symbol">?: </span><a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a>, spreadMethod<span class="tsd-signature-symbol">?: </span><a href="../enums/openfl.display.spreadmethod.html" class="tsd-signature-type">SpreadMethod</a>, interpolationMethod<span class="tsd-signature-symbol">?: </span><a href="../enums/openfl.display.interpolationmethod.html" class="tsd-signature-type">InterpolationMethod</a>, focalPointRatio<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">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L160">lib/openfl/display/Graphics.d.ts:160</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Specifies a gradient fill used by subsequent calls to other Graphics
|
|
methods(such as <code>lineTo()</code> or <code>drawCircle()</code>) for
|
|
the object. The fill remains in effect until you call the
|
|
<code>beginFill()</code>, <code>beginBitmapFill()</code>,
|
|
<code>beginGradientFill()</code>, or <code>beginShaderFill()</code>
|
|
method. Calling the <code>clear()</code> method clears the fill.</p>
|
|
</div>
|
|
<p>The application renders the fill whenever three or more points are
|
|
drawn, or when the <code>endFill()</code> method is called.</p>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>ArgumentError If the <code>type</code> parameter is not valid.</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <a href="../enums/openfl.display.gradienttype.html" class="tsd-signature-type">GradientType</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A value from the GradientType class that
|
|
specifies which gradient type to use:
|
|
<code>GradientType.LINEAR</code> or
|
|
<code>GradientType.RADIAL</code>.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>colors: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>alphas: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>ratios: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> matrix: <a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A transformation matrix as defined by the
|
|
openfl.geom.Matrix class. The openfl.geom.Matrix
|
|
class includes a
|
|
<code>createGradientBox()</code> method, which
|
|
lets you conveniently set up the matrix for use
|
|
with the <code>beginGradientFill()</code>
|
|
method.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> spreadMethod: <a href="../enums/openfl.display.spreadmethod.html" class="tsd-signature-type">SpreadMethod</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A value from the SpreadMethod class that
|
|
specifies which spread method to use, either:
|
|
<code>SpreadMethod.PAD</code>,
|
|
<code>SpreadMethod.REFLECT</code>, or
|
|
<code>SpreadMethod.REPEAT</code>.</p>
|
|
<pre><code> <span class="hljs-keyword">For</span> example, consider a simple linear
|
|
gradient between two colors:
|
|
|
|
This example <span class="hljs-keyword">uses</span>
|
|
`SpreadMethod.PAD` <span class="hljs-keyword">for</span> the spread
|
|
<span class="hljs-function"><span class="hljs-keyword">method</span>, <span class="hljs-title">and</span> <span class="hljs-title">the</span> <span class="hljs-title">gradient</span> <span class="hljs-title">fill</span> <span class="hljs-title">looks</span> <span class="hljs-title">like</span> <span class="hljs-title">the</span>
|
|
<span class="hljs-title">following</span>:</span>
|
|
|
|
<span class="hljs-keyword">If</span> you use `SpreadMethod.REFLECT`
|
|
<span class="hljs-keyword">for</span> the spread <span class="hljs-function"><span class="hljs-keyword">method</span>, <span class="hljs-title">the</span> <span class="hljs-title">gradient</span> <span class="hljs-title">fill</span> <span class="hljs-title">looks</span>
|
|
<span class="hljs-title">like</span> <span class="hljs-title">the</span> <span class="hljs-title">following</span>:</span>
|
|
|
|
<span class="hljs-keyword">If</span> you use `SpreadMethod.REPEAT`
|
|
<span class="hljs-keyword">for</span> the spread <span class="hljs-function"><span class="hljs-keyword">method</span>, <span class="hljs-title">the</span> <span class="hljs-title">gradient</span> <span class="hljs-title">fill</span> <span class="hljs-title">looks</span>
|
|
<span class="hljs-title">like</span> <span class="hljs-title">the</span> <span class="hljs-title">following</span>:</span>
|
|
</code></pre>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> interpolationMethod: <a href="../enums/openfl.display.interpolationmethod.html" class="tsd-signature-type">InterpolationMethod</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A value from the InterpolationMethod class that
|
|
specifies which value to use:
|
|
<code>InterpolationMethod.LINEAR_RGB</code> or
|
|
<code>InterpolationMethod.RGB</code></p>
|
|
<pre><code> <span class="hljs-keyword">For</span> example, consider a<span class="hljs-built_in"> simple </span>linear
|
|
gradient between two colors(with the
|
|
`spreadMethod` parameter <span class="hljs-builtin-name">set</span> <span class="hljs-keyword">to</span>
|
|
`SpreadMethod.REFLECT`). The
|
|
different interpolation methods affect the
|
|
appearance as follows:
|
|
</code></pre>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> focalPointRatio: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A number that controls the location of the
|
|
focal point of the gradient. 0 means that the
|
|
focal point is in the center. 1 means that the
|
|
focal point is at one border of the gradient
|
|
circle. -1 means that the focal point is at the
|
|
other border of the gradient circle. A value
|
|
less than -1 or greater than 1 is rounded to -1
|
|
or 1. For example, the following example shows
|
|
a <code>focalPointRatio</code> set to 0.75:</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="clear" class="tsd-anchor"></a>
|
|
<h3>clear</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">clear<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L173">lib/openfl/display/Graphics.d.ts:173</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Clears the graphics that were drawn to this Graphics object, and resets
|
|
fill and line style settings.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="copyfrom" class="tsd-anchor"></a>
|
|
<h3>copy<wbr>From</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">copy<wbr>From<span class="tsd-signature-symbol">(</span>sourceGraphics<span class="tsd-signature-symbol">: </span><a href="openfl.display.graphics.html" class="tsd-signature-type">Graphics</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L176">lib/openfl/display/Graphics.d.ts:176</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>sourceGraphics: <a href="openfl.display.graphics.html" class="tsd-signature-type">Graphics</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="cubiccurveto" class="tsd-anchor"></a>
|
|
<h3>cubic<wbr>Curve<wbr>To</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">cubic<wbr>Curve<wbr>To<span class="tsd-signature-symbol">(</span>controlX1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, controlY1<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, controlX2<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, controlY2<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, anchorX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, anchorY<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">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L179">lib/openfl/display/Graphics.d.ts:179</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>controlX1: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>controlY1: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>controlX2: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>controlY2: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>anchorX: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>anchorY: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="curveto" class="tsd-anchor"></a>
|
|
<h3>curve<wbr>To</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">curve<wbr>To<span class="tsd-signature-symbol">(</span>controlX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, controlY<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, anchorX<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, anchorY<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">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L212">lib/openfl/display/Graphics.d.ts:212</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Draws a curve using the current line style from the current drawing
|
|
position to(anchorX, anchorY) and using the control point that
|
|
(<code>controlX</code>, <code>controlY</code>) specifies. The current
|
|
drawing position is then set to(<code>anchorX</code>,
|
|
<code>anchorY</code>). If the movie clip in which you are drawing contains
|
|
content created with the Flash drawing tools, calls to the
|
|
<code>curveTo()</code> method are drawn underneath this content. If you
|
|
call the <code>curveTo()</code> method before any calls to the
|
|
<code>moveTo()</code> method, the default of the current drawing position
|
|
is(0, 0). If any of the parameters are missing, this method fails and the
|
|
current drawing position is not changed.</p>
|
|
</div>
|
|
<p>The curve drawn is a quadratic Bezier curve. Quadratic Bezier curves
|
|
consist of two anchor points and one control point. The curve interpolates
|
|
the two anchor points and curves toward the control point.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>controlX: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A number that specifies the horizontal position of the
|
|
control point relative to the registration point of the
|
|
parent display object.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>controlY: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A number that specifies the vertical position of the
|
|
control point relative to the registration point of the
|
|
parent display object.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>anchorX: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A number that specifies the horizontal position of the
|
|
next anchor point relative to the registration point of
|
|
the parent display object.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>anchorY: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A number that specifies the vertical position of the next
|
|
anchor point relative to the registration point of the
|
|
parent display object.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="drawcircle" class="tsd-anchor"></a>
|
|
<h3>draw<wbr>Circle</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">draw<wbr>Circle<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, radius<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">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L230">lib/openfl/display/Graphics.d.ts:230</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Draws a circle. Set the line style, fill, or both before you call the
|
|
<code>drawCircle()</code> method, by calling the <code>linestyle()</code>,
|
|
<code>lineGradientStyle()</code>, <code>beginFill()</code>,
|
|
<code>beginGradientFill()</code>, or <code>beginBitmapFill()</code>
|
|
method.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>x: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The <em>x</em> location of the center of the circle relative
|
|
to the registration point of the parent display object(in
|
|
pixels).</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>y: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The <em>y</em> location of the center of the circle relative
|
|
to the registration point of the parent display object(in
|
|
pixels).</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>radius: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The radius of the circle(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="drawellipse" class="tsd-anchor"></a>
|
|
<h3>draw<wbr>Ellipse</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">draw<wbr>Ellipse<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<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">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L249">lib/openfl/display/Graphics.d.ts:249</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Draws an ellipse. Set the line style, fill, or both before you call the
|
|
<code>drawEllipse()</code> method, by calling the
|
|
<code>linestyle()</code>, <code>lineGradientStyle()</code>,
|
|
<code>beginFill()</code>, <code>beginGradientFill()</code>, or
|
|
<code>beginBitmapFill()</code> method.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>x: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The <em>x</em> location of the top-left of the bounding-box of
|
|
the ellipse relative to the registration point of the parent
|
|
display object(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>y: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The <em>y</em> location of the top left of the bounding-box of
|
|
the ellipse relative to the registration point of the parent
|
|
display object(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>width: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The width of the ellipse(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>height: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The height of the ellipse(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="drawgraphicsdata" class="tsd-anchor"></a>
|
|
<h3>draw<wbr>Graphics<wbr>Data</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">draw<wbr>Graphics<wbr>Data<span class="tsd-signature-symbol">(</span>graphicsData<span class="tsd-signature-symbol">: </span><a href="openfl.vector.html" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol"><</span><a href="openfl.display.igraphicsdata.html" class="tsd-signature-type">IGraphicsData</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L264">lib/openfl/display/Graphics.d.ts:264</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Submits a series of IGraphicsData instances for drawing. This method
|
|
accepts a Vector containing objects including paths, fills, and strokes
|
|
that implement the IGraphicsData interface. A Vector of IGraphicsData
|
|
instances can refer to a part of a shape, or a complex fully defined set
|
|
of data for rendering a complete shape.</p>
|
|
</div>
|
|
<p> Graphics paths can contain other graphics paths. If the
|
|
<code>graphicsData</code> Vector includes a path, that path and all its
|
|
sub-paths are rendered during this operation.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>graphicsData: <a href="openfl.vector.html" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol"><</span><a href="openfl.display.igraphicsdata.html" class="tsd-signature-type">IGraphicsData</a><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="drawpath" class="tsd-anchor"></a>
|
|
<h3>draw<wbr>Path</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">draw<wbr>Path<span class="tsd-signature-symbol">(</span>commands<span class="tsd-signature-symbol">: </span><a href="openfl.vector.html" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span>, data<span class="tsd-signature-symbol">: </span><a href="openfl.vector.html" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span>, winding<span class="tsd-signature-symbol">?: </span><a href="../enums/openfl.display.graphicspathwinding.html" class="tsd-signature-type">GraphicsPathWinding</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L312">lib/openfl/display/Graphics.d.ts:312</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Submits a series of commands for drawing. The <code>drawPath()</code>
|
|
method uses vector arrays to consolidate individual <code>moveTo()</code>,
|
|
<code>lineTo()</code>, and <code>curveTo()</code> drawing commands into a
|
|
single call. The <code>drawPath()</code> method parameters combine drawing
|
|
commands with x- and y-coordinate value pairs and a drawing direction. The
|
|
drawing commands are values from the GraphicsPathCommand class. The x- and
|
|
y-coordinate value pairs are Numbers in an array where each pair defines a
|
|
coordinate location. The drawing direction is a value from the
|
|
GraphicsPathWinding class.</p>
|
|
</div>
|
|
<p> Generally, drawings render faster with <code>drawPath()</code> than
|
|
with a series of individual <code>lineTo()</code> and
|
|
<code>curveTo()</code> methods.</p>
|
|
<p> The <code>drawPath()</code> method uses a uses a floating computation
|
|
so rotation and scaling of shapes is more accurate and gives better
|
|
results. However, curves submitted using the <code>drawPath()</code>
|
|
method can have small sub-pixel alignment errors when used in conjunction
|
|
with the <code>lineTo()</code> and <code>curveTo()</code> methods.</p>
|
|
<p> The <code>drawPath()</code> method also uses slightly different rules
|
|
for filling and drawing lines. They are:</p>
|
|
<ul>
|
|
<li><p>When a fill is applied to rendering a path:</p>
|
|
</li>
|
|
<li><p>A sub-path of less than 3 points is not rendered.(But note that the
|
|
stroke rendering will still occur, consistent with the rules for strokes
|
|
below.)</p>
|
|
</li>
|
|
<li>A sub-path that isn't closed(the end point is not equal to the
|
|
begin point) is implicitly closed.</li>
|
|
</ul>
|
|
<ul>
|
|
<li><p>When a stroke is applied to rendering a path:</p>
|
|
</li>
|
|
<li><p>The sub-paths can be composed of any number of points.</p>
|
|
</li>
|
|
<li>The sub-path is never implicitly closed.</li>
|
|
</ul>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>commands: <a href="openfl.vector.html" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>data: <a href="openfl.vector.html" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> winding: <a href="../enums/openfl.display.graphicspathwinding.html" class="tsd-signature-type">GraphicsPathWinding</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Specifies the winding rule using a value defined in the
|
|
GraphicsPathWinding class.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="drawrect" class="tsd-anchor"></a>
|
|
<h3>draw<wbr>Rect</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">draw<wbr>Rect<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<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">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L332">lib/openfl/display/Graphics.d.ts:332</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Draws a rectangle. Set the line style, fill, or both before you call the
|
|
<code>drawRect()</code> method, by calling the <code>linestyle()</code>,
|
|
<code>lineGradientStyle()</code>, <code>beginFill()</code>,
|
|
<code>beginGradientFill()</code>, or <code>beginBitmapFill()</code>
|
|
method.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>ArgumentError If the <code>width</code> or <code>height</code>
|
|
parameters are not a number
|
|
(<code>Number.NaN</code>).</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>x: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A number indicating the horizontal position relative to the
|
|
registration point of the parent display object(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>y: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A number indicating the vertical position relative to the
|
|
registration point of the parent display object(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>width: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The width of the rectangle(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>height: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The height of the rectangle(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="drawroundrect" class="tsd-anchor"></a>
|
|
<h3>draw<wbr>Round<wbr>Rect</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">draw<wbr>Round<wbr>Rect<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, ellipseWidth<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, ellipseHeight<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L361">lib/openfl/display/Graphics.d.ts:361</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Draws a rounded rectangle. Set the line style, fill, or both before you
|
|
call the <code>drawRoundRect()</code> method, by calling the
|
|
<code>linestyle()</code>, <code>lineGradientStyle()</code>,
|
|
<code>beginFill()</code>, <code>beginGradientFill()</code>, or
|
|
<code>beginBitmapFill()</code> method.</p>
|
|
</div>
|
|
<dl class="tsd-comment-tags">
|
|
<dt>throws</dt>
|
|
<dd><p>ArgumentError If the <code>width</code>, <code>height</code>,
|
|
<code>ellipseWidth</code> or
|
|
<code>ellipseHeight</code> parameters are not a
|
|
number(<code>Number.NaN</code>).</p>
|
|
</dd>
|
|
</dl>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>x: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A number indicating the horizontal position relative
|
|
to the registration point of the parent display
|
|
object(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>y: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A number indicating the vertical position relative to
|
|
the registration point of the parent display object
|
|
(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>width: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The width of the round rectangle(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>height: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The height of the round rectangle(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>ellipseWidth: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The width of the ellipse used to draw the rounded
|
|
corners(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ellipseHeight: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The height of the ellipse used to draw the rounded
|
|
corners(in pixels). Optional; if no value is
|
|
specified, the default value matches that provided
|
|
for the <code>ellipseWidth</code> parameter.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="drawroundrectcomplex" class="tsd-anchor"></a>
|
|
<h3>draw<wbr>Round<wbr>Rect<wbr>Complex</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">draw<wbr>Round<wbr>Rect<wbr>Complex<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, topLeftRadius<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, topRightRadius<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, bottomLeftRadius<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, bottomRightRadius<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">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L364">lib/openfl/display/Graphics.d.ts:364</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>x: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>y: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>width: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>height: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>topLeftRadius: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>topRightRadius: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>bottomLeftRadius: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>bottomRightRadius: <span class="tsd-signature-type">number</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="drawtriangles" class="tsd-anchor"></a>
|
|
<h3>draw<wbr>Triangles</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">draw<wbr>Triangles<span class="tsd-signature-symbol">(</span>vertices<span class="tsd-signature-symbol">: </span><a href="openfl.vector.html" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span>, indices<span class="tsd-signature-symbol">?: </span><a href="openfl.vector.html" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span>, uvtData<span class="tsd-signature-symbol">?: </span><a href="openfl.vector.html" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span>, culling<span class="tsd-signature-symbol">?: </span><a href="../enums/openfl.display.triangleculling.html" class="tsd-signature-type">TriangleCulling</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L385">lib/openfl/display/Graphics.d.ts:385</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Renders a set of triangles, typically to distort bitmaps and give them a
|
|
three-dimensional appearance. The <code>drawTriangles()</code> method maps
|
|
either the current fill, or a bitmap fill, to the triangle faces using a
|
|
set of(u,v) coordinates.</p>
|
|
</div>
|
|
<p> Any type of fill can be used, but if the fill has a transform matrix
|
|
that transform matrix is ignored.</p>
|
|
<p> A <code>uvtData</code> parameter improves texture mapping when a
|
|
bitmap fill is used.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>vertices: <a href="openfl.vector.html" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> indices: <a href="openfl.vector.html" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> uvtData: <a href="openfl.vector.html" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> culling: <a href="../enums/openfl.display.triangleculling.html" class="tsd-signature-type">TriangleCulling</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Specifies whether to render triangles that face in a
|
|
specified direction. This parameter prevents the rendering
|
|
of triangles that cannot be seen in the current view. This
|
|
parameter can be set to any value defined by the
|
|
TriangleCulling class.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="endfill" class="tsd-anchor"></a>
|
|
<h3>end<wbr>Fill</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">end<wbr>Fill<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L399">lib/openfl/display/Graphics.d.ts:399</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Applies a fill to the lines and curves that were added since the last call
|
|
to the <code>beginFill()</code>, <code>beginGradientFill()</code>, or
|
|
<code>beginBitmapFill()</code> method. Flash uses the fill that was
|
|
specified in the previous call to the <code>beginFill()</code>,
|
|
<code>beginGradientFill()</code>, or <code>beginBitmapFill()</code>
|
|
method. If the current drawing position does not equal the previous
|
|
position specified in a <code>moveTo()</code> method and a fill is
|
|
defined, the path is closed with a line and then filled.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="linebitmapstyle" class="tsd-anchor"></a>
|
|
<h3>line<wbr>Bitmap<wbr>Style</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">line<wbr>Bitmap<wbr>Style<span class="tsd-signature-symbol">(</span>bitmap<span class="tsd-signature-symbol">: </span><a href="openfl.display.bitmapdata.html" class="tsd-signature-type">BitmapData</a>, matrix<span class="tsd-signature-symbol">?: </span><a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a>, repeat<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, smooth<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L431">lib/openfl/display/Graphics.d.ts:431</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Specifies a bitmap to use for the line stroke when drawing lines.</p>
|
|
</div>
|
|
<p>The bitmap line style is used for subsequent calls to Graphics methods
|
|
such as the <code>lineTo()</code> method or the <code>drawCircle()</code>
|
|
method. The line style remains in effect until you call the
|
|
<code>lineStyle()</code> or <code>lineGradientStyle()</code> methods, or
|
|
the <code>lineBitmapStyle()</code> method again with different parameters.</p>
|
|
<p>You can call the <code>lineBitmapStyle()</code> method in the middle of
|
|
drawing a path to specify different styles for different line segments
|
|
within a path.</p>
|
|
<p>Call the <code>lineStyle()</code> method before you call the
|
|
<code>lineBitmapStyle()</code> method to enable a stroke, or else the
|
|
value of the line style is <code>undefined</code>.</p>
|
|
<p>Calls to the <code>clear()</code> method set the line style back to
|
|
<code>undefined</code>.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>bitmap: <a href="openfl.display.bitmapdata.html" class="tsd-signature-type">BitmapData</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The bitmap to use for the line stroke.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> matrix: <a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>An optional transformation matrix as defined by the
|
|
openfl.geom.Matrix class. The matrix can be used to scale or
|
|
otherwise manipulate the bitmap before applying it to the
|
|
line style.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> repeat: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Whether to repeat the bitmap in a tiled fashion.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> smooth: <span class="tsd-signature-type">boolean</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Whether smoothing should be applied to the bitmap.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="linegradientstyle" class="tsd-anchor"></a>
|
|
<h3>line<wbr>Gradient<wbr>Style</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">line<wbr>Gradient<wbr>Style<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><a href="../enums/openfl.display.gradienttype.html" class="tsd-signature-type">GradientType</a>, colors<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span>, alphas<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span>, ratios<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span>, matrix<span class="tsd-signature-symbol">?: </span><a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a>, spreadMethod<span class="tsd-signature-symbol">?: </span><a href="../enums/openfl.display.spreadmethod.html" class="tsd-signature-type">SpreadMethod</a>, interpolationMethod<span class="tsd-signature-symbol">?: </span><a href="../enums/openfl.display.interpolationmethod.html" class="tsd-signature-type">InterpolationMethod</a>, focalPointRatio<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">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L486">lib/openfl/display/Graphics.d.ts:486</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Specifies a gradient to use for the stroke when drawing lines.</p>
|
|
</div>
|
|
<p>The gradient line style is used for subsequent calls to Graphics
|
|
methods such as the <code>lineTo()</code> methods or the
|
|
<code>drawCircle()</code> method. The line style remains in effect until
|
|
you call the <code>lineStyle()</code> or <code>lineBitmapStyle()</code>
|
|
methods, or the <code>lineGradientStyle()</code> method again with
|
|
different parameters.</p>
|
|
<p>You can call the <code>lineGradientStyle()</code> method in the middle
|
|
of drawing a path to specify different styles for different line segments
|
|
within a path.</p>
|
|
<p>Call the <code>lineStyle()</code> method before you call the
|
|
<code>lineGradientStyle()</code> method to enable a stroke, or else the
|
|
value of the line style is <code>undefined</code>.</p>
|
|
<p>Calls to the <code>clear()</code> method set the line style back to
|
|
<code>undefined</code>.</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>type: <a href="../enums/openfl.display.gradienttype.html" class="tsd-signature-type">GradientType</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A value from the GradientType class that
|
|
specifies which gradient type to use, either
|
|
GradientType.LINEAR or GradientType.RADIAL.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>colors: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>alphas: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>ratios: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">></span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> matrix: <a href="openfl.geom.matrix.html" class="tsd-signature-type">Matrix</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A transformation matrix as defined by the
|
|
openfl.geom.Matrix class. The openfl.geom.Matrix
|
|
class includes a
|
|
<code>createGradientBox()</code> method, which
|
|
lets you conveniently set up the matrix for use
|
|
with the <code>lineGradientStyle()</code>
|
|
method.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> spreadMethod: <a href="../enums/openfl.display.spreadmethod.html" class="tsd-signature-type">SpreadMethod</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A value from the SpreadMethod class that
|
|
specifies which spread method to use:</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> interpolationMethod: <a href="../enums/openfl.display.interpolationmethod.html" class="tsd-signature-type">InterpolationMethod</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A value from the InterpolationMethod class that
|
|
specifies which value to use. For example,
|
|
consider a simple linear gradient between two
|
|
colors(with the <code>spreadMethod</code>
|
|
parameter set to
|
|
<code>SpreadMethod.REFLECT</code>). The
|
|
different interpolation methods affect the
|
|
appearance as follows:</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> focalPointRatio: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A number that controls the location of the
|
|
focal point of the gradient. The value 0 means
|
|
the focal point is in the center. The value 1
|
|
means the focal point is at one border of the
|
|
gradient circle. The value -1 means that the
|
|
focal point is at the other border of the
|
|
gradient circle. Values less than -1 or greater
|
|
than 1 are rounded to -1 or 1. The following
|
|
image shows a gradient with a
|
|
<code>focalPointRatio</code> of -0.75:</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="linestyle" class="tsd-anchor"></a>
|
|
<h3>line<wbr>Style</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">line<wbr>Style<span class="tsd-signature-symbol">(</span>thickness<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span>, color<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, alpha<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span>, pixelHinting<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span>, scaleMode<span class="tsd-signature-symbol">?: </span><a href="../enums/openfl.display.linescalemode.html" class="tsd-signature-type">LineScaleMode</a>, caps<span class="tsd-signature-symbol">?: </span><a href="../enums/openfl.display.capsstyle.html" class="tsd-signature-type">CapsStyle</a>, joints<span class="tsd-signature-symbol">?: </span><a href="../enums/openfl.display.jointstyle.html" class="tsd-signature-type">JointStyle</a>, miterLimit<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">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L628">lib/openfl/display/Graphics.d.ts:628</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Specifies a line style used for subsequent calls to Graphics methods such
|
|
as the <code>lineTo()</code> method or the <code>drawCircle()</code>
|
|
method. The line style remains in effect until you call the
|
|
<code>lineGradientStyle()</code> method, the
|
|
<code>lineBitmapStyle()</code> method, or the <code>lineStyle()</code>
|
|
method with different parameters.</p>
|
|
</div>
|
|
<p>You can call the <code>lineStyle()</code> method in the middle of
|
|
drawing a path to specify different styles for different line segments
|
|
within the path.</p>
|
|
<p><strong>Note: </strong>Calls to the <code>clear()</code> method set the line
|
|
style back to <code>undefined</code>.</p>
|
|
<p><strong>Note: </strong>Flash Lite 4 supports only the first three parameters
|
|
(<code>thickness</code>, <code>color</code>, and <code>alpha</code>).</p>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> thickness: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>An integer that indicates the thickness of the line in
|
|
points; valid values are 0-255. If a number is not
|
|
specified, or if the parameter is undefined, a line is
|
|
not drawn. If a value of less than 0 is passed, the
|
|
default is 0. The value 0 indicates hairline
|
|
thickness; the maximum thickness is 255. If a value
|
|
greater than 255 is passed, the default is 255.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> color: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A hexadecimal color value of the line; for example,
|
|
red is 0xFF0000, blue is 0x0000FF, and so on. If a
|
|
value is not indicated, the default is 0x000000
|
|
(black). Optional.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> alpha: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A number that indicates the alpha value of the color
|
|
of the line; valid values are 0 to 1. If a value is
|
|
not indicated, the default is 1(solid). If the value
|
|
is less than 0, the default is 0. If the value is
|
|
greater than 1, the default is 1.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> pixelHinting: <span class="tsd-signature-type">boolean</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> scaleMode: <a href="../enums/openfl.display.linescalemode.html" class="tsd-signature-type">LineScaleMode</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>(Not supported in Flash Lite 4) A value from the
|
|
LineScaleMode class that specifies which scale mode to
|
|
use:</p>
|
|
<pre><code> * `LineScaleMode.NORMAL` - Always
|
|
scale <span class="hljs-keyword">the</span> <span class="hljs-built_in">line</span> thickness when <span class="hljs-keyword">the</span> object is scaled
|
|
(<span class="hljs-keyword">the</span> default).
|
|
* `LineScaleMode.<span class="hljs-literal">NONE</span>` - Never scale
|
|
<span class="hljs-keyword">the</span> <span class="hljs-built_in">line</span> thickness.
|
|
* `LineScaleMode.VERTICAL` - Do <span class="hljs-keyword">not</span>
|
|
scale <span class="hljs-keyword">the</span> <span class="hljs-built_in">line</span> thickness <span class="hljs-keyword">if</span> <span class="hljs-keyword">the</span> object is scaled
|
|
vertically <span class="hljs-title">_only</span>_. For example, consider <span class="hljs-keyword">the</span>
|
|
following circles, drawn <span class="hljs-keyword">with</span> <span class="hljs-keyword">a</span> <span class="hljs-literal">one</span>-pixel <span class="hljs-built_in">line</span>, <span class="hljs-keyword">and</span>
|
|
<span class="hljs-keyword">each</span> <span class="hljs-keyword">with</span> <span class="hljs-keyword">the</span> `scaleMode` parameter <span class="hljs-built_in">set</span> <span class="hljs-built_in">to</span>
|
|
`LineScaleMode.VERTICAL`. The circle <span class="hljs-keyword">on</span> <span class="hljs-title">the</span>
|
|
left is scaled vertically only, <span class="hljs-keyword">and</span> <span class="hljs-keyword">the</span> circle <span class="hljs-keyword">on</span> <span class="hljs-title">the</span>
|
|
<span class="hljs-literal">right</span> is scaled both vertically <span class="hljs-keyword">and</span> horizontally:
|
|
|
|
* `LineScaleMode.HORIZONTAL` - Do <span class="hljs-keyword">not</span>
|
|
scale <span class="hljs-keyword">the</span> <span class="hljs-built_in">line</span> thickness <span class="hljs-keyword">if</span> <span class="hljs-keyword">the</span> object is scaled
|
|
horizontally <span class="hljs-title">_only</span>_. For example, consider <span class="hljs-keyword">the</span>
|
|
following circles, drawn <span class="hljs-keyword">with</span> <span class="hljs-keyword">a</span> <span class="hljs-literal">one</span>-pixel <span class="hljs-built_in">line</span>, <span class="hljs-keyword">and</span>
|
|
<span class="hljs-keyword">each</span> <span class="hljs-keyword">with</span> <span class="hljs-keyword">the</span> `scaleMode` parameter <span class="hljs-built_in">set</span> <span class="hljs-built_in">to</span>
|
|
`LineScaleMode.HORIZONTAL`. The circle <span class="hljs-keyword">on</span>
|
|
<span class="hljs-keyword">the</span> left is scaled horizontally only, <span class="hljs-keyword">and</span> <span class="hljs-keyword">the</span> circle
|
|
<span class="hljs-keyword">on</span> <span class="hljs-title">the</span> <span class="hljs-title">right</span> <span class="hljs-title">is</span> <span class="hljs-title">scaled</span> <span class="hljs-title">both</span> <span class="hljs-title">vertically</span> <span class="hljs-title">and</span>
|
|
horizontally:
|
|
</code></pre>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> caps: <a href="../enums/openfl.display.capsstyle.html" class="tsd-signature-type">CapsStyle</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>(Not supported in Flash Lite 4) A value from the
|
|
CapsStyle class that specifies the type of caps at the
|
|
end of lines. Valid values are:
|
|
<code>CapsStyle.NONE</code>,
|
|
<code>CapsStyle.ROUND</code>, and
|
|
<code>CapsStyle.SQUARE</code>. If a value is not
|
|
indicated, Flash uses round caps.</p>
|
|
<pre><code> For example, <span class="hljs-keyword">the</span> following illustrations show <span class="hljs-keyword">the</span>
|
|
different `capsStyle` settings. For <span class="hljs-keyword">each</span>
|
|
setting, <span class="hljs-keyword">the</span> illustration shows <span class="hljs-keyword">a</span> blue <span class="hljs-built_in">line</span> <span class="hljs-keyword">with</span> <span class="hljs-keyword">a</span>
|
|
thickness <span class="hljs-keyword">of</span> <span class="hljs-number">30</span>(<span class="hljs-keyword">for</span> which <span class="hljs-keyword">the</span> `capsStyle`
|
|
applies), <span class="hljs-keyword">and</span> <span class="hljs-keyword">a</span> superimposed <span class="hljs-keyword">black</span> <span class="hljs-built_in">line</span> <span class="hljs-keyword">with</span> <span class="hljs-keyword">a</span>
|
|
thickness <span class="hljs-keyword">of</span> <span class="hljs-number">1</span>(<span class="hljs-keyword">for</span> which no `capsStyle`
|
|
applies):
|
|
</code></pre>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> joints: <a href="../enums/openfl.display.jointstyle.html" class="tsd-signature-type">JointStyle</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>(Not supported in Flash Lite 4) A value from the
|
|
JointStyle class that specifies the type of joint
|
|
appearance used at angles. Valid values are:
|
|
<code>JointStyle.BEVEL</code>,
|
|
<code>JointStyle.MITER</code>, and
|
|
<code>JointStyle.ROUND</code>. If a value is not
|
|
indicated, Flash uses round joints.</p>
|
|
<pre><code> For example, <span class="hljs-keyword">the</span> following illustrations show <span class="hljs-keyword">the</span>
|
|
different `joints` settings. For <span class="hljs-keyword">each</span>
|
|
setting, <span class="hljs-keyword">the</span> illustration shows <span class="hljs-keyword">an</span> angled blue <span class="hljs-built_in">line</span>
|
|
<span class="hljs-keyword">with</span> <span class="hljs-keyword">a</span> thickness <span class="hljs-keyword">of</span> <span class="hljs-number">30</span>(<span class="hljs-keyword">for</span> which <span class="hljs-keyword">the</span>
|
|
`jointStyle` applies), <span class="hljs-keyword">and</span> <span class="hljs-keyword">a</span> superimposed
|
|
angled <span class="hljs-keyword">black</span> <span class="hljs-built_in">line</span> <span class="hljs-keyword">with</span> <span class="hljs-keyword">a</span> thickness <span class="hljs-keyword">of</span> <span class="hljs-number">1</span>(<span class="hljs-keyword">for</span> which no
|
|
`jointStyle` applies):
|
|
|
|
**Note:** For `joints` <span class="hljs-built_in">set</span> <span class="hljs-built_in">to</span>
|
|
`JointStyle.MITER`, you can use <span class="hljs-keyword">the</span>
|
|
`miterLimit` parameter <span class="hljs-built_in">to</span> limit <span class="hljs-keyword">the</span> <span class="hljs-built_in">length</span>
|
|
<span class="hljs-keyword">of</span> <span class="hljs-keyword">the</span> miter.
|
|
</code></pre>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> miterLimit: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>(Not supported in Flash Lite 4) A number that
|
|
indicates the limit at which a miter is cut off. Valid
|
|
values range from 1 to 255(and values outside that
|
|
range are rounded to 1 or 255). This value is only
|
|
used if the <code>jointStyle</code> is set to
|
|
<code>"miter"</code>. The <code>miterLimit</code>
|
|
value represents the length that a miter can extend
|
|
beyond the point at which the lines meet to form a
|
|
joint. The value expresses a factor of the line
|
|
<code>thickness</code>. For example, with a
|
|
<code>miterLimit</code> factor of 2.5 and a
|
|
<code>thickness</code> of 10 pixels, the miter is cut
|
|
off at 25 pixels.</p>
|
|
<pre><code> For example, consider <span class="hljs-keyword">the</span> following angled <span class="hljs-keyword">lines</span>,
|
|
<span class="hljs-keyword">each</span> drawn <span class="hljs-keyword">with</span> <span class="hljs-keyword">a</span> `thickness` <span class="hljs-keyword">of</span> <span class="hljs-number">20</span>, but
|
|
<span class="hljs-keyword">with</span> `miterLimit` <span class="hljs-built_in">set</span> <span class="hljs-built_in">to</span> <span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-keyword">and</span> <span class="hljs-number">4.</span>
|
|
Superimposed are <span class="hljs-keyword">black</span> reference <span class="hljs-keyword">lines</span> showing <span class="hljs-keyword">the</span>
|
|
meeting points <span class="hljs-keyword">of</span> <span class="hljs-keyword">the</span> joints:
|
|
|
|
Notice that <span class="hljs-keyword">a</span> given `miterLimit` <span class="hljs-built_in">value</span>
|
|
has <span class="hljs-keyword">a</span> specific maximum angle <span class="hljs-keyword">for</span> which <span class="hljs-keyword">the</span> miter is
|
|
cut off. The following table lists some examples:
|
|
</code></pre>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="lineto" class="tsd-anchor"></a>
|
|
<h3>line<wbr>To</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">line<wbr>To<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<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">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L647">lib/openfl/display/Graphics.d.ts:647</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Draws a line using the current line style from the current drawing
|
|
position to(<code>x</code>, <code>y</code>); the current drawing position
|
|
is then set to(<code>x</code>, <code>y</code>). If the display object in
|
|
which you are drawing contains content that was created with the Flash
|
|
drawing tools, calls to the <code>lineTo()</code> method are drawn
|
|
underneath the content. If you call <code>lineTo()</code> before any calls
|
|
to the <code>moveTo()</code> method, the default position for the current
|
|
drawing is(<em>0, 0</em>). If any of the parameters are missing, this
|
|
method fails and the current drawing position is not changed.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>x: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A number that indicates the horizontal position relative to the
|
|
registration point of the parent display object(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>y: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A number that indicates the vertical position relative to the
|
|
registration point of the parent display object(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="moveto" class="tsd-anchor"></a>
|
|
<h3>move<wbr>To</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">move<wbr>To<span class="tsd-signature-symbol">(</span>x<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, y<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">void</span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L660">lib/openfl/display/Graphics.d.ts:660</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Moves the current drawing position to(<code>x</code>, <code>y</code>). If
|
|
any of the parameters are missing, this method fails and the current
|
|
drawing position is not changed.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>x: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A number that indicates the horizontal position relative to the
|
|
registration point of the parent display object(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>y: <span class="tsd-signature-type">number</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A number that indicates the vertical position relative to the
|
|
registration point of the parent display object(in pixels).</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a name="readgraphicsdata" class="tsd-anchor"></a>
|
|
<h3>read<wbr>Graphics<wbr>Data</h3>
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<li class="tsd-signature tsd-kind-icon">read<wbr>Graphics<wbr>Data<span class="tsd-signature-symbol">(</span>recurse<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="openfl.vector.html" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol"><</span><a href="openfl.display.igraphicsdata.html" class="tsd-signature-type">IGraphicsData</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/openfl/openfl/blob/9921d3bf/lib/openfl/display/Graphics.d.ts#L663">lib/openfl/display/Graphics.d.ts:663</a></li>
|
|
</ul>
|
|
</aside>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> recurse: <span class="tsd-signature-type">boolean</span></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="openfl.vector.html" class="tsd-signature-type">Vector</a><span class="tsd-signature-symbol"><</span><a href="openfl.display.igraphicsdata.html" class="tsd-signature-type">IGraphicsData</a><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
</section>
|
|
</div>
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
<nav class="tsd-navigation primary">
|
|
<ul>
|
|
<li class="label tsd-is-external">
|
|
<span>Externals</span>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.desktop.html">openfl.desktop</a>
|
|
</li>
|
|
<li class="current tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.display.html">openfl.display</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.display3d.html">openfl.display3D</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.errors.html">openfl.errors</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.events.html">openfl.events</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.external.html">openfl.external</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.filters.html">openfl.filters</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.geom.html">openfl.geom</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.media.html">openfl.media</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.net.html">openfl.net</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.profiler.html">openfl.profiler</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.sensors.html">openfl.sensors</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.system.html">openfl.system</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.text.html">openfl.text</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.ui.html">openfl.ui</a>
|
|
</li>
|
|
<li class=" tsd-kind-module tsd-parent-kind-module tsd-is-external">
|
|
<a href="../modules/openfl.utils.html">openfl.utils</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 tsd-parent-kind-module tsd-is-external">
|
|
<a href="openfl.display.graphics.html" class="tsd-kind-icon">Graphics</a>
|
|
<ul>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#beginbitmapfill" class="tsd-kind-icon">begin<wbr>Bitmap<wbr>Fill</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#beginfill" class="tsd-kind-icon">begin<wbr>Fill</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#begingradientfill" class="tsd-kind-icon">begin<wbr>Gradient<wbr>Fill</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#clear" class="tsd-kind-icon">clear</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#copyfrom" class="tsd-kind-icon">copy<wbr>From</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#cubiccurveto" class="tsd-kind-icon">cubic<wbr>Curve<wbr>To</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#curveto" class="tsd-kind-icon">curve<wbr>To</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#drawcircle" class="tsd-kind-icon">draw<wbr>Circle</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#drawellipse" class="tsd-kind-icon">draw<wbr>Ellipse</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#drawgraphicsdata" class="tsd-kind-icon">draw<wbr>Graphics<wbr>Data</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#drawpath" class="tsd-kind-icon">draw<wbr>Path</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#drawrect" class="tsd-kind-icon">draw<wbr>Rect</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#drawroundrect" class="tsd-kind-icon">draw<wbr>Round<wbr>Rect</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#drawroundrectcomplex" class="tsd-kind-icon">draw<wbr>Round<wbr>Rect<wbr>Complex</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#drawtriangles" class="tsd-kind-icon">draw<wbr>Triangles</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#endfill" class="tsd-kind-icon">end<wbr>Fill</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#linebitmapstyle" class="tsd-kind-icon">line<wbr>Bitmap<wbr>Style</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#linegradientstyle" class="tsd-kind-icon">line<wbr>Gradient<wbr>Style</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#linestyle" class="tsd-kind-icon">line<wbr>Style</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#lineto" class="tsd-kind-icon">line<wbr>To</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#moveto" class="tsd-kind-icon">move<wbr>To</a>
|
|
</li>
|
|
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-external">
|
|
<a href="openfl.display.graphics.html#readgraphicsdata" class="tsd-kind-icon">read<wbr>Graphics<wbr>Data</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul class="after-current">
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</h2>
|
|
<div class="tsd-legend-group">
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
|
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
|
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
|
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
|
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
|
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
|
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
|
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
|
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
|
<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>
|
|
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
|
<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>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
|
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
|
</ul>
|
|
<ul class="tsd-legend">
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
|
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</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-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
<div class="container tsd-generator">
|
|
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<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> |