deploy: c15f465

openfl/desktop/Clipboard.html

@@ -101,7 +101,7 @@
 on a paste event. Calling <code><a href="../../openfl/desktop/Clipboard.html#getData">Clipboard.getData</a>()</code> under any other
 circumstances will be unsuccessful. The same restriction applies in AIR
 for content outside the application sandbox.</p>
-<p>On Linux, clipboard data does not persist when an AIR application closes.</p></div><h3 class="section">Static variables</h3><div class="fields"><div class="field "><a name="generalClipboard"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label">read only</span><a href="#generalClipboard"><span class="identifier">generalClipboard</span></a>:<a class="type" title="openfl.desktop.Clipboard - The Clipboard class provides a container for transferring data and objects through the clipboard." href="../../openfl/desktop/Clipboard.html">Clipboard</a></code></h3><div class="doc"><p>The operating system clipboard.
+<p>On Linux, clipboard data does not persist when an AIR application closes.</p><p class="javadoc">See also:</p><ul><li><div class="inline-content"><p><a href="https://books.openfl.org/openfl-developers-guide/copy-and-paste/">Copy and paste</a></p></div></li></ul></div><h3 class="section">Static variables</h3><div class="fields"><div class="field "><a name="generalClipboard"></a><h3 class="anchor"><code><span class="label label-static">static</span><span class="label">read only</span><a href="#generalClipboard"><span class="identifier">generalClipboard</span></a>:<a class="type" title="openfl.desktop.Clipboard - The Clipboard class provides a container for transferring data and objects through the clipboard." href="../../openfl/desktop/Clipboard.html">Clipboard</a></code></h3><div class="doc"><p>The operating system clipboard.
 Any data pasted to the system clipboard is available to other
 applications. This may include insecure remote code running in a web
 browser.</p>

openfl/display/BitmapData.html

@@ -483,11 +483,13 @@
 considered opaque in the second BitmapData object. Use this parameter only when
 the value of <code>secondObject</code> is a BitmapData object and both BitmapData objects
 are transparent.</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>A value of <code>true</code> if a hit occurs; otherwise, <code>false</code>.</p></div><p class="javadoc">Throws:</p><table class="table table-bordered params"><tr class="indent"><th style="width:25%;"><code>ArgumentError</code></th><td><p>The <code>secondObject</code> parameter is not a Point, Rectangle,
-Bitmap, or BitmapData object.</p></td></tr><tr class="indent"><th style="width:25%;"><code>TypeError</code></th><td><p>The <code>firstPoint</code> is <code>null</code>.</p></td></tr></table></div></div><div class="field "><a name="lock"></a><h3 class="anchor"><code><a href="#lock"><span class="identifier">lock</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p>Locks an image so that any objects that reference the BitmapData object,
-such as Bitmap objects, are not updated when this BitmapData object
-changes. To improve performance, use this method along with the
-<code>unlock()</code> method before and after numerous calls to the
-<code>setPixel()</code> or <code>setPixel32()</code> method.</p></div></div><div class="field "><a name="merge"></a><h3 class="anchor"><code><a href="#merge"><span class="identifier">merge</span></a>(<span style="white-space:nowrap">sourceBitmapData:<a class="type" title="openfl.display.BitmapData - The BitmapData class lets you work with the data (pixels) of a Bitmap object." href="../../openfl/display/BitmapData.html">BitmapData</a>,</span> <span style="white-space:nowrap">sourceRect:<a class="type" title="openfl.geom.Rectangle - A Rectangle object is an area defined by its position, as indicated by its top-left corner point(x, y) and by its width and its height." href="../../openfl/geom/Rectangle.html">Rectangle</a>,</span> <span style="white-space:nowrap">destPoint:<a class="type" title="openfl.geom.Point - The Point object represents a location in a two-dimensional coordinate system, where x represents the horizontal axis and y represents the vertical axis." href="../../openfl/geom/Point.html">Point</a>,</span> <span style="white-space:nowrap">redMultiplier:<span class="type">UInt</span>,</span> <span style="white-space:nowrap">greenMultiplier:<span class="type">UInt</span>,</span> <span style="white-space:nowrap">blueMultiplier:<span class="type">UInt</span>,</span> <span style="white-space:nowrap">alphaMultiplier:<span class="type">UInt</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p>Performs per-channel blending from a source image to a destination image. For
+Bitmap, or BitmapData object.</p></td></tr><tr class="indent"><th style="width:25%;"><code>TypeError</code></th><td><p>The <code>firstPoint</code> is <code>null</code>.</p></td></tr></table></div></div><div class="field "><a name="lock"></a><h3 class="anchor"><code><a href="#lock"><span class="identifier">lock</span></a>():<span class="type">Void</span></code></h3><div class="doc"><p>When targeting AIR, this method locks an image so that any objects 
+that reference the BitmapData object, such as Bitmap objects, are not 
+updated when this BitmapData object changes. To improve performance, 
+use this method along with the <code>unlock()</code> method before and after numerous 
+calls to the <code>setPixel()</code> or <code>setPixel32()</code> method.</p>
+<p>Note: This method only provides an optimization on the AIR(Flash) target.
+For all other targets, this method contains an empty function body.</p></div></div><div class="field "><a name="merge"></a><h3 class="anchor"><code><a href="#merge"><span class="identifier">merge</span></a>(<span style="white-space:nowrap">sourceBitmapData:<a class="type" title="openfl.display.BitmapData - The BitmapData class lets you work with the data (pixels) of a Bitmap object." href="../../openfl/display/BitmapData.html">BitmapData</a>,</span> <span style="white-space:nowrap">sourceRect:<a class="type" title="openfl.geom.Rectangle - A Rectangle object is an area defined by its position, as indicated by its top-left corner point(x, y) and by its width and its height." href="../../openfl/geom/Rectangle.html">Rectangle</a>,</span> <span style="white-space:nowrap">destPoint:<a class="type" title="openfl.geom.Point - The Point object represents a location in a two-dimensional coordinate system, where x represents the horizontal axis and y represents the vertical axis." href="../../openfl/geom/Point.html">Point</a>,</span> <span style="white-space:nowrap">redMultiplier:<span class="type">UInt</span>,</span> <span style="white-space:nowrap">greenMultiplier:<span class="type">UInt</span>,</span> <span style="white-space:nowrap">blueMultiplier:<span class="type">UInt</span>,</span> <span style="white-space:nowrap">alphaMultiplier:<span class="type">UInt</span></span>):<span class="type">Void</span></code></h3><div class="doc"><p>Performs per-channel blending from a source image to a destination image. For
 each channel and each pixel, a new value is computed based on the channel
 values of the source and destination pixels. For example, in the red channel,
 the new value is computed as follows (where <code>redSrc</code> is the red channel value
@@ -674,11 +676,14 @@
 destination when the threshold test fails. If the
 value is <code>false</code>, the source image is
 not copied when the threshold test fails.</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>The number of pixels that were changed.</p></div><p class="javadoc">Throws:</p><table class="table table-bordered params"><tr class="indent"><th style="width:25%;"><code>ArgumentError</code></th><td><p>The operation string is not a valid operation</p></td></tr><tr class="indent"><th style="width:25%;"><code>TypeError</code></th><td><p>The sourceBitmapData, sourceRect destPoint or
-operation are null.</p></td></tr></table></div></div><div class="field "><a name="unlock"></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({ changeRect : null })</span><a href="#unlock"><span class="identifier">unlock</span></a>(<span style="white-space:nowrap">?changeRect:<a class="type" title="openfl.geom.Rectangle - A Rectangle object is an area defined by its position, as indicated by its top-left corner point(x, y) and by its width and its height." href="../../openfl/geom/Rectangle.html">Rectangle</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p>Unlocks an image so that any objects that reference the BitmapData object,
-such as Bitmap objects, are updated when this BitmapData object changes.
-To improve performance, use this method along with the <code>lock()</code>
+operation are null.</p></td></tr></table></div></div><div class="field "><a name="unlock"></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({ changeRect : null })</span><a href="#unlock"><span class="identifier">unlock</span></a>(<span style="white-space:nowrap">?changeRect:<a class="type" title="openfl.geom.Rectangle - A Rectangle object is an area defined by its position, as indicated by its top-left corner point(x, y) and by its width and its height." href="../../openfl/geom/Rectangle.html">Rectangle</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p>When targeting AIR, this method Unlocks an image so that any objects that reference 
+the BitmapData object, such as Bitmap objects, are updated when this BitmapData object 
+changes.</p>
+<p>To improve performance, use this method along with the <code>lock()</code>
 method before and after numerous calls to the <code>setPixel()</code> or
-<code>setPixel32()</code> method.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>changeRect</code></th><td><p>The area of the BitmapData object that has changed. If
+<code>setPixel32()</code> method.</p>
+<p>Note: This method only provides an optimization on the AIR(Flash) target.
+For all other targets, this method contains an empty function body.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>changeRect</code></th><td><p>The area of the BitmapData object that has changed. If
 you do not specify a value for this parameter, the
 entire area of the BitmapData object is considered
 changed.</p></td></tr></table></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#777777">&copy; 2024 &nbsp;<a style="color:#777777" href="https://www.openfl.org">https://www.openfl.org</a></p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html>

openfl/filesystem/FileStream.html

@@ -123,28 +123,18 @@
 Output data is still available to written, and output-related events (such as the
 outputProgress event or the ioError event) have registered event listeners.</p><p class="javadoc">Events:</p><table class="table table-bordered params"><tr class="indent"><th style="width:25%;"><code>close</code></th><td><p>The file, which was opened asynchronously, is closed.</p></td></tr></table></div></div><div class="field "><a name="open"></a><h3 class="anchor"><code><a href="#open"><span class="identifier">open</span></a>(<span style="white-space:nowrap">file:<a class="type" title="openfl.filesystem.File - A File object represents a path to a file or directory." href="../../openfl/filesystem/File.html">File</a>,</span> <span style="white-space:nowrap">fileMode:<a class="type" title="openfl.filesystem.FileMode - The FileMode enum defines string constants used in the fileMode parameter of the open() and openAsync() methods of the FileStream class." href="../../openfl/filesystem/FileMode.html">FileMode</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p>Opens the FileStream object synchronously, pointing to the file specified by the
 file parameter.</p>
-<pre><code>	If the FileStream object is already open, calling the method closes the file before
-	opening and no further events (including close) are delivered for the previously opened
-	file.
-
-	On systems that support file locking, a file opened in "write" or "update" mode
-	(FileMode.WRITE or FileMode.UPDATE) is not readable until it is closed.
-
-	Once you are done performing operations on the file, call the close() method of the
-	FileStream object. Some operating systems limit the number of concurrently open files.
-	@param 		file The File object specifying the file to open.
-	@param 		 A string from the FileMode class that defines the capabilities of the
-	FileStream, such as the ability to read from or write to the file.
-	@throws 	IOError The file does not exist; you do not have adequate permissions to
-	open the file; you are opening a file for read access, and you do not have read
-	permissions; or you are opening a file for write access, and you do not have write
-	permissions.
-	@throws 	SecurityError The file location is in the application directory, and the
-	fileMode parameter is set to "append", "update", or "write" mode.
-
-	@see [Initializing a FileStream object, and opening and closing files](https://books.openfl.org/openfl-developers-guide/working-with-the-file-system/initializing-a-filestream-object-and-opening-and-closing-files.html)
-	@see [FileStream open modes](https://books.openfl.org/openfl-developers-guide/working-with-the-file-system/filestream-open-modes.html)
-</code></pre></div></div><div class="field "><a name="openAsync"></a><h3 class="anchor"><code><a href="#openAsync"><span class="identifier">openAsync</span></a>(<span style="white-space:nowrap">file:<a class="type" title="openfl.filesystem.File - A File object represents a path to a file or directory." href="../../openfl/filesystem/File.html">File</a>,</span> <span style="white-space:nowrap">fileMode:<a class="type" title="openfl.filesystem.FileMode - The FileMode enum defines string constants used in the fileMode parameter of the open() and openAsync() methods of the FileStream class." href="../../openfl/filesystem/FileMode.html">FileMode</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p>Opens the FileStream object asynchronously, pointing to the file specified by the file
+<p>If the FileStream object is already open, calling the method closes the file before
+opening and no further events (including close) are delivered for the previously opened
+file.</p>
+<p>On systems that support file locking, a file opened in "write" or "update" mode
+(FileMode.WRITE or FileMode.UPDATE) is not readable until it is closed.</p>
+<p>Once you are done performing operations on the file, call the close() method of the
+FileStream object. Some operating systems limit the number of concurrently open files.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>file</code></th><td><p>The File object specifying the file to open.</p></td></tr><tr><th style="width:25%;"><code>fileMode</code></th><td><p>A string from the FileMode class that defines the capabilities of the
+FileStream, such as the ability to read from or write to the file.</p></td></tr></table><p class="javadoc">Throws:</p><table class="table table-bordered params"><tr class="indent"><th style="width:25%;"><code>IOError</code></th><td><p>The file does not exist; you do not have adequate permissions to
+open the file; you are opening a file for read access, and you do not have read
+permissions; or you are opening a file for write access, and you do not have write
+permissions.</p></td></tr><tr class="indent"><th style="width:25%;"><code>SecurityError</code></th><td><p>The file location is in the application directory, and the
+fileMode parameter is set to "append", "update", or "write" mode.</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/working-with-the-file-system/initializing-a-filestream-object-and-opening-and-closing-files.html">https://books.openfl.org/openfl-developers-guide/working-with-the-file-system/initializing-a-filestream-object-and-opening-and-closing-files.html</a></p></div></li><li><div class="inline-content"><p><a href="https://books.openfl.org/openfl-developers-guide/working-with-the-file-system/filestream-open-modes.html">https://books.openfl.org/openfl-developers-guide/working-with-the-file-system/filestream-open-modes.html</a></p></div></li></ul></div></div><div class="field "><a name="openAsync"></a><h3 class="anchor"><code><a href="#openAsync"><span class="identifier">openAsync</span></a>(<span style="white-space:nowrap">file:<a class="type" title="openfl.filesystem.File - A File object represents a path to a file or directory." href="../../openfl/filesystem/File.html">File</a>,</span> <span style="white-space:nowrap">fileMode:<a class="type" title="openfl.filesystem.FileMode - The FileMode enum defines string constants used in the fileMode parameter of the open() and openAsync() methods of the FileStream class." href="../../openfl/filesystem/FileMode.html">FileMode</a></span>):<span class="type">Void</span></code></h3><div class="doc"><p>Opens the FileStream object asynchronously, pointing to the file specified by the file
 parameter.</p>
 <p>If the FileStream object is already open, calling the method closes the file before opening
 and no further events (including close) are delivered for the previously opened file.</p>
@@ -204,7 +194,7 @@
 (specified by the bytesAvailable property).</p></td></tr></table><p class="javadoc">Events:</p><table class="table table-bordered params"><tr class="indent"><th style="width:25%;"><code>ioError</code></th><td><p>The file cannot be read or the file is not open. This event is dispatched only
 for files opened for asynchronous operations (by using the openAsync() method).</p></td></tr></table></div></div><div class="field "><a name="readUTF"></a><h3 class="anchor"><code><a href="#readUTF"><span class="identifier">readUTF</span></a>():<span class="type">String</span></code></h3><div class="doc"><p>Reads a UTF-8 string from the file stream, byte stream, or byte array. The string is assumed to be
 prefixed with an unsigned short indicating the length in bytes.</p>
-<pre><code>			This method is similar to the readUTF() method in the Java® IDataInput interface.
+<pre><code>	This method is similar to the readUTF() method in the Java® IDataInput interface.
 </code></pre><p class="javadoc">Returns:</p><div class="indent inline-content"><p>A UTF-8 string produced by the byte representation of characters.</p></div><p class="javadoc">Throws:</p><table class="table table-bordered params"><tr class="indent"><th style="width:25%;"><code>IOError</code></th><td><p>The file has not been opened; the file has been opened, but it was not opened
 with read capabilities; or for a file that has been opened for synchronous operations (by using
 the open() method), the file cannot be read (for example, because the file is missing).</p></td></tr><tr class="indent"><th style="width:25%;"><code>EOFError</code></th><td><p>The position specfied for reading data exceeds the number of bytes available