Skip to content

Commit 848ad66

Browse files
deploy: 7961784
1 parent d76283a commit 848ad66

16 files changed

+87
-149
lines changed

openfl/display/BitmapData.html

Lines changed: 15 additions & 18 deletions
Large diffs are not rendered by default.

openfl/display/Graphics.html

Lines changed: 16 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,7 @@
7979
example, you can use the following matrix to rotate a bitmap
8080
by 45 degrees(pi/4 radians):</p>
8181
<pre><code class="prettyprint haxe">matrix = new openfl.geom.Matrix();
82-
matrix.rotate(Math.PI / 4);
83-
```
84-
85-
</code></pre></td></tr><tr><th style="width:25%;"><code>repeat</code></th><td><p>If <code>true</code>, the bitmap image repeats in a tiled
82+
matrix.rotate(Math.PI / 4);</code></pre></td></tr><tr><th style="width:25%;"><code>repeat</code></th><td><p>If <code>true</code>, the bitmap image repeats in a tiled
8683
pattern. If <code>false</code>, the bitmap image does not
8784
repeat, and the edges of the bitmap are used for any fill
8885
area that extends beyond the bitmap.</p>
@@ -245,7 +242,7 @@
245242
anchor point relative to the registration point of the
246243
parent display object.</p></td></tr></table><p class="javadoc">See also:</p><ul><li><div class="inline-content"><p><a href="https://books.openfl.org/openfl-developers-guide/using-the-drawing-api/drawing-lines-and-curves.html">Drawing lines and curves</a></p></div></li></ul></div></div><div class="field "><a name="drawCircle"></a><h3 class="anchor"><code><a href="#drawCircle"><span class="identifier">drawCircle</span></a>(<span style="white-space:nowrap">x:<span class="type">Float</span>,</span> <span style="white-space:nowrap">y:<span class="type">Float</span>,</span> <span style="white-space:nowrap">radius:<span class="type">Float</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p class="javadoc">See also:</p><ul><li><div class="inline-content"><p><a href="https://books.openfl.org/openfl-developers-guide/using-the-drawing-api/drawing-shapes-using-built-in-methods.html">Drawing shapes using built-in methods</a></p></div></li></ul></div></div><div class="field "><a name="drawEllipse"></a><h3 class="anchor"><code><a href="#drawEllipse"><span class="identifier">drawEllipse</span></a>(<span style="white-space:nowrap">x:<span class="type">Float</span>,</span> <span style="white-space:nowrap">y:<span class="type">Float</span>,</span> <span style="white-space:nowrap">width:<span class="type">Float</span>,</span> <span style="white-space:nowrap">height:<span class="type">Float</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p>Draws an ellipse. Set the line style, fill, or both before you call the
247244
<code>drawEllipse()</code> method, by calling the
248-
<code>linestyle()</code>, <code>lineGradientStyle()</code>,
245+
<code>lineStyle()</code>, <code>lineGradientStyle()</code>,
249246
<code>beginFill()</code>, <code>beginGradientFill()</code>, or
250247
<code>beginBitmapFill()</code> method.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>x</code></th><td><p>The <em>x</em> location of the top-left of the bounding-box of
251248
the ellipse relative to the registration point of the parent
@@ -309,24 +306,22 @@
309306
matrix [ a, b, c, d, ... ] values. A <code>transforms</code> object
310307
which is six times the draw count in size will use full
311308
matrix [ a, b, c, d, tx, ty, ... ] values per draw.</p></td></tr></table></div></div><div class="field "><a name="drawRect"></a><h3 class="anchor"><code><a href="#drawRect"><span class="identifier">drawRect</span></a>(<span style="white-space:nowrap">x:<span class="type">Float</span>,</span> <span style="white-space:nowrap">y:<span class="type">Float</span>,</span> <span style="white-space:nowrap">width:<span class="type">Float</span>,</span> <span style="white-space:nowrap">height:<span class="type">Float</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p>Draws a rectangle. Set the line style, fill, or both before you call the
312-
<code>drawRect()</code> method, by calling the <code>linestyle()</code>,
309+
<code>drawRect()</code> method, by calling the <code>lineStyle()</code>,
313310
<code>lineGradientStyle()</code>, <code>beginFill()</code>,
314311
<code>beginGradientFill()</code>, or <code>beginBitmapFill()</code>
315312
method.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>x</code></th><td><p>A number indicating the horizontal position relative to the
316313
registration point of the parent display object (in pixels).</p></td></tr><tr><th style="width:25%;"><code>y</code></th><td><p>A number indicating the vertical position relative to the
317314
registration point of the parent display object (in pixels).</p></td></tr><tr><th style="width:25%;"><code>width</code></th><td><p>The width of the rectangle (in pixels).</p></td></tr><tr><th style="width:25%;"><code>height</code></th><td><p>The height of the rectangle (in pixels).</p></td></tr></table><p class="javadoc">Throws:</p><table class="table table-bordered params"><tr class="indent"><th style="width:25%;"><code>ArgumentError</code></th><td><p>If the <code>width</code> or <code>height</code>
318-
parameters are not a number</p>
319-
<pre><code> (`Number.NaN`).
320-
</code></pre></td></tr></table><p class="javadoc">See also:</p><ul><li><div class="inline-content"><p><a href="https://books.openfl.org/openfl-developers-guide/using-the-drawing-api/drawing-shapes-using-built-in-methods.html">Drawing shapes using built-in methods</a></p></div></li></ul></div></div><div class="field "><a name="drawRoundRect"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ ellipseHeight : null })</span><a href="#drawRoundRect"><span class="identifier">drawRoundRect</span></a>(<span style="white-space:nowrap">x:<span class="type">Float</span>,</span> <span style="white-space:nowrap">y:<span class="type">Float</span>,</span> <span style="white-space:nowrap">width:<span class="type">Float</span>,</span> <span style="white-space:nowrap">height:<span class="type">Float</span>,</span> <span style="white-space:nowrap">ellipseWidth:<span class="type">Float</span>,</span> <span style="white-space:nowrap">?ellipseHeight:<span class="type">Float</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p>Draws a rounded rectangle. Set the line style, fill, or both before you
315+
parameters are not a number
316+
(<code>Number.NaN</code>).</p></td></tr></table><p class="javadoc">See also:</p><ul><li><div class="inline-content"><p><a href="https://books.openfl.org/openfl-developers-guide/using-the-drawing-api/drawing-shapes-using-built-in-methods.html">Drawing shapes using built-in methods</a></p></div></li></ul></div></div><div class="field "><a name="drawRoundRect"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ ellipseHeight : null })</span><a href="#drawRoundRect"><span class="identifier">drawRoundRect</span></a>(<span style="white-space:nowrap">x:<span class="type">Float</span>,</span> <span style="white-space:nowrap">y:<span class="type">Float</span>,</span> <span style="white-space:nowrap">width:<span class="type">Float</span>,</span> <span style="white-space:nowrap">height:<span class="type">Float</span>,</span> <span style="white-space:nowrap">ellipseWidth:<span class="type">Float</span>,</span> <span style="white-space:nowrap">?ellipseHeight:<span class="type">Float</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p>Draws a rounded rectangle. Set the line style, fill, or both before you
321317
call the <code>drawRoundRect()</code> method, by calling the
322-
<code>linestyle()</code>, <code>lineGradientStyle()</code>,
318+
<code>lineStyle()</code>, <code>lineGradientStyle()</code>,
323319
<code>beginFill()</code>, <code>beginGradientFill()</code>, or
324320
<code>beginBitmapFill()</code> method.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>x</code></th><td><p>A number indicating the horizontal position relative
325321
to the registration point of the parent display
326322
object(in pixels).</p></td></tr><tr><th style="width:25%;"><code>y</code></th><td><p>A number indicating the vertical position relative to
327-
the registration point of the parent display object</p>
328-
<pre><code> (in pixels).
329-
</code></pre></td></tr><tr><th style="width:25%;"><code>width</code></th><td><p>The width of the round rectangle (in pixels).</p></td></tr><tr><th style="width:25%;"><code>height</code></th><td><p>The height of the round rectangle (in pixels).</p></td></tr><tr><th style="width:25%;"><code>ellipseWidth</code></th><td><p>The width of the ellipse used to draw the rounded
323+
the registration point of the parent display object
324+
(in pixels).</p></td></tr><tr><th style="width:25%;"><code>width</code></th><td><p>The width of the round rectangle (in pixels).</p></td></tr><tr><th style="width:25%;"><code>height</code></th><td><p>The height of the round rectangle (in pixels).</p></td></tr><tr><th style="width:25%;"><code>ellipseWidth</code></th><td><p>The width of the ellipse used to draw the rounded
330325
corners(in pixels).</p></td></tr><tr><th style="width:25%;"><code>ellipseHeight</code></th><td><p>The height of the ellipse used to draw the rounded
331326
corners(in pixels). Optional; if no value is
332327
specified, the default value matches that provided
@@ -431,9 +426,8 @@
431426
thickness; the maximum thickness is 255. If a value
432427
greater than 255 is passed, the default is 255.</p></td></tr><tr><th style="width:25%;"><code>color</code></th><td><p>A hexadecimal color value of the line; for example,
433428
red is 0xFF0000, blue is 0x0000FF, and so on. If a
434-
value is not indicated, the default is 0x000000</p>
435-
<pre><code> (black). Optional.
436-
</code></pre></td></tr><tr><th style="width:25%;"><code>alpha</code></th><td><p>A number that indicates the alpha value of the color
429+
value is not indicated, the default is 0x000000
430+
(black). Optional.</p></td></tr><tr><th style="width:25%;"><code>alpha</code></th><td><p>A number that indicates the alpha value of the color
437431
of the line; valid values are 0 to 1. If a value is
438432
not indicated, the default is 1 (solid). If the value
439433
is less than 0, the default is 0. If the value is
@@ -449,19 +443,16 @@
449443
Flash Player or Adobe AIR renders two rounded
450444
rectangles that are identical, except that the
451445
<code>pixelHinting</code> parameter used in the
452-
<code>lineStyle()</code> method is set differently</p>
453-
<pre><code> (the images are scaled by 200%, to emphasize the
454-
</code></pre>
455-
<p>difference):</p>
446+
<code>lineStyle()</code> method is set differently
447+
(the images are scaled by 200%, to emphasize the
448+
difference):</p>
456449
<p><img src="/images/lineStyle_pixelHinting.jpg" alt="pixelHinting false and pixelHinting true" /></p>
457450
<p>If a value is not supplied, the line does not use
458451
pixel hinting.</p></td></tr><tr><th style="width:25%;"><code>scaleMode</code></th><td><p>(Not supported in Flash Lite 4) A value from the
459452
LineScaleMode class that specifies which scale mode to
460-
use:</p><ul><li>
461-
<p><code><a href="../../openfl/display/LineScaleMode.html#NORMAL">LineScaleMode.NORMAL</a></code> - Always
462-
scale the line thickness when the object is scaled</p>
463-
<pre><code> (the default).
464-
</code></pre></li><li><code><a href="../../openfl/display/LineScaleMode.html#NONE">LineScaleMode.NONE</a></code> - Never scale
453+
use:</p><ul><li><code><a href="../../openfl/display/LineScaleMode.html#NORMAL">LineScaleMode.NORMAL</a></code> - Always
454+
scale the line thickness when the object is scaled
455+
(the default).</li><li><code><a href="../../openfl/display/LineScaleMode.html#NONE">LineScaleMode.NONE</a></code> - Never scale
465456
the line thickness.</li><li><code><a href="../../openfl/display/LineScaleMode.html#VERTICAL">LineScaleMode.VERTICAL</a></code> - Do not
466457
scale the line thickness if the object is scaled
467458
vertically <em>only</em>. For example, consider the

openfl/display/GraphicsStroke.html

Lines changed: 21 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -70,17 +70,14 @@
7070
illustrations show how Flash Player renders two
7171
rounded rectangles that are identical, except that the
7272
<code>pixelHinting</code> parameter used in the
73-
<code>lineStyle()</code> method is set differently</p>
74-
<pre><code> (the images are scaled by 200%, to emphasize the
75-
</code></pre>
76-
<p>difference):</p>
73+
<code>lineStyle()</code> method is set differently
74+
(the images are scaled by 200%, to emphasize the
75+
difference):</p>
7776
<p>If a value is not supplied, the line does not use
7877
pixel hinting.</p></td></tr><tr><th style="width:25%;"><code>scaleMode</code></th><td><p>A value from the LineScaleMode class that specifies
79-
which scale mode to use:</p><ul><li>
80-
<p><code><a href="../../openfl/display/LineScaleMode.html#NORMAL">LineScaleMode.NORMAL</a></code> - Always
81-
scale the line thickness when the object is scaled</p>
82-
<pre><code> (the default).
83-
</code></pre></li><li><code><a href="../../openfl/display/LineScaleMode.html#NONE">LineScaleMode.NONE</a></code> - Never scale
78+
which scale mode to use:</p><ul><li><code><a href="../../openfl/display/LineScaleMode.html#NORMAL">LineScaleMode.NORMAL</a></code> - Always
79+
scale the line thickness when the object is scaled
80+
(the default).</li><li><code><a href="../../openfl/display/LineScaleMode.html#NONE">LineScaleMode.NONE</a></code> - Never scale
8481
the line thickness.</li><li>
8582
<p><code><a href="../../openfl/display/LineScaleMode.html#VERTICAL">LineScaleMode.VERTICAL</a></code> - Do not
8683
scale the line thickness if the object is scaled
@@ -170,27 +167,21 @@
170167
rounded rectangles that are identical, except that the
171168
<code>pixelHinting</code> parameter used in the <code>lineStyle()</code>
172169
method is set differently (the images are scaled by 200%, to emphasize the
173-
difference):</p></div></div><div class="field "><a name="scaleMode"></a><h3 class="anchor"><code><a href="#scaleMode"><span class="identifier">scaleMode</span></a>:<a class="type" title="openfl.display.LineScaleMode - The LineScaleMode class provides values for the scaleMode parameter in the Graphics." href="../../openfl/display/LineScaleMode.html">LineScaleMode</a></code></h3><div class="doc"><p>Specifies the stroke thickness scaling. Valid values are:</p>
174-
<p><code><a href="../../openfl/display/LineScaleMode.html#NORMAL">LineScaleMode.NORMAL</a></code> - Always scale the line thickness</p>
175-
<pre><code> when the object is scaled (the default).
176-
</code></pre>
177-
<p><code><a href="../../openfl/display/LineScaleMode.html#NONE">LineScaleMode.NONE</a></code> - Never scale the line thickness.</p>
178-
<p><code><a href="../../openfl/display/LineScaleMode.html#VERTICAL">LineScaleMode.VERTICAL</a></code> - Do not scale the line</p>
179-
<pre><code> thickness if the object is scaled vertically _only_. For example,
180-
consider the following circles, drawn with a one-pixel line, and each with
181-
the `scaleMode` parameter set to
182-
`LineScaleMode.VERTICAL`. The circle on the left is scaled
183-
vertically only, and the circle on the right is scaled both vertically and
184-
horizontally:
185-
</code></pre>
186-
<p><code><a href="../../openfl/display/LineScaleMode.html#HORIZONTAL">LineScaleMode.HORIZONTAL</a></code> - Do not scale the line</p>
187-
<pre><code> thickness if the object is scaled horizontally _only_. For example,
188-
consider the following circles, drawn with a one-pixel line, and each with
189-
the `scaleMode` parameter set to
190-
`LineScaleMode.HORIZONTAL`. The circle on the left is scaled
191-
horizontally only, and the circle on the right is scaled both vertically
192-
and horizontally:
193-
</code></pre></div></div><div class="field "><a name="thickness"></a><h3 class="anchor"><code><a href="#thickness"><span class="identifier">thickness</span></a>:<span class="type">Float</span></code></h3><div class="doc"><p>Indicates the thickness of the line in points; valid values are 0-255. If
170+
difference):</p></div></div><div class="field "><a name="scaleMode"></a><h3 class="anchor"><code><a href="#scaleMode"><span class="identifier">scaleMode</span></a>:<a class="type" title="openfl.display.LineScaleMode - The LineScaleMode class provides values for the scaleMode parameter in the Graphics." href="../../openfl/display/LineScaleMode.html">LineScaleMode</a></code></h3><div class="doc"><p>Specifies the stroke thickness scaling. Valid values are:</p><ul><li><code><a href="../../openfl/display/LineScaleMode.html#NORMAL">LineScaleMode.NORMAL</a></code> - Always scale the line thickness
171+
when the object is scaled (the default).</li><li>
172+
<p><code><a href="../../openfl/display/LineScaleMode.html#NONE">LineScaleMode.NONE</a></code> - Never scale the line thickness.</p></li><li>
173+
<p><code><a href="../../openfl/display/LineScaleMode.html#VERTICAL">LineScaleMode.VERTICAL</a></code> - Do not scale the line
174+
thickness if the object is scaled vertically <em>only</em>. For example,
175+
consider the following circles, drawn with a one-pixel line, and each with
176+
the <code>scaleMode</code> parameter set to
177+
<code><a href="../../openfl/display/LineScaleMode.html#VERTICAL">LineScaleMode.VERTICAL</a></code>. The circle on the left is scaled
178+
vertically only, and the circle on the right is scaled both vertically and
179+
horizontally:</p></li><li><code><a href="../../openfl/display/LineScaleMode.html#HORIZONTAL">LineScaleMode.HORIZONTAL</a></code> - Do not scale the line
180+
thickness if the object is scaled horizontally <em>only</em>. For example,
181+
consider the following circles, drawn with a one-pixel line, and each with
182+
the <code>scaleMode</code> parameter set to <code><a href="../../openfl/display/LineScaleMode.html#HORIZONTAL">LineScaleMode.HORIZONTAL</a></code>. The circle
183+
on the left is scaled horizontally only, and the circle on the right is
184+
scaled both vertically and horizontally:</li></ul></div></div><div class="field "><a name="thickness"></a><h3 class="anchor"><code><a href="#thickness"><span class="identifier">thickness</span></a>:<span class="type">Float</span></code></h3><div class="doc"><p>Indicates the thickness of the line in points; valid values are 0-255. If
194185
a number is not specified, or if the parameter is undefined, a line is not
195186
drawn. If a value of less than 0 is passed, the default is 0. The value 0
196187
indicates hairline thickness; the maximum thickness is 255. If a value

openfl/display/MovieClip.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@
7777
<code>width</code>, <code>x</code>, or <code>y</code>. However, it does not
7878
stop the playhead in any child MovieClip objects of that MovieClip
7979
object.</p>
80-
<p><strong>Note:</strong>Flash Lite 4 supports the MovieClip.opaqueBackground
80+
<p><strong>Note:</strong> Flash Lite 4 supports the MovieClip.opaqueBackground
8181
property only if FEATURE_BITMAPCACHE is defined. The default configuration
8282
of Flash Lite 4 does not define FEATURE_BITMAPCACHE. To enable the
8383
MovieClip.opaqueBackground property for a suitable device, define

openfl/filesystem/File.html

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -778,9 +778,7 @@
778778
(content installed with the AIR application) is not restricted by
779779
these security limitations.</p>
780780
<p>For more information related to security, see the Flash Player
781-
Developer Center Topic: &lt;a
782-
href="<a href="http://www.adobe.com/go/devnet_security_en">http://www.adobe.com/go/devnet_security_en</a>"
783-
scope="external">Security</a>.</p>
781+
Developer Center Topic: <a href="http://www.adobe.com/go/devnet_security_en">Security</a>.</p>
784782
<p>When you download a file using this method, it is flagged as
785783
downloaded on operating systems that flag downloaded files:</p><ul><li>Windows XP service pack 2 and later, and on Windows Vista</li><li>Mac OS 10.5 and later</li></ul>
786784
<p>Some operating systems, such as Linux, do not flag downloaded files.</p>
@@ -1067,9 +1065,7 @@
10671065
(content installed with the AIR application) are not restricted by
10681066
these security limitations.</p>
10691067
<p>For more information related to security, see the Flash Player
1070-
Developer Center Topic: &lt;a
1071-
href="<a href="http://www.adobe.com/go/devnet_security_en">http://www.adobe.com/go/devnet_security_en</a>"
1072-
scope="external">Security</a>.</p>
1068+
Developer Center Topic: <a href="http://www.adobe.com/go/devnet_security_en">Security</a>.</p>
10731069
<p>Note that because of new functionality added to the Flash Player, when
10741070
publishing to Flash Player 10, you can have only one of the following
10751071
operations active at one time: <code><a href="../../openfl/net/FileReference.html#browse">FileReference.browse</a>()</code>,

0 commit comments

Comments
 (0)