From 0595ce4d2c44846bc63f45c2fb2d5b9a92e768fd Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 6 Sep 2024 05:31:14 +0000 Subject: [PATCH] deploy: 85be9f17fc5a568375adf05e962c2b96842c7022 --- 404.html | 2 +- index.html | 37 +---- nav.js | 2 +- openfl/Assets.html | 4 +- openfl/Lib.html | 42 +++-- openfl/Memory.html | 4 +- openfl/Vector.html | 4 +- openfl/desktop/Clipboard.html | 8 +- openfl/desktop/ClipboardFormats.html | 4 +- openfl/desktop/ClipboardTransferMode.html | 4 +- openfl/desktop/DockIcon.html | 6 +- openfl/desktop/Icon.html | 6 +- openfl/desktop/InteractiveIcon.html | 6 +- openfl/desktop/InvokeEventReason.html | 4 +- openfl/desktop/NativeApplication.html | 6 +- openfl/desktop/NativeProcess.html | 6 +- openfl/desktop/NativeProcessStartupInfo.html | 4 +- openfl/desktop/NotificationType.html | 4 +- openfl/desktop/SystemIdleMode.html | 4 +- openfl/desktop/SystemTrayIcon.html | 25 ++- openfl/desktop/Updater.html | 4 +- openfl/desktop/index.html | 40 +---- openfl/display/AVM1Movie.html | 78 ++++----- openfl/display/Application.html | 4 +- openfl/display/Bitmap.html | 80 +++++----- openfl/display/BitmapData.html | 58 +++---- openfl/display/BitmapDataChannel.html | 6 +- openfl/display/BlendMode.html | 24 +-- openfl/display/CairoRenderer.html | 6 +- openfl/display/CanvasRenderer.html | 6 +- openfl/display/CapsStyle.html | 4 +- openfl/display/ChildAccess.html | 6 +- openfl/display/DOMElement.html | 78 ++++----- openfl/display/DOMRenderer.html | 6 +- openfl/display/DisplayObject.html | 90 +++++------ openfl/display/DisplayObjectContainer.html | 102 ++++++------ openfl/display/DisplayObjectRenderer.html | 6 +- openfl/display/DisplayObjectShader.html | 4 +- openfl/display/FPS.html | 136 ++++++++-------- openfl/display/FocusDirection.html | 4 +- openfl/display/FrameLabel.html | 6 +- openfl/display/FrameScript.html | 4 +- openfl/display/GradientType.html | 6 +- openfl/display/Graphics.html | 64 ++++---- openfl/display/GraphicsBitmapFill.html | 6 +- openfl/display/GraphicsEndFill.html | 6 +- openfl/display/GraphicsGradientFill.html | 6 +- openfl/display/GraphicsPath.html | 6 +- openfl/display/GraphicsPathCommand.html | 4 +- openfl/display/GraphicsPathWinding.html | 6 +- openfl/display/GraphicsQuadPath.html | 6 +- openfl/display/GraphicsShader.html | 4 +- openfl/display/GraphicsShaderFill.html | 6 +- openfl/display/GraphicsSolidFill.html | 14 +- openfl/display/GraphicsStroke.html | 30 ++-- openfl/display/GraphicsTrianglePath.html | 6 +- openfl/display/IBitmapDrawable.html | 8 +- openfl/display/IGraphicsData.html | 12 +- openfl/display/IGraphicsFill.html | 10 +- openfl/display/IGraphicsPath.html | 10 +- openfl/display/IGraphicsStroke.html | 10 +- openfl/display/ITileContainer.html | 4 +- openfl/display/InteractiveObject.html | 141 ++++++++-------- openfl/display/InterpolationMethod.html | 8 +- openfl/display/JPEGEncoderOptions.html | 4 +- openfl/display/JointStyle.html | 4 +- openfl/display/LineScaleMode.html | 6 +- openfl/display/Loader.html | 117 +++++++------- openfl/display/LoaderInfo.html | 16 +- openfl/display/MovieClip.html | 120 +++++++------- openfl/display/NativeWindow.html | 8 +- openfl/display/NativeWindowDisplayState.html | 4 +- openfl/display/NativeWindowInitOptions.html | 4 +- openfl/display/NativeWindowSystemChrome.html | 4 +- openfl/display/NativeWindowType.html | 4 +- openfl/display/OpenGLRenderer.html | 6 +- openfl/display/PNGEncoderOptions.html | 4 +- openfl/display/PixelSnapping.html | 4 +- openfl/display/Preloader.html | 4 +- openfl/display/Scene.html | 22 ++- openfl/display/Screen.html | 12 +- openfl/display/ScreenMode.html | 55 +++++++ openfl/display/Shader.html | 4 +- openfl/display/ShaderData.html | 4 +- openfl/display/ShaderInput.html | 4 +- openfl/display/ShaderJob.html | 6 +- openfl/display/ShaderParameter.html | 4 +- openfl/display/ShaderParameterType.html | 4 +- openfl/display/ShaderPrecision.html | 4 +- openfl/display/Shape.html | 82 +++++----- openfl/display/SimpleButton.html | 90 +++++------ openfl/display/SpreadMethod.html | 4 +- openfl/display/Sprite.html | 113 ++++++------- openfl/display/Stage.html | 140 ++++++++-------- openfl/display/Stage3D.html | 8 +- openfl/display/StageAlign.html | 4 +- openfl/display/StageDisplayState.html | 4 +- openfl/display/StageQuality.html | 4 +- openfl/display/StageScaleMode.html | 4 +- openfl/display/Tile.html | 6 +- openfl/display/TileContainer.html | 6 +- openfl/display/Tilemap.html | 78 ++++----- openfl/display/Tileset.html | 4 +- openfl/display/Timeline.html | 6 +- openfl/display/TriangleCulling.html | 4 +- openfl/display/Window.html | 4 +- openfl/display/index.html | 70 ++++---- openfl/display3D/Context3D.html | 6 +- openfl/display3D/Context3DBlendFactor.html | 4 +- openfl/display3D/Context3DBufferUsage.html | 4 +- openfl/display3D/Context3DClearMask.html | 4 +- openfl/display3D/Context3DCompareMode.html | 4 +- openfl/display3D/Context3DMipFilter.html | 4 +- openfl/display3D/Context3DProfile.html | 4 +- openfl/display3D/Context3DProgramFormat.html | 4 +- openfl/display3D/Context3DProgramType.html | 4 +- openfl/display3D/Context3DRenderMode.html | 4 +- openfl/display3D/Context3DStencilAction.html | 4 +- openfl/display3D/Context3DTextureFilter.html | 4 +- openfl/display3D/Context3DTextureFormat.html | 4 +- openfl/display3D/Context3DTriangleFace.html | 4 +- .../Context3DVertexBufferFormat.html | 4 +- openfl/display3D/Context3DWrapMode.html | 4 +- openfl/display3D/IndexBuffer3D.html | 4 +- openfl/display3D/Program3D.html | 4 +- openfl/display3D/VertexBuffer3D.html | 4 +- openfl/display3D/index.html | 37 +---- openfl/display3D/textures/CubeTexture.html | 6 +- .../display3D/textures/RectangleTexture.html | 6 +- openfl/display3D/textures/Texture.html | 6 +- openfl/display3D/textures/TextureBase.html | 6 +- openfl/display3D/textures/VideoTexture.html | 6 +- openfl/display3D/textures/index.html | 37 +---- openfl/errors/ArgumentError.html | 12 +- openfl/errors/EOFError.html | 4 +- openfl/errors/Error.html | 12 +- openfl/errors/IOError.html | 4 +- openfl/errors/IllegalOperationError.html | 10 +- openfl/errors/PermissionError.html | 4 +- openfl/errors/RangeError.html | 8 +- openfl/errors/SecurityError.html | 7 +- openfl/errors/TypeError.html | 6 +- openfl/errors/index.html | 50 ++---- openfl/events/AccelerometerEvent.html | 12 +- openfl/events/ActivityEvent.html | 12 +- openfl/events/AsyncErrorEvent.html | 16 +- openfl/events/ContextMenuEvent.html | 12 +- openfl/events/DNSResolverEvent.html | 12 +- openfl/events/DataEvent.html | 12 +- openfl/events/DatagramSocketDataEvent.html | 12 +- openfl/events/DeviceRotationEvent.html | 12 +- openfl/events/ErrorEvent.html | 14 +- openfl/events/Event.html | 16 +- openfl/events/EventDispatcher.html | 8 +- openfl/events/EventPhase.html | 6 +- openfl/events/EventType.html | 6 +- openfl/events/FileListEvent.html | 28 +++- openfl/events/FocusEvent.html | 12 +- openfl/events/FullScreenEvent.html | 12 +- openfl/events/GameInputEvent.html | 12 +- openfl/events/GeolocationEvent.html | 12 +- openfl/events/HTTPStatusEvent.html | 16 +- openfl/events/IEventDispatcher.html | 6 +- openfl/events/IOErrorEvent.html | 18 +-- openfl/events/InvokeEvent.html | 61 ++++++- openfl/events/KeyboardEvent.html | 30 ++-- openfl/events/MouseEvent.html | 24 +-- openfl/events/NativeProcessExitEvent.html | 12 +- openfl/events/NativeWindowBoundsEvent.html | 12 +- .../events/NativeWindowDisplayStateEvent.html | 12 +- openfl/events/NetStatusEvent.html | 12 +- openfl/events/OutputProgressEvent.html | 20 ++- openfl/events/PermissionEvent.html | 12 +- openfl/events/ProgressEvent.html | 16 +- openfl/events/RenderEvent.html | 12 +- openfl/events/SampleDataEvent.html | 12 +- openfl/events/ScreenMouseEvent.html | 22 +-- openfl/events/SecurityErrorEvent.html | 12 +- openfl/events/ServerSocketConnectEvent.html | 12 +- openfl/events/TextEvent.html | 12 +- openfl/events/TimerEvent.html | 12 +- openfl/events/TouchEvent.html | 46 +++--- openfl/events/UncaughtErrorEvent.html | 14 +- openfl/events/UncaughtErrorEvents.html | 4 +- openfl/events/VideoTextureEvent.html | 12 +- openfl/events/index.html | 53 ++----- openfl/external/ExternalInterface.html | 16 +- openfl/external/index.html | 37 +---- openfl/filesystem/File.html | 116 +++++++------- openfl/filesystem/FileMode.html | 20 ++- openfl/filesystem/FileStream.html | 21 +-- openfl/filesystem/index.html | 42 +---- openfl/filters/BitmapFilter.html | 4 +- openfl/filters/BitmapFilterQuality.html | 4 +- openfl/filters/BitmapFilterShader.html | 4 +- openfl/filters/BitmapFilterType.html | 4 +- openfl/filters/BlurFilter.html | 12 +- openfl/filters/ColorMatrixFilter.html | 4 +- openfl/filters/ConvolutionFilter.html | 4 +- openfl/filters/DisplacementMapFilter.html | 4 +- openfl/filters/DisplacementMapFilterMode.html | 4 +- openfl/filters/DropShadowFilter.html | 16 +- openfl/filters/GlowFilter.html | 18 +-- openfl/filters/ShaderFilter.html | 4 +- openfl/filters/index.html | 41 +---- openfl/geom/ColorTransform.html | 8 +- openfl/geom/Matrix.html | 20 ++- openfl/geom/Matrix3D.html | 87 +++++++++- openfl/geom/Orientation3D.html | 4 +- openfl/geom/PerspectiveProjection.html | 11 +- openfl/geom/Point.html | 29 +++- openfl/geom/Rectangle.html | 27 +++- openfl/geom/Transform.html | 12 +- openfl/geom/Utils3D.html | 19 ++- openfl/geom/Vector3D.html | 29 +++- openfl/geom/index.html | 39 +---- openfl/globalization/DateTimeFormatter.html | 4 +- openfl/globalization/DateTimeNameContext.html | 15 +- openfl/globalization/DateTimeNameStyle.html | 15 +- openfl/globalization/DateTimeStyle.html | 15 +- openfl/globalization/LastOperationStatus.html | 29 +++- openfl/globalization/LocaleID.html | 93 ++++++++++- openfl/globalization/index.html | 51 ++---- openfl/media/AudioPlaybackMode.html | 4 +- openfl/media/CameraPosition.html | 4 +- openfl/media/ID3Info.html | 4 +- openfl/media/Sound.html | 34 ++-- openfl/media/SoundChannel.html | 12 +- openfl/media/SoundLoaderContext.html | 8 +- openfl/media/SoundMixer.html | 6 +- openfl/media/SoundTransform.html | 38 +++-- openfl/media/Video.html | 78 ++++----- openfl/media/index.html | 37 +---- openfl/net/DatagramSocket.html | 4 +- openfl/net/FileFilter.html | 4 +- openfl/net/FileReference.html | 28 ++-- openfl/net/FileReferenceList.html | 6 +- openfl/net/IDynamicPropertyOutput.html | 4 +- openfl/net/IDynamicPropertyWriter.html | 4 +- openfl/net/IPVersion.html | 4 +- openfl/net/NetConnection.html | 10 +- openfl/net/NetStream.html | 8 +- openfl/net/ObjectEncoding.html | 4 +- openfl/net/Responder.html | 4 +- openfl/net/SecureSocket.html | 10 +- openfl/net/ServerSocket.html | 4 +- openfl/net/SharedObject.html | 16 +- openfl/net/SharedObjectFlushStatus.html | 4 +- openfl/net/Socket.html | 14 +- openfl/net/URLLoader.html | 22 +-- openfl/net/URLLoaderDataFormat.html | 4 +- openfl/net/URLRequest.html | 48 +++--- openfl/net/URLRequestDefaults.html | 6 +- openfl/net/URLRequestHeader.html | 18 ++- openfl/net/URLRequestMethod.html | 8 +- openfl/net/URLStream.html | 40 ++--- openfl/net/URLVariables.html | 6 +- openfl/net/XMLSocket.html | 6 +- openfl/net/dns/AAAARecord.html | 4 +- openfl/net/dns/ARecord.html | 4 +- openfl/net/dns/DNSResolver.html | 6 +- openfl/net/dns/MXRecord.html | 4 +- openfl/net/dns/PTRRecord.html | 4 +- openfl/net/dns/ResourceRecord.html | 4 +- openfl/net/dns/SRVRecord.html | 4 +- openfl/net/dns/index.html | 37 +---- openfl/net/index.html | 37 +---- openfl/permissions/PermissionStatus.html | 4 +- openfl/permissions/index.html | 37 +---- openfl/printing/PrintJob.html | 10 +- openfl/printing/PrintJobOptions.html | 4 +- openfl/printing/PrintJobOrientation.html | 4 +- openfl/printing/index.html | 37 +---- openfl/profiler/Telemetry.html | 4 +- openfl/profiler/index.html | 37 +---- openfl/security/CertificateStatus.html | 4 +- openfl/security/X500DistinguishedName.html | 4 +- openfl/security/X509Certificate.html | 4 +- openfl/security/index.html | 37 +---- openfl/sensors/Accelerometer.html | 6 +- openfl/sensors/DeviceRotation.html | 4 +- openfl/sensors/Geolocation.html | 4 +- openfl/sensors/index.html | 37 +---- openfl/system/ApplicationDomain.html | 6 +- openfl/system/Capabilities.html | 44 ++--- openfl/system/ImageDecodingPolicy.html | 4 +- openfl/system/LoaderContext.html | 12 +- openfl/system/Security.html | 8 +- openfl/system/SecurityDomain.html | 4 +- openfl/system/System.html | 14 +- openfl/system/TouchscreenType.html | 4 +- openfl/system/index.html | 37 +---- openfl/text/AntiAliasType.html | 6 +- openfl/text/AutoCapitalize.html | 4 +- openfl/text/Font.html | 4 +- openfl/text/FontStyle.html | 4 +- openfl/text/FontType.html | 4 +- openfl/text/GridFitType.html | 4 +- openfl/text/ReturnKeyLabel.html | 4 +- openfl/text/SoftKeyboardType.html | 4 +- openfl/text/StageText.html | 6 +- openfl/text/StageTextClearButtonMode.html | 4 +- openfl/text/StageTextInitOptions.html | 4 +- openfl/text/StaticText.html | 92 +++++------ openfl/text/StyleSheet.html | 8 +- openfl/text/TextField.html | 150 +++++++++--------- openfl/text/TextFieldAutoSize.html | 4 +- openfl/text/TextFieldType.html | 6 +- openfl/text/TextFormat.html | 14 +- openfl/text/TextFormatAlign.html | 4 +- openfl/text/TextLineMetrics.html | 4 +- openfl/text/engine/FontPosture.html | 4 +- openfl/text/engine/FontWeight.html | 4 +- openfl/text/engine/index.html | 37 +---- openfl/text/index.html | 45 +----- openfl/ui/GameInput.html | 4 +- openfl/ui/GameInputControl.html | 6 +- openfl/ui/GameInputDevice.html | 4 +- openfl/ui/KeyLocation.html | 4 +- openfl/ui/Keyboard.html | 12 +- openfl/ui/Mouse.html | 4 +- openfl/ui/MouseCursor.html | 4 +- openfl/ui/Multitouch.html | 16 +- openfl/ui/MultitouchInputMode.html | 6 +- openfl/ui/index.html | 39 +---- openfl/utils/AGALMiniAssembler.html | 4 +- openfl/utils/AssetBundle.html | 4 +- openfl/utils/AssetCache.html | 4 +- openfl/utils/AssetLibrary.html | 4 +- openfl/utils/AssetManifest.html | 4 +- openfl/utils/AssetType.html | 4 +- openfl/utils/Assets.html | 4 +- openfl/utils/ByteArray.html | 68 ++++---- openfl/utils/CompressionAlgorithm.html | 4 +- openfl/utils/Dictionary.html | 4 +- openfl/utils/Endian.html | 4 +- openfl/utils/Function.html | 4 +- openfl/utils/Future.html | 4 +- openfl/utils/IAssetCache.html | 4 +- openfl/utils/IDataInput.html | 4 +- openfl/utils/IDataOutput.html | 4 +- openfl/utils/IExternalizable.html | 4 +- openfl/utils/Namespace.html | 4 +- openfl/utils/Object.html | 4 +- openfl/utils/ObjectPool.html | 4 +- openfl/utils/PerspectiveMatrix3D.html | 64 +++++++- openfl/utils/Promise.html | 4 +- openfl/utils/QName.html | 4 +- openfl/utils/Timer.html | 8 +- openfl/utils/index.html | 37 +---- 350 files changed, 2948 insertions(+), 3064 deletions(-) create mode 100644 openfl/display/ScreenMode.html diff --git a/404.html b/404.html index 22a4486..607808c 100644 --- a/404.html +++ b/404.html @@ -1 +1 @@ -File not found - API Reference

404 Page not found

Page not found, sorry.

\ No newline at end of file +File not found - OpenFL API Reference

404 Page not found

Page not found, sorry.

\ No newline at end of file diff --git a/index.html b/index.html index 7b78520..925e711 100644 --- a/index.html +++ b/index.html @@ -1,7 +1,7 @@ -openfl - API Reference

openfl

-
desktop
display
display3D
errors
events
external
filesystem
filters
geom
globalization
media
net
permissions
printing
profiler
security
sensors
system
text
ui
utils
Assets

Lib

Memory

Adobe Flash Player supports an accelerated method of reading and +

OpenFL API documentation

OpenFL is a library for creative expression on the web, desktop, mobile, and game consoles — inspired by the Adobe Flash APIs. Publish to native C++, JS and WebGL, or run-times like HashLink and AIR — using one seamless toolset.

Getting Started With OpenFL

openfl

desktop
display
display3D
errors
events
external
filesystem
filters
geom
globalization
media
net
permissions
printing
profiler
security
sensors
system
text
ui
utils
Assets

Lib

Memory

Adobe Flash Player supports an accelerated method of reading and writing to the ByteArray object, known as "domain memory"

Vector

The Vector class lets you access and manipulate a vector — an array whose elements all have the same data type. The data type of a Vector's elements is known as the Vector's base type. The base type can be any class, including built in classes and diff --git a/nav.js b/nav.js index fc7865d..4211655 100644 --- a/nav.js +++ b/nav.js @@ -1 +1 @@ -var navContent='

'; \ No newline at end of file +var navContent=''; \ No newline at end of file diff --git a/openfl/Assets.html b/openfl/Assets.html index 73cd444..44daa5c 100644 --- a/openfl/Assets.html +++ b/openfl/Assets.html @@ -1,7 +1,7 @@ -openfl.Assets - API Reference
View source

typedef Assets

package openfl

Available on all platforms

Alias

alias for openfl.utils.Assets
\ No newline at end of file +
View source

typedef Assets

package openfl

Available on all platforms

Alias

alias for openfl.utils.Assets
\ No newline at end of file diff --git a/openfl/Lib.html b/openfl/Lib.html index 73fdabd..fbe3636 100644 --- a/openfl/Lib.html +++ b/openfl/Lib.html @@ -1,7 +1,7 @@ -openfl.Lib - API Reference
View source

class Lib

package openfl

@:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Stage)

Available on all platforms

Static variables

staticread onlyapplication:Application

staticread onlycurrent:MovieClip

Static methods

staticas<T>(v:Dynamic, c:Class<T>):Null<T>

staticattach(name:String):MovieClip

staticclearInterval(id:UInt):Void

Cancels a specified setInterval() call.

Parameters:

id

The ID of the setInterval() call, which you set to a variable, as +

View source

class Lib

package openfl

@:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Stage)@:access(openfl.events.UncaughtErrorEvents)

Available on all platforms

Static variables

staticread onlyapplication:Application

staticread onlycurrent:MovieClip

Static methods

staticas<T>(v:Dynamic, c:Class<T>):Null<T>

staticattach(name:String):MovieClip

staticclearInterval(id:UInt):Void

Cancels a specified setInterval() call.

Parameters:

id

The ID of the setInterval() call, which you set to a variable, as in the following:

staticclearTimeout(id:UInt):Void

Cancels a specified setTimeout() call.

Parameters:

id

The ID of the setTimeout() call, which you set to a variable, as in -the following

staticgetClassByAlias(aliasName:String):Class<Dynamic>

Looks up a class that previously had an alias registered through a call +the following

staticdecodeURIComponent(value:String):String

Decodes an encoded URI component into a string. Returns a string in +which all characters previously escaped by the encodeURIComponent +function are restored to their uncoded representation.

staticdescribeType(value:Dynamic):Xml

Produces an Xml object that describes the Haxe object named as the +parameter of the method. This method implements the programming concept +of reflection for OpenFL.

+

OpenFL target support: Not currently supported, except when targeting AIR.

+

If the value parameter is an instance of a type, the returned Xml +object includes all the instance properties of that type, but does not +include any static properties. You can check for this condition when you +parse the Xml object by examining the value of the <type> tag's +isStatic attribute, which is false when the value parameter is an +instance of a type.

+

To obtain the static properties of a type, pass the type itself for the +value parameter. The returned Xml object includes not only the +type's static properties, but also all of its instance properties. The +instance properties are nested inside a tag named <factory> to +distinguish them from the static properties. In this case, the +isStatic attribute of the <type> tag is true.

+

Note: If you need only to traverse an object's inheritance hierarchy and +do not need the other information provided by describeType(), use the +getQualifiedClassName() and getQualifiedSuperclassName() functions +instead.

staticencodeURIComponent(value:String):String

Encodes a string into a valid URI component. Converts a substring of a +URI into a string in which all characters are encoded as UTF-8 escape +sequences unless a character belongs to a very small group of basic +characters.

staticgetClassByAlias(aliasName:String):Class<Dynamic>

Looks up a class that previously had an alias registered through a call to the registerClassAlias() method.

This method does not interact with getDefinitionByName() method.

staticgetDefinitionByName(name:String):Class<Dynamic>

Returns a reference to the class object of the class specified by the name parameter.

Parameters:

name

The name of a class.

Returns:

Returns a reference to the class object of the class specified by the name parameter.

Throws:

ReferenceError

No public definition exists with the specified name.

staticgetQualifiedClassName(value:Dynamic):String

Returns the fully qualified class name of an object.

Parameters:

value

The object for which a fully qualified class name is desired. Any -ActionScript value may be passed to this method including all available -ActionScript types, object instances, primitive types such as uint, and class +Haxe value may be passed to this method including all available +Haxe types, object instances, primitive types such as Int, and class objects.

Returns:

String A string containing the fully qualified class name.

staticgetQualifiedSuperclassName(value:Dynamic):String

Returns the fully qualified class name of the base class of the object specified by the value parameter. This function provides a quicker way of retrieving the base class name than describeType(), but also doesn't provide all the @@ -136,7 +160,7 @@ enclosing HTML page.

In Flash Player, and in non-application sandboxes in Adobe AIR, you cannot connect to commonly reserved ports. For a complete list of blocked ports, see "Restricting -Networking APIs" in the ActionScript 3.0 Developer's Guide.

+Networking APIs" in the OpenFL Developer's Guide.

In Flash Player 10 and later running in a browser, using this method programmatically to open a pop-up window may not be successful. Various browsers (and browser configurations) may block pop-up windows at any time; it is not possible to guarantee @@ -203,7 +227,7 @@ You cannot navigate a window with a nondefault name from within a SWF file that is in the local-with-filesystem sandbox. * You cannot connect to commonly reserved ports. For a complete list of blocked -ports, see "Restricting Networking APIs" in the ActionScript 3.0 Developer's Guide.

Error

If the method is not called in response to a user action, such as a +ports, see "Restricting Networking APIs" in the OpenFL Developer's Guide.

Error

If the method is not called in response to a user action, such as a mouse event or keypress event. This requirement only applies to content in Flash Player and to non-application sandbox content in Adobe AIR.

staticnotImplemented(?posInfo:Null<PosInfos>):Void

staticpreventDefaultTouchMove():Void

staticregisterClassAlias(aliasName:String, classObject:Class<Dynamic>):Void

Preserves the class (type) of an object when the object is encoded in Action Message Format (AMF). When you encode an object into AMF, this @@ -221,7 +245,7 @@ serializes.

staticsendToURL(request:URLRequest):Void

Sends a URL request to a server, but ignores any response.

To examine the server response, use the URLLoader.load() method instead.

You cannot connect to commonly reserved ports. For a complete list of blocked -ports, see "Restricting Networking APIs" in the ActionScript 3.0 Developer's Guide.

+ports, see "Restricting Networking APIs" in the OpenFL Developer's Guide.

You can prevent a SWF file from using this method by setting the allowNetworking parameter of the the object and embed tags in the HTML page that contains the SWF content.

@@ -240,7 +264,7 @@ Internet. You can avoid this situation by reclassifying this SWF file as local-with-networking or trusted.

SecurityError

You cannot connect to commonly reserved ports. For a complete list of blocked ports, see "Restricting Networking APIs" in the -ActionScript 3.0 Developer's Guide.

@:value({ args : null })staticsetInterval(closure:Function, delay:Int, ?args:Array<Dynamic>):UInt

Runs a function at a specified interval (in milliseconds).

+OpenFL Developer's Guide.

@:value({ args : null })staticsetInterval(closure:Function, delay:Int, ?args:Array<Dynamic>):UInt

Runs a function at a specified interval (in milliseconds).

Instead of using the setInterval() method, consider creating a Timer object, with the specified interval, using 0 as the repeatCount parameter (which sets the timer to repeat indefinitely).

diff --git a/openfl/Memory.html b/openfl/Memory.html index 79a19e0..80e651e 100644 --- a/openfl/Memory.html +++ b/openfl/Memory.html @@ -1,7 +1,7 @@ -openfl.Memory - API Referenceopenfl.Memory - OpenFL API Reference
View source

class Memory

package openfl

@:fileXml("tags=\"haxe,release\"")@:noDebug@SuppressWarnings("checkstyle:FieldDocComment")

Available on all platforms

Adobe Flash Player supports an accelerated method of reading and +

View source

class Memory

package openfl

@:fileXml("tags=\"haxe,release\"")@:noDebug@SuppressWarnings("checkstyle:FieldDocComment")

Available on all platforms

Adobe Flash Player supports an accelerated method of reading and writing to the ByteArray object, known as "domain memory"

The Memory API provides access to domain memory using Memory.select on an existing ByteArray on the Flash target, and falls back to diff --git a/openfl/Vector.html b/openfl/Vector.html index bf067ec..08fbe76 100644 --- a/openfl/Vector.html +++ b/openfl/Vector.html @@ -1,7 +1,7 @@ -openfl.Vector - API Referenceopenfl.Vector - OpenFL API Reference

API Reference
View source

abstract Vector<T>(IVector<T>)

package openfl

@:multiType(T)

Available on all platforms

The Vector class lets you access and manipulate a vector — an array whose elements +

View source

abstract Vector<T>(IVector<T>)

package openfl

@:multiType(T)

Available on all platforms

The Vector class lets you access and manipulate a vector — an array whose elements all have the same data type. The data type of a Vector's elements is known as the Vector's base type. The base type can be any class, including built in classes and custom classes. The base type is specified when declaring a Vector variable as well diff --git a/openfl/desktop/Clipboard.html b/openfl/desktop/Clipboard.html index d236cea..8d0e928 100644 --- a/openfl/desktop/Clipboard.html +++ b/openfl/desktop/Clipboard.html @@ -1,7 +1,7 @@ -openfl.desktop.Clipboard - API Referenceopenfl.desktop.Clipboard - OpenFL API Reference

API Reference
View source

class Clipboard

package openfl.desktop

@:fileXml("tags=\"haxe,release\"")@:noDebug

Available on all platforms

The Clipboard class provides a container for transferring data and objects +

View source

class Clipboard

package openfl.desktop

@:fileXml("tags=\"haxe,release\"")@:noDebug

Available on all platforms

The Clipboard class provides a container for transferring data and objects through the clipboard. The operating system clipboard can be accessed through the static generalClipboard property. A Clipboard object can contain the same information in more than one @@ -71,9 +71,9 @@

These constants for the names of the standard formats are defined in the ClipboardFormats class.

When a transfer to or from the operating system occurs, the standard -formats are automatically translated between ActionScript data types and +formats are automatically translated between Haxe data types and the native operating system clipboard types.

-

You can use application-defined formats to add ActionScript objects to a +

You can use application-defined formats to add Haxe objects to a Clipboard object. If an object is serializable, both a reference and a clone of the object can be made available. Object references are valid only within the originating application.

diff --git a/openfl/desktop/ClipboardFormats.html b/openfl/desktop/ClipboardFormats.html index 15569f7..a37a11b 100644 --- a/openfl/desktop/ClipboardFormats.html +++ b/openfl/desktop/ClipboardFormats.html @@ -1,7 +1,7 @@ -openfl.desktop.ClipboardFormats - API Referenceopenfl.desktop.ClipboardFormats - OpenFL API Reference
View source

enum abstract ClipboardFormats(Null<Int>)

package openfl.desktop

@:enum

Available on all platforms

The ClipboardFormats class defines constants for the names of the standard +

View source

enum abstract ClipboardFormats(Null<Int>)

package openfl.desktop

@:enum

Available on all platforms

The ClipboardFormats class defines constants for the names of the standard data formats used with the Clipboard class. Flash Player 10 only supports TEXT_FORMAT, RICH_TEXT_FORMAT, and HTML_FORMAT.

Variables

@:value(cast 0)@:impl@:enuminlineread onlyHTML_FORMAT:ClipboardFormats = 0

HTML data.

@:value(cast 1)@:impl@:enuminlineread onlyRICH_TEXT_FORMAT:ClipboardFormats = 1

Rich Text Format data.

@:value(cast 2)@:impl@:enuminlineread onlyTEXT_FORMAT:ClipboardFormats = 2

String data.

\ No newline at end of file diff --git a/openfl/desktop/ClipboardTransferMode.html b/openfl/desktop/ClipboardTransferMode.html index 19e82b8..5e16386 100644 --- a/openfl/desktop/ClipboardTransferMode.html +++ b/openfl/desktop/ClipboardTransferMode.html @@ -1,7 +1,7 @@ -openfl.desktop.ClipboardTransferMode - API Referenceopenfl.desktop.ClipboardTransferMode - OpenFL API Reference
API Reference
View source

enum abstract ClipboardTransferMode(Null<Int>)

package openfl.desktop

@:enum

Available on all platforms

The ClipboardTransferMode class defines constants for the modes used as +

View source

enum abstract ClipboardTransferMode(Null<Int>)

package openfl.desktop

@:enum

Available on all platforms

The ClipboardTransferMode class defines constants for the modes used as values of the transferMode parameter of the Clipboard.getData() method. The transfer mode provides a hint about whether to return a reference or a diff --git a/openfl/desktop/DockIcon.html b/openfl/desktop/DockIcon.html index 3695603..95a9f56 100644 --- a/openfl/desktop/DockIcon.html +++ b/openfl/desktop/DockIcon.html @@ -1,7 +1,7 @@ -openfl.desktop.DockIcon - API Reference

View source

class DockIcon

package openfl.desktop

extends InteractiveIcon › Icon › EventDispatcher

Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

The DockIcon class represents the macOS-style dock icon.

+
View source

class DockIcon

package openfl.desktop

extends InteractiveIcon › Icon › EventDispatcher

Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

The DockIcon class represents the macOS-style dock icon.

You can test for support at run time using the NativeApplication.supportsDockIcon property.

OpenFL target support: Not currently supported, except when targeting AIR.

@@ -178,7 +178,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

Weak references are supported on some OpenFL diff --git a/openfl/desktop/Icon.html b/openfl/desktop/Icon.html index 1c8d91b..6749c13 100644 --- a/openfl/desktop/Icon.html +++ b/openfl/desktop/Icon.html @@ -1,7 +1,7 @@ -openfl.desktop.Icon - API Reference

View source

class Icon

package openfl.desktop

extends EventDispatcher

extended by InteractiveIcon

Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

The Icon class represents an operating system icon.

+
View source

class Icon

package openfl.desktop

extends EventDispatcher

extended by InteractiveIcon

Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

The Icon class represents an operating system icon.

An Icon object has one property, bitmaps, which is an array of BitmapData objects. Only one image is displayed at a time. The operating system selects the image closest in size to the icon's current display size, scaling if @@ -146,7 +146,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

Weak references are supported on some OpenFL diff --git a/openfl/desktop/InteractiveIcon.html b/openfl/desktop/InteractiveIcon.html index 44064d4..36d7aa4 100644 --- a/openfl/desktop/InteractiveIcon.html +++ b/openfl/desktop/InteractiveIcon.html @@ -1,7 +1,7 @@ -openfl.desktop.InteractiveIcon - API Referenceopenfl.desktop.InteractiveIcon - OpenFL API Reference

View source

class InteractiveIcon

package openfl.desktop

extends Icon › EventDispatcher

extended by DockIcon, SystemTrayIcon

Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

The InteractiveIcon class is the base class for the operating system icons +

View source

class InteractiveIcon

package openfl.desktop

extends Icon › EventDispatcher

extended by DockIcon, SystemTrayIcon

Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

The InteractiveIcon class is the base class for the operating system icons associated with applications.

Use the icon property of the NativeApplication object to get an instance of the application icon. The icon type will be one of the subclasses of @@ -158,7 +158,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

Weak references are supported on some OpenFL diff --git a/openfl/desktop/InvokeEventReason.html b/openfl/desktop/InvokeEventReason.html index e0adccc..206d383 100644 --- a/openfl/desktop/InvokeEventReason.html +++ b/openfl/desktop/InvokeEventReason.html @@ -1,7 +1,7 @@ -openfl.desktop.InvokeEventReason - API Referenceopenfl.desktop.InvokeEventReason - OpenFL API Reference

View source

enum abstract InvokeEventReason(Null<Int>)

package openfl.desktop

@:enum

Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

The InvokeEventReason class enumerates values returned by the reason +

View source

enum abstract InvokeEventReason(Null<Int>)

package openfl.desktop

@:enum

Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

The InvokeEventReason class enumerates values returned by the reason property of an InvokeEvent object.

See also:

Variables

@:value(cast 0)@:impl@:enuminlineread onlyLOGIN:InvokeEventReason = 0

Desktop only; indicates that the InvokeEvent event occurred due to the user logging in.

@:value(cast 1)@:impl@:enuminlineread onlyNOTIFICATION:InvokeEventReason = 1

iOS only; indicates that the InvokeEvent occurred because the application was invoked on receiving a remote notification.

@:value(cast 2)@:impl@:enuminlineread onlyOPEN_URL:InvokeEventReason = 2

Mobile only; indicates that the InvokeEvent occurred because the diff --git a/openfl/desktop/NativeApplication.html b/openfl/desktop/NativeApplication.html index e64e516..21e49ef 100644 --- a/openfl/desktop/NativeApplication.html +++ b/openfl/desktop/NativeApplication.html @@ -1,7 +1,7 @@ -openfl.desktop.NativeApplication - API Reference

View source

class NativeApplication

package openfl.desktop

extends EventDispatcher

@:directlyUsed

Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

The NativeApplication class represents this OpenFL application.

+
View source

class NativeApplication

package openfl.desktop

extends EventDispatcher

@:directlyUsed

Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

The NativeApplication class represents this OpenFL application.

The NativeApplication class provides application information, application-wide functions, and dispatches application-level events.

The NativeApplication object is a singleton object, created automatically @@ -250,7 +250,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

Weak references are supported on some OpenFL diff --git a/openfl/desktop/NativeProcess.html b/openfl/desktop/NativeProcess.html index 9e17ab6..522e3fd 100644 --- a/openfl/desktop/NativeProcess.html +++ b/openfl/desktop/NativeProcess.html @@ -1,7 +1,7 @@ -openfl.desktop.NativeProcess - API Referenceopenfl.desktop.NativeProcess - OpenFL API Reference

API Reference
View source

class NativeProcess

package openfl.desktop

extends EventDispatcher

@:access(openfl.utils.ByteArrayData)@:fileXml("tags=\"haxe,release\"")@:noDebug

Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

The NativeProcess class provides command line integration and general +

View source

class NativeProcess

package openfl.desktop

extends EventDispatcher

@:access(openfl.utils.ByteArrayData)@:fileXml("tags=\"haxe,release\"")@:noDebug

Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

The NativeProcess class provides command line integration and general launching capabilities. The NativeProcess class lets an OpenFL application execute native processes on the host operating system. The OpenFL application can monitor the standard input (stdin) and standard output @@ -227,7 +227,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

Weak references are supported on some OpenFL diff --git a/openfl/desktop/NativeProcessStartupInfo.html b/openfl/desktop/NativeProcessStartupInfo.html index d267806..d68767e 100644 --- a/openfl/desktop/NativeProcessStartupInfo.html +++ b/openfl/desktop/NativeProcessStartupInfo.html @@ -1,7 +1,7 @@ -openfl.desktop.NativeProcessStartupInfo - API Referenceopenfl.desktop.NativeProcessStartupInfo - OpenFL API Reference

View source

class NativeProcessStartupInfo

package openfl.desktop

@:fileXml("tags=\"haxe,release\"")@:noDebug

Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

This class provides the basic information used to start a process on the +

View source

class NativeProcessStartupInfo

package openfl.desktop

@:fileXml("tags=\"haxe,release\"")@:noDebug

Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

This class provides the basic information used to start a process on the host operating system. It is constructed and passed to the start() method of a NativeProcess object.

Native process access is only available to Haxe "sys" targets and AIR diff --git a/openfl/desktop/NotificationType.html b/openfl/desktop/NotificationType.html index 988320f..ea69e2c 100644 --- a/openfl/desktop/NotificationType.html +++ b/openfl/desktop/NotificationType.html @@ -1,7 +1,7 @@ -openfl.desktop.NotificationType - API Referenceopenfl.desktop.NotificationType - OpenFL API Reference

View source

enum abstract NotificationType(Null<Int>)

package openfl.desktop

@:enum

Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

The NotificationType class defines constants for use in the priority +

View source

enum abstract NotificationType(Null<Int>)

package openfl.desktop

@:enum

Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

The NotificationType class defines constants for use in the priority parameter of the DockIcon bounce() method and the type parameter of the NativeWindow notifyUser() method.

See also:

Variables

@:value(cast 0)@:impl@:enuminlineread onlyCRITICAL:NotificationType = 0

Specifies that a notification alert is critical in nature and the user should attend to it promptly.

@:value(cast 1)@:impl@:enuminlineread onlyINFORMATIONAL:NotificationType = 1

Specifies that a notification alert is informational in nature and the diff --git a/openfl/desktop/SystemIdleMode.html b/openfl/desktop/SystemIdleMode.html index 39ca99f..ff7256e 100644 --- a/openfl/desktop/SystemIdleMode.html +++ b/openfl/desktop/SystemIdleMode.html @@ -1,7 +1,7 @@ -openfl.desktop.SystemIdleMode - API Referenceopenfl.desktop.SystemIdleMode - OpenFL API Reference

View source

enum abstract SystemIdleMode(Null<Int>)

package openfl.desktop

@:enum

Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

The SystemIdleMode class provides constant values for system idle behaviors. +

View source

enum abstract SystemIdleMode(Null<Int>)

package openfl.desktop

@:enum

Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

The SystemIdleMode class provides constant values for system idle behaviors. These constants are used in the systemIdleMode property of the NativeApplication class.

See also:

Variables

@:value(cast 0)@:impl@:enuminlineread onlyKEEP_AWAKE:SystemIdleMode = 0

Prevents the system from dropping into an idle mode.

On Android, the application must specify the Android permissions for diff --git a/openfl/desktop/SystemTrayIcon.html b/openfl/desktop/SystemTrayIcon.html index 81c6533..4afaeb9 100644 --- a/openfl/desktop/SystemTrayIcon.html +++ b/openfl/desktop/SystemTrayIcon.html @@ -1,7 +1,8 @@ -openfl.desktop.SystemTrayIcon - API Reference

View source

class SystemTrayIcon

package openfl.desktop

extends InteractiveIcon › Icon › EventDispatcher

Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

Static variables

@:value(63)staticfinalread onlyMAX_TIP_LENGTH:Int = 63

The permitted length of the system tray icon tooltip.

Variables

tooltip:String

The tooltip that pops up for the system tray icon. If the string is +

View source

class SystemTrayIcon

package openfl.desktop

extends InteractiveIcon › Icon › EventDispatcher

Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

The SystemTrayIcon class represents the Windows® taskbar notification area +(system tray)-style icon.

+

OpenFL target support: Not currently supported, except when targeting AIR.

+

Adobe AIR profile support: This feature is supported on desktop operating systems, +but it is not supported on mobile devices or AIR for TV devices. See +AIR Profile Support +for more information regarding API support across multiple profiles.

+

Not all desktop operating systems have system tray icons. Check +NativeApplication.supportsSystemTrayIcon to determine whether system tray +icons are supported on the current system.

+

An instance of the SystemTrayIcon class cannot be created. Get the object +representing the system tray icon from the icon property of the "global" +NativeApplication object.

+

When system tray icons are supported, the icon will be of type +SystemTrayIcon. Otherwise, the type of icon will be another subclass of +InteractiveIcon, typically DockIcon.

+

Important: Attempting to call a SystemTrayIcon class method on the +NativeApplication.icon object on an operating system for which OpenFL does +not support system tray icons will generate a run-time exception.

Static variables

@:value(63)staticfinalread onlyMAX_TIP_LENGTH:Int = 63

The permitted length of the system tray icon tooltip.

Variables

tooltip:String

The tooltip that pops up for the system tray icon. If the string is longer than SystemTrayIcon.MAX_TIP_LENGTH, the tip will be truncated.

Inherited Variables

Defined by InteractiveIcon

@:value(0)read onlyheight:Int = 0

The current display height of the icon in pixels.

Some icon contexts support dynamic sizes. The height property indicates the height of the icon chosen from the bitmaps array for the @@ -151,7 +170,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

Weak references are supported on some OpenFL diff --git a/openfl/desktop/Updater.html b/openfl/desktop/Updater.html index 14f7955..e8ed168 100644 --- a/openfl/desktop/Updater.html +++ b/openfl/desktop/Updater.html @@ -1,7 +1,7 @@ -openfl.desktop.Updater - API Referenceopenfl.desktop.Updater - OpenFL API Reference

View source

class Updater

package openfl.desktop

Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

The Updater class is used to update the currently running application with a +

View source

class Updater

package openfl.desktop

Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

The Updater class is used to update the currently running application with a different version. To use it, instantiate an Updater object and then call its update() method.

You can test for support at run time using the Updater.isSupported diff --git a/openfl/desktop/index.html b/openfl/desktop/index.html index ca22767..b472d0d 100644 --- a/openfl/desktop/index.html +++ b/openfl/desktop/index.html @@ -1,7 +1,7 @@ -openfl.desktop - API Reference

openfl.desktop

-
..
Clipboard

The Clipboard class provides a container for transferring data and objects +

openfl.desktop

..
Clipboard

The Clipboard class provides a container for transferring data and objects through the clipboard. The operating system clipboard can be accessed through the static generalClipboard property. A Clipboard object can contain the same information in more than one @@ -111,6 +78,7 @@

package ::full::

parameter of the DockIcon bounce() method and the type parameter of the NativeWindow notifyUser() method.

SystemIdleMode

The SystemIdleMode class provides constant values for system idle behaviors. These constants are used in the systemIdleMode property of the -NativeApplication class.

SystemTrayIcon

Updater

The Updater class is used to update the currently running application with a +NativeApplication class.

SystemTrayIcon

The SystemTrayIcon class represents the Windows® taskbar notification area +(system tray)-style icon.

Updater

The Updater class is used to update the currently running application with a different version. To use it, instantiate an Updater object and then call its update() method.

\ No newline at end of file diff --git a/openfl/display/AVM1Movie.html b/openfl/display/AVM1Movie.html index 97bd3d1..679064c 100644 --- a/openfl/display/AVM1Movie.html +++ b/openfl/display/AVM1Movie.html @@ -1,7 +1,7 @@ -openfl.display.AVM1Movie - API Referenceopenfl.display.AVM1Movie - OpenFL API Reference
API Reference
View source

class AVM1Movie

package openfl.display

extends DisplayObject › EventDispatcher

@:fileXml("tags=\"haxe,release\"")@:noDebug@SuppressWarnings("checkstyle:Dynamic")

Available on AIR, Flash

AVM1Movie is a simple class that represents AVM1 movie clips, which use +

View source

class AVM1Movie

package openfl.display

extends DisplayObject › EventDispatcher

@:fileXml("tags=\"haxe,release\"")@:noDebug@SuppressWarnings("checkstyle:Dynamic")

Available on AIR, Flash

AVM1Movie is a simple class that represents AVM1 movie clips, which use ActionScript 1.0 or 2.0. (AVM1 is the ActionScript virtual machine used to run ActionScript 1.0 and 2.0. AVM2 is the ActionScript virtual machine used to run ActionScript 3.0.) When a Flash Player 8, or older, SWF file @@ -80,7 +80,7 @@ However, child Sprite objects, MovieClip objects, or other AVM1 SWF files loaded by this SWF file can load into this.

Inherited Variables

Defined by DisplayObject

@:keepalpha:Float

Indicates the alpha transparency value of the object specified. Valid values are 0 (fully transparent) to 1 (fully opaque). The default value is 1. -Display objects with alpha set to 0 are active, even though they are invisible.

blendMode:BlendMode

A value from the BlendMode class that specifies which blend mode to use. A +Display objects with alpha set to 0 are active, even though they are invisible.

See also:

blendMode:BlendMode

A value from the BlendMode class that specifies which blend mode to use. A bitmap can be drawn internally in two ways. If you have a blend mode enabled or an external clipping mask, the bitmap is drawn by adding a bitmap-filled square shape to the vector render. If you attempt to set @@ -100,7 +100,7 @@ BlendMode class defines string values you can use. The illustrations in the table show blendMode values applied to a circular display object(2) superimposed on another display object(1).

-

Square Number 1 Circle Number 2

BlendMode ConstantIllustrationDescription
BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
BlendMode.INVERTblend mode INVERTInverts the background.
BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

cacheAsBitmap:Bool

All vector data for a display object that has a cached bitmap is drawn +

Square Number 1 Circle Number 2

BlendMode ConstantIllustrationDescription
BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
BlendMode.INVERTblend mode INVERTInverts the background.
BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

See also:

cacheAsBitmap:Bool

All vector data for a display object that has a cached bitmap is drawn to the bitmap instead of the main display. If cacheAsBitmapMatrix is null or unsupported, the bitmap is then copied to the main display as unstretched, unrotated pixels snapped @@ -131,12 +131,12 @@ number of pixels cannot exceed 16,777,215 pixels.(So, if a bitmap image is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is is 2880 pixels in height and 2,880 pixels -in width.

  • The bitmap fails to allocate(out of memory error).
    • +in width.
  • The bitmap fails to allocate (out of memory error).

    • The cacheAsBitmap property is best used with movie clips that have mostly static content and that do not scale and rotate frequently. With such movie clips, cacheAsBitmap can lead to -performance increases when the movie clip is translated(when its x -and y position is changed).

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to +performance increases when the movie clip is translated (when its x +and y position is changed).

    See also:

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. The application uses this matrix as a transformation matrix that is applied when rendering the bitmap version of the display object.

    Adobe AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop @@ -170,16 +170,16 @@

    Note: The cacheAsBitmapMatrix property is suitable for 2D transformations. If you need to apply transformations in 3D, you may do so by setting a 3D property of the object and manipulating its transform.matrix3D property. If the application is packaged using GPU mode, this allows the 3D transforms -to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated +to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    See also:

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated with the display object. The openfl.filters package contains several classes that define specific filters you can use.

    Filters can be applied in Flash Professional at design time, or at run -time by using ActionScript code. To apply a filter by using ActionScript, +time by using Haxe code. To apply a filter by using Haxe, you must make a temporary copy of the entire filters array, modify the temporary array, then assign the value of the temporary array back to the filters array. You cannot directly add a new filter object to the filters array.

    -

    To add a filter by using ActionScript, perform the following steps +

    To add a filter by using Haxe, perform the following steps (assume that the target display object is named myDisplayObject):

    1. Create a new filter object by using the constructor method of your chosen filter class.
    2. Assign the value of the myDisplayObject.filters array @@ -210,7 +210,7 @@

      The openfl.filters package includes classes for filters. For example, to create a DropShadow filter, you would write:

      Throws:

      ArgumentError

      When filters includes a ShaderFilter and the shader output type is not compatible with -this operation(the shader must specify a +this operation (the shader must specify a pixel4 output).

      ArgumentError

      When filters includes a ShaderFilter and the shader doesn't specify any image input or the first input is not an image4 input.

      ArgumentError

      When filters includes a ShaderFilter @@ -228,10 +228,10 @@ is adjusted accordingly, as shown in the following code:

      Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a height of 0, even if you try to -set height to a different value.

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file +set height to a different value.

      See also:

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file to which this display object belongs. The loaderInfo property is defined only for the root display object of a SWF file or for a loaded -Bitmap(not for a Bitmap that is drawn with ActionScript). To find the +Bitmap (not for a Bitmap that is drawn with Haxe). To find the loaderInfo object associated with the SWF file that contains a display object named myDisplayObject, use myDisplayObject.root.loaderInfo.

      @@ -243,7 +243,7 @@ list. The mask object itself is not drawn. Set mask to null to remove the mask.

      To be able to scale a mask object, it must be on the display list. To -be able to drag a mask Sprite object(by calling its +be able to drag a mask Sprite object (by calling its startDrag() method), it must be on the display list. To call the startDrag() method for a mask sprite based on a mouseDown event being dispatched by the sprite, set the @@ -262,23 +262,23 @@ more than one calling display object. When the mask is assigned to a second display object, it is removed as the mask of the first object, and that object's mask property becomes -null.

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in +null.

      See also:

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned x -coordinate will reflect the non-rotated object.

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in +coordinate will reflect the non-rotated object.

      See also:

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned y -coordinate will reflect the non-rotated object.

      name:String

      Indicates the instance name of the DisplayObject. The object can be +coordinate will reflect the non-rotated object.

      See also:

      name:String

      Indicates the instance name of the DisplayObject. The object can be identified in the child list of its parent display object container by calling the getChildByName() method of the display object container.

      Throws:

      IllegalOperationError

      If you are attempting to set this property on an object that was placed on the timeline in the Flash authoring tool.

      opaqueBackground:Null<Int>

      Specifies whether the display object is opaque with a certain background color. A transparent bitmap contains alpha channel data and is drawn -transparently. An opaque bitmap has no alpha channel(and renders faster +transparently. An opaque bitmap has no alpha channel (and renders faster than a transparent bitmap). If the bitmap is opaque, you specify its own background color to use.

      -

      If set to a number value, the surface is opaque(not transparent) with +

      If set to a number value, the surface is opaque (not transparent) with the RGB background color that the number specifies. If set to null(the default value), the display object has a transparent background.

      @@ -290,7 +290,7 @@

      The opaque background region is not matched when calling the hitTestPoint() method with the shapeFlag parameter set to true.

      -

      The opaque background region does not respond to mouse events.

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display +

      The opaque background region does not respond to mouse events.

      See also:

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display object. Use the parent property to specify a relative path to display objects that are above the current display object in the display list hierarchy.

      @@ -299,7 +299,7 @@ 
      this.parent.parent.alpha = 20;

      Throws:

      SecurityError

      The parent display object belongs to a security sandbox to which you do not have access. You can avoid this situation by having the parent movie call -the Security.allowDomain() method.

      read onlyroot:DisplayObject

      For a display object in a loaded SWF file, the root property +the Security.allowDomain() method.

      See also:

    read onlyroot:DisplayObject

    For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. For a Bitmap object representing a loaded image file, the root property is the Bitmap object @@ -312,7 +312,7 @@ is a child of the top-most display object in a loaded SWF file.

    For example, if you create a new Sprite object by calling the Sprite() constructor method, its root property -is null until you add it to the display list(or to a display +is null until you add it to the display list (or to a display object container that is off the display list but that is a child of the top-most display object in a SWF file).

    For a loaded SWF file, even though the Loader object used to load the @@ -320,12 +320,12 @@ SWF file has its root property set to itself. The Loader object does not have its root property set until it is added as a child of a display object for which the root property is -set.

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its +set.

    See also:

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement my_video.rotation = 450 -is the same as my_video.rotation = 90.

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, +is the same as my_video.rotation = 90.

    See also:

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, the entire display object is scaled normally when any scale transformation is applied.

    When you define the scale9Grid property, the display @@ -353,11 +353,11 @@ the registration point. The default registration point is (0,0). 1.0 equals 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the +y property values, which are defined in whole pixels.

    See also:

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. The default registration point is (0,0). 1.0 is 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is +y property values, which are defined in whole pixels.

    See also:

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is cropped to the size defined by the rectangle, and it scrolls within the rectangle when you change the x and y properties of the scrollRect object.

    @@ -374,17 +374,17 @@ an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated 90° and you scroll it left and right, the display object actually scrolls -up and down.

    @:betashader:Shader

    BETA**

    +up and down.

    See also:

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to apply a post-process effect to multiple display objects at once, enable cacheAsBitmap or use the filters property with a ShaderFilter

    read onlystage:Stage

    The Stage of the display object. A Flash runtime application has only one Stage object. For example, you can create and load multiple display objects into the display list, and the stage property of each -display object refers to the same Stage object(even if the display object +display object refers to the same Stage object (even if the display object belongs to a loaded SWF file).

    If a display object is not added to the display list, its -stage property is set to null.

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color +stage property is set to null.

    See also:

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. The specific properties - matrix, colorTransform, and three read-only properties (concatenatedMatrix, concatenatedColorTransform, @@ -421,21 +421,21 @@ is adjusted accordingly, as shown in the following code:

    Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a width of 0, even if you try to set -width to a different value.

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative +width to a different value.

    See also:

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative +registration point position.

    See also:

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative +registration point position.

    See also:

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. Consider the following code, which shows how the rectangle returned can vary depending on the targetCoordinateSpace parameter that @@ -462,8 +462,8 @@ coordinates, respectively.

    Parameters:

    targetCoordinateSpace

    The display object that defines the coordinate system to use.

    Returns:

    The rectangle that defines the area of the display object relative to the targetCoordinateSpace object's coordinate -system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage(global) coordinates -to the display object's(local) coordinates.

    +system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage (global) coordinates +to the display object's (local) coordinates.

    To use this method, first create an instance of the Point class. The x and y values that you assign represent global coordinates because they relate to the origin(0,0) of the main display area. Then @@ -478,17 +478,17 @@ point specified by the x and y parameters. The x and y parameters specify a point in the coordinate space of the Stage, not the display object container that -contains the display object(unless that display object container is the +contains the display object (unless that display object container is the Stage).

    Parameters:

    x

    The x coordinate to test against this object.

    y

    The y coordinate to test against this object.

    shapeFlag

    Whether to check against the actual pixels of the object (true) or the bounding box (false).

    Returns:

    true if the display object overlaps or intersects with the specified point; false otherwise.

    invalidate():Void

    Calling the invalidate() method signals to have the current object -redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's(local) -coordinates to the Stage(global) coordinates.

    +redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's (local) +coordinates to the Stage (global) coordinates.

    This method allows you to convert any given x and y coordinates from values that are relative to the origin(0,0) of a -specific display object(local coordinates) to values that are relative to -the origin of the Stage(global coordinates).

    +specific display object (local coordinates) to values that are relative to +the origin of the Stage (global coordinates).

    To use this method, first create an instance of the Point class. The x and y values that you assign represent local coordinates because they relate to the origin of the display object.

    diff --git a/openfl/display/Application.html b/openfl/display/Application.html index 692b631..3ebf919 100644 --- a/openfl/display/Application.html +++ b/openfl/display/Application.html @@ -1,7 +1,7 @@ -openfl.display.Application - API Referenceopenfl.display.Application - OpenFL API Reference
    View source

    class Application

    package openfl.display

    extends Application

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.DisplayObject)@:access(openfl.display.LoaderInfo)@:access(openfl.display.Window)@:access(openfl.display.NativeWindowInitOptions)@SuppressWarnings("checkstyle:FieldDocComment")

    Available on all platforms

    The Application class is a Lime Application instance that uses +

    View source

    class Application

    package openfl.display

    extends Application

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.DisplayObject)@:access(openfl.display.LoaderInfo)@:access(openfl.display.Window)@:access(openfl.display.NativeWindowInitOptions)@SuppressWarnings("checkstyle:FieldDocComment")

    Available on all platforms

    The Application class is a Lime Application instance that uses OpenFL Window by default when a new window is created.

    Constructor

    new()

    Methods

    \ No newline at end of file diff --git a/openfl/display/Bitmap.html b/openfl/display/Bitmap.html index eec5d07..9fee63b 100644 --- a/openfl/display/Bitmap.html +++ b/openfl/display/Bitmap.html @@ -1,7 +1,7 @@ -openfl.display.Bitmap - API Referenceopenfl.display.Bitmap - OpenFL API Reference
    View source

    class Bitmap

    package openfl.display

    extends DisplayObject › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.BitmapData)@:access(openfl.display.Graphics)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)

    Available on all platforms

    The Bitmap class represents display objects that represent bitmap images. +

    View source

    class Bitmap

    package openfl.display

    extends DisplayObject › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.BitmapData)@:access(openfl.display.Graphics)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)

    Available on all platforms

    The Bitmap class represents display objects that represent bitmap images. These can be images that you load with the openfl.Assets or openfl.display.Loader classes, or they can be images that you create with the Bitmap() constructor.

    @@ -79,7 +79,7 @@

    Note: The Bitmap class is not a subclass of the InteractiveObject class, so it cannot dispatch mouse events. However, you can use the addEventListener() method of the display object container that -contains the Bitmap object.

    Constructor

    @:value({ smoothing : false, pixelSnapping : null, bitmapData : null })new(?bitmapData:BitmapData, ?pixelSnapping:PixelSnapping, smoothing:Bool = false)

    Initializes a Bitmap object to refer to the specified BitmapData object.

    Parameters:

    bitmapData

    The BitmapData object being referenced.

    pixelSnapping

    Whether or not the Bitmap object is snapped to the nearest pixel.

    smoothing

    Whether or not the bitmap is smoothed when scaled. For example, the following examples +contains the Bitmap object.

    See also:

    Constructor

    @:value({ smoothing : false, pixelSnapping : null, bitmapData : null })new(?bitmapData:BitmapData, ?pixelSnapping:PixelSnapping, smoothing:Bool = false)

    Initializes a Bitmap object to refer to the specified BitmapData object.

    Parameters:

    bitmapData

    The BitmapData object being referenced.

    pixelSnapping

    Whether or not the Bitmap object is snapped to the nearest pixel.

    smoothing

    Whether or not the bitmap is smoothed when scaled. For example, the following examples show the same bitmap scaled by a factor of 3, with smoothing set to false (left) and true (right): A bitmap without smoothing. A bitmap with smoothing.

    Variables

    bitmapData:BitmapData

    The BitmapData object being referenced.

    pixelSnapping:PixelSnapping

    Controls whether or not the Bitmap object is snapped to the nearest pixel. This value is ignored in the native and HTML5 targets. @@ -93,7 +93,7 @@ true, the bitmap is smoothed when scaled. If false, the bitmap is not smoothed when scaled.

    Inherited Variables

    Defined by DisplayObject

    @:keepalpha:Float

    Indicates the alpha transparency value of the object specified. Valid values are 0 (fully transparent) to 1 (fully opaque). The default value is 1. -Display objects with alpha set to 0 are active, even though they are invisible.

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A +Display objects with alpha set to 0 are active, even though they are invisible.

    See also:

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A bitmap can be drawn internally in two ways. If you have a blend mode enabled or an external clipping mask, the bitmap is drawn by adding a bitmap-filled square shape to the vector render. If you attempt to set @@ -113,7 +113,7 @@ BlendMode class defines string values you can use. The illustrations in the table show blendMode values applied to a circular display object(2) superimposed on another display object(1).

    -

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn +

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    See also:

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn to the bitmap instead of the main display. If cacheAsBitmapMatrix is null or unsupported, the bitmap is then copied to the main display as unstretched, unrotated pixels snapped @@ -144,12 +144,12 @@ number of pixels cannot exceed 16,777,215 pixels.(So, if a bitmap image is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is is 2880 pixels in height and 2,880 pixels -in width.

  • The bitmap fails to allocate(out of memory error).
    • +in width.
  • The bitmap fails to allocate (out of memory error).

    • The cacheAsBitmap property is best used with movie clips that have mostly static content and that do not scale and rotate frequently. With such movie clips, cacheAsBitmap can lead to -performance increases when the movie clip is translated(when its x -and y position is changed).

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to +performance increases when the movie clip is translated (when its x +and y position is changed).

    See also:

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. The application uses this matrix as a transformation matrix that is applied when rendering the bitmap version of the display object.

    Adobe AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop @@ -183,16 +183,16 @@

    Note: The cacheAsBitmapMatrix property is suitable for 2D transformations. If you need to apply transformations in 3D, you may do so by setting a 3D property of the object and manipulating its transform.matrix3D property. If the application is packaged using GPU mode, this allows the 3D transforms -to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated +to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    See also:

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated with the display object. The openfl.filters package contains several classes that define specific filters you can use.

    Filters can be applied in Flash Professional at design time, or at run -time by using ActionScript code. To apply a filter by using ActionScript, +time by using Haxe code. To apply a filter by using Haxe, you must make a temporary copy of the entire filters array, modify the temporary array, then assign the value of the temporary array back to the filters array. You cannot directly add a new filter object to the filters array.

    -

    To add a filter by using ActionScript, perform the following steps +

    To add a filter by using Haxe, perform the following steps (assume that the target display object is named myDisplayObject):

    1. Create a new filter object by using the constructor method of your chosen filter class.
    2. Assign the value of the myDisplayObject.filters array @@ -223,7 +223,7 @@

      The openfl.filters package includes classes for filters. For example, to create a DropShadow filter, you would write:

      Throws:

      ArgumentError

      When filters includes a ShaderFilter and the shader output type is not compatible with -this operation(the shader must specify a +this operation (the shader must specify a pixel4 output).

      ArgumentError

      When filters includes a ShaderFilter and the shader doesn't specify any image input or the first input is not an image4 input.

      ArgumentError

      When filters includes a ShaderFilter @@ -241,10 +241,10 @@ is adjusted accordingly, as shown in the following code:

      Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a height of 0, even if you try to -set height to a different value.

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file +set height to a different value.

      See also:

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file to which this display object belongs. The loaderInfo property is defined only for the root display object of a SWF file or for a loaded -Bitmap(not for a Bitmap that is drawn with ActionScript). To find the +Bitmap (not for a Bitmap that is drawn with Haxe). To find the loaderInfo object associated with the SWF file that contains a display object named myDisplayObject, use myDisplayObject.root.loaderInfo.

      @@ -256,7 +256,7 @@ list. The mask object itself is not drawn. Set mask to null to remove the mask.

      To be able to scale a mask object, it must be on the display list. To -be able to drag a mask Sprite object(by calling its +be able to drag a mask Sprite object (by calling its startDrag() method), it must be on the display list. To call the startDrag() method for a mask sprite based on a mouseDown event being dispatched by the sprite, set the @@ -275,23 +275,23 @@ more than one calling display object. When the mask is assigned to a second display object, it is removed as the mask of the first object, and that object's mask property becomes -null.

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in +null.

      See also:

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned x -coordinate will reflect the non-rotated object.

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in +coordinate will reflect the non-rotated object.

      See also:

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned y -coordinate will reflect the non-rotated object.

      name:String

      Indicates the instance name of the DisplayObject. The object can be +coordinate will reflect the non-rotated object.

      See also:

      name:String

      Indicates the instance name of the DisplayObject. The object can be identified in the child list of its parent display object container by calling the getChildByName() method of the display object container.

      Throws:

      IllegalOperationError

      If you are attempting to set this property on an object that was placed on the timeline in the Flash authoring tool.

      opaqueBackground:Null<Int>

      Specifies whether the display object is opaque with a certain background color. A transparent bitmap contains alpha channel data and is drawn -transparently. An opaque bitmap has no alpha channel(and renders faster +transparently. An opaque bitmap has no alpha channel (and renders faster than a transparent bitmap). If the bitmap is opaque, you specify its own background color to use.

      -

      If set to a number value, the surface is opaque(not transparent) with +

      If set to a number value, the surface is opaque (not transparent) with the RGB background color that the number specifies. If set to null(the default value), the display object has a transparent background.

      @@ -303,7 +303,7 @@

      The opaque background region is not matched when calling the hitTestPoint() method with the shapeFlag parameter set to true.

      -

      The opaque background region does not respond to mouse events.

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display +

      The opaque background region does not respond to mouse events.

      See also:

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display object. Use the parent property to specify a relative path to display objects that are above the current display object in the display list hierarchy.

      @@ -312,7 +312,7 @@ 
      this.parent.parent.alpha = 20;

      Throws:

      SecurityError

      The parent display object belongs to a security sandbox to which you do not have access. You can avoid this situation by having the parent movie call -the Security.allowDomain() method.

      read onlyroot:DisplayObject

      For a display object in a loaded SWF file, the root property +the Security.allowDomain() method.

      See also:

    read onlyroot:DisplayObject

    For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. For a Bitmap object representing a loaded image file, the root property is the Bitmap object @@ -325,7 +325,7 @@ is a child of the top-most display object in a loaded SWF file.

    For example, if you create a new Sprite object by calling the Sprite() constructor method, its root property -is null until you add it to the display list(or to a display +is null until you add it to the display list (or to a display object container that is off the display list but that is a child of the top-most display object in a SWF file).

    For a loaded SWF file, even though the Loader object used to load the @@ -333,12 +333,12 @@ SWF file has its root property set to itself. The Loader object does not have its root property set until it is added as a child of a display object for which the root property is -set.

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its +set.

    See also:

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement my_video.rotation = 450 -is the same as my_video.rotation = 90.

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, +is the same as my_video.rotation = 90.

    See also:

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, the entire display object is scaled normally when any scale transformation is applied.

    When you define the scale9Grid property, the display @@ -366,11 +366,11 @@ the registration point. The default registration point is (0,0). 1.0 equals 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the +y property values, which are defined in whole pixels.

    See also:

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. The default registration point is (0,0). 1.0 is 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is +y property values, which are defined in whole pixels.

    See also:

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is cropped to the size defined by the rectangle, and it scrolls within the rectangle when you change the x and y properties of the scrollRect object.

    @@ -387,17 +387,17 @@ an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated 90° and you scroll it left and right, the display object actually scrolls -up and down.

    @:betashader:Shader

    BETA**

    +up and down.

    See also:

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to apply a post-process effect to multiple display objects at once, enable cacheAsBitmap or use the filters property with a ShaderFilter

    read onlystage:Stage

    The Stage of the display object. A Flash runtime application has only one Stage object. For example, you can create and load multiple display objects into the display list, and the stage property of each -display object refers to the same Stage object(even if the display object +display object refers to the same Stage object (even if the display object belongs to a loaded SWF file).

    If a display object is not added to the display list, its -stage property is set to null.

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color +stage property is set to null.

    See also:

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. The specific properties - matrix, colorTransform, and three read-only properties (concatenatedMatrix, concatenatedColorTransform, @@ -434,21 +434,21 @@ is adjusted accordingly, as shown in the following code:

    Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a width of 0, even if you try to set -width to a different value.

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative +width to a different value.

    See also:

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative +registration point position.

    See also:

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative +registration point position.

    See also:

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. Consider the following code, which shows how the rectangle returned can vary depending on the targetCoordinateSpace parameter that @@ -475,8 +475,8 @@ coordinates, respectively.

    Parameters:

    targetCoordinateSpace

    The display object that defines the coordinate system to use.

    Returns:

    The rectangle that defines the area of the display object relative to the targetCoordinateSpace object's coordinate -system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage(global) coordinates -to the display object's(local) coordinates.

    +system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage (global) coordinates +to the display object's (local) coordinates.

    To use this method, first create an instance of the Point class. The x and y values that you assign represent global coordinates because they relate to the origin(0,0) of the main display area. Then @@ -491,17 +491,17 @@ point specified by the x and y parameters. The x and y parameters specify a point in the coordinate space of the Stage, not the display object container that -contains the display object(unless that display object container is the +contains the display object (unless that display object container is the Stage).

    Parameters:

    x

    The x coordinate to test against this object.

    y

    The y coordinate to test against this object.

    shapeFlag

    Whether to check against the actual pixels of the object (true) or the bounding box (false).

    Returns:

    true if the display object overlaps or intersects with the specified point; false otherwise.

    invalidate():Void

    Calling the invalidate() method signals to have the current object -redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's(local) -coordinates to the Stage(global) coordinates.

    +redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's (local) +coordinates to the Stage (global) coordinates.

    This method allows you to convert any given x and y coordinates from values that are relative to the origin(0,0) of a -specific display object(local coordinates) to values that are relative to -the origin of the Stage(global coordinates).

    +specific display object (local coordinates) to values that are relative to +the origin of the Stage (global coordinates).

    To use this method, first create an instance of the Point class. The x and y values that you assign represent local coordinates because they relate to the origin of the display object.

    diff --git a/openfl/display/BitmapData.html b/openfl/display/BitmapData.html index bc3b3fe..cfe763b 100644 --- a/openfl/display/BitmapData.html +++ b/openfl/display/BitmapData.html @@ -1,7 +1,7 @@ -openfl.display.BitmapData - API Referenceopenfl.display.BitmapData - OpenFL API Reference
    API Reference
    View source

    class BitmapData

    package openfl.display

    implements IBitmapDrawable

    @:directlyUsed@:access(lime.graphics.opengl.GL)@:access(lime.graphics.Image)@:access(lime.graphics.ImageBuffer)@:access(lime.math.Rectangle)@:access(openfl.display3D.textures.TextureBase)@:access(openfl.display3D.Context3D)@:access(openfl.display.DisplayObject)@:access(openfl.display.DisplayObjectShader)@:access(openfl.display.Graphics)@:access(openfl.display.Shader)@:access(openfl.filters.BitmapFilter)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Matrix)@:access(openfl.geom.Point)@:access(openfl.geom.Rectangle)@:fileXml("tags=\"haxe,release\"")@:noDebug@:autoBuild(openfl.utils._internal.AssetsMacro.embedBitmap())

    Available on all platforms

    The BitmapData class lets you work with the data (pixels) of a Bitmap +

    View source

    class BitmapData

    package openfl.display

    implements IBitmapDrawable

    @:directlyUsed@:access(lime.graphics.opengl.GL)@:access(lime.graphics.Image)@:access(lime.graphics.ImageBuffer)@:access(lime.math.Rectangle)@:access(openfl.display3D.textures.TextureBase)@:access(openfl.display3D.Context3D)@:access(openfl.display.DisplayObject)@:access(openfl.display.DisplayObjectShader)@:access(openfl.display.Graphics)@:access(openfl.display.Shader)@:access(openfl.filters.BitmapFilter)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Matrix)@:access(openfl.geom.Point)@:access(openfl.geom.Rectangle)@:fileXml("tags=\"haxe,release\"")@:noDebug@:autoBuild(openfl.utils._internal.AssetsMacro.embedBitmap())

    Available on all platforms

    The BitmapData class lets you work with the data (pixels) of a Bitmap object. You can use the methods of the BitmapData class to create arbitrarily sized transparent or opaque bitmap images and manipulate them in various ways at runtime. You can also access the BitmapData for a bitmap @@ -95,13 +95,13 @@ is 8,191 pixels in width or height, and the total number of pixels cannot exceed 16,777,215 pixels. (So, if a BitmapData object is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation -is 2,880 pixels in height and 2,880 in width.

    Static methods

    staticfromBase64(base64:String, type:String):BitmapData

    Available on Android, Linux, Neko, Windows, iOS, macOS

    Creates a new BitmapData instance from Base64-encoded data +is 2,880 pixels in height and 2,880 in width.

    See also:

    Static methods

    staticfromBase64(base64:String, type:String):BitmapData

    Available on Android, HashLink, Linux, Neko, Windows, iOS, macOS

    Creates a new BitmapData instance from Base64-encoded data synchronously. This means that the BitmapData will be returned immediately (if supported). The bytes must be of a supported bitmap file format, such as PNG or JPG. To use raw ARGB pixel data, call setPixels or setVector instead.

    HTML5 and Flash do not support creating BitmapData synchronously, so these targets -always return null. Other targets will return null if decoding was unsuccessful.

    Parameters:

    base64

    Base64-encoded data

    type

    The MIME-type for the encoded data ("image/jpeg", etc)

    Returns:

    A new BitmapData if successful, or null if unsuccessful

    @:value({ rawAlpha : null })staticfromBytes(bytes:ByteArray, ?rawAlpha:ByteArray):BitmapData

    Available on Android, Linux, Neko, Windows, iOS, macOS

    Creates a new BitmapData from bytes (a haxe.io.Bytes or +always return null. Other targets will return null if decoding was unsuccessful.

    Parameters:

    base64

    Base64-encoded data

    type

    The MIME-type for the encoded data ("image/jpeg", etc)

    Returns:

    A new BitmapData if successful, or null if unsuccessful

    @:value({ rawAlpha : null })staticfromBytes(bytes:ByteArray, ?rawAlpha:ByteArray):BitmapData

    Available on Android, HashLink, Linux, Neko, Windows, iOS, macOS

    Creates a new BitmapData from bytes (a haxe.io.Bytes or openfl.utils.ByteArray) synchronously. This means that the BitmapData will be returned immediately (if supported). The bytes must be of a supported bitmap file format, such as PNG or JPG. To use raw ARGB pixel @@ -111,7 +111,7 @@

    The optional rawAlpha parameter makes it easier to process images that have alpha data stored separately.

    Parameters:

    bytes

    A haxe.io.Bytes or openfl.utils.ByteArray instance

    rawAlpha

    An optional byte array with alpha data

    Returns:

    A new BitmapData if successful, or null if unsuccessful

    @:value({ transparent : true })staticfromCanvas(canvas:CanvasElement, transparent:Bool = true):BitmapData

    Available on HTML5

    Creates a new BitmapData from an HTML5 canvas element immediately.

    All targets except from HTML5 targets will return null.

    Parameters:

    canvas

    An HTML5 canvas element

    transparent

    Whether the new BitmapData object should be considered -transparent

    Returns:

    A new BitmapData if successful, or null if unsuccessful

    staticfromFile(path:String):BitmapData

    Available on Android, Linux, Neko, Windows, iOS, macOS

    Creates a new BitmapData from a file path synchronously. This means that the +transparent

    Returns:

    A new BitmapData if successful, or null if unsuccessful

    staticfromFile(path:String):BitmapData

    Available on Android, HashLink, Linux, Neko, Windows, iOS, macOS

    Creates a new BitmapData from a file path synchronously. This means that the BitmapData will be returned immediately (if supported).

    HTML5 and Flash do not support creating BitmapData synchronously, so these targets always return null.

    @@ -139,7 +139,7 @@ for the transparent parameter. After you create an opaque bitmap, you cannot change it to a transparent bitmap. Every pixel in an opaque bitmap uses only 24 bits of color channel information. If you define the bitmap as transparent, every pixel uses 32 bits of color -channel information, including an alpha transparency channel.

    Parameters:

    width

    The width of the bitmap image in pixels.

    height

    The height of the bitmap image in pixels.

    transparent

    Specifies whether the bitmap image supports per-pixel transparency. The default value is true(transparent). To create a fully transparent bitmap, set the value of the transparent parameter to true and the value of the fillColor parameter to 0x00000000(or to 0). Setting the transparent property to false can result in minor improvements in rendering performance.

    fillColor

    A 32-bit ARGB color value that you use to fill the bitmap image area. The default value is 0xFFFFFFFF(solid white).

    Variables

    read onlyheight:Int

    The height of the bitmap image in pixels.

    @SuppressWarnings("checkstyle:Dynamic")read onlyimage:Image

    The Lime image that holds the pixels for the current image.

    +channel information, including an alpha transparency channel.

    Parameters:

    width

    The width of the bitmap image in pixels.

    height

    The height of the bitmap image in pixels.

    transparent

    Specifies whether the bitmap image supports per-pixel transparency. The default value is true(transparent). To create a fully transparent bitmap, set the value of the transparent parameter to true and the value of the fillColor parameter to 0x00000000 (or to 0). Setting the transparent property to false can result in minor improvements in rendering performance.

    fillColor

    A 32-bit ARGB color value that you use to fill the bitmap image area. The default value is 0xFFFFFFFF (solid white).

    Variables

    read onlyheight:Int

    The height of the bitmap image in pixels.

    @SuppressWarnings("checkstyle:Dynamic")read onlyimage:Image

    The Lime image that holds the pixels for the current image.

    In Flash Player, this property is always null.

    @:betaread onlyreadable:Bool

    Defines whether the bitmap image is readable. Hardware-only bitmap images do not support getPixels, setPixels and other BitmapData methods, nor may they be used with @@ -169,7 +169,7 @@ pixels outside the sourceRect parameter to generate the destination rectangle.

    If the BitmapData object and the object specified as the sourceBitmapData parameter are the same object, the application uses a temporary copy of the object to -perform the filter. For best performance, avoid this situation.

    Parameters:

    sourceBitmapData

    The input bitmap image to use. The source image can be a different BitmapData object or it can refer to the current BitmapData instance.

    sourceRect

    A rectangle that defines the area of the source image to use as input.

    destPoint

    The point within the destination image(the current BitmapData instance) that corresponds to the upper-left corner of the source rectangle.

    filter

    The filter object that you use to perform the filtering operation.

    clone():BitmapData

    Returns a new BitmapData object that is a clone of the original instance with an exact copy of the contained bitmap.

    Returns:

    A new BitmapData object that is identical to the original.

    colorTransform(rect:Rectangle, colorTransform:ColorTransform):Void

    Adjusts the color values in a specified area of a bitmap image by using a ColorTransform +perform the filter. For best performance, avoid this situation.

    Parameters:

    sourceBitmapData

    The input bitmap image to use. The source image can be a different BitmapData object or it can refer to the current BitmapData instance.

    sourceRect

    A rectangle that defines the area of the source image to use as input.

    destPoint

    The point within the destination image (the current BitmapData instance) that corresponds to the upper-left corner of the source rectangle.

    filter

    The filter object that you use to perform the filtering operation.

    clone():BitmapData

    Returns a new BitmapData object that is a clone of the original instance with an exact copy of the contained bitmap.

    Returns:

    A new BitmapData object that is identical to the original.

    colorTransform(rect:Rectangle, colorTransform:ColorTransform):Void

    Adjusts the color values in a specified area of a bitmap image by using a ColorTransform object. If the rectangle matches the boundaries of the bitmap image, this method transforms the color values of the entire image.

    Parameters:

    rect

    A Rectangle object that defines the area of the image in which the ColorTransform object is applied.

    colorTransform

    A ColorTransform object that describes the color transformation values to apply.

    @SuppressWarnings("checkstyle:Dynamic")compare(otherBitmapData:BitmapData):Dynamic

    Compares two BitmapData objects. If the two BitmapData objects have the same dimensions (width and height), the method returns a new BitmapData object, in which each pixel is the "difference" between the pixels in the two source objects:

    • If two pixels are equal, the difference pixel is 0x00000000.
    • If two pixels have different RGB values (ignoring the alpha value), the difference pixel is 0xFFRRGGBB where RR/GG/BB are the individual difference values between red, green, and blue channels. Alpha channel differences are ignored in this case.
    • If only the alpha channel value is different, the pixel value is 0xZZFFFFFF, where ZZ is the difference in the alpha value.

    Parameters:

    otherBitmapData

    The BitmapData object to compare with the source BitmapData object.

    Returns:

    If the two BitmapData objects have the same dimensions (width and height), the method returns a new BitmapData object that has the difference between the two objects (see the main discussion).If the BitmapData objects are equivalent, the method returns the number 0. If no argument is passed or if the argument is not a BitmapData object, the method returns -1. If either BitmapData object has been disposed of, the method returns -2. If the widths of the BitmapData objects are not equal, the method returns the number -3. If the heights of the BitmapData objects are not equal, the method returns the number -4.

    copyChannel(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, sourceChannel:BitmapDataChannel, destChannel:BitmapDataChannel):Void

    Transfers data from one channel of another BitmapData object or the current BitmapData object into a channel of the current BitmapData object. @@ -199,7 +199,7 @@

    BitmapDataChannel.BLUE, BitmapDataChannel.GREEN, -BitmapDataChannel.ALPHA).

    Throws:

    TypeError

    The sourceBitmapData, sourceRect or destPoint are null.

    @:value({ mergeAlpha : false, alphaPoint : null, alphaBitmapData : null })copyPixels(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, ?alphaBitmapData:BitmapData, ?alphaPoint:Point, mergeAlpha:Bool = false):Void

    Provides a fast routine to perform pixel manipulation between images with +BitmapDataChannel.ALPHA).

    Throws:

    TypeError

    The sourceBitmapData, sourceRect or destPoint are null.

    See also:

    @:value({ mergeAlpha : false, alphaPoint : null, alphaBitmapData : null })copyPixels(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, ?alphaBitmapData:BitmapData, ?alphaPoint:Point, mergeAlpha:Bool = false):Void

    Provides a fast routine to perform pixel manipulation between images with no stretching, rotation, or color effects. This method copies a rectangular area of a source image to a rectangular area of the same size at the destination point of the destination BitmapData object.

    @@ -225,7 +225,7 @@ that corresponds to the upper-left corner of the sourceRect parameter.

    mergeAlpha

    To use the alpha channel, set the value to true. To copy pixels with no alpha -channel, set the value to false.

    Throws:

    TypeError

    The sourceBitmapData, sourceRect, destPoint are null.

    dispose():Void

    Frees memory that is used to store the BitmapData object.

    +channel, set the value to false.

    Throws:

    TypeError

    The sourceBitmapData, sourceRect, destPoint are null.

    See also:

    dispose():Void

    Frees memory that is used to store the BitmapData object.

    When the dispose() method is called on an image, the width and height of the image are set to 0. All subsequent calls to methods or properties of this BitmapData instance fail, and an exception is thrown.

    @@ -244,7 +244,7 @@ buffer will be available to garbage collection after a hardware texture has been created internally.

    BitmapData.disposeImage() will immediately change the value of -the readable property to false.

    @:value({ smoothing : false, clipRect : null, blendMode : null, colorTransform : null, matrix : null })draw(source:IBitmapDrawable, ?matrix:Matrix, ?colorTransform:ColorTransform, ?blendMode:BlendMode, ?clipRect:Rectangle, smoothing:Bool = false):Void

    Draws the source display object onto the bitmap image, using +the readable property to false.

    @:value({ smoothing : false, clipRect : null, blendMode : null, colorTransform : null, matrix : null })draw(source:IBitmapDrawable, ?matrix:Matrix, ?colorTransform:ColorTransform, ?blendMode:BlendMode, ?clipRect:Rectangle, smoothing:Bool = false):Void

    Draws the source display object onto the bitmap image, using the OpenFL software renderer. You can specify matrix, colorTransform, blendMode, and a destination clipRect parameter to control how the rendering performs. @@ -253,7 +253,7 @@

    The source display object does not use any of its applied transformations for this call. It is treated as it exists in the library or file, with no matrix transform, no color transform, and no blend mode. -To draw a display object(such as a movie clip) by using its own transform +To draw a display object (such as a movie clip) by using its own transform properties, you can copy its transform property object to the transform property of the Bitmap object that uses the BitmapData object.

    Parameters:

    source

    The display object or BitmapData object to draw to @@ -295,14 +295,14 @@ smoothing set to false.

    Throws:

    ArgumentError

    The source parameter is not a BitmapData or DisplayObject object.

    ArgumentError

    The source is null or not a valid IBitmapDrawable -object.

    SecurityError

    The source object and(in the case of a +object.

    SecurityError

    The source object and (in the case of a Sprite or MovieClip object) all of its child objects do not come from the same domain as the caller, or are not in a content that is accessible to the caller by having called the Security.allowDomain() method. This restriction does not apply to AIR content in the -application security sandbox.

    @:value({ quality : null, smoothing : false, clipRect : null, blendMode : null, colorTransform : null, matrix : null })drawWithQuality(source:IBitmapDrawable, ?matrix:Matrix, ?colorTransform:ColorTransform, ?blendMode:BlendMode, ?clipRect:Rectangle, smoothing:Bool = false, ?quality:StageQuality):Void

    Draws the source display object onto the bitmap image, using the Flash runtime +application security sandbox.

    See also:

    @:value({ quality : null, smoothing : false, clipRect : null, blendMode : null, colorTransform : null, matrix : null })drawWithQuality(source:IBitmapDrawable, ?matrix:Matrix, ?colorTransform:ColorTransform, ?blendMode:BlendMode, ?clipRect:Rectangle, smoothing:Bool = false, ?quality:StageQuality):Void

    Draws the source display object onto the bitmap image, using the Flash runtime vector renderer. You can specify matrix, colorTransform, blendMode, and a destination clipRect parameter to control how the rendering performs. Optionally, you can specify whether the bitmap should be smoothed when scaled @@ -369,7 +369,7 @@ object) all of its child objects do not come from the same domain as the caller, or are not in a content that is accessible to the caller by having called the Security.allowDomain() method. This restriction does not apply to AIR content -in the application security sandbox.

    ArgumentError

    The source is null or not a valid IBitmapDrawable object.

    @:value({ byteArray : null })encode(rect:Rectangle, compressor:Object, ?byteArray:ByteArray):ByteArray

    Compresses this BitmapData object using the selected compressor algorithm and +in the application security sandbox.

    ArgumentError

    The source is null or not a valid IBitmapDrawable object.

    See also:

    @:value({ byteArray : null })encode(rect:Rectangle, compressor:Object, ?byteArray:ByteArray):ByteArray

    Compresses this BitmapData object using the selected compressor algorithm and returns a new ByteArray object. Optionally, writes the resulting data to the specified ByteArray. The compressor argument specifies the encoding algorithm, and can be PNGEncoderOptions, JPEGEncoderOptions, or JPEGXREncoderOptions.

    @@ -379,7 +379,7 @@ var byteArray:ByteArray = new ByteArray(); bitmapData.encode(new Rectangle(0,0,640,480), new openfl.display.JPEGEncoderOptions(), byteArray);

    Parameters:

    rect

    The area of the BitmapData object to compress.

    compressor

    The compressor type to use. Valid values are: flash.display.PNGEncoderOptions, flash.display.JPEGEncoderOptions, and -flash.display.JPEGXREncoderOptions.

    byteArray

    The output ByteArray to hold the encoded image.

    Returns:

    A ByteArray containing the encoded image.

    fillRect(rect:Rectangle, color:Int):Void

    Fills a rectangular area of pixels with a specified ARGB color.

    Parameters:

    rect

    The rectangular area to fill.

    color

    The ARGB color value that fills the area. ARGB colors are +flash.display.JPEGXREncoderOptions.

    byteArray

    The output ByteArray to hold the encoded image.

    Returns:

    A ByteArray containing the encoded image.

    See also:

    fillRect(rect:Rectangle, color:Int):Void

    Fills a rectangular area of pixels with a specified ARGB color.

    Parameters:

    rect

    The rectangular area to fill.

    color

    The ARGB color value that fills the area. ARGB colors are often specified in hexadecimal format; for example, 0xFF336699.

    Throws:

    TypeError

    The rect is null.

    floodFill(x:Int, y:Int, color:Int):Void

    Performs a flood fill operation on an image starting at an(x, y) coordinate and filling with a certain color. The @@ -403,9 +403,9 @@ as input.

    filter

    A filter object that you use to calculate the destination rectangle.

    Returns:

    A destination rectangle computed by using an image, the sourceRect parameter, and a filter.

    Throws:

    TypeError

    The sourceRect or filter are null.

    @:value({ findColor : true })getColorBoundsRect(mask:Int, color:Int, findColor:Bool = true):Rectangle

    Determines a rectangular region that either fully encloses all pixels of a -specified color within the bitmap image(if the findColor +specified color within the bitmap image (if the findColor parameter is set to true) or fully encloses all pixels that -do not include the specified color(if the findColor +do not include the specified color (if the findColor parameter is set to false).

    For example, if you have a source image and you want to determine the rectangle of the image that contains a nonzero alpha channel, pass @@ -442,7 +442,7 @@ set operation, the pixel value is premultiplied before the raw image pixel is set.

    Parameters:

    x

    The x position of the pixel.

    y

    The y position of the pixel.

    Returns:

    A number that represents an RGB pixel value. If the(x, y) coordinates are outside the bounds of the image, the -method returns 0.

    getPixel32(x:Int, y:Int):Int

    Returns an ARGB color value that contains alpha channel data and RGB data. +method returns 0.

    See also:

    getPixel32(x:Int, y:Int):Int

    Returns an ARGB color value that contains alpha channel data and RGB data. This method is similar to the getPixel() method, which returns an RGB color without alpha channel data.

    All pixels in a BitmapData object are stored as premultiplied color @@ -456,10 +456,10 @@ set operation, the pixel value is premultiplied before the raw image pixel is set.

    Parameters:

    x

    The x position of the pixel.

    y

    The y position of the pixel.

    Returns:

    A number representing an ARGB pixel value. If the(x, y) coordinates are outside the bounds of the image, 0 is -returned.

    getPixels(rect:Rectangle):ByteArray

    Generates a byte array from a rectangular region of pixel data. Writes an -unsigned integer(a 32-bit unmultiplied pixel value) for each pixel into +returned.

    See also:

    getPixels(rect:Rectangle):ByteArray

    Generates a byte array from a rectangular region of pixel data. Writes an +unsigned integer (a 32-bit unmultiplied pixel value) for each pixel into the byte array.

    Parameters:

    rect

    A rectangular area in the current BitmapData object.

    Returns:

    A ByteArray representing the pixels in the given Rectangle.

    Throws:

    TypeError

    The rect is null.

    getVector(rect:Rectangle):Vector<UInt>

    Generates a vector array from a rectangular region of pixel data. Returns -a Vector object of unsigned integers(a 32-bit unmultiplied pixel value) +a Vector object of unsigned integers (a 32-bit unmultiplied pixel value) for the specified rectangle.

    Parameters:

    rect

    A rectangular area in the current BitmapData object.

    Returns:

    A Vector representing the given Rectangle.

    Throws:

    TypeError

    The rect is null.

    @:value({ hRect : null })histogram(?hRect:Rectangle):Array<Array<Int>>

    Computes a 256-value binary number histogram of a BitmapData object. This method returns a Vector object containing four Vector instances (four Vector objects that contain Float objects). The four Vector instances represent the @@ -514,8 +514,8 @@ value. The noise function is a mapping function, not a true random-number generation function, so it creates the same results each time from the same -random seed.

    low

    The lowest value to generate for each channel(0 to -255).

    high

    The highest value to generate for each channel(0 to +random seed.

    low

    The lowest value to generate for each channel (0 to +255).

    high

    The highest value to generate for each channel (0 to 255).

    channelOptions

    A number that can be a combination of any of the four color channel values

    				 (`BitmapDataChannel.RED`,
@@ -528,7 +528,7 @@
 a grayscale image is created by setting all of the
 color channels to the same value. The alpha channel
 selection is not affected by setting this parameter
-to true.

    @:value({ alphaArray : null, blueArray : null, greenArray : null, redArray : null })paletteMap(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, ?redArray:Array<Int>, ?greenArray:Array<Int>, ?blueArray:Array<Int>, ?alphaArray:Array<Int>):Void

    Remaps the color channel values in an image that has up to four arrays of +to true.

    See also:

    @:value({ alphaArray : null, blueArray : null, greenArray : null, redArray : null })paletteMap(sourceBitmapData:BitmapData, sourceRect:Rectangle, destPoint:Point, ?redArray:Array<Int>, ?greenArray:Array<Int>, ?blueArray:Array<Int>, ?alphaArray:Array<Int>):Void

    Remaps the color channel values in an image that has up to four arrays of color palette data, one for each channel.

    Flash runtimes use the following steps to generate the resulting image:

    1. After the red, green, blue, and alpha values are computed, they are added together using standard 32-bit-integer arithmetic.
    2. The red, green, blue, and alpha channel values of each pixel are extracted @@ -550,7 +550,7 @@ as input.

      destPoint

      The point within the destination image (the current BitmapData object) that corresponds to the upper-left corner of the source rectangle.

      redArray

      If redArray is not null, red = redArray[source red value] else red = source rect value.

      greenArray

      If greenArray is not null, green = greenArray[source green value] else green = source green value.

      blueArray

      If blueArray is not null, blue = blueArray[source blue value] else blue = source blue value`.

      alphaArray

      If alphaArray is not null, alpha = alphaArray[source alpha value] else alpha = source alpha value`.

      Throws:

      TypeError

      The sourceBitmapData, sourceRect or destPoint are null.

    @:value({ offsets : null, grayScale : false, channelOptions : 7 })perlinNoise(baseX:Float, baseY:Float, numOctaves:UInt, randomSeed:Int, stitch:Bool, fractalNoise:Bool, channelOptions:UInt = 7, grayScale:Bool = false, ?offsets:Array<Point>):Void

    Generates a Perlin noise image.

    The Perlin noise generation algorithm interpolates and combines -individual random noise functions(called octaves) into a single function +individual random noise functions (called octaves) into a single function that generates more natural-seeming random noise. Like musical octaves, each octave function is twice the frequency of the one before it. Perlin noise has been described as a "fractal sum of noise" because it combines @@ -600,8 +600,8 @@ a grayscale image is created by setting each of the red, green, and blue color channels to identical values. The alpha channel value is not affected if -this value is set to true.

    scroll(x:Int, y:Int):Void

    Scrolls an image by a certain(x, y) pixel amount. Edge -regions outside the scrolling area are left unchanged.

    Parameters:

    x

    The amount by which to scroll horizontally.

    y

    The amount by which to scroll vertically.

    setPixel(x:Int, y:Int, color:Int):Void

    Sets a single pixel of a BitmapData object. The current alpha channel +this value is set to true.

    See also:

    scroll(x:Int, y:Int):Void

    Scrolls an image by a certain(x, y) pixel amount. Edge +regions outside the scrolling area are left unchanged.

    Parameters:

    x

    The amount by which to scroll horizontally.

    y

    The amount by which to scroll vertically.

    See also:

    setPixel(x:Int, y:Int, color:Int):Void

    Sets a single pixel of a BitmapData object. The current alpha channel value of the image pixel is preserved during this operation. The value of the RGB color parameter is treated as an unmultiplied color value.

    Note: To increase performance, when you use the @@ -610,7 +610,7 @@ setPixel() or setPixel32() method, and then call the unlock() method when you have made all pixel changes. This process prevents objects that reference this BitmapData instance from -updating until you finish making the pixel changes.

    Parameters:

    x

    The x position of the pixel whose value changes.

    y

    The y position of the pixel whose value changes.

    color

    The resulting RGB color for the pixel.

    setPixel32(x:Int, y:Int, color:Int):Void

    Sets the color and alpha transparency values of a single pixel of a +updating until you finish making the pixel changes.

    Parameters:

    x

    The x position of the pixel whose value changes.

    y

    The y position of the pixel whose value changes.

    color

    The resulting RGB color for the pixel.

    See also:

    setPixel32(x:Int, y:Int, color:Int):Void

    Sets the color and alpha transparency values of a single pixel of a BitmapData object. This method is similar to the setPixel() method; the main difference is that the setPixel32() method takes an ARGB color value that contains alpha channel information.

    @@ -632,7 +632,7 @@ This process prevents objects that reference this BitmapData instance from updating until you finish making the pixel changes.

    Parameters:

    x

    The x position of the pixel whose value changes.

    y

    The y position of the pixel whose value changes.

    color

    The resulting ARGB color for the pixel. If the bitmap is opaque(not transparent), the alpha transparency portion of -this color value is ignored.

    setPixels(rect:Rectangle, byteArray:ByteArray):Void

    Converts a byte array into a rectangular region of pixel data. For each +this color value is ignored.

    See also:

    setPixels(rect:Rectangle, byteArray:ByteArray):Void

    Converts a byte array into a rectangular region of pixel data. For each pixel, the ByteArray.readUnsignedInt() method is called and the return value is written into the pixel. If the byte array ends before the full rectangle is written, the function returns. The data in the byte diff --git a/openfl/display/BitmapDataChannel.html b/openfl/display/BitmapDataChannel.html index 47e7dc4..dfa8f11 100644 --- a/openfl/display/BitmapDataChannel.html +++ b/openfl/display/BitmapDataChannel.html @@ -1,7 +1,7 @@ -openfl.display.BitmapDataChannel - API Referenceopenfl.display.BitmapDataChannel - OpenFL API Reference

    View source

    enum abstract BitmapDataChannel(Int)

    package openfl.display

    from Int, UInt to Int, UInt

    @:enum

    Available on all platforms

    The BitmapDataChannel class is an enumeration of constant values that +

    View source

    enum abstract BitmapDataChannel(Int)

    package openfl.display

    from Int, UInt to Int, UInt

    @:enum

    Available on all platforms

    The BitmapDataChannel class is an enumeration of constant values that indicate which channel to use: red, blue, green, or alpha transparency.

    When you call some methods, you can use the bitwise OR operator (|) to combine BitmapDataChannel constants to indicate @@ -63,4 +63,4 @@ parameters of the openfl.display.BitmapData.copyChannel() method

  • The channelOptions parameter of the openfl.display.BitmapData.noise() method
  • The openfl.filters.DisplacementMapFilter.componentX and -openfl.filters.DisplacementMapFilter.componentY properties

    • Variables

    @:value(cast 8)@:impl@:enuminlineread onlyALPHA:BitmapDataChannel = 8

    The alpha channel.

    @:value(cast 4)@:impl@:enuminlineread onlyBLUE:BitmapDataChannel = 4

    The blue channel.

    @:value(cast 2)@:impl@:enuminlineread onlyGREEN:BitmapDataChannel = 2

    The green channel.

    @:value(cast 1)@:impl@:enuminlineread onlyRED:BitmapDataChannel = 1

    The red channel.

    \ No newline at end of file +openfl.filters.DisplacementMapFilter.componentY properties

    See also:

    Variables

    @:value(cast 8)@:impl@:enuminlineread onlyALPHA:BitmapDataChannel = 8

    The alpha channel.

    @:value(cast 4)@:impl@:enuminlineread onlyBLUE:BitmapDataChannel = 4

    The blue channel.

    @:value(cast 2)@:impl@:enuminlineread onlyGREEN:BitmapDataChannel = 2

    The green channel.

    @:value(cast 1)@:impl@:enuminlineread onlyRED:BitmapDataChannel = 1

    The red channel.

    \ No newline at end of file diff --git a/openfl/display/BlendMode.html b/openfl/display/BlendMode.html index c6b44e0..faf679d 100644 --- a/openfl/display/BlendMode.html +++ b/openfl/display/BlendMode.html @@ -1,7 +1,7 @@ -openfl.display.BlendMode - API Referenceopenfl.display.BlendMode - OpenFL API Reference
    View source

    enum abstract BlendMode(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    A class that provides constant values for visual blend mode effects. These +

    View source

    enum abstract BlendMode(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    A class that provides constant values for visual blend mode effects. These constants are used in the following:

    • The blendMode property of the openfl.display.DisplayObject class.
    • The blendMode parameter of the draw() -method of the openfl.display.BitmapData class

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyADD:BlendMode = 0

    Adds the values of the constituent colors of the display object to the +method of the openfl.display.BitmapData class

    See also:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyADD:BlendMode = 0

    Adds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.

    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the -resulting RGB value for the displayed pixel is 0xFFC833(because 0xAA + +resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).

    @:value(cast 1)@:impl@:enuminlineread onlyALPHA:BlendMode = 1

    Applies the alpha value of each pixel of the display object to the background. This requires the blendMode property of the parent display object be set to openfl.display.BlendMode.LAYER.

    Not supported under GPU rendering.

    @:value(cast 2)@:impl@:enuminlineread onlyDARKEN:BlendMode = 2

    Selects the darker of the constituent colors of the display object and the -colors of the background(the colors with the smaller values). This +colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.

    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the -resulting RGB value for the displayed pixel is 0xDDCC00(because 0xFF > +resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33).

    Not supported under GPU rendering.

    @:value(cast 3)@:impl@:enuminlineread onlyDIFFERENCE:BlendMode = 3

    Compares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two @@ -79,7 +79,7 @@ for more vibrant colors.

    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the -resulting RGB value for the displayed pixel is 0x222C33(because 0xFF - +resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).

    @:value(cast 4)@:impl@:enuminlineread onlyERASE:BlendMode = 4

    Erases the background based on the alpha value of the display object. This process requires that the blendMode property of the parent display object be set to openfl.display.BlendMode.LAYER.

    @@ -96,17 +96,17 @@ object is a display object container that has at least one child object with a blendMode setting other than "normal".

    Not supported under GPU rendering.

    @:value(cast 8)@:impl@:enuminlineread onlyLIGHTEN:BlendMode = 8

    Selects the lighter of the constituent colors of the display object and -the colors of the background(the colors with the larger values). This +the colors of the background (the colors with the larger values). This setting is commonly used for superimposing type.

    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the -resulting RGB value for the displayed pixel is 0xFFF833(because 0xFF > +resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33).

    Not supported under GPU rendering.

    @:value(cast 9)@:impl@:enuminlineread onlyMULTIPLY:BlendMode = 9

    Multiplies the values of the display object constituent colors by the constituent colors of the background color, and normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.

    -

    For example, if a constituent color(such as red) of one pixel in the +

    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker @@ -119,7 +119,7 @@ background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects.

    -

    Not supported under GPU rendering.

    @:value(cast 12)@:impl@:enuminlineread onlySCREEN:BlendMode = 12

    Multiplies the complement(inverse) of the display object color by the +

    Not supported under GPU rendering.

    @:value(cast 12)@:impl@:enuminlineread onlySCREEN:BlendMode = 12

    Multiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.

    @:value(cast 13)@:impl@:enuminlineread onlySHADER:BlendMode = 13

    Uses a shader to define the blend between objects.

    @@ -138,5 +138,5 @@ commonly used for animating a darkening dissolve between two objects.

    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the -resulting RGB value for the displayed pixel is 0x338400(because 0xDD - +resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).

    \ No newline at end of file diff --git a/openfl/display/CairoRenderer.html b/openfl/display/CairoRenderer.html index 4772737..0d2267b 100644 --- a/openfl/display/CairoRenderer.html +++ b/openfl/display/CairoRenderer.html @@ -1,7 +1,7 @@ -openfl.display.CairoRenderer - API Reference
    View source

    class CairoRenderer

    package openfl.display

    extends DisplayObjectRenderer › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.DisplayObject)@:access(openfl.display.Graphics)@:access(openfl.display.IBitmapDrawable)@:access(openfl.display.Stage)@:access(openfl.display.Stage3D)@:allow(openfl.display._internal)@:allow(openfl.display)

    Available on all platforms

    BETA**

    +
    View source

    class CairoRenderer

    package openfl.display

    extends DisplayObjectRenderer › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.DisplayObject)@:access(openfl.display.Graphics)@:access(openfl.display.IBitmapDrawable)@:access(openfl.display.Stage)@:access(openfl.display.Stage3D)@:allow(openfl.display._internal)@:allow(openfl.display)

    Available on all platforms

    BETA**

    The CairoRenderer API exposes support for native Cairo render instructions within the RenderEvent.RENDER_CAIRO event

    Variables

    @SuppressWarnings("checkstyle:Dynamic")cairo:CairoRenderContext

    The current Cairo render context

    Methods

    @:value({ cairo : null })@SuppressWarnings("checkstyle:Dynamic")applyMatrix(transform:Matrix, ?cairo:Cairo):Void

    Set the matrix value for the current render context, or (optionally) another Cairo object

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that @@ -128,7 +128,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/display/CanvasRenderer.html b/openfl/display/CanvasRenderer.html index fc0bc53..5190101 100644 --- a/openfl/display/CanvasRenderer.html +++ b/openfl/display/CanvasRenderer.html @@ -1,7 +1,7 @@ -openfl.display.CanvasRenderer - API Reference

    View source

    class CanvasRenderer

    package openfl.display

    extends DisplayObjectRenderer › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.DisplayObject)@:access(openfl.display.IBitmapDrawable)@:access(openfl.display.Stage)@:access(openfl.display.Stage3D)@:allow(openfl.display._internal)@:allow(openfl.display)@:allow(openfl.text)

    Available on all platforms

    BETA**

    +
    View source

    class CanvasRenderer

    package openfl.display

    extends DisplayObjectRenderer › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.DisplayObject)@:access(openfl.display.IBitmapDrawable)@:access(openfl.display.Stage)@:access(openfl.display.Stage3D)@:allow(openfl.display._internal)@:allow(openfl.display)@:allow(openfl.text)

    Available on all platforms

    BETA**

    The CanvasRenderer API exposes support for HTML5 canvas render instructions within the RenderEvent.RENDER_CANVAS event

    Variables

    @SuppressWarnings("checkstyle:Dynamic")context:Canvas2DRenderContext

    The current HTML5 canvas render context

    Methods

    @SuppressWarnings("checkstyle:Dynamic")applySmoothing(context:Canvas2DRenderContext, value:Bool):Void

    Set whether smoothing should be enabled on a canvas context

    @:value({ context : null })@SuppressWarnings("checkstyle:Dynamic")setTransform(transform:Matrix, ?context:Canvas2DRenderContext):Void

    Set the matrix value for the current render context, or (optionally) another canvas context

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that @@ -128,7 +128,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/display/CapsStyle.html b/openfl/display/CapsStyle.html index b244e0a..8fc1792 100644 --- a/openfl/display/CapsStyle.html +++ b/openfl/display/CapsStyle.html @@ -1,7 +1,7 @@ -openfl.display.CapsStyle - API Referenceopenfl.display.CapsStyle - OpenFL API Reference

    API Reference
    View source

    enum abstract CapsStyle(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The CapsStyle class is an enumeration of constant values that specify the +

    View source

    enum abstract CapsStyle(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The CapsStyle class is an enumeration of constant values that specify the caps style to use in drawing lines. The constants are provided for use as values in the caps parameter of the openfl.display.Graphics.lineStyle() method. You can specify the diff --git a/openfl/display/ChildAccess.html b/openfl/display/ChildAccess.html index 864c72b..9c71440 100644 --- a/openfl/display/ChildAccess.html +++ b/openfl/display/ChildAccess.html @@ -1,7 +1,7 @@ -openfl.display.ChildAccess - API Referenceopenfl.display.ChildAccess - OpenFL API Reference

    View source

    abstract ChildAccess<T>(T)

    package openfl.display

    from T to T,

    @:access(openfl.display.DisplayObject)@:transitive@:forward

    Available on all platforms

    The ChildAccess abstract simplifies access to nested DisplayObjects. Although +

    View source

    abstract ChildAccess<T>(T)

    package openfl.display

    from T to T,

    @:access(openfl.display.DisplayObject)@:transitive@:forward

    Available on all platforms

    The ChildAccess abstract simplifies access to nested DisplayObjects. Although performance may be somewhat slower than using direct references, this is especially useful when setting up a UI or performing non-intensive tasks.

    For example, consider the following hierarchy:

    @@ -72,4 +72,4 @@

    You can use array access to reach child instances as well. This is useful if the child object has the name of a DisplayObject property, or if it uses special characters:

    var movieClip:ChildAccess<MovieClip> = movieClip;
-movieClip.sprite["sprite2"].x = 100;

    Static variables

    staticalpha:Float

    Accesses the alpha property.

    staticantiAliasType:AntiAliasType

    Accesses the antiAliasType property (for TextField instances only).

    staticautoSize:TextFieldAutoSize

    Accesses the autoSize property (for TextField instances only).

    staticbackground:Bool

    Accesses the background property (for TextField instances only).

    staticbackgroundColor:Int

    Accesses the backgroundColor property (for TextField instances only).

    staticbitmapData:BitmapData

    Accesses the bitmapData property (for Bitmap instances only).

    staticblendMode:BlendMode

    Accesses the blendMode property.

    staticborder:Bool

    Accesses the border property (for TextField instances only).

    staticborderColor:Int

    Accesses the borderColor property (for TextField instances only).

    staticread onlybottomScrollV:Int

    Accesses the bottomScrollV property (for TextField instances only).

    staticbuttonMode:Bool

    Accesses the buttonMode property (for Sprite instances only).

    staticcacheAsBitmap:Bool

    Accesses the cacheAsBitmap property.

    staticcacheAsBitmapMatrix:Matrix

    Accesses the cacheAsBitmapMatrix property.

    staticread onlycaretIndex:Int

    Accesses the caretIndex property (for TextField instances only).

    staticcondenseWhite:Bool

    Accesses the condenseWhite property (for TextField instances only).

    staticread onlycurrentFrame:Int

    Accesses the currentFrame property (for MovieClip instances only).

    staticread onlycurrentFrameLabel:String

    Accesses the currentFrameLabel property (for MovieClip instances only).

    staticread onlycurrentLabel:String

    Accesses the currentLabel property (for MovieClip instances only).

    staticread onlycurrentLabels:Array<FrameLabel>

    Accesses the currentLabels property (for MovieClip instances only).

    staticread onlycurrentScene:Scene

    Accesses the currentScene property (for MovieClip instances only).

    staticdeblocking:Int

    Accesses the deblocking property (for Video instances only).

    staticdefaultTextFormat:TextFormat

    Accesses the defaultTextFormat property (for TextField instances only).

    staticdisplayAsPassword:Bool

    Accesses the displayAsPassword property (for TextField instances only).

    staticdoubleClickEnabled:Bool

    Accesses the doubleClickEnabled property (for InteractiveObject instances only).

    staticread onlydropTarget:DisplayObject

    Accesses the dropTarget property (for Sprite instances only).

    staticembedFonts:Bool

    Accesses the embedFonts property (for TextField instances only).

    staticenabled:Bool

    Accesses the enabled property (for MovieClip instances only).

    staticfilters:Array<BitmapFilter>

    Accesses the filters property.

    staticfocusRect:Null<Bool>

    Accesses the focusRect property (for InteractiveObject instances only).

    staticread onlyframesLoaded:Int

    Accesses the framesLoaded property (for MovieClip instances only).

    staticread onlygraphics:Graphics

    Accesses the graphics property (for Shape or Sprite instances only).

    staticgridFitType:GridFitType

    Accesses the gridFitType property (for TextField instances only).

    staticheight:Float

    Accesses the height property.

    statichitArea:Sprite

    Accesses the hitArea property (for Sprite instances only).

    statichtmlText:UTF8String

    Accesses the htmlText property (for TextField instances only).

    staticread onlyisPlaying:Bool

    Accesses the isPlaying property (for MovieClip instances only).

    staticread onlylength:Int

    Accesses the length property (for TextField instances only).

    staticread onlyloaderInfo:LoaderInfo

    Accesses the loaderInfo property.

    staticmask:DisplayObject

    Accesses the mask property.

    staticmaxChars:Int

    Accesses the maxChars property (for TextField instances only).

    staticread onlymaxScrollH:Int

    Accesses the maxScrollH property (for TextField instances only).

    staticread onlymaxScrollV:Int

    Accesses the maxScrollV property (for TextField instances only).

    staticmouseChildren:Bool

    Accesses the mouseChildren property (for DisplayObjectContainer instances only).

    staticmouseEnabled:Bool

    Accesses the mouseEnabled property (for InteractiveObject instances only).

    staticmouseWheelEnabled:Bool

    Accesses the mouseWheelEnabled property (for TextField instances only).

    staticread onlymouseX:Float

    Accesses the mouseX property.

    staticread onlymouseY:Float

    Accesses the mouseY property.

    staticmultiline:Bool

    Accesses the multiline property (for TextField instances only).

    staticname:String

    Accesses the name property.

    staticneedsSoftKeyboard:Bool

    Accesses the needsSoftKeyboard property (for InteractiveObject instances only).

    staticread onlynumChildren:Int

    Accesses the numChildren property (for DisplayObjectContainer instances only).

    staticread onlynumLines:Int

    Accesses the numLines property (for TextField instances only).

    staticread onlynumTiles:Int

    Accesses the numTiles property (for Tilemap instances only).

    staticopaqueBackground:Null<Int>

    Accesses the opaqueBackground property.

    staticpixelSnapping:PixelSnapping

    Accesses the pixelSnapping property (for Bitmap instances only).

    staticrestrict:UTF8String

    Accesses the restrict property (for TextField instances only).

    staticread onlyroot:DisplayObject

    Accesses the root property.

    staticrotation:Float

    Accesses the rotation property.

    staticscale9Grid:Rectangle

    Accesses the scale9Grid property.

    staticscaleX:Float

    Accesses the scaleX property.

    staticscaleY:Float

    Accesses the scaleY property.

    staticread onlyscenes:Array<Scene>

    Accesses the scenes property (for MovieClip instances only).

    staticscrollH:Int

    Accesses the scrollH property (for TextField instances only).

    staticscrollRect:Rectangle

    Accesses the scrollRect property.

    staticscrollV:Int

    Accesses the scrollV property (for TextField instances only).

    staticselectable:Bool

    Accesses the selectable property (for TextField instances only).

    staticread onlyselectionBeginIndex:Int

    Accesses the selectionBeginIndex property (for TextField instances only).

    staticread onlyselectionEndIndex:Int

    Accesses the selectionEndIndex property (for TextField instances only).

    staticshader:Shader

    Accesses the shader property.

    staticsharpness:Float

    Accesses the sharpness property (for TextField instances only).

    staticsmoothing:Bool

    Accesses the smoothing property (for Video or Bitmap instances only).

    staticsoftKeyboardInputAreaOfInterest:Rectangle

    Accesses the softKeyboardInputAreaOfInterest property (for InteractiveObject instances only).

    staticread onlystage:Stage

    Accesses the stage property.

    staticstyleSheet:StyleSheet

    Accesses the styleSheet property (for TextField instances only).

    statictabChildren:Bool

    Accesses the tabChildren property (for DisplayObjectContainer instances only).

    statictabEnabled:Bool

    Accesses the tabEnabled property (for InteractiveObject instances only).

    statictabIndex:Int

    Accesses the tabIndex property (for InteractiveObject instances only).

    statictext:UTF8String

    Accesses the text property (for StaticText or TextField instances only).

    statictextColor:Int

    Accesses the textColor property (for TextField instances only).

    staticread onlytextHeight:Float

    Accesses the textHeight property (for TextField instances only).

    staticread onlytextWidth:Float

    Accesses the textWidth property (for TextField instances only).

    statictileAlphaEnabled:Bool

    Accesses the tileAlphaEnabled property (for Tilemap instances only).

    statictileBlendModeEnabled:Bool

    Accesses the tileBlendModeEnabled property (for Tilemap instances only).

    statictileColorTransformEnabled:Bool

    Accesses the tileColorTransformEnabled property (for Tilemap instances only).

    statictileset:Tileset

    Accesses the tileset property (for Tilemap instances only).

    staticread onlytotalFrames:Int

    Accesses the totalFrames property (for MovieClip instances only).

    statictransform:Transform

    Accesses the transform property.

    statictype:TextFieldType

    Accesses the type property (for TextField instances only).

    staticuseHandCursor:Bool

    Accesses the useHandCursor property (for Sprite instances only).

    staticread onlyvideoWidth:Int

    Accesses the videoWidth property (for Video instances only).

    staticvisible:Bool

    Accesses the visible property.

    staticwidth:Float

    Accesses the width property.

    staticwordWrap:Bool

    Accesses the wordWrap property (for TextField instances only).

    staticx:Float

    Accesses the x property.

    staticy:Float

    Accesses the y property.

    Static methods

    staticaddChild(this:T, child:DisplayObject):DisplayObject

    Accesses the addChild method (for DisplayObjectContainer instances only).

    staticaddChildAt(this:T, child:DisplayObject, index:Int):DisplayObject

    Accesses the addChildAt method (for DisplayObjectContainer instances only).

    @:value({ useWeakReference : false, priority : 0, useCapture : false })staticaddEventListener<T2>(this:T, type:EventType<T2>, listener:T2 ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Accesses the addEventListener method.

    staticaddFrameScript(this:T, index:Int, method:() ‑> Void):Void

    Accesses the addFrameScript method (for MovieClip instances only).

    staticaddTile(this:T, tile:Tile):Tile

    Accesses the addTile method (for Tilemap instances only).

    staticaddTileAt(this:T, tile:Tile, index:Int):Tile

    Accesses the addTileAt method (for Tilemap instances only).

    staticaddTiles(this:T, tiles:Array<Tile>):Array<Tile>

    Accesses the addTiles method (for Tilemap instances only).

    staticappendText(this:T, text:String):Void

    Accesses the appendText method (for TextField instances only).

    staticareInaccessibleObjectsUnderPoint(this:T, point:Point):Bool

    Accesses the areInaccessibleObjectsUnderPoint method (for DisplayObjectContainer instances only).

    staticattachNetStream(this:T, netStream:NetStream):Void

    Accesses the attachNetStream method (for Video instances only).

    staticattachTimeline(this:T, timeline:Timeline):Void

    Accesses the attachTimeline method (for MovieClip instances only).

    staticclear(this:T):Void

    Accesses the clear method (for Video instances only).

    staticcontains(this:T, child:Dynamic):Bool

    Accesses the contains method (for Tilemap or DisplayObjectContainer instances only).

    staticdispatchEvent(this:T, event:Event):Bool

    Accesses the dispatchEvent method.

    staticgetBounds(this:T, targetCoordinateSpace:DisplayObject):Rectangle

    Accesses the getBounds method.

    staticgetCharBoundaries(this:T, charIndex:Int):Rectangle

    Accesses the getCharBoundaries method (for TextField instances only).

    staticgetCharIndexAtPoint(this:T, x:Float, y:Float):Int

    Accesses the getCharIndexAtPoint method (for TextField instances only).

    staticgetChildAt(this:T, index:Int):DisplayObject

    Accesses the getChildAt method (for DisplayObjectContainer instances only).

    staticgetChildByName(this:T, name:String):DisplayObject

    Accesses the getChildByName method (for DisplayObjectContainer instances only).

    staticgetChildIndex(this:T, child:DisplayObject):Int

    Accesses the getChildIndex method (for DisplayObjectContainer instances only).

    staticgetFirstCharInParagraph(this:T, charIndex:Int):Int

    Accesses the getFirstCharInParagraph method (for TextField instances only).

    staticgetLineIndexAtPoint(this:T, x:Float, y:Float):Int

    Accesses the getLineIndexAtPoint method (for TextField instances only).

    staticgetLineIndexOfChar(this:T, charIndex:Int):Int

    Accesses the getLineIndexOfChar method (for TextField instances only).

    staticgetLineLength(this:T, lineIndex:Int):Int

    Accesses the getLineLength method (for TextField instances only).

    staticgetLineMetrics(this:T, lineIndex:Int):TextLineMetrics

    Accesses the getLineMetrics method (for TextField instances only).

    staticgetLineOffset(this:T, lineIndex:Int):Int

    Accesses the getLineOffset method (for TextField instances only).

    staticgetLineText(this:T, lineIndex:Int):String

    Accesses the getLineText method (for TextField instances only).

    staticgetObjectsUnderPoint(this:T, point:Point):Array<DisplayObject>

    Accesses the getObjectsUnderPoint method (for DisplayObjectContainer instances only).

    staticgetParagraphLength(this:T, charIndex:Int):Int

    Accesses the getParagraphLength method (for TextField instances only).

    staticgetRect(this:T, targetCoordinateSpace:DisplayObject):Rectangle

    Accesses the getRect method.

    @:value({ endIndex : -1, beginIndex : -1 })staticgetTextFormat(this:T, beginIndex:Int = -1, endIndex:Int = -1):TextFormat

    Accesses the getTextFormat method (for TextField instances only).

    staticgetTileAt(this:T, index:Int):Tile

    Accesses the getTileAt method (for Tilemap instances only).

    staticgetTileIndex(this:T, tile:Tile):Int

    Accesses the getTileIndex method (for Tilemap instances only).

    staticgetTiles(this:T):TileContainer

    Accesses the getTiles method (for Tilemap instances only).

    staticglobalToLocal(this:T, pos:Point):Point

    Accesses the globalToLocal method.

    @:value({ scene : null })staticgotoAndPlay(this:T, frame:Any, ?scene:String):Void

    Accesses the gotoAndPlay method (for MovieClip instances only).

    @:value({ scene : null })staticgotoAndStop(this:T, frame:Any, ?scene:String):Void

    Accesses the gotoAndStop method (for MovieClip instances only).

    statichasEventListener(this:T, type:String):Bool

    Accesses the hasEventListener method.

    statichitTestObject(this:T, obj:DisplayObject):Bool

    Accesses the hitTestObject method.

    @:value({ shapeFlag : false })statichitTestPoint(this:T, x:Float, y:Float, shapeFlag:Bool = false):Bool

    Accesses the hitTestPoint method.

    staticinvalidate(this:T):Void

    Accesses the invalidate method.

    staticlocalToGlobal(this:T, point:Point):Point

    Accesses the localToGlobal method.

    staticnextFrame(this:T):Void

    Accesses the nextFrame method (for MovieClip instances only).

    staticnextScene(this:T):Void

    Accesses the nextScene method (for MovieClip instances only).

    staticplay(this:T):Void

    Accesses the play method (for MovieClip instances only).

    staticprevFrame(this:T):Void

    Accesses the prevFrame method (for MovieClip instances only).

    staticprevScene(this:T):Void

    Accesses the prevScene method (for MovieClip instances only).

    staticremoveChild(this:T, child:DisplayObject):DisplayObject

    Accesses the removeChild method (for DisplayObjectContainer instances only).

    staticremoveChildAt(this:T, index:Int):DisplayObject

    Accesses the removeChildAt method (for DisplayObjectContainer instances only).

    @:value({ endIndex : 0x7FFFFFFF, beginIndex : 0 })staticremoveChildren(this:T, beginIndex:Int = 0, endIndex:Int = 0x7FFFFFFF):Void

    Accesses the removeChildren method (for DisplayObjectContainer instances only).

    @:value({ useCapture : false })staticremoveEventListener<T2>(this:T, type:EventType<T2>, listener:T2 ‑> Void, useCapture:Bool = false):Void

    Accesses the removeEventListener method.

    staticremoveTile(this:T, tile:Tile):Tile

    Accesses the removeTile method (for Tilemap instances only).

    staticremoveTileAt(this:T, index:Int):Tile

    Accesses the removeTileAt method (for Tilemap instances only).

    @:value({ endIndex : 0x7fffffff, beginIndex : 0 })staticremoveTiles(this:T, beginIndex:Int = 0, endIndex:Int = 0x7fffffff):Void

    Accesses the removeTiles method (for Tilemap instances only).

    staticreplaceSelectedText(this:T, value:String):Void

    Accesses the replaceSelectedText method (for TextField instances only).

    staticreplaceText(this:T, beginIndex:Int, endIndex:Int, newText:String):Void

    Accesses the replaceText method (for TextField instances only).

    staticrequestSoftKeyboard(this:T):Bool

    Accesses the requestSoftKeyboard method (for InteractiveObject instances only).

    staticsetChildIndex(this:T, child:DisplayObject, index:Int):Void

    Accesses the setChildIndex method (for DisplayObjectContainer instances only).

    staticsetSelection(this:T, beginIndex:Int, endIndex:Int):Void

    Accesses the setSelection method (for TextField instances only).

    @:value({ endIndex : -1, beginIndex : -1 })staticsetTextFormat(this:T, format:TextFormat, beginIndex:Int = -1, endIndex:Int = -1):Void

    Accesses the setTextFormat method (for TextField instances only).

    staticsetTileIndex(this:T, tile:Tile, index:Int):Void

    Accesses the setTileIndex method (for Tilemap instances only).

    staticsetTiles(this:T, group:TileContainer):Void

    Accesses the setTiles method (for Tilemap instances only).

    staticsortTiles(this:T, compareFunction:(Tile, Tile) ‑> Int):Void

    Accesses the sortTiles method (for Tilemap instances only).

    @:value({ bounds : null, lockCenter : false })staticstartDrag(this:T, lockCenter:Bool = false, ?bounds:Rectangle):Void

    Accesses the startDrag method (for Sprite instances only).

    staticstop(this:T):Void

    Accesses the stop method (for MovieClip instances only).

    staticstopAllMovieClips(this:T):Void

    Accesses the stopAllMovieClips method (for DisplayObjectContainer instances only).

    staticstopDrag(this:T):Void

    Accesses the stopDrag method (for Sprite instances only).

    staticswapChildren(this:T, child1:DisplayObject, child2:DisplayObject):Void

    Accesses the swapChildren method (for DisplayObjectContainer instances only).

    staticswapChildrenAt(this:T, index1:Int, index2:Int):Void

    Accesses the swapChildrenAt method (for DisplayObjectContainer instances only).

    staticswapTiles(this:T, tile1:Tile, tile2:Tile):Void

    Accesses the swapTiles method (for Tilemap instances only).

    staticswapTilesAt(this:T, index1:Int, index2:Int):Void

    Accesses the swapTilesAt method (for Tilemap instances only).

    statictoString(this:T):String

    Accesses the toString method.

    staticwillTrigger(this:T, type:String):Bool

    Accesses the willTrigger method.

    \ No newline at end of file +movieClip.sprite["sprite2"].x = 100;

    Static variables

    staticalpha:Float

    Accesses the alpha property.

    staticantiAliasType:AntiAliasType

    Accesses the antiAliasType property (for TextField instances only).

    staticautoSize:TextFieldAutoSize

    Accesses the autoSize property (for TextField instances only).

    staticbackground:Bool

    Accesses the background property (for TextField instances only).

    staticbackgroundColor:Int

    Accesses the backgroundColor property (for TextField instances only).

    staticbitmapData:BitmapData

    Accesses the bitmapData property (for Bitmap instances only).

    staticblendMode:BlendMode

    Accesses the blendMode property.

    staticborder:Bool

    Accesses the border property (for TextField instances only).

    staticborderColor:Int

    Accesses the borderColor property (for TextField instances only).

    staticread onlybottomScrollV:Int

    Accesses the bottomScrollV property (for TextField instances only).

    staticbuttonMode:Bool

    Accesses the buttonMode property (for Sprite instances only).

    staticcacheAsBitmap:Bool

    Accesses the cacheAsBitmap property.

    staticcacheAsBitmapMatrix:Matrix

    Accesses the cacheAsBitmapMatrix property.

    staticread onlycaretIndex:Int

    Accesses the caretIndex property (for TextField instances only).

    staticcondenseWhite:Bool

    Accesses the condenseWhite property (for TextField instances only).

    staticread onlycurrentFrame:Int

    Accesses the currentFrame property (for MovieClip instances only).

    staticread onlycurrentFrameLabel:String

    Accesses the currentFrameLabel property (for MovieClip instances only).

    staticread onlycurrentLabel:String

    Accesses the currentLabel property (for MovieClip instances only).

    staticread onlycurrentLabels:Array<FrameLabel>

    Accesses the currentLabels property (for MovieClip instances only).

    staticread onlycurrentScene:Scene

    Accesses the currentScene property (for MovieClip instances only).

    staticdeblocking:Int

    Accesses the deblocking property (for Video instances only).

    staticdefaultTextFormat:TextFormat

    Accesses the defaultTextFormat property (for TextField instances only).

    staticdisplayAsPassword:Bool

    Accesses the displayAsPassword property (for TextField instances only).

    staticdoubleClickEnabled:Bool

    Accesses the doubleClickEnabled property (for InteractiveObject instances only).

    staticread onlydropTarget:DisplayObject

    Accesses the dropTarget property (for Sprite instances only).

    staticembedFonts:Bool

    Accesses the embedFonts property (for TextField instances only).

    staticenabled:Bool

    Accesses the enabled property (for MovieClip instances only).

    staticfilters:Array<BitmapFilter>

    Accesses the filters property.

    staticfocusRect:Null<Bool>

    Accesses the focusRect property (for InteractiveObject instances only).

    staticread onlyframesLoaded:Int

    Accesses the framesLoaded property (for MovieClip instances only).

    staticread onlygraphics:Graphics

    Accesses the graphics property (for Shape or Sprite instances only).

    staticgridFitType:GridFitType

    Accesses the gridFitType property (for TextField instances only).

    staticheight:Float

    Accesses the height property.

    statichitArea:Sprite

    Accesses the hitArea property (for Sprite instances only).

    statichtmlText:UTF8String

    Accesses the htmlText property (for TextField instances only).

    staticread onlyisPlaying:Bool

    Accesses the isPlaying property (for MovieClip instances only).

    staticread onlylength:Int

    Accesses the length property (for TextField instances only).

    staticread onlyloaderInfo:LoaderInfo

    Accesses the loaderInfo property.

    staticmask:DisplayObject

    Accesses the mask property.

    staticmaxChars:Int

    Accesses the maxChars property (for TextField instances only).

    staticread onlymaxScrollH:Int

    Accesses the maxScrollH property (for TextField instances only).

    staticread onlymaxScrollV:Int

    Accesses the maxScrollV property (for TextField instances only).

    staticmouseChildren:Bool

    Accesses the mouseChildren property (for DisplayObjectContainer instances only).

    staticmouseEnabled:Bool

    Accesses the mouseEnabled property (for InteractiveObject instances only).

    staticmouseWheelEnabled:Bool

    Accesses the mouseWheelEnabled property (for TextField instances only).

    staticread onlymouseX:Float

    Accesses the mouseX property.

    staticread onlymouseY:Float

    Accesses the mouseY property.

    staticmultiline:Bool

    Accesses the multiline property (for TextField instances only).

    staticname:String

    Accesses the name property.

    staticneedsSoftKeyboard:Bool

    Accesses the needsSoftKeyboard property (for InteractiveObject instances only).

    staticread onlynumChildren:Int

    Accesses the numChildren property (for DisplayObjectContainer instances only).

    staticread onlynumLines:Int

    Accesses the numLines property (for TextField instances only).

    staticread onlynumTiles:Int

    Accesses the numTiles property (for Tilemap instances only).

    staticopaqueBackground:Null<Int>

    Accesses the opaqueBackground property.

    staticpixelSnapping:PixelSnapping

    Accesses the pixelSnapping property (for Bitmap instances only).

    staticrestrict:UTF8String

    Accesses the restrict property (for TextField instances only).

    staticread onlyroot:DisplayObject

    Accesses the root property.

    staticrotation:Float

    Accesses the rotation property.

    staticscale9Grid:Rectangle

    Accesses the scale9Grid property.

    staticscaleX:Float

    Accesses the scaleX property.

    staticscaleY:Float

    Accesses the scaleY property.

    staticread onlyscenes:Array<Scene>

    Accesses the scenes property (for MovieClip instances only).

    staticscrollH:Int

    Accesses the scrollH property (for TextField instances only).

    staticscrollRect:Rectangle

    Accesses the scrollRect property.

    staticscrollV:Int

    Accesses the scrollV property (for TextField instances only).

    staticselectable:Bool

    Accesses the selectable property (for TextField instances only).

    staticread onlyselectionBeginIndex:Int

    Accesses the selectionBeginIndex property (for TextField instances only).

    staticread onlyselectionEndIndex:Int

    Accesses the selectionEndIndex property (for TextField instances only).

    staticshader:Shader

    Accesses the shader property.

    staticsharpness:Float

    Accesses the sharpness property (for TextField instances only).

    staticsmoothing:Bool

    Accesses the smoothing property (for Video or Bitmap instances only).

    staticsoftKeyboardInputAreaOfInterest:Rectangle

    Accesses the softKeyboardInputAreaOfInterest property (for InteractiveObject instances only).

    staticread onlystage:Stage

    Accesses the stage property.

    staticstyleSheet:StyleSheet

    Accesses the styleSheet property (for TextField instances only).

    statictabChildren:Bool

    Accesses the tabChildren property (for DisplayObjectContainer instances only).

    statictabEnabled:Bool

    Accesses the tabEnabled property (for InteractiveObject instances only).

    statictabIndex:Int

    Accesses the tabIndex property (for InteractiveObject instances only).

    statictext:UTF8String

    Accesses the text property (for StaticText or TextField instances only).

    statictextColor:Int

    Accesses the textColor property (for TextField instances only).

    staticread onlytextHeight:Float

    Accesses the textHeight property (for TextField instances only).

    staticread onlytextWidth:Float

    Accesses the textWidth property (for TextField instances only).

    statictileAlphaEnabled:Bool

    Accesses the tileAlphaEnabled property (for Tilemap instances only).

    statictileBlendModeEnabled:Bool

    Accesses the tileBlendModeEnabled property (for Tilemap instances only).

    statictileColorTransformEnabled:Bool

    Accesses the tileColorTransformEnabled property (for Tilemap instances only).

    statictileset:Tileset

    Accesses the tileset property (for Tilemap instances only).

    staticread onlytotalFrames:Int

    Accesses the totalFrames property (for MovieClip instances only).

    statictransform:Transform

    Accesses the transform property.

    statictype:TextFieldType

    Accesses the type property (for TextField instances only).

    staticuseHandCursor:Bool

    Accesses the useHandCursor property (for Sprite instances only).

    staticread onlyvideoWidth:Int

    Accesses the videoWidth property (for Video instances only).

    staticvisible:Bool

    Accesses the visible property.

    staticwidth:Float

    Accesses the width property.

    staticwordWrap:Bool

    Accesses the wordWrap property (for TextField instances only).

    staticx:Float

    Accesses the x property.

    staticy:Float

    Accesses the y property.

    Static methods

    staticaddChild(this:T, child:DisplayObject):DisplayObject

    Accesses the addChild method (for DisplayObjectContainer instances only).

    staticaddChildAt(this:T, child:DisplayObject, index:Int):DisplayObject

    Accesses the addChildAt method (for DisplayObjectContainer instances only).

    @:value({ useWeakReference : false, priority : 0, useCapture : false })staticaddEventListener<T2>(this:T, type:EventType<T2>, listener:T2 ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Accesses the addEventListener method.

    staticaddFrameScript(this:T, index:Int, method:() ‑> Void):Void

    Accesses the addFrameScript method (for MovieClip instances only).

    staticaddTile(this:T, tile:Tile):Tile

    Accesses the addTile method (for Tilemap instances only).

    staticaddTileAt(this:T, tile:Tile, index:Int):Tile

    Accesses the addTileAt method (for Tilemap instances only).

    staticaddTiles(this:T, tiles:Array<Tile>):Array<Tile>

    Accesses the addTiles method (for Tilemap instances only).

    staticappendText(this:T, text:String):Void

    Accesses the appendText method (for TextField instances only).

    staticareInaccessibleObjectsUnderPoint(this:T, point:Point):Bool

    Accesses the areInaccessibleObjectsUnderPoint method (for DisplayObjectContainer instances only).

    staticattachNetStream(this:T, netStream:NetStream):Void

    Accesses the attachNetStream method (for Video instances only).

    staticattachTimeline(this:T, timeline:Timeline):Void

    Accesses the attachTimeline method (for MovieClip instances only).

    staticclear(this:T):Void

    Accesses the clear method (for Video instances only).

    staticcontains(this:T, child:Dynamic):Bool

    Accesses the contains method (for Tilemap or DisplayObjectContainer instances only).

    staticdispatchEvent(this:T, event:Event):Bool

    Accesses the dispatchEvent method.

    staticgetBounds(this:T, targetCoordinateSpace:DisplayObject):Rectangle

    Accesses the getBounds method.

    staticgetCharBoundaries(this:T, charIndex:Int):Rectangle

    Accesses the getCharBoundaries method (for TextField instances only).

    staticgetCharIndexAtPoint(this:T, x:Float, y:Float):Int

    Accesses the getCharIndexAtPoint method (for TextField instances only).

    staticgetChildAt(this:T, index:Int):DisplayObject

    Accesses the getChildAt method (for DisplayObjectContainer instances only).

    staticgetChildByName(this:T, name:String):DisplayObject

    Accesses the getChildByName method (for DisplayObjectContainer instances only).

    staticgetChildIndex(this:T, child:DisplayObject):Int

    Accesses the getChildIndex method (for DisplayObjectContainer instances only).

    staticgetFirstCharInParagraph(this:T, charIndex:Int):Int

    Accesses the getFirstCharInParagraph method (for TextField instances only).

    staticgetLineIndexAtPoint(this:T, x:Float, y:Float):Int

    Accesses the getLineIndexAtPoint method (for TextField instances only).

    staticgetLineIndexOfChar(this:T, charIndex:Int):Int

    Accesses the getLineIndexOfChar method (for TextField instances only).

    staticgetLineLength(this:T, lineIndex:Int):Int

    Accesses the getLineLength method (for TextField instances only).

    staticgetLineMetrics(this:T, lineIndex:Int):TextLineMetrics

    Accesses the getLineMetrics method (for TextField instances only).

    staticgetLineOffset(this:T, lineIndex:Int):Int

    Accesses the getLineOffset method (for TextField instances only).

    staticgetLineText(this:T, lineIndex:Int):String

    Accesses the getLineText method (for TextField instances only).

    staticgetObjectsUnderPoint(this:T, point:Point):Array<DisplayObject>

    Accesses the getObjectsUnderPoint method (for DisplayObjectContainer instances only).

    staticgetParagraphLength(this:T, charIndex:Int):Int

    Accesses the getParagraphLength method (for TextField instances only).

    staticgetRect(this:T, targetCoordinateSpace:DisplayObject):Rectangle

    Accesses the getRect method.

    @:value({ endIndex : -1, beginIndex : -1 })staticgetTextFormat(this:T, beginIndex:Int = -1, endIndex:Int = -1):TextFormat

    Accesses the getTextFormat method (for TextField instances only).

    staticgetTileAt(this:T, index:Int):Tile

    Accesses the getTileAt method (for Tilemap instances only).

    staticgetTileIndex(this:T, tile:Tile):Int

    Accesses the getTileIndex method (for Tilemap instances only).

    staticgetTiles(this:T):TileContainer

    Accesses the getTiles method (for Tilemap instances only).

    staticglobalToLocal(this:T, pos:Point):Point

    Accesses the globalToLocal method.

    @:value({ scene : null })staticgotoAndPlay(this:T, frame:Any, ?scene:String):Void

    Accesses the gotoAndPlay method (for MovieClip instances only).

    @:value({ scene : null })staticgotoAndStop(this:T, frame:Any, ?scene:String):Void

    Accesses the gotoAndStop method (for MovieClip instances only).

    statichasEventListener(this:T, type:String):Bool

    Accesses the hasEventListener method.

    statichitTestObject(this:T, obj:DisplayObject):Bool

    Accesses the hitTestObject method.

    @:value({ shapeFlag : false })statichitTestPoint(this:T, x:Float, y:Float, shapeFlag:Bool = false):Bool

    Accesses the hitTestPoint method.

    staticinvalidate(this:T):Void

    Accesses the invalidate method.

    staticlocalToGlobal(this:T, point:Point):Point

    Accesses the localToGlobal method.

    staticnextFrame(this:T):Void

    Accesses the nextFrame method (for MovieClip instances only).

    staticnextScene(this:T):Void

    Accesses the nextScene method (for MovieClip instances only).

    staticplay(this:T):Void

    Accesses the play method (for MovieClip instances only).

    staticprevFrame(this:T):Void

    Accesses the prevFrame method (for MovieClip instances only).

    staticprevScene(this:T):Void

    Accesses the prevScene method (for MovieClip instances only).

    staticremoveChild(this:T, child:DisplayObject):DisplayObject

    Accesses the removeChild method (for DisplayObjectContainer instances only).

    staticremoveChildAt(this:T, index:Int):DisplayObject

    Accesses the removeChildAt method (for DisplayObjectContainer instances only).

    @:value({ endIndex : 0x7FFFFFFF, beginIndex : 0 })staticremoveChildren(this:T, beginIndex:Int = 0, endIndex:Int = 0x7FFFFFFF):Void

    Accesses the removeChildren method (for DisplayObjectContainer instances only).

    @:value({ useCapture : false })staticremoveEventListener<T2>(this:T, type:EventType<T2>, listener:T2 ‑> Void, useCapture:Bool = false):Void

    Accesses the removeEventListener method.

    staticremoveTile(this:T, tile:Tile):Tile

    Accesses the removeTile method (for Tilemap instances only).

    staticremoveTileAt(this:T, index:Int):Tile

    Accesses the removeTileAt method (for Tilemap instances only).

    @:value({ endIndex : 0x7fffffff, beginIndex : 0 })staticremoveTiles(this:T, beginIndex:Int = 0, endIndex:Int = 0x7fffffff):Void

    Accesses the removeTiles method (for Tilemap instances only).

    staticreplaceSelectedText(this:T, value:String):Void

    Accesses the replaceSelectedText method (for TextField instances only).

    staticreplaceText(this:T, beginIndex:Int, endIndex:Int, newText:String):Void

    Accesses the replaceText method (for TextField instances only).

    staticrequestSoftKeyboard(this:T):Bool

    Accesses the requestSoftKeyboard method (for InteractiveObject instances only).

    staticsetChildIndex(this:T, child:DisplayObject, index:Int):Void

    Accesses the setChildIndex method (for DisplayObjectContainer instances only).

    staticsetSelection(this:T, beginIndex:Int, endIndex:Int):Void

    Accesses the setSelection method (for TextField instances only).

    @:value({ endIndex : -1, beginIndex : -1 })staticsetTextFormat(this:T, format:TextFormat, beginIndex:Int = -1, endIndex:Int = -1):Void

    Accesses the setTextFormat method (for TextField instances only).

    staticsetTileIndex(this:T, tile:Tile, index:Int):Void

    Accesses the setTileIndex method (for Tilemap instances only).

    staticsetTiles(this:T, group:TileContainer):Void

    Accesses the setTiles method (for Tilemap instances only).

    staticsortTiles(this:T, compareFunction:(Tile, Tile) ‑> Int):Void

    Accesses the sortTiles method (for Tilemap instances only).

    @:value({ bounds : null, lockCenter : false })staticstartDrag(this:T, lockCenter:Bool = false, ?bounds:Rectangle):Void

    Accesses the startDrag method (for Sprite instances only).

    staticstop(this:T):Void

    Accesses the stop method (for MovieClip instances only).

    staticstopAllMovieClips(this:T):Void

    Accesses the stopAllMovieClips method (for DisplayObjectContainer instances only).

    staticstopDrag(this:T):Void

    Accesses the stopDrag method (for Sprite instances only).

    staticswapChildren(this:T, child1:DisplayObject, child2:DisplayObject):Void

    Accesses the swapChildren method (for DisplayObjectContainer instances only).

    staticswapChildrenAt(this:T, index1:Int, index2:Int):Void

    Accesses the swapChildrenAt method (for DisplayObjectContainer instances only).

    staticswapTiles(this:T, tile1:Tile, tile2:Tile):Void

    Accesses the swapTiles method (for Tilemap instances only).

    staticswapTilesAt(this:T, index1:Int, index2:Int):Void

    Accesses the swapTilesAt method (for Tilemap instances only).

    statictoString(this:T):String

    Accesses the toString method.

    staticwillTrigger(this:T, type:String):Bool

    Accesses the willTrigger method.

    \ No newline at end of file diff --git a/openfl/display/DOMElement.html b/openfl/display/DOMElement.html index 257d18d..ff7b878 100644 --- a/openfl/display/DOMElement.html +++ b/openfl/display/DOMElement.html @@ -1,7 +1,7 @@ -openfl.display.DOMElement - API Reference
    View source

    class DOMElement

    package openfl.display

    extends DisplayObject › EventDispatcher

    Available on HTML5

    Constructor

    @SuppressWarnings("checkstyle:Dynamic")new(element:Element)

    Inherited Variables

    Defined by DisplayObject

    @:keepalpha:Float

    Indicates the alpha transparency value of the object specified. Valid +

    View source

    class DOMElement

    package openfl.display

    extends DisplayObject › EventDispatcher

    Available on HTML5

    Constructor

    @SuppressWarnings("checkstyle:Dynamic")new(element:Element)

    Inherited Variables

    Defined by DisplayObject

    @:keepalpha:Float

    Indicates the alpha transparency value of the object specified. Valid values are 0 (fully transparent) to 1 (fully opaque). The default value is 1. -Display objects with alpha set to 0 are active, even though they are invisible.

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A +Display objects with alpha set to 0 are active, even though they are invisible.

    See also:

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A bitmap can be drawn internally in two ways. If you have a blend mode enabled or an external clipping mask, the bitmap is drawn by adding a bitmap-filled square shape to the vector render. If you attempt to set @@ -74,7 +74,7 @@ BlendMode class defines string values you can use. The illustrations in the table show blendMode values applied to a circular display object(2) superimposed on another display object(1).

    -

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn +

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    See also:

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn to the bitmap instead of the main display. If cacheAsBitmapMatrix is null or unsupported, the bitmap is then copied to the main display as unstretched, unrotated pixels snapped @@ -105,12 +105,12 @@ number of pixels cannot exceed 16,777,215 pixels.(So, if a bitmap image is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is is 2880 pixels in height and 2,880 pixels -in width.

  • The bitmap fails to allocate(out of memory error).
    • +in width.
  • The bitmap fails to allocate (out of memory error).

    • The cacheAsBitmap property is best used with movie clips that have mostly static content and that do not scale and rotate frequently. With such movie clips, cacheAsBitmap can lead to -performance increases when the movie clip is translated(when its x -and y position is changed).

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to +performance increases when the movie clip is translated (when its x +and y position is changed).

    See also:

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. The application uses this matrix as a transformation matrix that is applied when rendering the bitmap version of the display object.

    Adobe AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop @@ -144,16 +144,16 @@

    Note: The cacheAsBitmapMatrix property is suitable for 2D transformations. If you need to apply transformations in 3D, you may do so by setting a 3D property of the object and manipulating its transform.matrix3D property. If the application is packaged using GPU mode, this allows the 3D transforms -to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated +to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    See also:

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated with the display object. The openfl.filters package contains several classes that define specific filters you can use.

    Filters can be applied in Flash Professional at design time, or at run -time by using ActionScript code. To apply a filter by using ActionScript, +time by using Haxe code. To apply a filter by using Haxe, you must make a temporary copy of the entire filters array, modify the temporary array, then assign the value of the temporary array back to the filters array. You cannot directly add a new filter object to the filters array.

    -

    To add a filter by using ActionScript, perform the following steps +

    To add a filter by using Haxe, perform the following steps (assume that the target display object is named myDisplayObject):

    1. Create a new filter object by using the constructor method of your chosen filter class.
    2. Assign the value of the myDisplayObject.filters array @@ -184,7 +184,7 @@

      The openfl.filters package includes classes for filters. For example, to create a DropShadow filter, you would write:

      Throws:

      ArgumentError

      When filters includes a ShaderFilter and the shader output type is not compatible with -this operation(the shader must specify a +this operation (the shader must specify a pixel4 output).

      ArgumentError

      When filters includes a ShaderFilter and the shader doesn't specify any image input or the first input is not an image4 input.

      ArgumentError

      When filters includes a ShaderFilter @@ -202,10 +202,10 @@ is adjusted accordingly, as shown in the following code:

      Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a height of 0, even if you try to -set height to a different value.

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file +set height to a different value.

      See also:

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file to which this display object belongs. The loaderInfo property is defined only for the root display object of a SWF file or for a loaded -Bitmap(not for a Bitmap that is drawn with ActionScript). To find the +Bitmap (not for a Bitmap that is drawn with Haxe). To find the loaderInfo object associated with the SWF file that contains a display object named myDisplayObject, use myDisplayObject.root.loaderInfo.

      @@ -217,7 +217,7 @@ list. The mask object itself is not drawn. Set mask to null to remove the mask.

      To be able to scale a mask object, it must be on the display list. To -be able to drag a mask Sprite object(by calling its +be able to drag a mask Sprite object (by calling its startDrag() method), it must be on the display list. To call the startDrag() method for a mask sprite based on a mouseDown event being dispatched by the sprite, set the @@ -236,23 +236,23 @@ more than one calling display object. When the mask is assigned to a second display object, it is removed as the mask of the first object, and that object's mask property becomes -null.

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in +null.

      See also:

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned x -coordinate will reflect the non-rotated object.

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in +coordinate will reflect the non-rotated object.

      See also:

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned y -coordinate will reflect the non-rotated object.

      name:String

      Indicates the instance name of the DisplayObject. The object can be +coordinate will reflect the non-rotated object.

      See also:

      name:String

      Indicates the instance name of the DisplayObject. The object can be identified in the child list of its parent display object container by calling the getChildByName() method of the display object container.

      Throws:

      IllegalOperationError

      If you are attempting to set this property on an object that was placed on the timeline in the Flash authoring tool.

      opaqueBackground:Null<Int>

      Specifies whether the display object is opaque with a certain background color. A transparent bitmap contains alpha channel data and is drawn -transparently. An opaque bitmap has no alpha channel(and renders faster +transparently. An opaque bitmap has no alpha channel (and renders faster than a transparent bitmap). If the bitmap is opaque, you specify its own background color to use.

      -

      If set to a number value, the surface is opaque(not transparent) with +

      If set to a number value, the surface is opaque (not transparent) with the RGB background color that the number specifies. If set to null(the default value), the display object has a transparent background.

      @@ -264,7 +264,7 @@

      The opaque background region is not matched when calling the hitTestPoint() method with the shapeFlag parameter set to true.

      -

      The opaque background region does not respond to mouse events.

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display +

      The opaque background region does not respond to mouse events.

      See also:

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display object. Use the parent property to specify a relative path to display objects that are above the current display object in the display list hierarchy.

      @@ -273,7 +273,7 @@ 
      this.parent.parent.alpha = 20;

      Throws:

      SecurityError

      The parent display object belongs to a security sandbox to which you do not have access. You can avoid this situation by having the parent movie call -the Security.allowDomain() method.

      read onlyroot:DisplayObject

      For a display object in a loaded SWF file, the root property +the Security.allowDomain() method.

      See also:

    read onlyroot:DisplayObject

    For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. For a Bitmap object representing a loaded image file, the root property is the Bitmap object @@ -286,7 +286,7 @@ is a child of the top-most display object in a loaded SWF file.

    For example, if you create a new Sprite object by calling the Sprite() constructor method, its root property -is null until you add it to the display list(or to a display +is null until you add it to the display list (or to a display object container that is off the display list but that is a child of the top-most display object in a SWF file).

    For a loaded SWF file, even though the Loader object used to load the @@ -294,12 +294,12 @@ SWF file has its root property set to itself. The Loader object does not have its root property set until it is added as a child of a display object for which the root property is -set.

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its +set.

    See also:

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement my_video.rotation = 450 -is the same as my_video.rotation = 90.

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, +is the same as my_video.rotation = 90.

    See also:

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, the entire display object is scaled normally when any scale transformation is applied.

    When you define the scale9Grid property, the display @@ -327,11 +327,11 @@ the registration point. The default registration point is (0,0). 1.0 equals 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the +y property values, which are defined in whole pixels.

    See also:

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. The default registration point is (0,0). 1.0 is 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is +y property values, which are defined in whole pixels.

    See also:

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is cropped to the size defined by the rectangle, and it scrolls within the rectangle when you change the x and y properties of the scrollRect object.

    @@ -348,17 +348,17 @@ an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated 90° and you scroll it left and right, the display object actually scrolls -up and down.

    @:betashader:Shader

    BETA**

    +up and down.

    See also:

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to apply a post-process effect to multiple display objects at once, enable cacheAsBitmap or use the filters property with a ShaderFilter

    read onlystage:Stage

    The Stage of the display object. A Flash runtime application has only one Stage object. For example, you can create and load multiple display objects into the display list, and the stage property of each -display object refers to the same Stage object(even if the display object +display object refers to the same Stage object (even if the display object belongs to a loaded SWF file).

    If a display object is not added to the display list, its -stage property is set to null.

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color +stage property is set to null.

    See also:

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. The specific properties - matrix, colorTransform, and three read-only properties (concatenatedMatrix, concatenatedColorTransform, @@ -395,21 +395,21 @@ is adjusted accordingly, as shown in the following code:

    Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a width of 0, even if you try to set -width to a different value.

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative +width to a different value.

    See also:

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative +registration point position.

    See also:

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative +registration point position.

    See also:

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. Consider the following code, which shows how the rectangle returned can vary depending on the targetCoordinateSpace parameter that @@ -436,8 +436,8 @@ coordinates, respectively.

    Parameters:

    targetCoordinateSpace

    The display object that defines the coordinate system to use.

    Returns:

    The rectangle that defines the area of the display object relative to the targetCoordinateSpace object's coordinate -system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage(global) coordinates -to the display object's(local) coordinates.

    +system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage (global) coordinates +to the display object's (local) coordinates.

    To use this method, first create an instance of the Point class. The x and y values that you assign represent global coordinates because they relate to the origin(0,0) of the main display area. Then @@ -452,17 +452,17 @@ point specified by the x and y parameters. The x and y parameters specify a point in the coordinate space of the Stage, not the display object container that -contains the display object(unless that display object container is the +contains the display object (unless that display object container is the Stage).

    Parameters:

    x

    The x coordinate to test against this object.

    y

    The y coordinate to test against this object.

    shapeFlag

    Whether to check against the actual pixels of the object (true) or the bounding box (false).

    Returns:

    true if the display object overlaps or intersects with the specified point; false otherwise.

    invalidate():Void

    Calling the invalidate() method signals to have the current object -redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's(local) -coordinates to the Stage(global) coordinates.

    +redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's (local) +coordinates to the Stage (global) coordinates.

    This method allows you to convert any given x and y coordinates from values that are relative to the origin(0,0) of a -specific display object(local coordinates) to values that are relative to -the origin of the Stage(global coordinates).

    +specific display object (local coordinates) to values that are relative to +the origin of the Stage (global coordinates).

    To use this method, first create an instance of the Point class. The x and y values that you assign represent local coordinates because they relate to the origin of the display object.

    diff --git a/openfl/display/DOMRenderer.html b/openfl/display/DOMRenderer.html index e0ecdfe..07e3522 100644 --- a/openfl/display/DOMRenderer.html +++ b/openfl/display/DOMRenderer.html @@ -1,7 +1,7 @@ -openfl.display.DOMRenderer - API Reference
    View source

    class DOMRenderer

    package openfl.display

    extends DisplayObjectRenderer › EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.DisplayObject)@:access(openfl.display.IBitmapDrawable)@:access(openfl.display.Stage3D)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)@:allow(openfl.display._internal)@:allow(openfl.display)

    Available on all platforms

    BETA**

    +
    View source

    class DOMRenderer

    package openfl.display

    extends DisplayObjectRenderer › EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.DisplayObject)@:access(openfl.display.IBitmapDrawable)@:access(openfl.display.Stage3D)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)@:allow(openfl.display._internal)@:allow(openfl.display)

    Available on all platforms

    BETA**

    The DOMRenderer API exposes support for HTML5 DOM render instructions within the RenderEvent.RENDER_DOM event

    Variables

    @SuppressWarnings("checkstyle:Dynamic")element:DOMRenderContext

    The current HTML5 DOM element

    Methods

    @SuppressWarnings("checkstyle:Dynamic")applyStyle(parent:DisplayObject, childElement:Dynamic):Void

    Applies CSS styles to the specified DOM element, using a DisplayObject as the virtual parent. This helps set the z-order, position and other components for @@ -130,7 +130,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/display/DisplayObject.html b/openfl/display/DisplayObject.html index a31eea0..ce702cf 100644 --- a/openfl/display/DisplayObject.html +++ b/openfl/display/DisplayObject.html @@ -1,7 +1,7 @@ -openfl.display.DisplayObject - API Referenceopenfl.display.DisplayObject - OpenFL API Reference

    API Reference
    View source

    class DisplayObject

    package openfl.display

    extends EventDispatcher

    implements IBitmapDrawable

    extended by AVM1Movie, Bitmap, DOMElement, InteractiveObject, Shape, Tilemap, Video, StaticText

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(lime.graphics.Image)@:access(lime.graphics.ImageBuffer)@:access(openfl.display3D._internal.Context3DState)@:access(openfl.display._internal.Context3DGraphics)@:access(openfl.events.Event)@:access(openfl.display3D.Context3D)@:access(openfl.display.Bitmap)@:access(openfl.display.BitmapData)@:access(openfl.display.DisplayObjectContainer)@:access(openfl.display.Graphics)@:access(openfl.display.Shader)@:access(openfl.display.Stage)@:access(openfl.filters.BitmapFilter)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)@:access(openfl.geom.Transform)

    Available on all platforms

    The DisplayObject class is the base class for all objects that can be +

    View source

    class DisplayObject

    package openfl.display

    extends EventDispatcher

    implements IBitmapDrawable

    extended by AVM1Movie, Bitmap, DOMElement, InteractiveObject, Shape, Tilemap, Video, StaticText

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(lime.graphics.Image)@:access(lime.graphics.ImageBuffer)@:access(openfl.display3D._internal.Context3DState)@:access(openfl.display._internal.Context3DGraphics)@:access(openfl.events.Event)@:access(openfl.display3D.Context3D)@:access(openfl.display.Bitmap)@:access(openfl.display.BitmapData)@:access(openfl.display.DisplayObjectContainer)@:access(openfl.display.Graphics)@:access(openfl.display.Shader)@:access(openfl.display.Stage)@:access(openfl.filters.BitmapFilter)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)@:access(openfl.geom.Transform)

    Available on all platforms

    The DisplayObject class is the base class for all objects that can be placed on the display list. The display list manages all objects displayed in openfl. Use the DisplayObjectContainer class to arrange the display objects in the display list. DisplayObjectContainer objects can @@ -91,13 +91,13 @@ class also inherits two broadcast events from the EventDispatcher class: activate and deactivate.

    Some properties previously used in the ActionScript 1.0 and 2.0 -MovieClip, TextField, and Button classes(such as _alpha, +MovieClip, TextField, and Button classes (such as _alpha, _height, _name, _width, _x, _y, and others) have equivalents in the -ActionScript 3.0 DisplayObject class that are renamed so that they no -longer begin with the underscore(_) character.

    +OpenFL DisplayObject class that are renamed so that they no +longer begin with the underscore (_) character.

    For more information, see the "Display Programming" chapter of the -ActionScript 3.0 Developer's Guide.

    Events:

    added

    Dispatched when a display object is added to the +OpenFL Developer's Guide.

    Events:

    added

    Dispatched when a display object is added to the display list. The following methods trigger this event: DisplayObjectContainer.addChild(), @@ -163,11 +163,11 @@ broadcast event, which means that it is dispatched by all display objects with a listener registered for this event.

    -

    Note: This event is not dispatched if the +

    Note: This event is not dispatched if the display is not rendering. This is the case when the -content is either minimized or obscured.

    Variables

    @:keepalpha:Float

    Indicates the alpha transparency value of the object specified. Valid +content is either minimized or obscured.

    See also:

    Variables

    @:keepalpha:Float

    Indicates the alpha transparency value of the object specified. Valid values are 0 (fully transparent) to 1 (fully opaque). The default value is 1. -Display objects with alpha set to 0 are active, even though they are invisible.

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A +Display objects with alpha set to 0 are active, even though they are invisible.

    See also:

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A bitmap can be drawn internally in two ways. If you have a blend mode enabled or an external clipping mask, the bitmap is drawn by adding a bitmap-filled square shape to the vector render. If you attempt to set @@ -187,7 +187,7 @@ BlendMode class defines string values you can use. The illustrations in the table show blendMode values applied to a circular display object(2) superimposed on another display object(1).

    -

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn +

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    See also:

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn to the bitmap instead of the main display. If cacheAsBitmapMatrix is null or unsupported, the bitmap is then copied to the main display as unstretched, unrotated pixels snapped @@ -218,12 +218,12 @@ number of pixels cannot exceed 16,777,215 pixels.(So, if a bitmap image is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is is 2880 pixels in height and 2,880 pixels -in width.

  • The bitmap fails to allocate(out of memory error).
    • +in width.
  • The bitmap fails to allocate (out of memory error).

    • The cacheAsBitmap property is best used with movie clips that have mostly static content and that do not scale and rotate frequently. With such movie clips, cacheAsBitmap can lead to -performance increases when the movie clip is translated(when its x -and y position is changed).

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to +performance increases when the movie clip is translated (when its x +and y position is changed).

    See also:

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. The application uses this matrix as a transformation matrix that is applied when rendering the bitmap version of the display object.

    Adobe AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop @@ -257,16 +257,16 @@

    Note: The cacheAsBitmapMatrix property is suitable for 2D transformations. If you need to apply transformations in 3D, you may do so by setting a 3D property of the object and manipulating its transform.matrix3D property. If the application is packaged using GPU mode, this allows the 3D transforms -to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated +to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    See also:

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated with the display object. The openfl.filters package contains several classes that define specific filters you can use.

    Filters can be applied in Flash Professional at design time, or at run -time by using ActionScript code. To apply a filter by using ActionScript, +time by using Haxe code. To apply a filter by using Haxe, you must make a temporary copy of the entire filters array, modify the temporary array, then assign the value of the temporary array back to the filters array. You cannot directly add a new filter object to the filters array.

    -

    To add a filter by using ActionScript, perform the following steps +

    To add a filter by using Haxe, perform the following steps (assume that the target display object is named myDisplayObject):

    1. Create a new filter object by using the constructor method of your chosen filter class.
    2. Assign the value of the myDisplayObject.filters array @@ -297,7 +297,7 @@

      The openfl.filters package includes classes for filters. For example, to create a DropShadow filter, you would write:

      Throws:

      ArgumentError

      When filters includes a ShaderFilter and the shader output type is not compatible with -this operation(the shader must specify a +this operation (the shader must specify a pixel4 output).

      ArgumentError

      When filters includes a ShaderFilter and the shader doesn't specify any image input or the first input is not an image4 input.

      ArgumentError

      When filters includes a ShaderFilter @@ -315,10 +315,10 @@ is adjusted accordingly, as shown in the following code:

      Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a height of 0, even if you try to -set height to a different value.

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file +set height to a different value.

      See also:

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file to which this display object belongs. The loaderInfo property is defined only for the root display object of a SWF file or for a loaded -Bitmap(not for a Bitmap that is drawn with ActionScript). To find the +Bitmap (not for a Bitmap that is drawn with Haxe). To find the loaderInfo object associated with the SWF file that contains a display object named myDisplayObject, use myDisplayObject.root.loaderInfo.

      @@ -330,7 +330,7 @@ list. The mask object itself is not drawn. Set mask to null to remove the mask.

      To be able to scale a mask object, it must be on the display list. To -be able to drag a mask Sprite object(by calling its +be able to drag a mask Sprite object (by calling its startDrag() method), it must be on the display list. To call the startDrag() method for a mask sprite based on a mouseDown event being dispatched by the sprite, set the @@ -349,23 +349,23 @@ more than one calling display object. When the mask is assigned to a second display object, it is removed as the mask of the first object, and that object's mask property becomes -null.

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in +null.

      See also:

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned x -coordinate will reflect the non-rotated object.

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in +coordinate will reflect the non-rotated object.

      See also:

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned y -coordinate will reflect the non-rotated object.

      name:String

      Indicates the instance name of the DisplayObject. The object can be +coordinate will reflect the non-rotated object.

      See also:

      name:String

      Indicates the instance name of the DisplayObject. The object can be identified in the child list of its parent display object container by calling the getChildByName() method of the display object container.

      Throws:

      IllegalOperationError

      If you are attempting to set this property on an object that was placed on the timeline in the Flash authoring tool.

      opaqueBackground:Null<Int>

      Specifies whether the display object is opaque with a certain background color. A transparent bitmap contains alpha channel data and is drawn -transparently. An opaque bitmap has no alpha channel(and renders faster +transparently. An opaque bitmap has no alpha channel (and renders faster than a transparent bitmap). If the bitmap is opaque, you specify its own background color to use.

      -

      If set to a number value, the surface is opaque(not transparent) with +

      If set to a number value, the surface is opaque (not transparent) with the RGB background color that the number specifies. If set to null(the default value), the display object has a transparent background.

      @@ -377,7 +377,7 @@

      The opaque background region is not matched when calling the hitTestPoint() method with the shapeFlag parameter set to true.

      -

      The opaque background region does not respond to mouse events.

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display +

      The opaque background region does not respond to mouse events.

      See also:

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display object. Use the parent property to specify a relative path to display objects that are above the current display object in the display list hierarchy.

      @@ -386,7 +386,7 @@ 
      this.parent.parent.alpha = 20;

      Throws:

      SecurityError

      The parent display object belongs to a security sandbox to which you do not have access. You can avoid this situation by having the parent movie call -the Security.allowDomain() method.

      read onlyroot:DisplayObject

      For a display object in a loaded SWF file, the root property +the Security.allowDomain() method.

      See also:

    read onlyroot:DisplayObject

    For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. For a Bitmap object representing a loaded image file, the root property is the Bitmap object @@ -399,7 +399,7 @@ is a child of the top-most display object in a loaded SWF file.

    For example, if you create a new Sprite object by calling the Sprite() constructor method, its root property -is null until you add it to the display list(or to a display +is null until you add it to the display list (or to a display object container that is off the display list but that is a child of the top-most display object in a SWF file).

    For a loaded SWF file, even though the Loader object used to load the @@ -407,12 +407,12 @@ SWF file has its root property set to itself. The Loader object does not have its root property set until it is added as a child of a display object for which the root property is -set.

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its +set.

    See also:

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement my_video.rotation = 450 -is the same as my_video.rotation = 90.

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, +is the same as my_video.rotation = 90.

    See also:

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, the entire display object is scaled normally when any scale transformation is applied.

    When you define the scale9Grid property, the display @@ -440,11 +440,11 @@ the registration point. The default registration point is (0,0). 1.0 equals 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the +y property values, which are defined in whole pixels.

    See also:

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. The default registration point is (0,0). 1.0 is 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is +y property values, which are defined in whole pixels.

    See also:

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is cropped to the size defined by the rectangle, and it scrolls within the rectangle when you change the x and y properties of the scrollRect object.

    @@ -461,17 +461,17 @@ an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated 90° and you scroll it left and right, the display object actually scrolls -up and down.

    @:betashader:Shader

    BETA**

    +up and down.

    See also:

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to apply a post-process effect to multiple display objects at once, enable cacheAsBitmap or use the filters property with a ShaderFilter

    read onlystage:Stage

    The Stage of the display object. A Flash runtime application has only one Stage object. For example, you can create and load multiple display objects into the display list, and the stage property of each -display object refers to the same Stage object(even if the display object +display object refers to the same Stage object (even if the display object belongs to a loaded SWF file).

    If a display object is not added to the display list, its -stage property is set to null.

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color +stage property is set to null.

    See also:

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. The specific properties - matrix, colorTransform, and three read-only properties (concatenatedMatrix, concatenatedColorTransform, @@ -508,21 +508,21 @@ is adjusted accordingly, as shown in the following code:

    Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a width of 0, even if you try to set -width to a different value.

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative +width to a different value.

    See also:

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative +registration point position.

    See also:

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    Methods

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative +registration point position.

    See also:

    Methods

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. Consider the following code, which shows how the rectangle returned can vary depending on the targetCoordinateSpace parameter that @@ -549,8 +549,8 @@ coordinates, respectively.

    Parameters:

    targetCoordinateSpace

    The display object that defines the coordinate system to use.

    Returns:

    The rectangle that defines the area of the display object relative to the targetCoordinateSpace object's coordinate -system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage(global) coordinates -to the display object's(local) coordinates.

    +system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage (global) coordinates +to the display object's (local) coordinates.

    To use this method, first create an instance of the Point class. The x and y values that you assign represent global coordinates because they relate to the origin(0,0) of the main display area. Then @@ -565,17 +565,17 @@ point specified by the x and y parameters. The x and y parameters specify a point in the coordinate space of the Stage, not the display object container that -contains the display object(unless that display object container is the +contains the display object (unless that display object container is the Stage).

    Parameters:

    x

    The x coordinate to test against this object.

    y

    The y coordinate to test against this object.

    shapeFlag

    Whether to check against the actual pixels of the object (true) or the bounding box (false).

    Returns:

    true if the display object overlaps or intersects with the specified point; false otherwise.

    invalidate():Void

    Calling the invalidate() method signals to have the current object -redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's(local) -coordinates to the Stage(global) coordinates.

    +redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's (local) +coordinates to the Stage (global) coordinates.

    This method allows you to convert any given x and y coordinates from values that are relative to the origin(0,0) of a -specific display object(local coordinates) to values that are relative to -the origin of the Stage(global coordinates).

    +specific display object (local coordinates) to values that are relative to +the origin of the Stage (global coordinates).

    To use this method, first create an instance of the Point class. The x and y values that you assign represent local coordinates because they relate to the origin of the display object.

    diff --git a/openfl/display/DisplayObjectContainer.html b/openfl/display/DisplayObjectContainer.html index 4be66e4..4a8eb82 100644 --- a/openfl/display/DisplayObjectContainer.html +++ b/openfl/display/DisplayObjectContainer.html @@ -1,7 +1,7 @@ -openfl.display.DisplayObjectContainer - API Referenceopenfl.display.DisplayObjectContainer - OpenFL API Reference
    API Reference
    View source

    class DisplayObjectContainer

    package openfl.display

    extends InteractiveObject › DisplayObject › EventDispatcher

    extended by Loader, Sprite, Stage

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.events.Event)@:access(openfl.display.Graphics)@:access(openfl.errors.Error)@:access(openfl.geom.Point)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)

    Available on all platforms

    The DisplayObjectContainer class is the base class for all objects that can +

    View source

    class DisplayObjectContainer

    package openfl.display

    extends InteractiveObject › DisplayObject › EventDispatcher

    extended by Loader, Sprite, Stage

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.events.Event)@:access(openfl.display.Graphics)@:access(openfl.errors.Error)@:access(openfl.geom.Point)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)

    Available on all platforms

    The DisplayObjectContainer class is the base class for all objects that can serve as display object containers on the display list. The display list manages all objects displayed in the Flash runtimes. Use the DisplayObjectContainer class to arrange the display objects in the display @@ -75,12 +75,12 @@ the new DisplayObjectContainer() constructor throws an ArgumentError exception.

    For more information, see the "Display Programming" chapter of the -ActionScript 3.0 Developer's Guide.

    Variables

    mouseChildren:Bool

    Determines whether or not the children of the object are mouse, or user +OpenFL Developer's Guide.

    See also:

    Variables

    mouseChildren:Bool

    Determines whether or not the children of the object are mouse, or user input device, enabled. If an object is enabled, a user can interact with it by using a mouse or user input device. The default is true.

    This property is useful when you create a button with an instance of -the Sprite class(instead of using the SimpleButton class). When you use a +the Sprite class (instead of using the SimpleButton class). When you use a Sprite instance to create a button, you can choose to decorate the button by using the addChild() method to add additional Sprite instances. This process can cause unexpected behavior with mouse events @@ -99,7 +99,7 @@ mx.core.UIComponent.hasFocusableChildren property.

    Throws:

    IllegalOperationError

    Calling this property of the Stage object throws an exception. The Stage object does not implement this property.

    Methods

    addChild(child:DisplayObject):DisplayObject

    Adds a child DisplayObject instance to this DisplayObjectContainer -instance. The child is added to the front(top) of all other children in +instance. The child is added to the front (top) of all other children in this DisplayObjectContainer instance.(To add a child to a specific index position, use the addChildAt() method.)

    If you add a child object that already has a different display object @@ -116,11 +116,11 @@ to the Stage.

    Parameters:

    child

    The DisplayObject instance to add as a child of this DisplayObjectContainer instance.

    Returns:

    The DisplayObject instance that you pass in the child parameter.

    Throws:

    ArgumentError

    Throws if the child is the same as the parent. Also -throws if the caller is a child(or grandchild etc.) +throws if the caller is a child (or grandchild etc.) of the child being added.

    Events:

    added

    Dispatched when a display object is added to the display -list.

    addChildAt(child:DisplayObject, index:Int):DisplayObject

    Adds a child DisplayObject instance to this DisplayObjectContainer +list.

    See also:

    addChildAt(child:DisplayObject, index:Int):DisplayObject

    Adds a child DisplayObject instance to this DisplayObjectContainer instance. The child is added at the index position specified. An index of -0 represents the back(bottom) of the display list for this +0 represents the back (bottom) of the display list for this DisplayObjectContainer object.

    For example, the following example shows three display objects, labeled a, b, and c, at index positions 0, 2, and 1, respectively:

    @@ -133,10 +133,10 @@ that exists at that position and all higher positions are moved up one position in the child list.

    Returns:

    The DisplayObject instance that you pass in the child parameter.

    Throws:

    ArgumentError

    Throws if the child is the same as the parent. Also -throws if the caller is a child(or grandchild etc.) +throws if the caller is a child (or grandchild etc.) of the child being added.

    RangeError

    Throws if the index position does not exist in the child list.

    Events:

    added

    Dispatched when a display object is added to the display -list.

    areInaccessibleObjectsUnderPoint(point:Point):Bool

    Indicates whether the security restrictions would cause any display +list.

    See also:

    areInaccessibleObjectsUnderPoint(point:Point):Bool

    Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point. By default, content from one domain @@ -160,7 +160,7 @@ list.

    SecurityError

    This child display object belongs to a sandbox to which you do not have access. You can avoid this situation by having the child movie call -Security.allowDomain().

    getChildByName(name:String):DisplayObject

    Returns the child display object that exists with the specified name. If +Security.allowDomain().

    See also:

    getChildByName(name:String):DisplayObject

    Returns the child display object that exists with the specified name. If more that one child display object has the specified name, the method returns the first object in the child list.

    The getChildAt() method is faster than the @@ -170,7 +170,7 @@ access a child.

    Parameters:

    name

    The name of the child to return.

    Returns:

    The child display object with the specified name.

    Throws:

    SecurityError

    This child display object belongs to a sandbox to which you do not have access. You can avoid this situation by having the child movie call the -Security.allowDomain() method.

    getChildIndex(child:DisplayObject):Int

    Returns the index position of a child DisplayObject instance.

    Parameters:

    child

    The DisplayObject instance to identify.

    Returns:

    The index position of the child display object to identify.

    Throws:

    ArgumentError

    Throws if the child parameter is not a child of this +Security.allowDomain() method.

    See also:

    getChildIndex(child:DisplayObject):Int

    Returns the index position of a child DisplayObject instance.

    Parameters:

    child

    The DisplayObject instance to identify.

    Returns:

    The index position of the child display object to identify.

    Throws:

    ArgumentError

    Throws if the child parameter is not a child of this object.

    getObjectsUnderPoint(point:Point):Array<DisplayObject>

    Returns an array of objects that lie under the specified point and are children(or grandchildren, and so on) of this DisplayObjectContainer instance. Any child objects that are inaccessible for security reasons are @@ -261,14 +261,14 @@ default any InteractiveObject instance that is on the display list receives mouse events or other user input events. If mouseEnabled is set to false, the instance does -not receive any mouse events(or other user input events like keyboard +not receive any mouse events (or other user input events like keyboard events). Any children of this instance on the display list are not affected. To change the mouseEnabled behavior for all children of an object on the display list, use openfl.display.DisplayObjectContainer.mouseChildren.

    No event is dispatched by setting this property. You must use the addEventListener() method to create interactive -functionality.

    needsSoftKeyboard:Bool

    Specifies whether a virtual keyboard(an on-screen, software keyboard) +functionality.

    needsSoftKeyboard:Bool

    Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.

    By default, the value is false and focusing an InteractiveObject instance does not raise a soft keyboard. If the @@ -328,7 +328,7 @@ cast(tlfInstance2.getChildAt(1), InteractiveObject).tabIndex = 2; cast(tlfInstance3.getChildAt(1), InteractiveObject).tabIndex = 1;

    Defined by DisplayObject

    @:keepalpha:Float

    Indicates the alpha transparency value of the object specified. Valid values are 0 (fully transparent) to 1 (fully opaque). The default value is 1. -Display objects with alpha set to 0 are active, even though they are invisible.

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A +Display objects with alpha set to 0 are active, even though they are invisible.

    See also:

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A bitmap can be drawn internally in two ways. If you have a blend mode enabled or an external clipping mask, the bitmap is drawn by adding a bitmap-filled square shape to the vector render. If you attempt to set @@ -348,7 +348,7 @@ BlendMode class defines string values you can use. The illustrations in the table show blendMode values applied to a circular display object(2) superimposed on another display object(1).

    -

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn +

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    See also:

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn to the bitmap instead of the main display. If cacheAsBitmapMatrix is null or unsupported, the bitmap is then copied to the main display as unstretched, unrotated pixels snapped @@ -379,12 +379,12 @@ number of pixels cannot exceed 16,777,215 pixels.(So, if a bitmap image is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is is 2880 pixels in height and 2,880 pixels -in width.

  • The bitmap fails to allocate(out of memory error).
    • +in width.
  • The bitmap fails to allocate (out of memory error).

    • The cacheAsBitmap property is best used with movie clips that have mostly static content and that do not scale and rotate frequently. With such movie clips, cacheAsBitmap can lead to -performance increases when the movie clip is translated(when its x -and y position is changed).

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to +performance increases when the movie clip is translated (when its x +and y position is changed).

    See also:

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. The application uses this matrix as a transformation matrix that is applied when rendering the bitmap version of the display object.

    Adobe AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop @@ -418,16 +418,16 @@

    Note: The cacheAsBitmapMatrix property is suitable for 2D transformations. If you need to apply transformations in 3D, you may do so by setting a 3D property of the object and manipulating its transform.matrix3D property. If the application is packaged using GPU mode, this allows the 3D transforms -to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated +to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    See also:

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated with the display object. The openfl.filters package contains several classes that define specific filters you can use.

    Filters can be applied in Flash Professional at design time, or at run -time by using ActionScript code. To apply a filter by using ActionScript, +time by using Haxe code. To apply a filter by using Haxe, you must make a temporary copy of the entire filters array, modify the temporary array, then assign the value of the temporary array back to the filters array. You cannot directly add a new filter object to the filters array.

    -

    To add a filter by using ActionScript, perform the following steps +

    To add a filter by using Haxe, perform the following steps (assume that the target display object is named myDisplayObject):

    1. Create a new filter object by using the constructor method of your chosen filter class.
    2. Assign the value of the myDisplayObject.filters array @@ -458,7 +458,7 @@

      The openfl.filters package includes classes for filters. For example, to create a DropShadow filter, you would write:

      Throws:

      ArgumentError

      When filters includes a ShaderFilter and the shader output type is not compatible with -this operation(the shader must specify a +this operation (the shader must specify a pixel4 output).

      ArgumentError

      When filters includes a ShaderFilter and the shader doesn't specify any image input or the first input is not an image4 input.

      ArgumentError

      When filters includes a ShaderFilter @@ -476,10 +476,10 @@ is adjusted accordingly, as shown in the following code:

      Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a height of 0, even if you try to -set height to a different value.

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file +set height to a different value.

      See also:

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file to which this display object belongs. The loaderInfo property is defined only for the root display object of a SWF file or for a loaded -Bitmap(not for a Bitmap that is drawn with ActionScript). To find the +Bitmap (not for a Bitmap that is drawn with Haxe). To find the loaderInfo object associated with the SWF file that contains a display object named myDisplayObject, use myDisplayObject.root.loaderInfo.

      @@ -491,7 +491,7 @@ list. The mask object itself is not drawn. Set mask to null to remove the mask.

      To be able to scale a mask object, it must be on the display list. To -be able to drag a mask Sprite object(by calling its +be able to drag a mask Sprite object (by calling its startDrag() method), it must be on the display list. To call the startDrag() method for a mask sprite based on a mouseDown event being dispatched by the sprite, set the @@ -510,23 +510,23 @@ more than one calling display object. When the mask is assigned to a second display object, it is removed as the mask of the first object, and that object's mask property becomes -null.

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in +null.

      See also:

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned x -coordinate will reflect the non-rotated object.

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in +coordinate will reflect the non-rotated object.

      See also:

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned y -coordinate will reflect the non-rotated object.

      name:String

      Indicates the instance name of the DisplayObject. The object can be +coordinate will reflect the non-rotated object.

      See also:

      name:String

      Indicates the instance name of the DisplayObject. The object can be identified in the child list of its parent display object container by calling the getChildByName() method of the display object container.

      Throws:

      IllegalOperationError

      If you are attempting to set this property on an object that was placed on the timeline in the Flash authoring tool.

      opaqueBackground:Null<Int>

      Specifies whether the display object is opaque with a certain background color. A transparent bitmap contains alpha channel data and is drawn -transparently. An opaque bitmap has no alpha channel(and renders faster +transparently. An opaque bitmap has no alpha channel (and renders faster than a transparent bitmap). If the bitmap is opaque, you specify its own background color to use.

      -

      If set to a number value, the surface is opaque(not transparent) with +

      If set to a number value, the surface is opaque (not transparent) with the RGB background color that the number specifies. If set to null(the default value), the display object has a transparent background.

      @@ -538,7 +538,7 @@

      The opaque background region is not matched when calling the hitTestPoint() method with the shapeFlag parameter set to true.

      -

      The opaque background region does not respond to mouse events.

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display +

      The opaque background region does not respond to mouse events.

      See also:

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display object. Use the parent property to specify a relative path to display objects that are above the current display object in the display list hierarchy.

      @@ -547,7 +547,7 @@ 
      this.parent.parent.alpha = 20;

      Throws:

      SecurityError

      The parent display object belongs to a security sandbox to which you do not have access. You can avoid this situation by having the parent movie call -the Security.allowDomain() method.

      read onlyroot:DisplayObject

      For a display object in a loaded SWF file, the root property +the Security.allowDomain() method.

      See also:

    read onlyroot:DisplayObject

    For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. For a Bitmap object representing a loaded image file, the root property is the Bitmap object @@ -560,7 +560,7 @@ is a child of the top-most display object in a loaded SWF file.

    For example, if you create a new Sprite object by calling the Sprite() constructor method, its root property -is null until you add it to the display list(or to a display +is null until you add it to the display list (or to a display object container that is off the display list but that is a child of the top-most display object in a SWF file).

    For a loaded SWF file, even though the Loader object used to load the @@ -568,12 +568,12 @@ SWF file has its root property set to itself. The Loader object does not have its root property set until it is added as a child of a display object for which the root property is -set.

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its +set.

    See also:

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement my_video.rotation = 450 -is the same as my_video.rotation = 90.

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, +is the same as my_video.rotation = 90.

    See also:

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, the entire display object is scaled normally when any scale transformation is applied.

    When you define the scale9Grid property, the display @@ -601,11 +601,11 @@ the registration point. The default registration point is (0,0). 1.0 equals 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the +y property values, which are defined in whole pixels.

    See also:

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. The default registration point is (0,0). 1.0 is 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is +y property values, which are defined in whole pixels.

    See also:

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is cropped to the size defined by the rectangle, and it scrolls within the rectangle when you change the x and y properties of the scrollRect object.

    @@ -622,17 +622,17 @@ an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated 90° and you scroll it left and right, the display object actually scrolls -up and down.

    @:betashader:Shader

    BETA**

    +up and down.

    See also:

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to apply a post-process effect to multiple display objects at once, enable cacheAsBitmap or use the filters property with a ShaderFilter

    read onlystage:Stage

    The Stage of the display object. A Flash runtime application has only one Stage object. For example, you can create and load multiple display objects into the display list, and the stage property of each -display object refers to the same Stage object(even if the display object +display object refers to the same Stage object (even if the display object belongs to a loaded SWF file).

    If a display object is not added to the display list, its -stage property is set to null.

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color +stage property is set to null.

    See also:

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. The specific properties - matrix, colorTransform, and three read-only properties (concatenatedMatrix, concatenatedColorTransform, @@ -669,21 +669,21 @@ is adjusted accordingly, as shown in the following code:

    Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a width of 0, even if you try to set -width to a different value.

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative +width to a different value.

    See also:

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative +registration point position.

    See also:

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    Inherited Methods

    Defined by InteractiveObject

    requestSoftKeyboard():Bool

    Raises a virtual keyboard.

    +registration point position.

    See also:

    Inherited Methods

    Defined by InteractiveObject

    requestSoftKeyboard():Bool

    Raises a virtual keyboard.

    Calling this method focuses the InteractiveObject instance and raises the soft keyboard, if necessary. The needsSoftKeyboard must also be true. A keyboard is not raised if a hardware keyboard @@ -719,8 +719,8 @@ coordinates, respectively.

    Parameters:

    targetCoordinateSpace

    The display object that defines the coordinate system to use.

    Returns:

    The rectangle that defines the area of the display object relative to the targetCoordinateSpace object's coordinate -system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage(global) coordinates -to the display object's(local) coordinates.

    +system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage (global) coordinates +to the display object's (local) coordinates.

    To use this method, first create an instance of the Point class. The x and y values that you assign represent global coordinates because they relate to the origin(0,0) of the main display area. Then @@ -735,17 +735,17 @@ point specified by the x and y parameters. The x and y parameters specify a point in the coordinate space of the Stage, not the display object container that -contains the display object(unless that display object container is the +contains the display object (unless that display object container is the Stage).

    Parameters:

    x

    The x coordinate to test against this object.

    y

    The y coordinate to test against this object.

    shapeFlag

    Whether to check against the actual pixels of the object (true) or the bounding box (false).

    Returns:

    true if the display object overlaps or intersects with the specified point; false otherwise.

    invalidate():Void

    Calling the invalidate() method signals to have the current object -redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's(local) -coordinates to the Stage(global) coordinates.

    +redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's (local) +coordinates to the Stage (global) coordinates.

    This method allows you to convert any given x and y coordinates from values that are relative to the origin(0,0) of a -specific display object(local coordinates) to values that are relative to -the origin of the Stage(global coordinates).

    +specific display object (local coordinates) to values that are relative to +the origin of the Stage (global coordinates).

    To use this method, first create an instance of the Point class. The x and y values that you assign represent local coordinates because they relate to the origin of the display object.

    diff --git a/openfl/display/DisplayObjectRenderer.html b/openfl/display/DisplayObjectRenderer.html index f961d41..bca5880 100644 --- a/openfl/display/DisplayObjectRenderer.html +++ b/openfl/display/DisplayObjectRenderer.html @@ -1,7 +1,7 @@ -openfl.display.DisplayObjectRenderer - API Reference
    View source

    class DisplayObjectRenderer

    package openfl.display

    extends EventDispatcher

    extended by CairoRenderer, CanvasRenderer, DOMRenderer, OpenGLRenderer

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display._internal.Context3DGraphics)@:access(lime.graphics.ImageBuffer)@:access(openfl.display.Bitmap)@:access(openfl.display.BitmapData)@:access(openfl.display.DisplayObject)@:access(openfl.display.Graphics)@:access(openfl.display.Tilemap)@:access(openfl.display3D.Context3D)@:access(openfl.events.RenderEvent)@:access(openfl.filters.BitmapFilter)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Rectangle)@:access(openfl.geom.Transform)@:access(openfl.text.TextField)@:allow(openfl.display._internal)@:allow(openfl.display)@:allow(openfl.text)

    Available on all platforms

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that +

    View source

    class DisplayObjectRenderer

    package openfl.display

    extends EventDispatcher

    extended by CairoRenderer, CanvasRenderer, DOMRenderer, OpenGLRenderer

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display._internal.Context3DGraphics)@:access(lime.graphics.ImageBuffer)@:access(openfl.display.Bitmap)@:access(openfl.display.BitmapData)@:access(openfl.display.DisplayObject)@:access(openfl.display.Graphics)@:access(openfl.display.Tilemap)@:access(openfl.display3D.Context3D)@:access(openfl.events.RenderEvent)@:access(openfl.filters.BitmapFilter)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Rectangle)@:access(openfl.geom.Transform)@:access(openfl.text.TextField)@:allow(openfl.display._internal)@:allow(openfl.display)@:allow(openfl.text)

    Available on all platforms

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

    @@ -125,7 +125,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/display/DisplayObjectShader.html b/openfl/display/DisplayObjectShader.html index 950cf2c..f708fd5 100644 --- a/openfl/display/DisplayObjectShader.html +++ b/openfl/display/DisplayObjectShader.html @@ -1,7 +1,7 @@ -openfl.display.DisplayObjectShader - API Reference

    View source

    class DisplayObjectShader

    package openfl.display

    extends Shader

    @:directlyUsed@:build(openfl.utils._internal.ShaderMacro.build())@:autoBuild(openfl.utils._internal.ShaderMacro.build())@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Constructor

    @:value({ code : null })@:glVertexHeader("attribute float openfl_Alpha;\n\t\tattribute vec4 openfl_ColorMultiplier;\n\t\tattribute vec4 openfl_ColorOffset;\n\t\tattribute vec4 openfl_Position;\n\t\tattribute vec2 openfl_TextureCoord;\n\n\t\tvarying float openfl_Alphav;\n\t\tvarying vec4 openfl_ColorMultiplierv;\n\t\tvarying vec4 openfl_ColorOffsetv;\n\t\tvarying vec2 openfl_TextureCoordv;\n\n\t\tuniform mat4 openfl_Matrix;\n\t\tuniform bool openfl_HasColorTransform;\n\t\tuniform vec2 openfl_TextureSize;")@:glVertexBody("openfl_Alphav = openfl_Alpha;\n\t\topenfl_TextureCoordv = openfl_TextureCoord;\n\n\t\tif (openfl_HasColorTransform) {\n\n\t\t\topenfl_ColorMultiplierv = openfl_ColorMultiplier;\n\t\t\topenfl_ColorOffsetv = openfl_ColorOffset / 255.0;\n\n\t\t}\n\n\t\tgl_Position = openfl_Matrix * openfl_Position;")@:glVertexSource("#pragma header\n\n\t\tvoid main(void) {\n\n\t\t\t#pragma body\n\n\t\t}")@:glFragmentHeader("varying float openfl_Alphav;\n\t\tvarying vec4 openfl_ColorMultiplierv;\n\t\tvarying vec4 openfl_ColorOffsetv;\n\t\tvarying vec2 openfl_TextureCoordv;\n\n\t\tuniform bool openfl_HasColorTransform;\n\t\tuniform sampler2D openfl_Texture;\n\t\tuniform vec2 openfl_TextureSize;")@:glFragmentBody("vec4 color = texture2D (openfl_Texture, openfl_TextureCoordv);\n\n\t\tif (color.a == 0.0) {\n\n\t\t\tgl_FragColor = vec4 (0.0, 0.0, 0.0, 0.0);\n\n\t\t} else if (openfl_HasColorTransform) {\n\n\t\t\tcolor = vec4 (color.rgb / color.a, color.a);\n\n\t\t\tmat4 colorMultiplier = mat4 (0);\n\t\t\tcolorMultiplier[0][0] = openfl_ColorMultiplierv.x;\n\t\t\tcolorMultiplier[1][1] = openfl_ColorMultiplierv.y;\n\t\t\tcolorMultiplier[2][2] = openfl_ColorMultiplierv.z;\n\t\t\tcolorMultiplier[3][3] = 1.0; // openfl_ColorMultiplierv.w;\n\n\t\t\tcolor = clamp (openfl_ColorOffsetv + (color * colorMultiplier), 0.0, 1.0);\n\n\t\t\tif (color.a > 0.0) {\n\n\t\t\t\tgl_FragColor = vec4 (color.rgb * color.a * openfl_Alphav, color.a * openfl_Alphav);\n\n\t\t\t} else {\n\n\t\t\t\tgl_FragColor = vec4 (0.0, 0.0, 0.0, 0.0);\n\n\t\t\t}\n\n\t\t} else {\n\n\t\t\tgl_FragColor = color * openfl_Alphav;\n\n\t\t}")@:glFragmentSource("#pragma header\n\n\t\tvoid main(void) {\n\n\t\t\t#pragma body\n\n\t\t}")new(?code:ByteArray)

    Inherited Variables

    Defined by Shader

    write onlybyteCode:ByteArray

    The raw shader bytecode for this Shader instance.

    data:ShaderData

    Provides access to parameters, input images, and metadata for the +

    View source

    class DisplayObjectShader

    package openfl.display

    extends Shader

    @:directlyUsed@:build(openfl.utils._internal.ShaderMacro.build())@:autoBuild(openfl.utils._internal.ShaderMacro.build())@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Constructor

    @:value({ code : null })@:glVertexHeader("attribute float openfl_Alpha;\n\t\tattribute vec4 openfl_ColorMultiplier;\n\t\tattribute vec4 openfl_ColorOffset;\n\t\tattribute vec4 openfl_Position;\n\t\tattribute vec2 openfl_TextureCoord;\n\n\t\tvarying float openfl_Alphav;\n\t\tvarying vec4 openfl_ColorMultiplierv;\n\t\tvarying vec4 openfl_ColorOffsetv;\n\t\tvarying vec2 openfl_TextureCoordv;\n\n\t\tuniform mat4 openfl_Matrix;\n\t\tuniform bool openfl_HasColorTransform;\n\t\tuniform vec2 openfl_TextureSize;")@:glVertexBody("openfl_Alphav = openfl_Alpha;\n\t\topenfl_TextureCoordv = openfl_TextureCoord;\n\n\t\tif (openfl_HasColorTransform) {\n\n\t\t\topenfl_ColorMultiplierv = openfl_ColorMultiplier;\n\t\t\topenfl_ColorOffsetv = openfl_ColorOffset / 255.0;\n\n\t\t}\n\n\t\tgl_Position = openfl_Matrix * openfl_Position;")@:glVertexSource("#pragma header\n\n\t\tvoid main(void) {\n\n\t\t\t#pragma body\n\n\t\t}")@:glFragmentHeader("varying float openfl_Alphav;\n\t\tvarying vec4 openfl_ColorMultiplierv;\n\t\tvarying vec4 openfl_ColorOffsetv;\n\t\tvarying vec2 openfl_TextureCoordv;\n\n\t\tuniform bool openfl_HasColorTransform;\n\t\tuniform sampler2D openfl_Texture;\n\t\tuniform vec2 openfl_TextureSize;")@:glFragmentBody("vec4 color = texture2D (openfl_Texture, openfl_TextureCoordv);\n\n\t\tif (color.a == 0.0) {\n\n\t\t\tgl_FragColor = vec4 (0.0, 0.0, 0.0, 0.0);\n\n\t\t} else if (openfl_HasColorTransform) {\n\n\t\t\tcolor = vec4 (color.rgb / color.a, color.a);\n\n\t\t\tmat4 colorMultiplier = mat4 (0);\n\t\t\tcolorMultiplier[0][0] = openfl_ColorMultiplierv.x;\n\t\t\tcolorMultiplier[1][1] = openfl_ColorMultiplierv.y;\n\t\t\tcolorMultiplier[2][2] = openfl_ColorMultiplierv.z;\n\t\t\tcolorMultiplier[3][3] = 1.0; // openfl_ColorMultiplierv.w;\n\n\t\t\tcolor = clamp (openfl_ColorOffsetv + (color * colorMultiplier), 0.0, 1.0);\n\n\t\t\tif (color.a > 0.0) {\n\n\t\t\t\tgl_FragColor = vec4 (color.rgb * color.a * openfl_Alphav, color.a * openfl_Alphav);\n\n\t\t\t} else {\n\n\t\t\t\tgl_FragColor = vec4 (0.0, 0.0, 0.0, 0.0);\n\n\t\t\t}\n\n\t\t} else {\n\n\t\t\tgl_FragColor = color * openfl_Alphav;\n\n\t\t}")@:glFragmentSource("#pragma header\n\n\t\tvoid main(void) {\n\n\t\t\t#pragma body\n\n\t\t}")new(?code:ByteArray)

    Inherited Variables

    Defined by Shader

    write onlybyteCode:ByteArray

    The raw shader bytecode for this Shader instance.

    data:ShaderData

    Provides access to parameters, input images, and metadata for the Shader instance. ShaderParameter objects representing parameters for the shader, ShaderInput objects representing the input images for the shader, and other values representing the shader's metadata are diff --git a/openfl/display/FPS.html b/openfl/display/FPS.html index db61587..072f83e 100644 --- a/openfl/display/FPS.html +++ b/openfl/display/FPS.html @@ -1,7 +1,7 @@ -openfl.display.FPS - API Referenceopenfl.display.FPS - OpenFL API Reference

    View source

    class FPS

    package openfl.display

    extends TextField › InteractiveObject › DisplayObject › EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The FPS class provides an easy-to-use monitor to display +

    View source

    class FPS

    package openfl.display

    extends TextField › InteractiveObject › DisplayObject › EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The FPS class provides an easy-to-use monitor to display the current frame rate of an OpenFL project

    Constructor

    @:value({ color : 0x000000, y : 10, x : 10 })new(x:Float = 10, y:Float = 10, color:Int = 0x000000)

    Variables

    read onlycurrentFPS:Int

    The current frame rate, expressed using frames-per-second

    Inherited Variables

    Defined by TextField

    antiAliasType:AntiAliasType

    The type of anti-aliasing used for this text field. Use openfl.text.AntiAliasType constants for this property. You can -control this setting only if the font is embedded(with the +control this setting only if the font is embedded (with the embedFonts property set to true). The default setting is openfl.text.AntiAliasType.NORMAL.

    To set values for this property, use the following string values:

    autoSize:TextFieldAutoSize

    Controls automatic sizing and alignment of text fields. Acceptable values @@ -78,7 +78,7 @@ TextFieldAutoSize.RIGHT, the text is treated as right-justified text, meaning that the right margin of the text field remains fixed and any resizing of a single line of the text field is on -the left margin. If the text includes a line break(for example, +the left margin. If the text includes a line break (for example, "\n" or "\r"), the bottom is also resized to fit the next line of text. If wordWrap is also set to true, only the bottom of the text field is resized and the left side remains @@ -87,7 +87,7 @@ TextFieldAutoSize.CENTER, the text is treated as center-justified text, meaning that any resizing of a single line of the text field is equally distributed to both the right and left margins. If -the text includes a line break(for example, "\n" or +the text includes a line break (for example, "\n" or "\r"), the bottom is also resized to fit the next line of text. If wordWrap is also set to true, only the bottom of the text field is resized and the left and right sides remain @@ -110,9 +110,9 @@ a window onto a block of text. The scrollV property is the 1-based index of the topmost visible line in the window.

    All the text between the lines indicated by scrollV and -bottomScrollV is currently visible in the text field.

    read onlycaretIndex:Int

    The index of the insertion point(caret) position. If no insertion point +bottomScrollV is currently visible in the text field.

    read onlycaretIndex:Int

    The index of the insertion point (caret) position. If no insertion point is displayed, the value is the position the insertion point would be if -you restored focus to the field(typically where the insertion point last +you restored focus to the field (typically where the insertion point last was, or 0 if the field has not had focus).

    Selection span indexes are zero-based(for example, the first position is 0, the second position is 1, and so on).

    @:value(false)condenseWhite:Bool = false

    A Boolean value that specifies whether extra white space (spaces, line @@ -141,7 +141,7 @@ is null.

    Note: You can't set this property if a style sheet is applied to the text field.

    Throws:

    Error

    This method cannot be used on a text field with a style -sheet.

    displayAsPassword:Bool

    Specifies whether the text field is a password text field. If the value of +sheet.

    See also:

    displayAsPassword:Bool

    Specifies whether the text field is a password text field. If the value of this property is true, the text field is treated as a password text field and hides the input characters using asterisks instead of the actual characters. If false, the text field is not @@ -155,7 +155,7 @@ for a text field, you must specify a font for that text by using the font property of a TextFormat object applied to the text field. If the specified font is not embedded in the SWF file, the text is -not displayed.

    gridFitType:GridFitType

    The type of grid fitting used for this text field. This property +not displayed.

    See also:

    gridFitType:GridFitType

    The type of grid fitting used for this text field. This property applies only if the openfl.text.AntiAliasType property of the text field is set to openfl.text.AntiAliasType.ADVANCED. The type of grid fitting used determines whether Flash Player forces @@ -163,7 +163,7 @@ grid, or not at all.

    For the openfl.text.GridFitType property, you can use the following string values:

    String valueDescription
    openfl.text.GridFitType.NONESpecifies no grid fitting. Horizontal and vertical lines in the glyphs are not forced to the pixel grid. This setting is recommended for animation or for large font sizes.
    openfl.text.GridFitType.PIXELSpecifies that strong horizontal and vertical lines are fit to the pixel grid. This setting works only for left-aligned text fields. To use this setting, the openfl.dispaly.AntiAliasType property of the text field must be set to openfl.text.AntiAliasType.ADVANCED. This setting generally provides the best legibility for left-aligned text.
    openfl.text.GridFitType.SUBPIXELSpecifies that strong horizontal and vertical lines are fit to the subpixel grid on an LCD monitor. To use this setting, the openfl.text.AntiAliasType property of the text field must be set to openfl.text.AntiAliasType.ADVANCED. The openfl.text.GridFitType.SUBPIXEL setting is often good for right-aligned or centered dynamic text, and it is sometimes a useful trade-off for animation versus text quality.

    htmlText:UTF8String

    Contains the HTML representation of the text field contents. -Flash Player supports the following HTML tags:

    TagDescription
    Anchor tagThe <a> tag creates a hypertext link and supports the following attributes:
    • target: Specifies the name of the target window where you load the page. Options include _self, _blank, _parent, and _top. The _self option specifies the current frame in the current window, _blank specifies a new window, _parent specifies the parent of the current frame, and _top specifies the top-level frame in the current window.
    • href: Specifies a URL or an ActionScript link event.The URL can be either absolute or relative to the location of the SWF file that is loading the page. An example of an absolute reference to a URL is http://www.adobe.com; an example of a relative reference is /index.html. Absolute URLs must be prefixed with http://; otherwise, Flash Player or AIR treats them as relative URLs. You can use the link event to cause the link to execute an ActionScript function in a SWF file instead of opening a URL. To specify a link event, use the event scheme instead of the http scheme in your href attribute. An example is href="event:myText" instead of href="http://myURL"; when the user clicks a hypertext link that contains the event scheme, the text field dispatches a link TextEvent with its text property set to "myText". You can then create an ActionScript function that executes whenever the link TextEvent is dispatched. You can also define a:link, a:hover, and a:active styles for anchor tags by using style sheets.
    Bold tagThe <b> tag renders text as bold. A bold typeface must be available for the font used.
    Break tagThe <br> tag creates a line break in the text field. Set the text field to be a multiline text field to use this tag.
    Font tagThe <font> tag specifies a font or list of fonts to display the text.The font tag supports the following attributes:
    • color: Only hexadecimal color (#FFFFFF) values are supported.
    • face: Specifies the name of the font to use. As shown in the following example, you can specify a list of comma-delimited font names, in which case Flash Player selects the first available font. If the specified font is not installed on the local computer system or isn't embedded in the SWF file, Flash Player selects a substitute font.
    • size: Specifies the size of the font. You can use absolute pixel sizes, such as 16 or 18, or relative point sizes, such as +2 or -4.
    Image tagThe <img> tag lets you embed external image files (JPEG, GIF, PNG), SWF files, and movie clips inside text fields. Text automatically flows around images you embed in text fields. You must set the text field to be multiline to wrap text around an image.
    The <img> tag supports the following attributes:
    • src: Specifies the URL to an image or SWF file, or the linkage identifier for a movie clip symbol in the library. This attribute is required; all other attributes are optional. External files (JPEG, GIF, PNG, and SWF files) do not show until they are downloaded completely.
    • width: The width of the image, SWF file, or movie clip being inserted, in pixels.
    • height: The height of the image, SWF file, or movie clip being inserted, in pixels.
    • align: Specifies the horizontal alignment of the embedded image within the text field. Valid values are left and right. The default value is left.
    • hspace: Specifies the amount of horizontal space that surrounds the image where no text appears. The default value is 8.
    • vspace: Specifies the amount of vertical space that surrounds the image where no text appears. The default value is 8.
    • id: Specifies the name for the movie clip instance (created by Flash Player) that contains the embedded image file, SWF file, or movie clip. This approach is used to control the embedded content with ActionScript.
    • checkPolicyFile: Specifies that Flash Player checks for a URL policy file on the server associated with the image domain. If a policy file exists, SWF files in the domains listed in the file can access the data of the loaded image, for example, by calling the BitmapData.draw() method with this image as the source parameter. For more information related to security, see the Flash Player Developer Center Topic: Security.
    Flash displays media embedded in a text field at full size. To specify the dimensions of the media you are embedding, use the <img> tag height and width attributes.
    In general, an image embedded in a text field appears on the line following the <img> tag. However, when the <img> tag is the first character in the text field, the image appears on the first line of the text field.
    For AIR content in the application security sandbox, AIR ignores img tags in HTML content in ActionScript TextField objects. This is to prevent possible phishing attacks.
    Italic tagThe <i> tag displays the tagged text in italics. An italic typeface must be available for the font used.
    List item tagThe <li> tag places a bullet in front of the text that it encloses.
    Note: Because Flash Player and AIR do not recognize ordered and unordered list tags (<ol> and <ul>, they do not modify how your list is rendered. All lists are unordered and all list items use bullets.
    Paragraph tagThe <p> tag creates a new paragraph. The text field must be set to be a multiline text field to use this tag. The <p> tag supports the following attributes:
    • align: Specifies alignment of text within the paragraph; valid values are left, right, justify, and center.
    • class: Specifies a CSS style class defined by a openfl.text.StyleSheet object.
    Span tagThe <span> tag is available only for use with CSS text styles. It supports the following attribute:
    • class: Specifies a CSS style class defined by a openfl.text.StyleSheet object.
    Text format tagThe <textformat> tag lets you use a subset of paragraph formatting properties of the TextFormat class within text fields, including line leading, indentation, margins, and tab stops. You can combine <textformat> tags with the built-in HTML tags.
    The <textformat> tag has the following attributes:
  • blockindent: Specifies the block indentation in points; corresponds to TextFormat.blockIndent.
  • indent: Specifies the indentation from the left margin to the first character in the paragraph; corresponds to TextFormat.indent. Both positive and negative numbers are acceptable.
  • leading: Specifies the amount of leading (vertical space) between lines; corresponds to TextFormat.leading. Both positive and negative numbers are acceptable.
  • leftmargin: Specifies the left margin of the paragraph, in points; corresponds to TextFormat.leftMargin.
  • rightmargin: Specifies the right margin of the paragraph, in points; corresponds to TextFormat.rightMargin.
  • tabstops: Specifies custom tab stops as an array of non-negative integers; corresponds to TextFormat.tabStops.
    • Underline tagThe <u> tag underlines the tagged text.
    +Flash Player supports the following HTML tags:

    TagDescription
    Anchor tagThe <a> tag creates a hypertext link and supports the following attributes:
    • target: Specifies the name of the target window where you load the page. Options include _self, _blank, _parent, and _top. The _self option specifies the current frame in the current window, _blank specifies a new window, _parent specifies the parent of the current frame, and _top specifies the top-level frame in the current window.
    • href: Specifies a URL or a link event. The URL can be either absolute or relative to the location of the SWF file that is loading the page. An example of an absolute reference to a URL is http://www.adobe.com; an example of a relative reference is /index.html. Absolute URLs must be prefixed with http://; otherwise, Flash Player or AIR treats them as relative URLs. You can use the link event to cause the link to execute a Haxe function instead of opening a URL. To specify a link event, use the event scheme instead of the http scheme in your href attribute. An example is href="event:myText" instead of href="http://myURL"; when the user clicks a hypertext link that contains the event scheme, the text field dispatches a link TextEvent with its text property set to "myText". You can then create a Haxe function that executes whenever the link TextEvent is dispatched. You can also define a:link, a:hover, and a:active styles for anchor tags by using style sheets.
    Bold tagThe <b> tag renders text as bold. A bold typeface must be available for the font used.
    Break tagThe <br> tag creates a line break in the text field. Set the text field to be a multiline text field to use this tag.
    Font tagThe <font> tag specifies a font or list of fonts to display the text.The font tag supports the following attributes:
    • color: Only hexadecimal color (#FFFFFF) values are supported.
    • face: Specifies the name of the font to use. As shown in the following example, you can specify a list of comma-delimited font names, in which case Flash Player selects the first available font. If the specified font is not installed on the local computer system or isn't embedded in the SWF file, Flash Player selects a substitute font.
    • size: Specifies the size of the font. You can use absolute pixel sizes, such as 16 or 18, or relative point sizes, such as +2 or -4.
    Image tagThe <img> tag lets you embed external image files (JPEG, GIF, PNG), SWF files, and movie clips inside text fields. Text automatically flows around images you embed in text fields. You must set the text field to be multiline to wrap text around an image.
    The <img> tag supports the following attributes:
    • src: Specifies the URL to an image or SWF file, or the linkage identifier for a movie clip symbol in the library. This attribute is required; all other attributes are optional. External files (JPEG, GIF, PNG, and SWF files) do not show until they are downloaded completely.
    • width: The width of the image, SWF file, or movie clip being inserted, in pixels.
    • height: The height of the image, SWF file, or movie clip being inserted, in pixels.
    • align: Specifies the horizontal alignment of the embedded image within the text field. Valid values are left and right. The default value is left.
    • hspace: Specifies the amount of horizontal space that surrounds the image where no text appears. The default value is 8.
    • vspace: Specifies the amount of vertical space that surrounds the image where no text appears. The default value is 8.
    • id: Specifies the name for the movie clip instance (created by Flash Player) that contains the embedded image file, SWF file, or movie clip. This approach is used to control the embedded content with Haxe.
    • checkPolicyFile: Specifies that Flash Player checks for a URL policy file on the server associated with the image domain. If a policy file exists, SWF files in the domains listed in the file can access the data of the loaded image, for example, by calling the BitmapData.draw() method with this image as the source parameter. For more information related to security, see the Flash Player Developer Center Topic: Security.
    Flash displays media embedded in a text field at full size. To specify the dimensions of the media you are embedding, use the <img> tag height and width attributes.
    In general, an image embedded in a text field appears on the line following the <img> tag. However, when the <img> tag is the first character in the text field, the image appears on the first line of the text field.
    For AIR content in the application security sandbox, AIR ignores img tags in HTML content in OpenFL TextField objects. This is to prevent possible phishing attacks.
    Italic tagThe <i> tag displays the tagged text in italics. An italic typeface must be available for the font used.
    List item tagThe <li> tag places a bullet in front of the text that it encloses.
    Note: Because Flash Player and AIR do not recognize ordered and unordered list tags (<ol> and <ul>, they do not modify how your list is rendered. All lists are unordered and all list items use bullets.
    Paragraph tagThe <p> tag creates a new paragraph. The text field must be set to be a multiline text field to use this tag. The <p> tag supports the following attributes:
    • align: Specifies alignment of text within the paragraph; valid values are left, right, justify, and center.
    • class: Specifies a CSS style class defined by a openfl.text.StyleSheet object.
    Span tagThe <span> tag is available only for use with CSS text styles. It supports the following attribute:
    • class: Specifies a CSS style class defined by a openfl.text.StyleSheet object.
    Text format tagThe <textformat> tag lets you use a subset of paragraph formatting properties of the TextFormat class within text fields, including line leading, indentation, margins, and tab stops. You can combine <textformat> tags with the built-in HTML tags.
    The <textformat> tag has the following attributes:
  • blockindent: Specifies the block indentation in points; corresponds to TextFormat.blockIndent.
  • indent: Specifies the indentation from the left margin to the first character in the paragraph; corresponds to TextFormat.indent. Both positive and negative numbers are acceptable.
  • leading: Specifies the amount of leading (vertical space) between lines; corresponds to TextFormat.leading. Both positive and negative numbers are acceptable.
  • leftmargin: Specifies the left margin of the paragraph, in points; corresponds to TextFormat.leftMargin.
  • rightmargin: Specifies the right margin of the paragraph, in points; corresponds to TextFormat.rightMargin.
  • tabstops: Specifies custom tab stops as an array of non-negative integers; corresponds to TextFormat.tabStops.
    • Underline tagThe <u> tag underlines the tagged text.

    Flash Player and AIR support the following HTML entities:

    EntityDescription
    &lt;< (less than)
    &gt;> (greater than)
    &amp;& (ampersand)
    &quot;" (double quotes)
    &apos;' (apostrophe, single quote)

    Flash Player and AIR also support explicit character codes, such as & (ASCII ampersand) and € (Unicode € symbol).

    read onlylength:Int

    The number of characters in a text field. A character such as tab @@ -178,7 +178,7 @@ true, the text field is multiline; if the value is false, the text field is a single-line text field. In a field of type TextFieldType.INPUT, the multiline value -determines whether the Enter key creates a new line(a value +determines whether the Enter key creates a new line (a value of false, and the Enter key is ignored). If you paste text into a TextField with a multiline value of false, newlines are stripped out of the text.

    read onlynumLines:Int

    Defines the number of text lines in a multiline text field. If @@ -207,7 +207,7 @@ my_txt.restrict = "^a-z";

    You can use a backslash to enter a ^ or - verbatim. The accepted backslash sequences are -, \^ or . The backslash must be an actual -character in the string, so when specified in ActionScript, a double +character in the string, so when specified in Haxe code, a double backslash must be used. For example, the following code includes only the dash(-) and caret(^): my_txt.restrict = "\\-\\^";

    @@ -217,8 +217,8 @@ my_txt.restrict = "A-Z^Q";

    You can use the \u escape sequence to construct restrict strings. The following code includes only the -characters from ASCII 32(space) to ASCII 126(tilde). -my_txt.restrict = "\u0020-\u007E";

    scrollH:Int

    The current horizontal scrolling position. If the scrollH +characters from ASCII 32 (space) to ASCII 126 (tilde). +my_txt.restrict = "\u0020-\u007E";

    See also:

    scrollH:Int

    The current horizontal scrolling position. If the scrollH property is 0, the text is not horizontally scrolled. This property value is an integer that represents the horizontal position in pixels.

    The units of horizontal scrolling are pixels, whereas the units of @@ -228,13 +228,13 @@ scrolling by line because users usually want to see a complete line of text rather than a partial line. Even if a line uses multiple fonts, the height of the line adjusts to fit the largest font in use.

    -

    Note: The scrollH property is zero-based, not +

    Note: The scrollH property is zero-based, not 1-based like the scrollV vertical scrolling property.

    scrollV:Int

    The vertical position of text in a text field. The scrollV property is useful for directing users to a specific paragraph in a long passage, or creating scrolling text fields.

    The units of vertical scrolling are lines, whereas the units of horizontal scrolling are pixels. If the first line displayed is the first -line in the text field, scrollV is set to 1(not 0). Horizontal scrolling +line in the text field, scrollV is set to 1 (not 0). Horizontal scrolling is measured in pixels because most fonts are proportionally spaced; that is, the characters can have different widths. Flash performs vertical scrolling by line because users usually want to see a complete line of @@ -251,19 +251,19 @@ selectable is set to true, the text in the text field can be selected with the mouse or keyboard, and the text can be copied with the Copy command. You can select text this way even if the -text field is a dynamic text field instead of an input text field.

    read onlyselectionBeginIndex:Int

    The zero-based character index value of the first character in the current +text field is a dynamic text field instead of an input text field.

    See also:

    read onlyselectionBeginIndex:Int

    The zero-based character index value of the first character in the current selection. For example, the first character is 0, the second character is 1, and so on. If no text is selected, this property is the value of -caretIndex.

    read onlyselectionEndIndex:Int

    The zero-based character index value of the last character in the current +caretIndex.

    See also:

    read onlyselectionEndIndex:Int

    The zero-based character index value of the last character in the current selection. For example, the first character is 0, the second character is 1, and so on. If no text is selected, this property is the value of -caretIndex.

    sharpness:Float

    The sharpness of the glyph edges in this text field. This property applies +caretIndex.

    See also:

    sharpness:Float

    The sharpness of the glyph edges in this text field. This property applies only if the openfl.text.AntiAliasType property of the text field is set to openfl.text.AntiAliasType.ADVANCED. The range for sharpness is a number from -400 to 400. If you attempt to set sharpness to a value outside that range, Flash sets the property to the nearest value in the range(either -400 or 400).

    styleSheet:StyleSheet

    Attaches a style sheet to the text field. For information on creating -style sheets, see the StyleSheet class and the ActionScript 3.0 +style sheets, see the StyleSheet class and the OpenFL Developer's Guide. You can change the style sheet associated with a text field at any time. If you change the style sheet in use, the text field is redrawn @@ -274,11 +274,11 @@ TextField.text and TextField.htmlText change to incorporate the formatting previously applied by the style sheet. To preserve the original TextField.htmlText contents without the formatting, save -the value in a variable before removing the style sheet.

    text:UTF8String

    A string that is the current text in the text field. Lines are separated +the value in a variable before removing the style sheet.

    See also:

    text:UTF8String

    A string that is the current text in the text field. Lines are separated by the carriage return character('\r', ASCII 13). This property contains unformatted text in the text field, without HTML tags.

    To get the text in HTML form, use the htmlText -property.

    textColor:Int

    The color of the text in a text field, in hexadecimal format. The +property.

    See also:

    textColor:Int

    The color of the text in a text field, in hexadecimal format. The hexadecimal color system uses six digits to represent color values. Each digit has 16 possible values or characters. The characters range from 0-9 and then A-F. For example, black is 0x000000; white is @@ -286,7 +286,7 @@ constants: TextFieldType.DYNAMIC, which specifies a dynamic text field, which a user cannot edit, or TextFieldType.INPUT, which specifies an input text field, which a user can edit.

    Throws:

    ArgumentError

    The type specified is not a member of -openfl.text.TextFieldType.

    wordWrap:Bool

    A Boolean value that indicates whether the text field has word wrap. If +openfl.text.TextFieldType.

    See also:

    wordWrap:Bool

    A Boolean value that indicates whether the text field has word wrap. If the value of wordWrap is true, the text field has word wrap; if the value is false, the text field does not have word wrap. The default value is false.

    Defined by InteractiveObject

    doubleClickEnabled:Bool

    Specifies whether the object receives doubleClick events. The @@ -308,14 +308,14 @@ default any InteractiveObject instance that is on the display list receives mouse events or other user input events. If mouseEnabled is set to false, the instance does -not receive any mouse events(or other user input events like keyboard +not receive any mouse events (or other user input events like keyboard events). Any children of this instance on the display list are not affected. To change the mouseEnabled behavior for all children of an object on the display list, use openfl.display.DisplayObjectContainer.mouseChildren.

    No event is dispatched by setting this property. You must use the addEventListener() method to create interactive -functionality.

    needsSoftKeyboard:Bool

    Specifies whether a virtual keyboard(an on-screen, software keyboard) +functionality.

    needsSoftKeyboard:Bool

    Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.

    By default, the value is false and focusing an InteractiveObject instance does not raise a soft keyboard. If the @@ -375,7 +375,7 @@ cast(tlfInstance2.getChildAt(1), InteractiveObject).tabIndex = 2; cast(tlfInstance3.getChildAt(1), InteractiveObject).tabIndex = 1;

    Defined by DisplayObject

    @:keepalpha:Float

    Indicates the alpha transparency value of the object specified. Valid values are 0 (fully transparent) to 1 (fully opaque). The default value is 1. -Display objects with alpha set to 0 are active, even though they are invisible.

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A +Display objects with alpha set to 0 are active, even though they are invisible.

    See also:

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A bitmap can be drawn internally in two ways. If you have a blend mode enabled or an external clipping mask, the bitmap is drawn by adding a bitmap-filled square shape to the vector render. If you attempt to set @@ -395,7 +395,7 @@ BlendMode class defines string values you can use. The illustrations in the table show blendMode values applied to a circular display object(2) superimposed on another display object(1).

    -

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn +

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    See also:

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn to the bitmap instead of the main display. If cacheAsBitmapMatrix is null or unsupported, the bitmap is then copied to the main display as unstretched, unrotated pixels snapped @@ -426,12 +426,12 @@ number of pixels cannot exceed 16,777,215 pixels.(So, if a bitmap image is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is is 2880 pixels in height and 2,880 pixels -in width.

  • The bitmap fails to allocate(out of memory error).
    • +in width.
  • The bitmap fails to allocate (out of memory error).

    • The cacheAsBitmap property is best used with movie clips that have mostly static content and that do not scale and rotate frequently. With such movie clips, cacheAsBitmap can lead to -performance increases when the movie clip is translated(when its x -and y position is changed).

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to +performance increases when the movie clip is translated (when its x +and y position is changed).

    See also:

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. The application uses this matrix as a transformation matrix that is applied when rendering the bitmap version of the display object.

    Adobe AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop @@ -465,16 +465,16 @@

    Note: The cacheAsBitmapMatrix property is suitable for 2D transformations. If you need to apply transformations in 3D, you may do so by setting a 3D property of the object and manipulating its transform.matrix3D property. If the application is packaged using GPU mode, this allows the 3D transforms -to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated +to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    See also:

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated with the display object. The openfl.filters package contains several classes that define specific filters you can use.

    Filters can be applied in Flash Professional at design time, or at run -time by using ActionScript code. To apply a filter by using ActionScript, +time by using Haxe code. To apply a filter by using Haxe, you must make a temporary copy of the entire filters array, modify the temporary array, then assign the value of the temporary array back to the filters array. You cannot directly add a new filter object to the filters array.

    -

    To add a filter by using ActionScript, perform the following steps +

    To add a filter by using Haxe, perform the following steps (assume that the target display object is named myDisplayObject):

    1. Create a new filter object by using the constructor method of your chosen filter class.
    2. Assign the value of the myDisplayObject.filters array @@ -505,7 +505,7 @@

      The openfl.filters package includes classes for filters. For example, to create a DropShadow filter, you would write:

      Throws:

      ArgumentError

      When filters includes a ShaderFilter and the shader output type is not compatible with -this operation(the shader must specify a +this operation (the shader must specify a pixel4 output).

      ArgumentError

      When filters includes a ShaderFilter and the shader doesn't specify any image input or the first input is not an image4 input.

      ArgumentError

      When filters includes a ShaderFilter @@ -523,10 +523,10 @@ is adjusted accordingly, as shown in the following code:

      Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a height of 0, even if you try to -set height to a different value.

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file +set height to a different value.

      See also:

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file to which this display object belongs. The loaderInfo property is defined only for the root display object of a SWF file or for a loaded -Bitmap(not for a Bitmap that is drawn with ActionScript). To find the +Bitmap (not for a Bitmap that is drawn with Haxe). To find the loaderInfo object associated with the SWF file that contains a display object named myDisplayObject, use myDisplayObject.root.loaderInfo.

      @@ -538,7 +538,7 @@ list. The mask object itself is not drawn. Set mask to null to remove the mask.

      To be able to scale a mask object, it must be on the display list. To -be able to drag a mask Sprite object(by calling its +be able to drag a mask Sprite object (by calling its startDrag() method), it must be on the display list. To call the startDrag() method for a mask sprite based on a mouseDown event being dispatched by the sprite, set the @@ -557,23 +557,23 @@ more than one calling display object. When the mask is assigned to a second display object, it is removed as the mask of the first object, and that object's mask property becomes -null.

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in +null.

      See also:

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned x -coordinate will reflect the non-rotated object.

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in +coordinate will reflect the non-rotated object.

      See also:

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned y -coordinate will reflect the non-rotated object.

      name:String

      Indicates the instance name of the DisplayObject. The object can be +coordinate will reflect the non-rotated object.

      See also:

      name:String

      Indicates the instance name of the DisplayObject. The object can be identified in the child list of its parent display object container by calling the getChildByName() method of the display object container.

      Throws:

      IllegalOperationError

      If you are attempting to set this property on an object that was placed on the timeline in the Flash authoring tool.

      opaqueBackground:Null<Int>

      Specifies whether the display object is opaque with a certain background color. A transparent bitmap contains alpha channel data and is drawn -transparently. An opaque bitmap has no alpha channel(and renders faster +transparently. An opaque bitmap has no alpha channel (and renders faster than a transparent bitmap). If the bitmap is opaque, you specify its own background color to use.

      -

      If set to a number value, the surface is opaque(not transparent) with +

      If set to a number value, the surface is opaque (not transparent) with the RGB background color that the number specifies. If set to null(the default value), the display object has a transparent background.

      @@ -585,7 +585,7 @@

      The opaque background region is not matched when calling the hitTestPoint() method with the shapeFlag parameter set to true.

      -

      The opaque background region does not respond to mouse events.

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display +

      The opaque background region does not respond to mouse events.

      See also:

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display object. Use the parent property to specify a relative path to display objects that are above the current display object in the display list hierarchy.

      @@ -594,7 +594,7 @@ 
      this.parent.parent.alpha = 20;

      Throws:

      SecurityError

      The parent display object belongs to a security sandbox to which you do not have access. You can avoid this situation by having the parent movie call -the Security.allowDomain() method.

      read onlyroot:DisplayObject

      For a display object in a loaded SWF file, the root property +the Security.allowDomain() method.

      See also:

    read onlyroot:DisplayObject

    For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. For a Bitmap object representing a loaded image file, the root property is the Bitmap object @@ -607,7 +607,7 @@ is a child of the top-most display object in a loaded SWF file.

    For example, if you create a new Sprite object by calling the Sprite() constructor method, its root property -is null until you add it to the display list(or to a display +is null until you add it to the display list (or to a display object container that is off the display list but that is a child of the top-most display object in a SWF file).

    For a loaded SWF file, even though the Loader object used to load the @@ -615,12 +615,12 @@ SWF file has its root property set to itself. The Loader object does not have its root property set until it is added as a child of a display object for which the root property is -set.

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its +set.

    See also:

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement my_video.rotation = 450 -is the same as my_video.rotation = 90.

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, +is the same as my_video.rotation = 90.

    See also:

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, the entire display object is scaled normally when any scale transformation is applied.

    When you define the scale9Grid property, the display @@ -648,11 +648,11 @@ the registration point. The default registration point is (0,0). 1.0 equals 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the +y property values, which are defined in whole pixels.

    See also:

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. The default registration point is (0,0). 1.0 is 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is +y property values, which are defined in whole pixels.

    See also:

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is cropped to the size defined by the rectangle, and it scrolls within the rectangle when you change the x and y properties of the scrollRect object.

    @@ -669,17 +669,17 @@ an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated 90° and you scroll it left and right, the display object actually scrolls -up and down.

    @:betashader:Shader

    BETA**

    +up and down.

    See also:

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to apply a post-process effect to multiple display objects at once, enable cacheAsBitmap or use the filters property with a ShaderFilter

    read onlystage:Stage

    The Stage of the display object. A Flash runtime application has only one Stage object. For example, you can create and load multiple display objects into the display list, and the stage property of each -display object refers to the same Stage object(even if the display object +display object refers to the same Stage object (even if the display object belongs to a loaded SWF file).

    If a display object is not added to the display list, its -stage property is set to null.

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color +stage property is set to null.

    See also:

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. The specific properties - matrix, colorTransform, and three read-only properties (concatenatedMatrix, concatenatedColorTransform, @@ -716,21 +716,21 @@ is adjusted accordingly, as shown in the following code:

    Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a width of 0, even if you try to set -width to a different value.

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative +width to a different value.

    See also:

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative +registration point position.

    See also:

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    Inherited Methods

    Defined by TextField

    appendText(text:String):Void

    Appends the string specified by the newText parameter to the +registration point position.

    See also:

    Inherited Methods

    Defined by TextField

    appendText(text:String):Void

    Appends the string specified by the newText parameter to the end of the text of the text field. This method is more efficient than an addition assignment(+=) on a text property (such as someTextField.text += moreText), particularly for a @@ -738,22 +738,22 @@ example, the first position is 0, the second position is 1, and so on).

    Returns:

    A rectangle with x and y minimum and maximum values defining the bounding box of the character.

    getCharIndexAtPoint(x:Float, y:Float):Int

    Returns the zero-based index value of the character at the point specified -by the x and y parameters.

    Parameters:

    x

    The x coordinate of the character.

    y

    The y coordinate of the character.

    Returns:

    The zero-based index value of the character(for example, the +by the x and y parameters.

    Parameters:

    x

    The x coordinate of the character.

    y

    The y coordinate of the character.

    Returns:

    The zero-based index value of the character (for example, the first position is 0, the second position is 1, and so on). Returns -1 if the point is not over any character.

    getFirstCharInParagraph(charIndex:Int):Int

    Given a character index, returns the index of the first character in the same paragraph.

    Parameters:

    charIndex

    The zero-based index value of the character (for example, the first character is 0, the second character is 1, and so on).

    Returns:

    The zero-based index value of the first character in the same paragraph.

    Throws:

    RangeError

    The character index specified is out of range.

    getLineIndexAtPoint(x:Float, y:Float):Int

    Returns the zero-based index value of the line at the point specified by -the x and y parameters.

    Parameters:

    x

    The x coordinate of the line.

    y

    The y coordinate of the line.

    Returns:

    The zero-based index value of the line(for example, the first +the x and y parameters.

    Parameters:

    x

    The x coordinate of the line.

    y

    The y coordinate of the line.

    Returns:

    The zero-based index value of the line (for example, the first line is 0, the second line is 1, and so on). Returns -1 if the point is not over any line.

    getLineIndexOfChar(charIndex:Int):Int

    Returns the zero-based index value of the line containing the character specified by the charIndex parameter.

    Parameters:

    charIndex

    The zero-based index value of the character (for example, the first character is 0, the second character is 1, and so on).

    Returns:

    The zero-based index value of the line.

    Throws:

    RangeError

    The character index specified is out of range.

    getLineLength(lineIndex:Int):Int

    Returns the number of characters in a specific text line.

    Parameters:

    lineIndex

    The line number for which you want the length.

    Returns:

    The number of characters in the line.

    Throws:

    RangeError

    The line number specified is out of range.

    getLineMetrics(lineIndex:Int):TextLineMetrics

    Returns metrics information about a given text line.

    Parameters:

    lineIndex

    The line number for which you want metrics information.

    Returns:

    A TextLineMetrics object.

    Throws:

    RangeError

    The line number specified is out of range.

    getLineOffset(lineIndex:Int):Int

    Returns the character index of the first character in the line that the -lineIndex parameter specifies.

    Parameters:

    lineIndex

    The zero-based index value of the line(for example, the +lineIndex parameter specifies.

    Parameters:

    lineIndex

    The zero-based index value of the line (for example, the first line is 0, the second line is 1, and so on).

    Returns:

    The zero-based index value of the first character in the line.

    Throws:

    RangeError

    The line number specified is out of range.

    getLineText(lineIndex:Int):String

    Returns the text of the line specified by the lineIndex -parameter.

    Parameters:

    lineIndex

    The zero-based index value of the line(for example, the +parameter.

    Parameters:

    lineIndex

    The zero-based index value of the line (for example, the first line is 0, the second line is 1, and so on).

    Returns:

    The text string contained in the specified line.

    Throws:

    RangeError

    The line number specified is out of range.

    getParagraphLength(charIndex:Int):Int

    Given a character index, returns the length of the paragraph containing the given character. The length is relative to the first character in the paragraph (as returned by @@ -793,7 +793,7 @@ caretIndex property.

    Parameters:

    beginIndex

    The zero-based index value of the first character in the selection(for example, the first character is 0, the second character is 1, and so on).

    endIndex

    The zero-based index value of the last character in the -selection.

    @:value({ endIndex : -1, beginIndex : -1 })setTextFormat(format:TextFormat, beginIndex:Int = -1, endIndex:Int = -1):Void

    Applies the text formatting that the format parameter +selection.

    See also:

    @:value({ endIndex : -1, beginIndex : -1 })setTextFormat(format:TextFormat, beginIndex:Int = -1, endIndex:Int = -1):Void

    Applies the text formatting that the format parameter specifies to the specified text in a text field. The value of format must be a TextFormat object that specifies the desired text formatting changes. Only the non-null properties of @@ -826,7 +826,7 @@ defaultTextFormat.

    Parameters:

    format

    A TextFormat object that contains character and paragraph formatting information.

    Throws:

    Error

    This method cannot be used on a text field with a style sheet.

    RangeError

    The beginIndex or endIndex -specified is out of range.

    Defined by InteractiveObject

    requestSoftKeyboard():Bool

    Raises a virtual keyboard.

    +specified is out of range.

    See also:

    Defined by InteractiveObject

    requestSoftKeyboard():Bool

    Raises a virtual keyboard.

    Calling this method focuses the InteractiveObject instance and raises the soft keyboard, if necessary. The needsSoftKeyboard must also be true. A keyboard is not raised if a hardware keyboard @@ -862,8 +862,8 @@ coordinates, respectively.

    Parameters:

    targetCoordinateSpace

    The display object that defines the coordinate system to use.

    Returns:

    The rectangle that defines the area of the display object relative to the targetCoordinateSpace object's coordinate -system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage(global) coordinates -to the display object's(local) coordinates.

    +system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage (global) coordinates +to the display object's (local) coordinates.

    To use this method, first create an instance of the Point class. The x and y values that you assign represent global coordinates because they relate to the origin(0,0) of the main display area. Then @@ -878,17 +878,17 @@ point specified by the x and y parameters. The x and y parameters specify a point in the coordinate space of the Stage, not the display object container that -contains the display object(unless that display object container is the +contains the display object (unless that display object container is the Stage).

    Parameters:

    x

    The x coordinate to test against this object.

    y

    The y coordinate to test against this object.

    shapeFlag

    Whether to check against the actual pixels of the object (true) or the bounding box (false).

    Returns:

    true if the display object overlaps or intersects with the specified point; false otherwise.

    invalidate():Void

    Calling the invalidate() method signals to have the current object -redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's(local) -coordinates to the Stage(global) coordinates.

    +redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's (local) +coordinates to the Stage (global) coordinates.

    This method allows you to convert any given x and y coordinates from values that are relative to the origin(0,0) of a -specific display object(local coordinates) to values that are relative to -the origin of the Stage(global coordinates).

    +specific display object (local coordinates) to values that are relative to +the origin of the Stage (global coordinates).

    To use this method, first create an instance of the Point class. The x and y values that you assign represent local coordinates because they relate to the origin of the display object.

    diff --git a/openfl/display/FocusDirection.html b/openfl/display/FocusDirection.html index 983ec58..a5e73c0 100644 --- a/openfl/display/FocusDirection.html +++ b/openfl/display/FocusDirection.html @@ -1,7 +1,7 @@ -openfl.display.FocusDirection - API Referenceopenfl.display.FocusDirection - OpenFL API Reference
    View source

    enum abstract FocusDirection(Null<Int>)

    package openfl.display

    @:enum

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The FocusDirection class enumerates values to be used for the direction +

    View source

    enum abstract FocusDirection(Null<Int>)

    package openfl.display

    @:enum

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The FocusDirection class enumerates values to be used for the direction parameter of the assignFocus() method of a Stage object and for the direction property of a FocusEvent object.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBOTTOM:FocusDirection = 0

    Indicates that focus should be given to the object at the end of the reading order.

    @:value(cast 1)@:impl@:enuminlineread onlyNONE:FocusDirection = 1

    Indicates that focus object within the interactive object should not diff --git a/openfl/display/FrameLabel.html b/openfl/display/FrameLabel.html index 26fab88..9566c11 100644 --- a/openfl/display/FrameLabel.html +++ b/openfl/display/FrameLabel.html @@ -1,7 +1,7 @@ -openfl.display.FrameLabel - API Referenceopenfl.display.FrameLabel - OpenFL API Reference

    View source

    final class FrameLabel

    package openfl.display

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The FrameLabel object contains properties that specify a frame number and +

    View source

    final class FrameLabel

    package openfl.display

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The FrameLabel object contains properties that specify a frame number and the corresponding label name. The Scene class includes a labels property, which is an array of FrameLabel objects for the scene.

    Constructor

    new(name:String, frame:Int)

    Variables

    read onlyframe:Int

    The frame number containing the label.

    read onlyname:String

    The name of the label.

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event @@ -129,7 +129,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/display/FrameScript.html b/openfl/display/FrameScript.html index dbab192..2fbe3fd 100644 --- a/openfl/display/FrameScript.html +++ b/openfl/display/FrameScript.html @@ -1,7 +1,7 @@ -openfl.display.FrameScript - API Reference

    View source

    final class FrameScript

    package openfl.display

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    Constructor

    new(script:MovieClip ‑> Void, frame:Int)

    Variables

    read onlyframe:Int

    read onlyscript:MovieClip ‑> Void

    \ No newline at end of file +
    View source

    final class FrameScript

    package openfl.display

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    Constructor

    new(script:MovieClip ‑> Void, frame:Int)

    Variables

    read onlyframe:Int

    read onlyscript:MovieClip ‑> Void

    \ No newline at end of file diff --git a/openfl/display/GradientType.html b/openfl/display/GradientType.html index 86519f0..d923a47 100644 --- a/openfl/display/GradientType.html +++ b/openfl/display/GradientType.html @@ -1,7 +1,7 @@ -openfl.display.GradientType - API Referenceopenfl.display.GradientType - OpenFL API Reference
    View source

    enum abstract GradientType(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The GradientType class provides values for the type parameter +

    View source

    enum abstract GradientType(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The GradientType class provides values for the type parameter in the beginGradientFill() and lineGradientStyle() methods of the openfl.display.Graphics -class.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyLINEAR:GradientType = 0

    Value used to specify a linear gradient fill.

    @:value(cast 1)@:impl@:enuminlineread onlyRADIAL:GradientType = 1

    Value used to specify a radial gradient fill.

    \ No newline at end of file +class.

    See also:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyLINEAR:GradientType = 0

    Value used to specify a linear gradient fill.

    @:value(cast 1)@:impl@:enuminlineread onlyRADIAL:GradientType = 1

    Value used to specify a radial gradient fill.

    \ No newline at end of file diff --git a/openfl/display/Graphics.html b/openfl/display/Graphics.html index 990ce92..3a6b197 100644 --- a/openfl/display/Graphics.html +++ b/openfl/display/Graphics.html @@ -1,7 +1,7 @@ -openfl.display.Graphics - API Referenceopenfl.display.Graphics - OpenFL API Reference
    API Reference
    View source

    final class Graphics

    package openfl.display

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.DisplayObject)@:access(openfl.display.GraphicsPath)@:access(openfl.display.IGraphicsData)@:access(openfl.display.IGraphicsFill)@:access(openfl.display.Shader)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)@:final

    Available on all platforms

    The Graphics class contains a set of methods that you can use to create a +

    View source

    final class Graphics

    package openfl.display

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.DisplayObject)@:access(openfl.display.GraphicsPath)@:access(openfl.display.IGraphicsData)@:access(openfl.display.IGraphicsFill)@:access(openfl.display.Shader)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)@:final

    Available on all platforms

    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 graphics property that is a Graphics object. The following are among those helper functions provided for ease of use: drawRect(), drawRoundRect(), drawCircle(), and drawEllipse().

    -

    You cannot create a Graphics object directly from ActionScript code. If +

    You cannot create a Graphics object directly from Haxe code. If you call new Graphics(), an exception is thrown.

    -

    The Graphics class is final; it cannot be subclassed.

    Methods

    @:value({ smooth : false, repeat : true, matrix : null })beginBitmapFill(bitmap:BitmapData, ?matrix:Matrix, repeat:Bool = true, smooth:Bool = false):Void

    Fills a drawing area with a bitmap image. The bitmap can be repeated or +

    The Graphics class is final; it cannot be subclassed.

    See also:

    Methods

    @:value({ smooth : false, repeat : true, matrix : null })beginBitmapFill(bitmap:BitmapData, ?matrix:Matrix, repeat:Bool = true, smooth:Bool = false):Void

    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 beginFill(), beginBitmapFill(), beginGradientFill(), or beginShaderFill() method. Calling the clear() method clears the fill.

    The application renders the fill whenever three or more points are drawn, or when the endFill() method is called.

    Parameters:

    bitmap

    A transparent or opaque bitmap image that contains the bits -to be displayed.

    matrix

    A matrix object(of the openfl.geom.Matrix class), which you +to be displayed.

    matrix

    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):

    @@ -86,7 +86,7 @@ pattern. If false, the bitmap image does not repeat, and the edges of the bitmap are used for any fill area that extends beyond the bitmap.

    -

    For example, consider the following bitmap(a 20 x +

    For example, consider the following bitmap (a 20 x 20-pixel checkerboard pattern):

    20 by 20 pixel checkerboard

    When repeat is set to true(as @@ -161,7 +161,7 @@ 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 focalPointRatio set to 0.75: -radial gradient with focalPointRatio set to 0.75

    Throws:

    ArgumentError

    If the type parameter is not valid.

    @:value({ matrix : null })beginShaderFill(shader:Shader, ?matrix:Matrix):Void

    Specifies a shader fill used by subsequent calls to other Graphics +radial gradient with focalPointRatio set to 0.75

    Throws:

    ArgumentError

    If the type parameter is not valid.

    See also:

    @:value({ matrix : null })beginShaderFill(shader:Shader, ?matrix:Matrix):Void

    Specifies a shader fill used by subsequent calls to other Graphics methods (such as lineTo() or drawCircle()) for the object. The fill remains in effect until you call the beginFill(), beginBitmapFill(), beginGradientFill(), or beginShaderFill() @@ -221,7 +221,7 @@ relative to the registration point of the parent display object.

    controlY2

    Specifies the vertical position of the second control point relative to the registration point of the parent display object.

    anchorX

    Specifies the horizontal position of the anchor point relative to the registration point of the parent display object.

    anchorY

    Specifies the vertical position of the anchor point relative to -the registration point of the parent display object.

    curveTo(controlX:Float, controlY:Float, anchorX:Float, anchorY:Float):Void

    Draws a quadratic curve using the current line style from the current drawing +the registration point of the parent display object.

    See also:

    curveTo(controlX:Float, controlY:Float, anchorX:Float, anchorY:Float):Void

    Draws a quadratic curve using the current line style from the current drawing position to(anchorX, anchorY) and using the control point that (controlX, controlY) specifies. The current drawing position is then set to(anchorX, @@ -243,15 +243,15 @@ next anchor point relative to the registration point of the parent display object.

    anchorY

    A number that specifies the vertical position of the next anchor point relative to the registration point of the -parent display object.

    drawCircle(x:Float, y:Float, radius:Float):Void

    drawEllipse(x:Float, y:Float, width:Float, height:Float):Void

    Draws an ellipse. Set the line style, fill, or both before you call the +parent display object.

    See also:

    drawCircle(x:Float, y:Float, radius:Float):Void

    See also:

    drawEllipse(x:Float, y:Float, width:Float, height:Float):Void

    Draws an ellipse. Set the line style, fill, or both before you call the drawEllipse() method, by calling the linestyle(), lineGradientStyle(), beginFill(), beginGradientFill(), or beginBitmapFill() method.

    Parameters:

    x

    The x location of the top-left of the bounding-box of the ellipse relative to the registration point of the parent -display object(in pixels).

    y

    The y location of the top left of the bounding-box of +display object (in pixels).

    y

    The y location of the top left of the bounding-box of the ellipse relative to the registration point of the parent -display object(in pixels).

    width

    The width of the ellipse(in pixels).

    height

    The height of the ellipse(in pixels).

    drawGraphicsData(graphicsData:Vector<IGraphicsData>):Void

    Submits a series of IGraphicsData instances for drawing. This method +display object (in pixels).

    width

    The width of the ellipse (in pixels).

    height

    The height of the ellipse (in pixels).

    See also:

    drawGraphicsData(graphicsData:Vector<IGraphicsData>):Void

    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 @@ -280,7 +280,7 @@ 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.) - A sub-path that isn't closed(the end point is not equal to the + A sub-path that isn't closed (the end point is not equal to the begin point) is implicitly closed.

  • When a stroke is applied to rendering a path: The sub-paths can be composed of any number of points. The sub-path is never implicitly closed.

    • Parameters:

    commands

    A Vector of integers representing drawing commands. The set @@ -288,7 +288,7 @@ as a coordinate location (an x, y pair). The x- and y-coordinate value pairs are not Point objects; the data vector is a series of numbers where each group of two numbers represents a coordinate location.

    winding

    Specifies the winding rule using a value defined in the -GraphicsPathWinding class.

    @:value({ transforms : null, indices : null })drawQuads(rects:Vector<Float>, ?indices:Vector<Int>, ?transforms:Vector<Float>):Void

    Renders a set of quadrilaterals. This is similar to calling drawRect +GraphicsPathWinding class.

    See also:

    @:value({ transforms : null, indices : null })drawQuads(rects:Vector<Float>, ?indices:Vector<Int>, ?transforms:Vector<Float>):Void

    Renders a set of quadrilaterals. This is similar to calling drawRect repeatedly, but each rectangle can use a transform value to rotate, scale or skew the result.

    Any type of fill can be used, but if the fill has a transform matrix @@ -313,11 +313,11 @@ lineGradientStyle(), beginFill(), beginGradientFill(), or beginBitmapFill() method.

    Parameters:

    x

    A number indicating the horizontal position relative to the -registration point of the parent display object(in pixels).

    y

    A number indicating the vertical position relative to the -registration point of the parent display object(in pixels).

    width

    The width of the rectangle(in pixels).

    height

    The height of the rectangle(in pixels).

    Throws:

    ArgumentError

    If the width or height +registration point of the parent display object (in pixels).

    y

    A number indicating the vertical position relative to the +registration point of the parent display object (in pixels).

    width

    The width of the rectangle (in pixels).

    height

    The height of the rectangle (in pixels).

    Throws:

    ArgumentError

    If the width or height parameters are not a number

    				 (`Number.NaN`).
-

    @:value({ ellipseHeight : null })drawRoundRect(x:Float, y:Float, width:Float, height:Float, ellipseWidth:Float, ?ellipseHeight:Float):Void

    Draws a rounded rectangle. Set the line style, fill, or both before you +

    See also:

    @:value({ ellipseHeight : null })drawRoundRect(x:Float, y:Float, width:Float, height:Float, ellipseWidth:Float, ?ellipseHeight:Float):Void

    Draws a rounded rectangle. Set the line style, fill, or both before you call the drawRoundRect() method, by calling the linestyle(), lineGradientStyle(), beginFill(), beginGradientFill(), or @@ -326,14 +326,14 @@ object(in pixels).

    y

    A number indicating the vertical position relative to the registration point of the parent display object

    				(in pixels).
-
    width

    The width of the round rectangle(in pixels).

    height

    The height of the round rectangle(in pixels).

    ellipseWidth

    The width of the ellipse used to draw the rounded +width

    The width of the round rectangle (in pixels).

    height

    The height of the round rectangle (in pixels).

    ellipseWidth

    The width of the ellipse used to draw the rounded corners(in pixels).

    ellipseHeight

    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 ellipseWidth parameter.

    Throws:

    ArgumentError

    If the width, height, ellipseWidth or ellipseHeight parameters are not a -number(Number.NaN).

    drawRoundRectComplex(x:Float, y:Float, width:Float, height:Float, topLeftRadius:Float, topRightRadius:Float, bottomLeftRadius:Float, bottomRightRadius:Float):Void

    Undocumented method

    @:value({ culling : TriangleCulling.NONE, uvtData : null, indices : null })drawTriangles(vertices:Vector<Float>, ?indices:Vector<Int>, ?uvtData:Vector<Float>, culling:TriangleCulling = TriangleCulling.NONE):Void

    Renders a set of triangles, typically to distort bitmaps and give them a +number(Number.NaN).

    See also:

    drawRoundRectComplex(x:Float, y:Float, width:Float, height:Float, topLeftRadius:Float, topRightRadius:Float, bottomLeftRadius:Float, bottomRightRadius:Float):Void

    Undocumented method

    @:value({ culling : TriangleCulling.NONE, uvtData : null, indices : null })drawTriangles(vertices:Vector<Float>, ?indices:Vector<Int>, ?uvtData:Vector<Float>, culling:TriangleCulling = TriangleCulling.NONE):Void

    Renders a set of triangles, typically to distort bitmaps and give them a three-dimensional appearance. The drawTriangles() method maps either the current fill, or a bitmap fill, to the triangle faces using a set of(u,v) coordinates.

    @@ -344,7 +344,7 @@ 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.

    endFill():Void

    Applies a fill to the lines and curves that were added since the last call +TriangleCulling class.

    See also:

    endFill():Void

    Applies a fill to the lines and curves that were added since the last call to the beginFill(), beginGradientFill(), or beginBitmapFill() method. Flash uses the fill that was specified in the previous call to the beginFill(), @@ -411,7 +411,7 @@ 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 focalPointRatio of -0.75: -radial gradient with focalPointRatio set to 0.75

    @:value({ miterLimit : 3, joints : null, caps : null, scaleMode : LineScaleMode.NORMAL, pixelHinting : false, alpha : 1, color : 0, thickness : null })lineStyle(?thickness:Float, color:Int = 0, alpha:Float = 1, pixelHinting:Bool = false, scaleMode:LineScaleMode = LineScaleMode.NORMAL, ?caps:CapsStyle, ?joints:JointStyle, miterLimit:Float = 3):Void

    Specifies a line style used for subsequent calls to Graphics methods such +radial gradient with focalPointRatio set to 0.75

    See also:

    @:value({ miterLimit : 3, joints : null, caps : null, scaleMode : LineScaleMode.NORMAL, pixelHinting : false, alpha : 1, color : 0, thickness : null })lineStyle(?thickness:Float, color:Int = 0, alpha:Float = 1, pixelHinting:Bool = false, scaleMode:LineScaleMode = LineScaleMode.NORMAL, ?caps:CapsStyle, ?joints:JointStyle, miterLimit:Float = 3):Void

    Specifies a line style used for subsequent calls to Graphics methods such as the lineTo() method or the drawCircle() method. The line style remains in effect until you call the lineGradientStyle() method, the @@ -420,9 +420,9 @@

    You can call the lineStyle() method in the middle of drawing a path to specify different styles for different line segments within the path.

    -

    Note: Calls to the clear() method set the line +

    Note: Calls to the clear() method set the line style back to undefined.

    -

    Note: Flash Lite 4 supports only the first three parameters +

    Note: Flash Lite 4 supports only the first three parameters (thickness, color, and alpha).

    Parameters:

    thickness

    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 @@ -435,7 +435,7 @@ 

    			   (black). Optional.
    alpha

    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 +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.

    pixelHinting

    (Not supported in Flash Lite 4) A Boolean value that specifies whether to hint strokes to full pixels. This @@ -489,9 +489,9 @@

    For example, the following illustrations show the different capsStyle settings. For each setting, the illustration shows a blue line with a -thickness of 30(for which the capsStyle +thickness of 30 (for which the capsStyle applies), and a superimposed black line with a -thickness of 1(for which no capsStyle +thickness of 1 (for which no capsStyle applies):

    NONE, ROUND, and SQUARE

    joints

    (Not supported in Flash Lite 4) A value from the JointStyle class that specifies the type of joint @@ -503,9 +503,9 @@

    For example, the following illustrations show the different joints settings. For each setting, the illustration shows an angled blue line -with a thickness of 30(for which the +with a thickness of 30 (for which the jointStyle applies), and a superimposed -angled black line with a thickness of 1(for which no +angled black line with a thickness of 1 (for which no jointStyle applies):

    MITER, ROUND, and BEVEL

    Note: For joints set to @@ -513,7 +513,7 @@ miterLimit parameter to limit the length of the miter.

    miterLimit

    (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 +values range from 1 to 255 (and values outside that range are rounded to 1 or 255). This value is only used if the jointStyle is set to "miter". The miterLimit @@ -541,12 +541,12 @@ to the moveTo() method, the default position for the current drawing is(0, 0). If any of the parameters are missing, this method fails and the current drawing position is not changed.

    Parameters:

    x

    A number that indicates the horizontal position relative to the -registration point of the parent display object(in pixels).

    y

    A number that indicates the vertical position relative to the -registration point of the parent display object(in pixels).

    moveTo(x:Float, y:Float):Void

    Moves the current drawing position to(x, y). If +registration point of the parent display object (in pixels).

    y

    A number that indicates the vertical position relative to the +registration point of the parent display object (in pixels).

    See also:

    moveTo(x:Float, y:Float):Void

    Moves the current drawing position to(x, y). If any of the parameters are missing, this method fails and the current drawing position is not changed.

    Parameters:

    x

    A number that indicates the horizontal position relative to the -registration point of the parent display object(in pixels).

    y

    A number that indicates the vertical position relative to the -registration point of the parent display object(in pixels).

    @:value({ recurse : true })readGraphicsData(recurse:Bool = true):Vector<IGraphicsData>

    Queries a Sprite or Shape object (and optionally, its children) for its vector +registration point of the parent display object (in pixels).

    y

    A number that indicates the vertical position relative to the +registration point of the parent display object (in pixels).

    @:value({ recurse : true })readGraphicsData(recurse:Bool = true):Vector<IGraphicsData>

    Queries a Sprite or Shape object (and optionally, its children) for its vector graphics content. The result is a Vector of IGraphicsData objects. Transformations are applied to the display object before the query, so the returned paths are all in the same coordinate space. Coordinates in the result data set are relative to diff --git a/openfl/display/GraphicsBitmapFill.html b/openfl/display/GraphicsBitmapFill.html index 6b94e3f..e74a682 100644 --- a/openfl/display/GraphicsBitmapFill.html +++ b/openfl/display/GraphicsBitmapFill.html @@ -1,7 +1,7 @@ -openfl.display.GraphicsBitmapFill - API Referenceopenfl.display.GraphicsBitmapFill - OpenFL API Reference

    API Reference
    View source

    final class GraphicsBitmapFill

    package openfl.display

    implements IGraphicsFill, IGraphicsData

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    Defines a bitmap fill. The bitmap can be smoothed, repeated or tiled to +

    View source

    final class GraphicsBitmapFill

    package openfl.display

    implements IGraphicsFill, IGraphicsData

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    Defines a bitmap fill. The bitmap can be smoothed, repeated or tiled to fill the area; or manipulated using a transformation matrix. Use a GraphicsBitmapFill object with the Graphics.drawGraphicsData() method. Drawing a GraphicsBitmapFill object is the equivalent of calling -the Graphics.beginBitmapFill() method.

    Constructor

    @:value({ smooth : false, repeat : true, matrix : null, bitmapData : null })new(?bitmapData:BitmapData, ?matrix:Matrix, repeat:Bool = true, smooth:Bool = false)

    Creates a new GraphicsBitmapFill object.

    Parameters:

    bitmapData

    A transparent or opaque bitmap image that contains +the Graphics.beginBitmapFill() method.

    See also:

    Constructor

    @:value({ smooth : false, repeat : true, matrix : null, bitmapData : null })new(?bitmapData:BitmapData, ?matrix:Matrix, repeat:Bool = true, smooth:Bool = false)

    Creates a new GraphicsBitmapFill object.

    Parameters:

    bitmapData

    A transparent or opaque bitmap image that contains the bits to display.

    matrix

    A matrix object (of the openfl.geom.Matrix class), which you use to define transformations on the bitmap.

    repeat

    If true, the bitmap image repeats in a tiled diff --git a/openfl/display/GraphicsEndFill.html b/openfl/display/GraphicsEndFill.html index dc7360c..bdf3564 100644 --- a/openfl/display/GraphicsEndFill.html +++ b/openfl/display/GraphicsEndFill.html @@ -1,7 +1,7 @@ -openfl.display.GraphicsEndFill - API Referenceopenfl.display.GraphicsEndFill - OpenFL API Reference

    View source

    final class GraphicsEndFill

    package openfl.display

    implements IGraphicsFill, IGraphicsData

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    Indicates the end of a graphics fill. Use a GraphicsEndFill object with the +

    View source

    final class GraphicsEndFill

    package openfl.display

    implements IGraphicsFill, IGraphicsData

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    Indicates the end of a graphics fill. Use a GraphicsEndFill object with the Graphics.drawGraphicsData() method.

    Drawing a GraphicsEndFill object is the equivalent of calling the -Graphics.endFill() method.

    Constructor

    new()

    Creates an object to use with the Graphics.drawGraphicsData() +Graphics.endFill() method.

    See also:

    Constructor

    new()

    Creates an object to use with the Graphics.drawGraphicsData() method to end the fill, explicitly.

    \ No newline at end of file diff --git a/openfl/display/GraphicsGradientFill.html b/openfl/display/GraphicsGradientFill.html index d21344c..0479b8f 100644 --- a/openfl/display/GraphicsGradientFill.html +++ b/openfl/display/GraphicsGradientFill.html @@ -1,7 +1,7 @@ -openfl.display.GraphicsGradientFill - API Referenceopenfl.display.GraphicsGradientFill - OpenFL API Reference
    View source

    final class GraphicsGradientFill

    package openfl.display

    implements IGraphicsFill, IGraphicsData

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    Defines a gradient fill. +

    View source

    final class GraphicsGradientFill

    package openfl.display

    implements IGraphicsFill, IGraphicsData

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    Defines a gradient fill. Use a GraphicsGradientFill object with the Graphics.drawGraphicsData() method. Drawing a GraphicsGradientFill object is the equivalent of calling -the Graphics.beginGradientFill() method.

    Constructor

    @:value({ focalPointRatio : 0, interpolationMethod : null, spreadMethod : null, matrix : null, ratios : null, alphas : null, colors : null, type : null })new(?type:GradientType, ?colors:Array<Int>, ?alphas:Array<Float>, ?ratios:Array<Int>, ?matrix:Matrix, ?spreadMethod:SpreadMethod, ?interpolationMethod:InterpolationMethod, focalPointRatio:Float = 0)

    Creates a new GraphicsGradientFill object.

    Parameters:

    type

    A value from the GradientType class that +the Graphics.beginGradientFill() method.

    See also:

    Constructor

    @:value({ focalPointRatio : 0, interpolationMethod : null, spreadMethod : null, matrix : null, ratios : null, alphas : null, colors : null, type : null })new(?type:GradientType, ?colors:Array<Int>, ?alphas:Array<Float>, ?ratios:Array<Int>, ?matrix:Matrix, ?spreadMethod:SpreadMethod, ?interpolationMethod:InterpolationMethod, focalPointRatio:Float = 0)

    Creates a new GraphicsGradientFill object.

    Parameters:

    type

    A value from the GradientType class that specifies which gradient type to use: GradientType.LINEAR or GradientType.RADIAL.

    matrix

    A transformation matrix as defined by the diff --git a/openfl/display/GraphicsPath.html b/openfl/display/GraphicsPath.html index 57ccd7b..52b86a4 100644 --- a/openfl/display/GraphicsPath.html +++ b/openfl/display/GraphicsPath.html @@ -1,7 +1,7 @@ -openfl.display.GraphicsPath - API Referenceopenfl.display.GraphicsPath - OpenFL API Reference

    View source

    final class GraphicsPath

    package openfl.display

    implements IGraphicsPath, IGraphicsData

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    A collection of drawing commands and the coordinate parameters for those +

    View source

    final class GraphicsPath

    package openfl.display

    implements IGraphicsPath, IGraphicsData

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    A collection of drawing commands and the coordinate parameters for those commands.

    Use a GraphicsPath object with the Graphics.drawGraphicsData() method. Drawing a GraphicsPath @@ -64,7 +64,7 @@ wideLineTo() and wideMoveTo()) similar to those in the Graphics class for making adjustments to the GraphicsPath.commands and GraphicsPath.data -vector arrays.

    Constructor

    @:value({ winding : GraphicsPathWinding.EVEN_ODD, data : null, commands : null })new(?commands:Vector<Int>, ?data:Vector<Float>, winding:GraphicsPathWinding = GraphicsPathWinding.EVEN_ODD)

    Creates a new GraphicsPath object.

    Parameters:

    winding

    Specifies the winding rule using a value defined in the +vector arrays.

    See also:

    Constructor

    @:value({ winding : GraphicsPathWinding.EVEN_ODD, data : null, commands : null })new(?commands:Vector<Int>, ?data:Vector<Float>, winding:GraphicsPathWinding = GraphicsPathWinding.EVEN_ODD)

    Creates a new GraphicsPath object.

    Parameters:

    winding

    Specifies the winding rule using a value defined in the GraphicsPathWinding class.

    Variables

    commands:Vector<Int>

    The Vector of drawing commands as integers representing the path. Each command can be one of the values defined by the GraphicsPathCommand class.

    data:Vector<Float>

    The Vector of Numbers containing the parameters used with the drawing commands.

    winding:GraphicsPathWinding

    Specifies the winding rule using a value defined in the diff --git a/openfl/display/GraphicsPathCommand.html b/openfl/display/GraphicsPathCommand.html index f0d838b..f7c028d 100644 --- a/openfl/display/GraphicsPathCommand.html +++ b/openfl/display/GraphicsPathCommand.html @@ -1,7 +1,7 @@ -openfl.display.GraphicsPathCommand - API Reference

    View source

    enum abstract GraphicsPathCommand(Int)

    package openfl.display

    from Int, UInt to Int, UInt

    @:enum

    Available on all platforms

    Defines the values to use for specifying path-drawing commands.

    +
    View source

    enum abstract GraphicsPathCommand(Int)

    package openfl.display

    from Int, UInt to Int, UInt

    @:enum

    Available on all platforms

    Defines the values to use for specifying path-drawing commands.

    The values in this class are used by the Graphics.drawPath() method, or stored in the commands vector of a GraphicsPath object.

    Variables

    @:value(cast 6)@:impl@:enuminlineread onlyCUBIC_CURVE_TO:GraphicsPathCommand = 6

    Specifies a drawing command that draws a curve from the current drawing position diff --git a/openfl/display/GraphicsPathWinding.html b/openfl/display/GraphicsPathWinding.html index 505b372..cde112f 100644 --- a/openfl/display/GraphicsPathWinding.html +++ b/openfl/display/GraphicsPathWinding.html @@ -1,7 +1,7 @@ -openfl.display.GraphicsPathWinding - API Referenceopenfl.display.GraphicsPathWinding - OpenFL API Reference

    API Reference
    View source

    enum abstract GraphicsPathWinding(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The GraphicsPathWinding class provides values for the +

    View source

    enum abstract GraphicsPathWinding(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The GraphicsPathWinding class provides values for the openfl.display.GraphicsPath.winding property and the openfl.display.Graphics.drawPath() method to determine the direction to draw a path. A clockwise path is positively wound, and a @@ -64,7 +64,7 @@

    positive and negative winding directions

    When paths intersect or overlap, the winding direction determines the rules for filling the areas created by the intersection or overlap:

    -

    a comparison of even-odd and non-zero winding rules

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyEVEN_ODD:GraphicsPathWinding = 0

    Establishes the even-odd winding type. The even-odd winding type is the rule +

    a comparison of even-odd and non-zero winding rules

    See also:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyEVEN_ODD:GraphicsPathWinding = 0

    Establishes the even-odd winding type. The even-odd winding type is the rule used by all of the original drawing API and is the default type for the openfl.display.Graphics.drawPath() method. Any overlapping paths will alternate between open and closed fills. If two squares drawn with the same diff --git a/openfl/display/GraphicsQuadPath.html b/openfl/display/GraphicsQuadPath.html index 9b6c652..75c8e5b 100644 --- a/openfl/display/GraphicsQuadPath.html +++ b/openfl/display/GraphicsQuadPath.html @@ -1,7 +1,7 @@ -openfl.display.GraphicsQuadPath - API Referenceopenfl.display.GraphicsQuadPath - OpenFL API Reference

    View source

    final class GraphicsQuadPath

    package openfl.display

    implements IGraphicsPath, IGraphicsData

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    Defines a set of quadrilaterals. This is similar to using GraphicsPath drawRect +

    View source

    final class GraphicsQuadPath

    package openfl.display

    implements IGraphicsPath, IGraphicsData

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    Defines a set of quadrilaterals. This is similar to using GraphicsPath drawRect repeatedly, but each rectangle can use a transform value to rotate, scale or skew the result.

    Any type of fill can be used, but if the fill has a transform matrix that transform matrix is ignored.

    The optional indices parameter allows the use of either repeated rectangle geometry, or allows the use of a subset of a broader rectangle -data Vector, such as Tileset rectData.

    Constructor

    @:value({ transforms : null, indices : null, rects : null })new(?rects:Vector<Float>, ?indices:Vector<Int>, ?transforms:Vector<Float>)

    Creates a new GraphicsTrianglePath object.

    Parameters:

    rects

    A Vector containing rectangle coordinates in [ x0, y0, width0, height0, x1, y1 ... ] +data Vector, such as Tileset rectData.

    See also:

    Constructor

    @:value({ transforms : null, indices : null, rects : null })new(?rects:Vector<Float>, ?indices:Vector<Int>, ?transforms:Vector<Float>)

    Creates a new GraphicsTrianglePath object.

    Parameters:

    rects

    A Vector containing rectangle coordinates in [ x0, y0, width0, height0, x1, y1 ... ] format.

    indices

    A Vector containing optional index values to reference the data contained in rects

    transforms

    A Vector containing optional transform data to adjust x, y, a, b, c or d value for the resulting quadrilateral.

    Variables

    indices:Vector<Int>

    A Vector containing optional index values to reference the data contained in diff --git a/openfl/display/GraphicsShader.html b/openfl/display/GraphicsShader.html index 0d80886..358b677 100644 --- a/openfl/display/GraphicsShader.html +++ b/openfl/display/GraphicsShader.html @@ -1,7 +1,7 @@ -openfl.display.GraphicsShader - API Reference

    View source

    class GraphicsShader

    package openfl.display

    extends Shader

    @:directlyUsed@:build(openfl.utils._internal.ShaderMacro.build())@:autoBuild(openfl.utils._internal.ShaderMacro.build())@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Constructor

    @:value({ code : null })@:glVertexHeader("attribute float openfl_Alpha;\n\t\tattribute vec4 openfl_ColorMultiplier;\n\t\tattribute vec4 openfl_ColorOffset;\n\t\tattribute vec4 openfl_Position;\n\t\tattribute vec2 openfl_TextureCoord;\n\n\t\tvarying float openfl_Alphav;\n\t\tvarying vec4 openfl_ColorMultiplierv;\n\t\tvarying vec4 openfl_ColorOffsetv;\n\t\tvarying vec2 openfl_TextureCoordv;\n\n\t\tuniform mat4 openfl_Matrix;\n\t\tuniform bool openfl_HasColorTransform;\n\t\tuniform vec2 openfl_TextureSize;")@:glVertexBody("openfl_Alphav = openfl_Alpha;\n\t\topenfl_TextureCoordv = openfl_TextureCoord;\n\n\t\tif (openfl_HasColorTransform) {\n\n\t\t\topenfl_ColorMultiplierv = openfl_ColorMultiplier;\n\t\t\topenfl_ColorOffsetv = openfl_ColorOffset / 255.0;\n\n\t\t}\n\n\t\tgl_Position = openfl_Matrix * openfl_Position;")@:glVertexSource("#pragma header\n\n\t\tvoid main(void) {\n\n\t\t\t#pragma body\n\n\t\t}")@:glFragmentHeader("varying float openfl_Alphav;\n\t\tvarying vec4 openfl_ColorMultiplierv;\n\t\tvarying vec4 openfl_ColorOffsetv;\n\t\tvarying vec2 openfl_TextureCoordv;\n\n\t\tuniform bool openfl_HasColorTransform;\n\t\tuniform vec2 openfl_TextureSize;\n\t\tuniform sampler2D bitmap;")@:glFragmentBody("vec4 color = texture2D (bitmap, openfl_TextureCoordv);\n\n\t\tif (color.a == 0.0) {\n\n\t\t\tgl_FragColor = vec4 (0.0, 0.0, 0.0, 0.0);\n\n\t\t} else if (openfl_HasColorTransform) {\n\n\t\t\tcolor = vec4 (color.rgb / color.a, color.a);\n\n\t\t\tmat4 colorMultiplier = mat4 (0);\n\t\t\tcolorMultiplier[0][0] = openfl_ColorMultiplierv.x;\n\t\t\tcolorMultiplier[1][1] = openfl_ColorMultiplierv.y;\n\t\t\tcolorMultiplier[2][2] = openfl_ColorMultiplierv.z;\n\t\t\tcolorMultiplier[3][3] = 1.0; // openfl_ColorMultiplierv.w;\n\n\t\t\tcolor = clamp (openfl_ColorOffsetv + (color * colorMultiplier), 0.0, 1.0);\n\n\t\t\tif (color.a > 0.0) {\n\n\t\t\t\tgl_FragColor = vec4 (color.rgb * color.a * openfl_Alphav, color.a * openfl_Alphav);\n\n\t\t\t} else {\n\n\t\t\t\tgl_FragColor = vec4 (0.0, 0.0, 0.0, 0.0);\n\n\t\t\t}\n\n\t\t} else {\n\n\t\t\tgl_FragColor = color * openfl_Alphav;\n\n\t\t}")@:glFragmentSource("#pragma header\n\n\t\tvoid main(void) {\n\n\t\t\t#pragma body\n\n\t\t}")new(?code:ByteArray)

    Variables

    @:keepbitmap:ShaderInput<BitmapData>

    Inherited Variables

    Defined by Shader

    write onlybyteCode:ByteArray

    The raw shader bytecode for this Shader instance.

    data:ShaderData

    Provides access to parameters, input images, and metadata for the +

    View source

    class GraphicsShader

    package openfl.display

    extends Shader

    @:directlyUsed@:build(openfl.utils._internal.ShaderMacro.build())@:autoBuild(openfl.utils._internal.ShaderMacro.build())@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Constructor

    @:value({ code : null })@:glVertexHeader("attribute float openfl_Alpha;\n\t\tattribute vec4 openfl_ColorMultiplier;\n\t\tattribute vec4 openfl_ColorOffset;\n\t\tattribute vec4 openfl_Position;\n\t\tattribute vec2 openfl_TextureCoord;\n\n\t\tvarying float openfl_Alphav;\n\t\tvarying vec4 openfl_ColorMultiplierv;\n\t\tvarying vec4 openfl_ColorOffsetv;\n\t\tvarying vec2 openfl_TextureCoordv;\n\n\t\tuniform mat4 openfl_Matrix;\n\t\tuniform bool openfl_HasColorTransform;\n\t\tuniform vec2 openfl_TextureSize;")@:glVertexBody("openfl_Alphav = openfl_Alpha;\n\t\topenfl_TextureCoordv = openfl_TextureCoord;\n\n\t\tif (openfl_HasColorTransform) {\n\n\t\t\topenfl_ColorMultiplierv = openfl_ColorMultiplier;\n\t\t\topenfl_ColorOffsetv = openfl_ColorOffset / 255.0;\n\n\t\t}\n\n\t\tgl_Position = openfl_Matrix * openfl_Position;")@:glVertexSource("#pragma header\n\n\t\tvoid main(void) {\n\n\t\t\t#pragma body\n\n\t\t}")@:glFragmentHeader("varying float openfl_Alphav;\n\t\tvarying vec4 openfl_ColorMultiplierv;\n\t\tvarying vec4 openfl_ColorOffsetv;\n\t\tvarying vec2 openfl_TextureCoordv;\n\n\t\tuniform bool openfl_HasColorTransform;\n\t\tuniform vec2 openfl_TextureSize;\n\t\tuniform sampler2D bitmap;")@:glFragmentBody("vec4 color = texture2D (bitmap, openfl_TextureCoordv);\n\n\t\tif (color.a == 0.0) {\n\n\t\t\tgl_FragColor = vec4 (0.0, 0.0, 0.0, 0.0);\n\n\t\t} else if (openfl_HasColorTransform) {\n\n\t\t\tcolor = vec4 (color.rgb / color.a, color.a);\n\n\t\t\tmat4 colorMultiplier = mat4 (0);\n\t\t\tcolorMultiplier[0][0] = openfl_ColorMultiplierv.x;\n\t\t\tcolorMultiplier[1][1] = openfl_ColorMultiplierv.y;\n\t\t\tcolorMultiplier[2][2] = openfl_ColorMultiplierv.z;\n\t\t\tcolorMultiplier[3][3] = 1.0; // openfl_ColorMultiplierv.w;\n\n\t\t\tcolor = clamp (openfl_ColorOffsetv + (color * colorMultiplier), 0.0, 1.0);\n\n\t\t\tif (color.a > 0.0) {\n\n\t\t\t\tgl_FragColor = vec4 (color.rgb * color.a * openfl_Alphav, color.a * openfl_Alphav);\n\n\t\t\t} else {\n\n\t\t\t\tgl_FragColor = vec4 (0.0, 0.0, 0.0, 0.0);\n\n\t\t\t}\n\n\t\t} else {\n\n\t\t\tgl_FragColor = color * openfl_Alphav;\n\n\t\t}")@:glFragmentSource("#pragma header\n\n\t\tvoid main(void) {\n\n\t\t\t#pragma body\n\n\t\t}")new(?code:ByteArray)

    Variables

    @:keepbitmap:ShaderInput<BitmapData>

    Inherited Variables

    Defined by Shader

    write onlybyteCode:ByteArray

    The raw shader bytecode for this Shader instance.

    data:ShaderData

    Provides access to parameters, input images, and metadata for the Shader instance. ShaderParameter objects representing parameters for the shader, ShaderInput objects representing the input images for the shader, and other values representing the shader's metadata are diff --git a/openfl/display/GraphicsShaderFill.html b/openfl/display/GraphicsShaderFill.html index 25f9f82..bfac46b 100644 --- a/openfl/display/GraphicsShaderFill.html +++ b/openfl/display/GraphicsShaderFill.html @@ -1,7 +1,7 @@ -openfl.display.GraphicsShaderFill - API Referenceopenfl.display.GraphicsShaderFill - OpenFL API Reference

    View source

    final class GraphicsShaderFill

    package openfl.display

    implements IGraphicsFill, IGraphicsData

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    Defines a shader fill. +

    View source

    final class GraphicsShaderFill

    package openfl.display

    implements IGraphicsFill, IGraphicsData

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    Defines a shader fill. Use a GraphicsShaderFill object with the Graphics.drawGraphicsData() method. Drawing a GraphicsShaderFill object is the equivalent of calling -the Graphics.beginShaderFill() method.

    Constructor

    @:value({ matrix : null })new(shader:Shader, ?matrix:Matrix)

    Creates a new GraphicsShaderFill object.

    Parameters:

    shader

    The shader to use for the fill. This Shader instance is +the Graphics.beginShaderFill() method.

    See also:

    Constructor

    @:value({ matrix : null })new(shader:Shader, ?matrix:Matrix)

    Creates a new GraphicsShaderFill object.

    Parameters:

    shader

    The shader to use for the fill. This Shader instance is not required to specify an image input. However, if an image input is specified in the shader, the input must be provided manually by setting the input property of diff --git a/openfl/display/GraphicsSolidFill.html b/openfl/display/GraphicsSolidFill.html index 0089ff6..f83756c 100644 --- a/openfl/display/GraphicsSolidFill.html +++ b/openfl/display/GraphicsSolidFill.html @@ -1,7 +1,7 @@ -openfl.display.GraphicsSolidFill - API Reference

    View source

    final class GraphicsSolidFill

    package openfl.display

    implements IGraphicsFill, IGraphicsData

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    Defines a solid fill.

    +
    View source

    final class GraphicsSolidFill

    package openfl.display

    implements IGraphicsFill, IGraphicsData

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    Defines a solid fill.

    Use a GraphicsSolidFill object with the Graphics.drawGraphicsData() method. Drawing a GraphicsSolidFill object is the equivalent of calling the -Graphics.beginFill() method.

    Constructor

    @:value({ alpha : 1, color : 0 })new(color:UInt = 0, alpha:Float = 1)

    Creates a new GraphicsSolidFill object.

    Parameters:

    color

    The color value. Valid values are in the hexadecimal format -0xRRGGBB.

    alpha

    The alpha transparency value. Valid values are 0(fully -transparent) to 1(fully opaque).

    Variables

    alpha:Float

    Indicates the alpha transparency value of the fill. Valid values are 0 -(fully transparent) to 1(fully opaque). The default value is 1. Display +Graphics.beginFill() method.

    See also:

    Constructor

    @:value({ alpha : 1, color : 0 })new(color:UInt = 0, alpha:Float = 1)

    Creates a new GraphicsSolidFill object.

    Parameters:

    color

    The color value. Valid values are in the hexadecimal format +0xRRGGBB.

    alpha

    The alpha transparency value. Valid values are 0 (fully +transparent) to 1 (fully opaque).

    Variables

    alpha:Float

    Indicates the alpha transparency value of the fill. Valid values are 0 +(fully transparent) to 1 (fully opaque). The default value is 1. Display objects with alpha set to 0 are active, even though they are invisible.

    color:UInt

    The color of the fill. Valid values are in the hexadecimal format -0xRRGGBB. The default value is 0xFF0000(or the uint 0).

    \ No newline at end of file +0xRRGGBB. The default value is 0xFF0000 (or the uint 0).

    \ No newline at end of file diff --git a/openfl/display/GraphicsStroke.html b/openfl/display/GraphicsStroke.html index 1fa82e3..976bc6a 100644 --- a/openfl/display/GraphicsStroke.html +++ b/openfl/display/GraphicsStroke.html @@ -1,7 +1,7 @@ -openfl.display.GraphicsStroke - API Reference
    View source

    final class GraphicsStroke

    package openfl.display

    implements IGraphicsStroke, IGraphicsData

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    Defines a line style or stroke.

    +
    View source

    final class GraphicsStroke

    package openfl.display

    implements IGraphicsStroke, IGraphicsData

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    Defines a line style or stroke.

    Use a GraphicsStroke object with the Graphics.drawGraphicsData() method. Drawing a GraphicsStroke object is the equivalent of calling one of the methods of the Graphics class that sets the line style, such as the Graphics.lineStyle() method, the Graphics.lineBitmapStyle() method, or the -Graphics.lineGradientStyle() method.

    Constructor

    @:value({ fill : null, miterLimit : 3, joints : JointStyle.ROUND, caps : CapsStyle.NONE, scaleMode : LineScaleMode.NORMAL, pixelHinting : false, thickness : null })new(?thickness:Float, pixelHinting:Bool = false, scaleMode:LineScaleMode = LineScaleMode.NORMAL, caps:CapsStyle = CapsStyle.NONE, joints:JointStyle = JointStyle.ROUND, miterLimit:Float = 3, ?fill:IGraphicsFill)

    Creates a new GraphicsStroke object.

    Parameters:

    pixelHinting

    A Boolean value that specifies whether to hint strokes +Graphics.lineGradientStyle() method.

    See also:

    Constructor

    @:value({ fill : null, miterLimit : 3, joints : JointStyle.ROUND, caps : CapsStyle.NONE, scaleMode : LineScaleMode.NORMAL, pixelHinting : false, thickness : null })new(?thickness:Float, pixelHinting:Bool = false, scaleMode:LineScaleMode = LineScaleMode.NORMAL, caps:CapsStyle = CapsStyle.NONE, joints:JointStyle = JointStyle.ROUND, miterLimit:Float = 3, ?fill:IGraphicsFill)

    Creates a new GraphicsStroke object.

    Parameters:

    pixelHinting

    A Boolean value that specifies whether to hint strokes to full pixels. This affects both the position of anchors of a curve and the line stroke size itself. With pixelHinting set to @@ -107,9 +107,9 @@

    For example, the following illustrations show the different capsStyle settings. For each setting, the illustration shows a blue line with a -thickness of 30(for which the capsStyle +thickness of 30 (for which the capsStyle applies), and a superimposed black line with a -thickness of 1(for which no capsStyle +thickness of 1 (for which no capsStyle applies):

    joints

    A value from the JointStyle class that specifies the type of joint appearance used at angles. Valid values are: JointStyle.BEVEL, @@ -119,9 +119,9 @@

    For example, the following illustrations show the different joints settings. For each setting, the illustration shows an angled blue line -with a thickness of 30(for which the +with a thickness of 30 (for which the jointStyle applies), and a superimposed -angled black line with a thickness of 1(for which no +angled black line with a thickness of 1 (for which no jointStyle applies):

    Note: For joints set to JointStyle.MITER, you can use the @@ -132,22 +132,22 @@ round caps.

    For example, the following illustrations show the different capsStyle settings. For each setting, the illustration shows -a blue line with a thickness of 30(for which the capsStyle -applies), and a superimposed black line with a thickness of 1(for which -no capsStyle applies):

    fill:IGraphicsFill

    Specifies the instance containing data for filling a stroke. An +a blue line with a thickness of 30 (for which the capsStyle +applies), and a superimposed black line with a thickness of 1 (for which +no capsStyle applies):

    fill:IGraphicsFill

    Specifies the instance containing data for filling a stroke. An IGraphicsFill instance can represent a series of fill commands.

    joints:JointStyle

    Specifies the type of joint appearance used at angles. Valid values are: JointStyle.BEVEL, JointStyle.MITER, and JointStyle.ROUND. If a value is not indicated, Flash uses round joints.

    For example, the following illustrations show the different joints settings. For each setting, the illustration shows an -angled blue line with a thickness of 30(for which the +angled blue line with a thickness of 30 (for which the jointStyle applies), and a superimposed angled black line -with a thickness of 1(for which no jointStyle applies):

    +with a thickness of 1 (for which no jointStyle applies):

    Note: For joints set to JointStyle.MITER, you can use the miterLimit parameter to limit the length of the miter.

    miterLimit:Float

    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 +to 255 (and values outside that range are rounded to 1 or 255). This value is only used if the jointStyle is set to "miter". The miterLimit value represents the length that a miter can extend beyond the point at which the lines meet to @@ -169,10 +169,10 @@ For example, the following illustrations show how Flash Player renders two rounded rectangles that are identical, except that the pixelHinting parameter used in the lineStyle() -method is set differently(the images are scaled by 200%, to emphasize the +method is set differently (the images are scaled by 200%, to emphasize the difference):

    scaleMode:LineScaleMode

    Specifies the stroke thickness scaling. Valid values are:

    LineScaleMode.NORMAL - Always scale the line thickness

    -
    	when the object is scaled(the default).
+
    	when the object is scaled (the default).
 
    
 
    LineScaleMode.NONE - Never scale the line thickness.
    
 
    LineScaleMode.VERTICAL - Do not scale the line
    
diff --git a/openfl/display/GraphicsTrianglePath.html b/openfl/display/GraphicsTrianglePath.html
index 50d7898..51638d6 100644
--- a/openfl/display/GraphicsTrianglePath.html
+++ b/openfl/display/GraphicsTrianglePath.html
@@ -1,7 +1,7 @@
 
 
 
-openfl.display.GraphicsTrianglePath - API Referenceopenfl.display.GraphicsTrianglePath - OpenFL API Reference
    API Reference
     View source
    final class GraphicsTrianglePath
    package openfl.display
        
    implements IGraphicsPath, IGraphicsData
    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final
    Available on  all platforms
    Defines an ordered set of triangles that can be rendered using either
+
     View source
    final class GraphicsTrianglePath
    package openfl.display
        
    implements IGraphicsPath, IGraphicsData
    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final
    Available on  all platforms
    Defines an ordered set of triangles that can be rendered using either
 (u,v) fill coordinates or a normal fill. Each triangle in the path is
 represented by three sets of (x, y) coordinates, each of which is one
 point of the triangle.
 The triangle vertices do not contain z coordinates and do not necessarily
 represent 3D faces. However a triangle path can be used to support the
-rendering of 3D geometry in a 2D space.
    Constructor
    @:value({ culling : NONE, uvtData : null, indices : null, vertices : null })new(?vertices:Vector<Float>, ?indices:Vector<Int>, ?uvtData:Vector<Float>, culling:TriangleCulling = NONE)
    Creates a new GraphicsTrianglePath object.
    Parameters:
    vertices
    A Vector of Numbers where each pair of numbers is treated as a point (an x, y pair).
+rendering of 3D geometry in a 2D space.
    See also:
    Constructor
    @:value({ culling : NONE, uvtData : null, indices : null, vertices : null })new(?vertices:Vector<Float>, ?indices:Vector<Int>, ?uvtData:Vector<Float>, culling:TriangleCulling = NONE)
    Creates a new GraphicsTrianglePath object.
    Parameters:
    vertices
    A Vector of Numbers where each pair of numbers is treated as a point (an x, y pair).
 Required.
    indices
    A Vector of integers or indexes, where every three indexes define a triangle.
    uvtData
    A Vector of normalized coordinates used to apply texture mapping.
    culling
    Specifies whether to render triangles that face in a
 given direction. Used to prevent the rendering of
 triangles that cannot be seen in the current view. Can
diff --git a/openfl/display/IBitmapDrawable.html b/openfl/display/IBitmapDrawable.html
index 09f51eb..f34f9aa 100644
--- a/openfl/display/IBitmapDrawable.html
+++ b/openfl/display/IBitmapDrawable.html
@@ -1,7 +1,9 @@
 
 
 
-openfl.display.IBitmapDrawable - API Reference
     View source
    interface IBitmapDrawable
    package openfl.display
        
     extended by BitmapData, DisplayObject
    Available on  all platforms
    
\ No newline at end of file
+
     View source
    interface IBitmapDrawable
    package openfl.display
        
     extended by BitmapData, DisplayObject
    Available on  all platforms
    The IBitmapDrawable interface is implemented by objects that can be passed
+as the source parameter of the draw() method of the BitmapData class.
+These objects are of type BitmapData or DisplayObject.
    See also:
    
\ No newline at end of file
diff --git a/openfl/display/IGraphicsData.html b/openfl/display/IGraphicsData.html
index 994f386..4b67589 100644
--- a/openfl/display/IGraphicsData.html
+++ b/openfl/display/IGraphicsData.html
@@ -1,7 +1,11 @@
 
 
 
-openfl.display.IGraphicsData - API Reference
     View source
    interface IGraphicsData
    package openfl.display
        
     extended by GraphicsBitmapFill, GraphicsEndFill, GraphicsGradientFill, GraphicsPath, GraphicsQuadPath, GraphicsShaderFill, GraphicsSolidFill, GraphicsStroke, GraphicsTrianglePath
    Available on  all platforms
    
\ No newline at end of file
+
     View source
    interface IGraphicsData
    package openfl.display
        
     extended by GraphicsBitmapFill, GraphicsEndFill, GraphicsGradientFill, GraphicsPath, GraphicsQuadPath, GraphicsShaderFill, GraphicsSolidFill, GraphicsStroke, GraphicsTrianglePath
    Available on  all platforms
    This interface is used to define objects that can be used as parameters in
+the openfl.display.Graphics methods, including fills, strokes, and paths.
+Use the implementor classes of this interface to create and manage drawing
+property data, and to reuse the same data for different instances. Then, use
+the methods of the Graphics class to render the drawing objects.
    See also:
    
\ No newline at end of file
diff --git a/openfl/display/IGraphicsFill.html b/openfl/display/IGraphicsFill.html
index 498abd5..6498a41 100644
--- a/openfl/display/IGraphicsFill.html
+++ b/openfl/display/IGraphicsFill.html
@@ -1,7 +1,10 @@
 
 
 
-openfl.display.IGraphicsFill - API Reference
     View source
    interface IGraphicsFill
    package openfl.display
        
     extended by GraphicsBitmapFill, GraphicsEndFill, GraphicsGradientFill, GraphicsShaderFill, GraphicsSolidFill
    Available on  all platforms
    
\ No newline at end of file
+
     View source
    interface IGraphicsFill
    package openfl.display
        
     extended by GraphicsBitmapFill, GraphicsEndFill, GraphicsGradientFill, GraphicsShaderFill, GraphicsSolidFill
    Available on  all platforms
    This interface is used to define objects that can be used as fill parameters
+in the openfl.display.Graphics methods and drawing classes. Use the
+implementor classes of this interface to create and manage fill property
+data, and to reuse the same data for different instances.
    See also:
    
\ No newline at end of file
diff --git a/openfl/display/IGraphicsPath.html b/openfl/display/IGraphicsPath.html
index 92f50ec..c4be891 100644
--- a/openfl/display/IGraphicsPath.html
+++ b/openfl/display/IGraphicsPath.html
@@ -1,7 +1,10 @@
 
 
 
-openfl.display.IGraphicsPath - API Reference
     View source
    interface IGraphicsPath
    package openfl.display
        
     extended by GraphicsPath, GraphicsQuadPath, GraphicsTrianglePath
    Available on  all platforms
    
\ No newline at end of file
+
     View source
    interface IGraphicsPath
    package openfl.display
        
     extended by GraphicsPath, GraphicsQuadPath, GraphicsTrianglePath
    Available on  all platforms
    This interface is used to define objects that can be used as path parameters
+in the openfl.display.Graphics methods and drawing classes. Use the
+implementor classes of this interface to create and manage path property
+data, and to reuse the same data for different instances.
    See also:
    
\ No newline at end of file
diff --git a/openfl/display/IGraphicsStroke.html b/openfl/display/IGraphicsStroke.html
index 6bf5239..ee147b3 100644
--- a/openfl/display/IGraphicsStroke.html
+++ b/openfl/display/IGraphicsStroke.html
@@ -1,7 +1,10 @@
 
 
 
-openfl.display.IGraphicsStroke - API Reference
     View source
    interface IGraphicsStroke
    package openfl.display
        
     extended by GraphicsStroke
    Available on  all platforms
    
\ No newline at end of file
+
     View source
    interface IGraphicsStroke
    package openfl.display
        
     extended by GraphicsStroke
    Available on  all platforms
    This interface is used to define objects that can be used as strok
+parameters in the openfl.display.Graphics methods and drawing classes. Use
+the implementor classes of this interface to create and manage stroke
+property data, and to reuse the same data for different instances.
    See also:
    
\ No newline at end of file
diff --git a/openfl/display/ITileContainer.html b/openfl/display/ITileContainer.html
index cc96465..cbb4e0a 100644
--- a/openfl/display/ITileContainer.html
+++ b/openfl/display/ITileContainer.html
@@ -1,7 +1,7 @@
 
 
 
-openfl.display.ITileContainer - API Referenceopenfl.display.ITileContainer - OpenFL API Reference
     View source
    interface ITileContainer
    package openfl.display
        
     extended by TileContainer, Tilemap
    Available on  all platforms
    ITileContainer is an interface implemented by compatible tile container
+
     View source
    interface ITileContainer
    package openfl.display
        
     extended by TileContainer, Tilemap
    Available on  all platforms
    ITileContainer is an interface implemented by compatible tile container
 objects, including the Tilemap and TileContainer classes.
    Variables
    read onlynumTiles:Int
    Returns the number of tiles of this object.
    Methods
    addTile(tile:Tile):Tile
    Adds a Tile instance to this ITileContainer instance. The tile is
 added to the front (top) of all other tiles in this ITileContainer
 instance. (To add a tile to a specific index position, use the addTileAt()
diff --git a/openfl/display/InteractiveObject.html b/openfl/display/InteractiveObject.html
index 208e905..d593f87 100644
--- a/openfl/display/InteractiveObject.html
+++ b/openfl/display/InteractiveObject.html
@@ -1,7 +1,7 @@
 
 
 
-openfl.display.InteractiveObject - API Referenceopenfl.display.InteractiveObject - OpenFL API Reference
     View source
    class InteractiveObject
    package openfl.display
    extends DisplayObject › EventDispatcher
        
    extended by DisplayObjectContainer, SimpleButton, TextField
    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug
    Available on  all platforms
    The InteractiveObject class is the abstract base class for all display
+
     View source
    class InteractiveObject
    package openfl.display
    extends DisplayObject › EventDispatcher
        
    extended by DisplayObjectContainer, SimpleButton, TextField
    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug
    Available on  all platforms
    The InteractiveObject class is the abstract base class for all display
 objects with which the user can interact, using the mouse, keyboard, or
 other user input device.
    
 
    You cannot instantiate the InteractiveObject class directly. A call to
@@ -165,7 +165,7 @@
 focusIn event by the related
 object.
    gesturePan
    Dispatched when the user moves a point of
 contact over the InteractiveObject instance
-on a touch-enabled device(such as moving a
+on a touch-enabled device (such as moving a
 finger from left to right over a display
 object on a mobile phone or tablet with a
 touch screen). Some devices might also
@@ -181,7 +181,7 @@
 current environment supports it. Choose how
 you want to handle the user interaction. Use
 the openfl.ui.Multitouch class to manage touch
-event handling(enable touch gesture event
+event handling (enable touch gesture event
 handling, simple touch point event handling,
 or disable touch events so only mouse events
 are dispatched). If you choose to handle the
@@ -199,7 +199,7 @@
 
    Note: See the Multitouch class for
 environment compatibility information.
    gesturePressAndTap
    Dispatched when the user creates a point of
 contact with an InteractiveObject instance,
-then taps on a touch-enabled device(such as
+then taps on a touch-enabled device (such as
 placing several fingers over a display object
 to open a menu and then taps one finger to
 select a menu item on a mobile phone or
@@ -217,7 +217,7 @@
 supports it. Choose how you want to handle
 the user interaction. Use the
 openfl.ui.Multitouch class to manage touch
-event handling(enable touch gesture event
+event handling (enable touch gesture event
 handling, simple touch point event handling,
 or disable touch events so only mouse events
 are dispatched). If you choose to handle the
@@ -241,7 +241,7 @@
 properties are the distance to the secondary
 point of contact(the "tap").
    gestureRotate
    Dispatched when the user performs a rotation
 gesture at a point of contact with an
-InteractiveObject instance(such as touching
+InteractiveObject instance (such as touching
 two fingers and rotating them over a display
 object on a mobile phone or tablet with a
 touch screen). Two-finger rotation is a
@@ -261,7 +261,7 @@
 supports it. Choose how you want to handle
 the user interaction. Use the
 openfl.ui.Multitouch class to manage touch
-event handling(enable touch gesture event
+event handling (enable touch gesture event
 handling, simple touch point event handling,
 or disable touch events so only mouse events
 are dispatched). If you choose to handle the
@@ -287,7 +287,7 @@
 
    Note: See the Multitouch class for
 environment compatibility information.
    gestureSwipe
    Dispatched when the user performs a swipe
 gesture at a point of contact with an
-InteractiveObject instance(such as touching
+InteractiveObject instance (such as touching
 three fingers to a screen and then moving
 them in parallel over a display object on a
 mobile phone or tablet with a touch screen).
@@ -331,7 +331,7 @@
 four-finger swipe, this API only supports a
 three-finger swipe.
    gestureTwoFingerTap
    Dispatched when the user presses two points
 of contact over the same InteractiveObject
-instance on a touch-enabled device(such as
+instance on a touch-enabled device (such as
 presses and releases two fingers over a
 display object on a mobile phone or tablet
 with a touch screen). Some devices might also
@@ -364,7 +364,7 @@
 
    Note: See the Multitouch class for
 environment compatibility information.
    gestureZoom
    Dispatched when the user performs a zoom
 gesture at a point of contact with an
-InteractiveObject instance(such as touching
+InteractiveObject instance (such as touching
 two fingers to a screen and then quickly
 spreading the fingers apart over a display
 object on a mobile phone or tablet with a
@@ -384,7 +384,7 @@
 current environment supports it. Choose how
 you want to handle the user interaction. Use
 the openfl.ui.Multitouch class to manage touch
-event handling(enable touch gesture event
+event handling (enable touch gesture event
 handling, simple touch point event handling,
 or disable touch events so only mouse events
 are dispatched). If you choose to handle the
@@ -414,7 +414,7 @@
 vary by device and operating system. This
 event type is generated after such a mapping
 occurs but before the processing of an input
-method editor(IME). IMEs are used to enter
+method editor (IME). IMEs are used to enter
 characters, such as Chinese ideographs, that
 the standard QWERTY keyboard is ill-equipped
 to produce. This event occurs before the
@@ -443,7 +443,7 @@
 vary by device and operating system. This
 event type is generated after such a mapping
 occurs but before the processing of an input
-method editor(IME). IMEs are used to enter
+method editor (IME). IMEs are used to enter
 characters, such as Chinese ideographs, that
 the standard QWERTY keyboard is ill-equipped
 to produce. This event occurs after a
@@ -728,12 +728,11 @@
 tabIndex property changes.
    textInput
    Dispatched when a user enters one or more
 characters of text. Various text input
 methods can generate this event, including
-standard keyboards, input method editors
    
-
    						 (IMEs), voice or speech recognition systems,
-
    
-
    and even the act of pasting plain text with
+standard keyboards, input method editors
+(IMEs), voice or speech recognition systems,
+and even the act of pasting plain text with
 no formatting or style information.
    touchBegin
    Dispatched when the user first contacts a
-touch-enabled device(such as touches a
+touch-enabled device (such as touches a
 finger to a mobile phone or tablet with a
 touch screen). Some devices might also
 interpret this contact as a
@@ -746,7 +745,7 @@
 current environment supports it. Choose how
 you want to handle the user interaction. Use
 the openfl.ui.Multitouch class to manage touch
-event handling(enable touch gesture event
+event handling (enable touch gesture event
 handling, simple touch point event handling,
 or disable touch events so only mouse events
 are dispatched). If you choose to handle the
@@ -763,7 +762,7 @@
 for a touch event than a mouse event.
    
 
    Note: See the Multitouch class for
 environment compatibility information.
    touchEnd
    Dispatched when the user removes contact with
-a touch-enabled device(such as lifts a
+a touch-enabled device (such as lifts a
 finger off a mobile phone or tablet with a
 touch screen). Some devices might also
 interpret this contact as a
@@ -792,7 +791,7 @@
 for a touch event than a mouse event.
    
 
    Note: See the Multitouch class for
 environment compatibility information.
    touchMove
    Dispatched when the user moves the point of
-contact with a touch-enabled device(such as
+contact with a touch-enabled device (such as
 drags a finger across a mobile phone or
 tablet with a touch screen). Some devices
 might also interpret this contact as a
@@ -805,7 +804,7 @@
 current environment supports it. Choose how
 you want to handle the user interaction. Use
 the openfl.ui.Multitouch class to manage touch
-event handling(enable touch gesture event
+event handling (enable touch gesture event
 handling, simple touch point event handling,
 or disable touch events so only mouse events
 are dispatched). If you choose to handle the
@@ -823,7 +822,7 @@
 
    Note: See the Multitouch class for
 environment compatibility information.
    touchOut
    Dispatched when the user moves the point of
 contact away from InteractiveObject instance
-on a touch-enabled device(such as drags a
+on a touch-enabled device (such as drags a
 finger from one display object to another on
 a mobile phone or tablet with a touch
 screen). Some devices might also interpret
@@ -854,7 +853,7 @@
 
    Note: See the Multitouch class for
 environment compatibility information.
    touchOver
    Dispatched when the user moves the point of
 contact over an InteractiveObject instance on
-a touch-enabled device(such as drags a
+a touch-enabled device (such as drags a
 finger from a point outside a display object
 to a point over a display object on a mobile
 phone or tablet with a touch screen). Some
@@ -868,7 +867,7 @@
 current environment supports it. Choose how
 you want to handle the user interaction. Use
 the openfl.ui.Multitouch class to manage touch
-event handling(enable touch gesture event
+event handling (enable touch gesture event
 handling, simple touch point event handling,
 or disable touch events so only mouse events
 are dispatched). If you choose to handle the
@@ -886,7 +885,7 @@
 
    Note: See the Multitouch class for
 environment compatibility information.
    touchRollOut
    Dispatched when the user moves the point of
 contact away from an InteractiveObject
-instance on a touch-enabled device(such as
+instance on a touch-enabled device (such as
 drags a finger from over a display object to
 a point outside the display object on a
 mobile phone or tablet with a touch screen).
@@ -900,7 +899,7 @@
 the current environment supports it. Choose
 how you want to handle the user interaction.
 Use the openfl.ui.Multitouch class to manage
-touch event handling(enable touch gesture
+touch event handling (enable touch gesture
 event handling, simple touch point event
 handling, or disable touch events so only
 mouse events are dispatched). If you choose
@@ -918,7 +917,7 @@
 
    Note: See the Multitouch class for
 environment compatibility information.
    touchRollOver
    Dispatched when the user moves the point of
 contact over an InteractiveObject instance on
-a touch-enabled device(such as drags a
+a touch-enabled device (such as drags a
 finger from a point outside a display object
 to a point over a display object on a mobile
 phone or tablet with a touch screen). Some
@@ -932,7 +931,7 @@
 the current environment supports it. Choose
 how you want to handle the user interaction.
 Use the openfl.ui.Multitouch class to manage
-touch event handling(enable touch gesture
+touch event handling (enable touch gesture
 event handling, simple touch point event
 handling, or disable touch events so only
 mouse events are dispatched). If you choose
@@ -951,7 +950,7 @@
 environment compatibility information.
    touchTap
    Dispatched when the user lifts the point of
 contact over the same InteractiveObject
 instance on which the contact was initiated
-on a touch-enabled device(such as presses
+on a touch-enabled device (such as presses
 and releases a finger from a single point
 over a display object on a mobile phone or
 tablet with a touch screen). Some devices
@@ -980,7 +979,7 @@
 separately, to provide a different response
 for a touch event than a mouse event.
    
 
    Note: See the Multitouch class for
-environment compatibility information.
    Constructor
    new()
    Calling the new InteractiveObject() constructor throws an
+environment compatibility information.
    See also:
    Constructor
    new()
    Calling the new InteractiveObject() constructor throws an
 ArgumentError exception. You can, however, call constructors
 for the following subclasses of InteractiveObject:
    Variables
    doubleClickEnabled:Bool
    Specifies whether the object receives doubleClick events. The
 default value is false, which means that by default an
@@ -1001,14 +1000,14 @@
 default any InteractiveObject instance that is on the display list
 receives mouse events or other user input events. If
 mouseEnabled is set to false, the instance does
-not receive any mouse events(or other user input events like keyboard
+not receive any mouse events (or other user input events like keyboard
 events). Any children of this instance on the display list are not
 affected. To change the mouseEnabled behavior for all
 children of an object on the display list, use
 openfl.display.DisplayObjectContainer.mouseChildren.
    
 
    No event is dispatched by setting this property. You must use the
 addEventListener() method to create interactive
-functionality.
    needsSoftKeyboard:Bool
    Specifies whether a virtual keyboard(an on-screen, software keyboard)
+functionality.
    needsSoftKeyboard:Bool
    Specifies whether a virtual keyboard (an on-screen, software keyboard)
 should display when this InteractiveObject instance receives focus.
    
 
    By default, the value is false and focusing an
 InteractiveObject instance does not raise a soft keyboard. If the
@@ -1077,7 +1076,7 @@
 was granted; false means that the soft keyboard was
 not raised.
      
    Inherited Variables
     Defined by DisplayObject
    @:keepalpha:Float
    Indicates the alpha transparency value of the object specified. Valid
 values are 0 (fully transparent) to 1 (fully opaque). The default value is 1.
-Display objects with alpha set to 0 are active, even though they are invisible.
    blendMode:BlendMode
    A value from the BlendMode class that specifies which blend mode to use. A
+Display objects with alpha set to 0 are active, even though they are invisible.
    See also:
    blendMode:BlendMode
    A value from the BlendMode class that specifies which blend mode to use. A
 bitmap can be drawn internally in two ways. If you have a blend mode
 enabled or an external clipping mask, the bitmap is drawn by adding a
 bitmap-filled square shape to the vector render. If you attempt to set
@@ -1097,7 +1096,7 @@
 BlendMode class defines string values you can use. The illustrations in
 the table show blendMode values applied to a circular display
 object(2) superimposed on another display object(1).
    
-
    Square Number 1  Circle Number 2
    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.
    cacheAsBitmap:Bool
    All vector data for a display object that has a cached bitmap is drawn
+
    Square Number 1  Circle Number 2
    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.
    See also:
    cacheAsBitmap:Bool
    All vector data for a display object that has a cached bitmap is drawn
 to the bitmap instead of the main display. If
 cacheAsBitmapMatrix is null or unsupported, the bitmap is
 then copied to the main display as unstretched, unrotated pixels snapped
@@ -1128,12 +1127,12 @@
 number of pixels cannot exceed 16,777,215 pixels.(So, if a bitmap image
 is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9
 and earlier, the limitation is is 2880 pixels in height and 2,880 pixels
-in width.
  • The bitmap fails to allocate(out of memory error).
    • 
+in width.
  • The bitmap fails to allocate (out of memory error).
    • 
 
    The cacheAsBitmap property is best used with movie clips
 that have mostly static content and that do not scale and rotate
 frequently. With such movie clips, cacheAsBitmap can lead to
-performance increases when the movie clip is translated(when its x
-and y position is changed).
    cacheAsBitmapMatrix:Matrix
    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to
+performance increases when the movie clip is translated (when its x
+and y position is changed).
    See also:
    cacheAsBitmapMatrix:Matrix
    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to
 true. The application uses this matrix as a transformation matrix that is applied when rendering the
 bitmap version of the display object.
    
 
    Adobe AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop
@@ -1167,16 +1166,16 @@
 
    Note: The cacheAsBitmapMatrix property is suitable for 2D transformations. If you need to apply
 transformations in 3D, you may do so by setting a 3D property of the object and manipulating its
 transform.matrix3D property. If the application is packaged using GPU mode, this allows the 3D transforms
-to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.
    filters:Array<BitmapFilter>
    An indexed array that contains each filter object currently associated
+to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.
    See also:
    filters:Array<BitmapFilter>
    An indexed array that contains each filter object currently associated
 with the display object. The openfl.filters package contains several
 classes that define specific filters you can use.
    
 
    Filters can be applied in Flash Professional at design time, or at run
-time by using ActionScript code. To apply a filter by using ActionScript,
+time by using Haxe code. To apply a filter by using Haxe,
 you must make a temporary copy of the entire filters array,
 modify the temporary array, then assign the value of the temporary array
 back to the filters array. You cannot directly add a new
 filter object to the filters array.
    
-
    To add a filter by using ActionScript, perform the following steps
+
    To add a filter by using Haxe, perform the following steps
 (assume that the target display object is named
 myDisplayObject):
    1. Create a new filter object by using the constructor method of your
 chosen filter class.
    2. Assign the value of the myDisplayObject.filters array
@@ -1207,7 +1206,7 @@
 
      The openfl.filters package includes classes for filters. For example, to
 create a DropShadow filter, you would write:
      Throws:
      ArgumentError
      When filters includes a ShaderFilter
 and the shader output type is not compatible with
-this operation(the shader must specify a
+this operation (the shader must specify a
 pixel4 output).
      ArgumentError
      When filters includes a ShaderFilter
 and the shader doesn't specify any image input or
 the first input is not an image4 input.
      ArgumentError
      When filters includes a ShaderFilter
@@ -1225,10 +1224,10 @@
 is adjusted accordingly, as shown in the following code:
      
 
      Except for TextField and Video objects, a display object with no
 content(such as an empty sprite) has a height of 0, even if you try to
-set height to a different value.
      read onlyloaderInfo:LoaderInfo
      Returns a LoaderInfo object containing information about loading the file
+set height to a different value.
      See also:
      read onlyloaderInfo:LoaderInfo
      Returns a LoaderInfo object containing information about loading the file
 to which this display object belongs. The loaderInfo property
 is defined only for the root display object of a SWF file or for a loaded
-Bitmap(not for a Bitmap that is drawn with ActionScript). To find the
+Bitmap (not for a Bitmap that is drawn with Haxe). To find the
 loaderInfo object associated with the SWF file that contains
 a display object named myDisplayObject, use
 myDisplayObject.root.loaderInfo.
      
@@ -1240,7 +1239,7 @@
 list. The mask object itself is not drawn. Set
 mask to null to remove the mask.
      
 
      To be able to scale a mask object, it must be on the display list. To
-be able to drag a mask Sprite object(by calling its
+be able to drag a mask Sprite object (by calling its
 startDrag() method), it must be on the display list. To call
 the startDrag() method for a mask sprite based on a
 mouseDown event being dispatched by the sprite, set the
@@ -1259,23 +1258,23 @@
 more than one calling display object. When the mask is
 assigned to a second display object, it is removed as the mask of the
 first object, and that object's mask property becomes
-null.
      read onlymouseX:Float
      Indicates the x coordinate of the mouse or user input device position, in
+null.
      See also:
      read onlymouseX:Float
      Indicates the x coordinate of the mouse or user input device position, in
 pixels.
      
 
      Note: For a DisplayObject that has been rotated, the returned x
-coordinate will reflect the non-rotated object.
      read onlymouseY:Float
      Indicates the y coordinate of the mouse or user input device position, in
+coordinate will reflect the non-rotated object.
      See also:
      read onlymouseY:Float
      Indicates the y coordinate of the mouse or user input device position, in
 pixels.
      
 
      Note: For a DisplayObject that has been rotated, the returned y
-coordinate will reflect the non-rotated object.
      name:String
      Indicates the instance name of the DisplayObject. The object can be
+coordinate will reflect the non-rotated object.
      See also:
      name:String
      Indicates the instance name of the DisplayObject. The object can be
 identified in the child list of its parent display object container by
 calling the getChildByName() method of the display object
 container.
      Throws:
      IllegalOperationError
      If you are attempting to set this property
 on an object that was placed on the timeline
 in the Flash authoring tool.
      opaqueBackground:Null<Int>
      Specifies whether the display object is opaque with a certain background
 color. A transparent bitmap contains alpha channel data and is drawn
-transparently. An opaque bitmap has no alpha channel(and renders faster
+transparently. An opaque bitmap has no alpha channel (and renders faster
 than a transparent bitmap). If the bitmap is opaque, you specify its own
 background color to use.
      
-
      If set to a number value, the surface is opaque(not transparent) with
+
      If set to a number value, the surface is opaque (not transparent) with
 the RGB background color that the number specifies. If set to
 null(the default value), the display object has a
 transparent background.
      
@@ -1287,7 +1286,7 @@
 
      The opaque background region is not matched when calling the
 hitTestPoint() method with the shapeFlag
 parameter set to true.
      
-
      The opaque background region does not respond to mouse events.
      read onlyparent:DisplayObjectContainer
      Indicates the DisplayObjectContainer object that contains this display
+
      The opaque background region does not respond to mouse events.
      See also:
      read onlyparent:DisplayObjectContainer
      Indicates the DisplayObjectContainer object that contains this display
 object. Use the parent property to specify a relative path to
 display objects that are above the current display object in the display
 list hierarchy.
      
@@ -1296,7 +1295,7 @@
 
      this.parent.parent.alpha = 20;
      Throws:
      SecurityError
      The parent display object belongs to a security
 sandbox to which you do not have access. You can
 avoid this situation by having the parent movie call
-the Security.allowDomain() method.
      read onlyroot:DisplayObject
      For a display object in a loaded SWF file, the root property
+the Security.allowDomain() method.
      See also:
    read onlyroot:DisplayObject
    For a display object in a loaded SWF file, the root property
 is the top-most display object in the portion of the display list's tree
 structure represented by that SWF file. For a Bitmap object representing a
 loaded image file, the root property is the Bitmap object
@@ -1309,7 +1308,7 @@
 is a child of the top-most display object in a loaded SWF file.
    
 
    For example, if you create a new Sprite object by calling the
 Sprite() constructor method, its root property
-is null until you add it to the display list(or to a display
+is null until you add it to the display list (or to a display
 object container that is off the display list but that is a child of the
 top-most display object in a SWF file).
    
 
    For a loaded SWF file, even though the Loader object used to load the
@@ -1317,12 +1316,12 @@
 SWF file has its root property set to itself. The Loader
 object does not have its root property set until it is added
 as a child of a display object for which the root property is
-set.
    @:keeprotation:Float
    Indicates the rotation of the DisplayObject instance, in degrees, from its
+set.
    See also:
    @:keeprotation:Float
    Indicates the rotation of the DisplayObject instance, in degrees, from its
 original orientation. Values from 0 to 180 represent clockwise rotation;
 values from 0 to -180 represent counterclockwise rotation. Values outside
 this range are added to or subtracted from 360 to obtain a value within
 the range. For example, the statement my_video.rotation = 450
-is the same as  my_video.rotation = 90.
    scale9Grid:Rectangle
    The current scaling grid that is in effect. If set to null,
+is the same as  my_video.rotation = 90.
    See also:
    scale9Grid:Rectangle
    The current scaling grid that is in effect. If set to null,
 the entire display object is scaled normally when any scale transformation
 is applied.
    
 
    When you define the scale9Grid property, the display
@@ -1350,11 +1349,11 @@
 the registration point. The default registration point is (0,0). 1.0
 equals 100% scale.
    
 
    Scaling the local coordinate system changes the x and
-y property values, which are defined in whole pixels.
    @:keepscaleY:Float
    Indicates the vertical scale (percentage) of an object as applied from the
+y property values, which are defined in whole pixels.
    See also:
    @:keepscaleY:Float
    Indicates the vertical scale (percentage) of an object as applied from the
 registration point of the object. The default registration point is (0,0).
 1.0 is 100% scale.
    
 
    Scaling the local coordinate system changes the x and
-y property values, which are defined in whole pixels.
    scrollRect:Rectangle
    The scroll rectangle bounds of the display object. The display object is
+y property values, which are defined in whole pixels.
    See also:
    scrollRect:Rectangle
    The scroll rectangle bounds of the display object. The display object is
 cropped to the size defined by the rectangle, and it scrolls within the
 rectangle when you change the x and y properties
 of the scrollRect object.
    
@@ -1371,17 +1370,17 @@
 an object up and down by setting the y property of the
 scrollRect Rectangle object. If the display object is rotated
 90° and you scroll it left and right, the display object actually scrolls
-up and down.
    @:betashader:Shader
    BETA**
    
+up and down.
    See also:
    @:betashader:Shader
    BETA**
    
 
    Applies a custom Shader object to use when rendering this display object (or its children) when using
 hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to
 apply a post-process effect to multiple display objects at once, enable cacheAsBitmap or use the
 filters property with a ShaderFilter
    read onlystage:Stage
    The Stage of the display object. A Flash runtime application has only one
 Stage object. For example, you can create and load multiple display
 objects into the display list, and the stage property of each
-display object refers to the same Stage object(even if the display object
+display object refers to the same Stage object (even if the display object
 belongs to a loaded SWF file).
    
 
    If a display object is not added to the display list, its
-stage property is set to null.
    @:keeptransform:Transform
    An object with properties pertaining to a display object's matrix, color
+stage property is set to null.
    See also:
    @:keeptransform:Transform
    An object with properties pertaining to a display object's matrix, color
 transform, and pixel bounds. The specific properties  -  matrix,
 colorTransform, and three read-only properties
 (concatenatedMatrix, concatenatedColorTransform,
@@ -1418,21 +1417,21 @@
 is adjusted accordingly, as shown in the following code:
    
 
    Except for TextField and Video objects, a display object with no
 content(such as an empty sprite) has a width of 0, even if you try to set
-width to a different value.
    @:keepx:Float
    Indicates the x coordinate of the DisplayObject instance relative
+width to a different value.
    See also:
    @:keepx:Float
    Indicates the x coordinate of the DisplayObject instance relative
 to the local coordinates of the parent DisplayObjectContainer. If the
 object is inside a DisplayObjectContainer that has transformations, it is
 in the local coordinate system of the enclosing DisplayObjectContainer.
 Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the
 DisplayObjectContainer's children inherit a coordinate system that is
 rotated 90° counterclockwise. The object's coordinates refer to the
-registration point position.
    @:keepy:Float
    Indicates the y coordinate of the DisplayObject instance relative
+registration point position.
    See also:
    @:keepy:Float
    Indicates the y coordinate of the DisplayObject instance relative
 to the local coordinates of the parent DisplayObjectContainer. If the
 object is inside a DisplayObjectContainer that has transformations, it is
 in the local coordinate system of the enclosing DisplayObjectContainer.
 Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the
 DisplayObjectContainer's children inherit a coordinate system that is
 rotated 90° counterclockwise. The object's coordinates refer to the
-registration point position.
    Inherited Methods
     Defined by DisplayObject
    getBounds(targetCoordinateSpace:DisplayObject):Rectangle
    Returns a rectangle that defines the area of the display object relative
+registration point position.
    See also:
    Inherited Methods
     Defined by DisplayObject
    getBounds(targetCoordinateSpace:DisplayObject):Rectangle
    Returns a rectangle that defines the area of the display object relative
 to the coordinate system of the targetCoordinateSpace object.
 Consider the following code, which shows how the rectangle returned can
 vary depending on the targetCoordinateSpace parameter that
@@ -1459,8 +1458,8 @@
 coordinates, respectively.
    Parameters:
    targetCoordinateSpace
    The display object that defines the
 coordinate system to use.
    Returns:
    The rectangle that defines the area of the display object relative
 to the targetCoordinateSpace object's coordinate
-system.
    globalToLocal(pos:Point):Point
    Converts the point object from the Stage(global) coordinates
-to the display object's(local) coordinates.
    
+system.
    globalToLocal(pos:Point):Point
    Converts the point object from the Stage (global) coordinates
+to the display object's (local) coordinates.
    
 
    To use this method, first create an instance of the Point class. The
 x and y values that you assign represent global coordinates
 because they relate to the origin(0,0) of the main display area. Then
@@ -1475,17 +1474,17 @@
 point specified by the x and y parameters. The
 x and y parameters specify a point in the
 coordinate space of the Stage, not the display object container that
-contains the display object(unless that display object container is the
+contains the display object (unless that display object container is the
 Stage).
    Parameters:
    x
    The x coordinate to test against this object.
    y
    The y coordinate to test against this object.
    shapeFlag
    Whether to check against the actual pixels of the object
 (true) or the bounding box
 (false).
    Returns:
    true if the display object overlaps or intersects
 with the specified point; false otherwise.
    invalidate():Void
    Calling the invalidate() method signals to have the current object
-redrawn the next time the object is eligible to be rendered.
    localToGlobal(point:Point):Point
    Converts the point object from the display object's(local)
-coordinates to the Stage(global) coordinates.
    
+redrawn the next time the object is eligible to be rendered.
    localToGlobal(point:Point):Point
    Converts the point object from the display object's (local)
+coordinates to the Stage (global) coordinates.
    
 
    This method allows you to convert any given x and y
 coordinates from values that are relative to the origin(0,0) of a
-specific display object(local coordinates) to values that are relative to
-the origin of the Stage(global coordinates).
    
+specific display object (local coordinates) to values that are relative to
+the origin of the Stage (global coordinates).
    
 
    To use this method, first create an instance of the Point class. The
 x and y values that you assign represent local coordinates
 because they relate to the origin of the display object.
    
diff --git a/openfl/display/InterpolationMethod.html b/openfl/display/InterpolationMethod.html
index 55653a3..aea7c87 100644
--- a/openfl/display/InterpolationMethod.html
+++ b/openfl/display/InterpolationMethod.html
@@ -1,7 +1,7 @@
 
 
 
-openfl.display.InterpolationMethod - API Referenceopenfl.display.InterpolationMethod - OpenFL API Reference
    API Reference
     View source
    enum abstract InterpolationMethod(Null<Int>)
    package openfl.display
    @:enum
    Available on  all platforms
    The InterpolationMethod class provides values for the
+
     View source
    enum abstract InterpolationMethod(Null<Int>)
    package openfl.display
    @:enum
    Available on  all platforms
    The InterpolationMethod class provides values for the
 interpolationMethod parameter in the
 Graphics.beginGradientFill() and
 Graphics.lineGradientStyle() methods. This parameter
 determines the RGB space to use when rendering the gradient.
    Variables
    @:value(cast 0)@:impl@:enuminlineread onlyLINEAR_RGB:InterpolationMethod = 0
    Specifies that the RGB interpolation method should be used. This means
-that the gradient is rendered with exponential sRGB(standard RGB) space.
+that the gradient is rendered with exponential sRGB (standard RGB) space.
 The sRGB space is a W3C-endorsed standard that defines a non-linear
 conversion between red, green, and blue component values and the actual
 intensity of the visible component color.
    
@@ -69,7 +69,7 @@
 the spreadMethod parameter set to
 SpreadMethod.REFLECT). The different interpolation methods
 affect the appearance as follows:
    @:value(cast 1)@:impl@:enuminlineread onlyRGB:InterpolationMethod = 1
    Specifies that the RGB interpolation method should be used. This means
-that the gradient is rendered with exponential sRGB(standard RGB) space.
+that the gradient is rendered with exponential sRGB (standard RGB) space.
 The sRGB space is a W3C-endorsed standard that defines a non-linear
 conversion between red, green, and blue component values and the actual
 intensity of the visible component color.
    
diff --git a/openfl/display/JPEGEncoderOptions.html b/openfl/display/JPEGEncoderOptions.html
index 896a416..20914df 100644
--- a/openfl/display/JPEGEncoderOptions.html
+++ b/openfl/display/JPEGEncoderOptions.html
@@ -1,7 +1,7 @@
 
 
 
-openfl.display.JPEGEncoderOptions - API Referenceopenfl.display.JPEGEncoderOptions - OpenFL API Reference
     View source
    final class JPEGEncoderOptions
    package openfl.display
        @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final
    Available on  all platforms
    The JPEGEncoderOptions class defines a compression algorithm for the
+
     View source
    final class JPEGEncoderOptions
    package openfl.display
        @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final
    Available on  all platforms
    The JPEGEncoderOptions class defines a compression algorithm for the
 openfl.display.BitmapData.encode() method.
    Constructor
    @:value({ quality : 80 })new(quality:Int = 80)
    Creates a JPEGEncoderOptions object with the specified setting.
    Parameters:
    quality
    The initial quality value.
    Variables
    quality:Int
    A value between 1 and 100, where 1 means the lowest quality and 100 means the
 highest quality. The higher the value, the larger the size of the output of the
 compression, and the smaller the compression ratio.
    
\ No newline at end of file
diff --git a/openfl/display/JointStyle.html b/openfl/display/JointStyle.html
index 0b3b977..6204b32 100644
--- a/openfl/display/JointStyle.html
+++ b/openfl/display/JointStyle.html
@@ -1,7 +1,7 @@
 
 
 
-openfl.display.JointStyle - API Referenceopenfl.display.JointStyle - OpenFL API Reference
    API Reference
     View source
    enum abstract JointStyle(Null<Int>)
    package openfl.display
    @:enum
    Available on  all platforms
    The JointStyle class is an enumeration of constant values that specify the
+
     View source
    enum abstract JointStyle(Null<Int>)
    package openfl.display
    @:enum
    Available on  all platforms
    The JointStyle class is an enumeration of constant values that specify the
 joint style to use in drawing lines. These constants are provided for use
 as values in the joints parameter of the
 openfl.display.Graphics.lineStyle() method. The method supports
diff --git a/openfl/display/LineScaleMode.html b/openfl/display/LineScaleMode.html
index 647dea9..89408f8 100644
--- a/openfl/display/LineScaleMode.html
+++ b/openfl/display/LineScaleMode.html
@@ -1,7 +1,7 @@
 
 
 
-openfl.display.LineScaleMode - API Referenceopenfl.display.LineScaleMode - OpenFL API Reference
     View source
    enum abstract LineScaleMode(Null<Int>)
    package openfl.display
    @:enum
    Available on  all platforms
    The LineScaleMode class provides values for the scaleMode
+
     View source
    enum abstract LineScaleMode(Null<Int>)
    package openfl.display
    @:enum
    Available on  all platforms
    The LineScaleMode class provides values for the scaleMode
 parameter in the Graphics.lineStyle() method.
    Variables
    @:value(cast 0)@:impl@:enuminlineread onlyHORIZONTAL:LineScaleMode = 0
    With this setting used as the scaleMode parameter of the
 lineStyle() method, the thickness of the line scales
 only vertically. For example, consider the following circles, drawn
@@ -63,7 +63,7 @@
 vertically and horizontally.
    @:value(cast 1)@:impl@:enuminlineread onlyNONE:LineScaleMode = 1
    With this setting used as the scaleMode parameter of the
 lineStyle() method, the thickness of the line never scales.
    @:value(cast 2)@:impl@:enuminlineread onlyNORMAL:LineScaleMode = 2
    With this setting used as the scaleMode parameter of the
 lineStyle() method, the thickness of the line always scales
-when the object is scaled(the default).
    @:value(cast 3)@:impl@:enuminlineread onlyVERTICAL:LineScaleMode = 3
    With this setting used as the scaleMode parameter of the
+when the object is scaled (the default).
    @:value(cast 3)@:impl@:enuminlineread onlyVERTICAL:LineScaleMode = 3
    With this setting used as the scaleMode parameter of the
 lineStyle() method, the thickness of the line scales
 only horizontally. For example, consider the following circles,
 drawn with a one-pixel line, and each with the scaleMode
diff --git a/openfl/display/Loader.html b/openfl/display/Loader.html
index ad5ec9f..305fa68 100644
--- a/openfl/display/Loader.html
+++ b/openfl/display/Loader.html
@@ -1,7 +1,7 @@
 
 
 
-openfl.display.Loader - API Referenceopenfl.display.Loader - OpenFL API Reference
     View source
    class Loader
    package openfl.display
    extends DisplayObjectContainer › InteractiveObject › DisplayObject › EventDispatcher
        @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.LoaderInfo)@:access(openfl.events.Event)
    Available on  all platforms
    The Loader class is used to load SWF files or image (JPG, PNG, or GIF)
+
     View source
    class Loader
    package openfl.display
    extends DisplayObjectContainer › InteractiveObject › DisplayObject › EventDispatcher
        @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.LoaderInfo)@:access(openfl.events.Event)
    Available on  all platforms
    The Loader class is used to load SWF files or image (JPG, PNG, or GIF)
 files. Use the load() method to initiate loading. The loaded
 display object is added as a child of the Loader object.
    
 
    Use the URLLoader class to load text or binary data.
    
@@ -67,8 +67,7 @@
 remove the Loader object from its parent DisplayObjectContainer
 child array.
    
 
    Note: The ActionScript 2.0 MovieClipLoader and LoadVars classes
-are not used in ActionScript 3.0. The Loader and URLLoader classes replace
-them.
    
+are not used in OpenFL. The Loader and URLLoader classes replace them.
    
 
    When you use the Loader class, consider the Flash Player and Adobe AIR
 security model:
    • You can load content from any accessible source.
    • Loading is not allowed if the calling SWF file is in a network
 sandbox and the file to be loaded is local.
    • If the loaded content is a SWF file written with ActionScript 3.0, it
@@ -76,8 +75,8 @@
 that cross-scripting arrangement was approved through a call to the
 System.allowDomain() or the
 System.allowInsecureDomain() method in the loaded content
-file.
    • If the loaded content is an AVM1 SWF file(written using ActionScript
-1.0 or 2.0), it cannot be cross-scripted by an AVM2 SWF file(written using
+file.
    • If the loaded content is an AVM1 SWF file (written using ActionScript
+1.0 or 2.0), it cannot be cross-scripted by an AVM2 SWF file (written using
 ActionScript 3.0). However, you can communicate between the two SWF files
 by using the LocalConnection class.
    • If the loaded content is an image, its data cannot be accessed by a
 SWF file outside of the security sandbox, unless the domain of that SWF
@@ -85,21 +84,21 @@
 image.
    • Movie clips in the local-with-file-system sandbox cannot script movie
 clips in the local-with-networking sandbox, and the reverse is also
 prevented.
    • You cannot connect to commonly reserved ports. For a complete list of
-blocked ports, see "Restricting Networking APIs" in the ActionScript 3.0
+blocked ports, see "Restricting Networking APIs" in the OpenFL
 Developer's Guide.
    
 
    However, in AIR, content in the application security
 sandbox(content installed with the AIR application) are not restricted by
 these security limitations.
    
 
    For more information related to security, see the Flash Player Developer
 Center Topic: Security.
    
-
    When loading a SWF file from an untrusted source(such as a domain other
+
    When loading a SWF file from an untrusted source (such as a domain other
 than that of the Loader object's root SWF file), you may want to define a
-mask for the Loader object, to prevent the loaded content(which is a child
+mask for the Loader object, to prevent the loaded content (which is a child
 of the Loader object) from drawing to portions of the Stage outside of that
-mask, as shown in the following code:
    Constructor
    new()
    Creates a Loader object that you can use to load files, such as SWF, JPEG,
+mask, as shown in the following code:
    See also:
    Constructor
    new()
    Creates a Loader object that you can use to load files, such as SWF, JPEG,
 GIF, or PNG files. Call the load() method to load the asset
 as a child of the Loader instance. You can then add the Loader object to
-the display list(for instance, by using the addChild()
+the display list (for instance, by using the addChild()
 method of a DisplayObjectContainer instance). The asset appears on the
 Stage as it loads.
    
 
    You can also use a Loader instance "offlist," that is without adding it
@@ -189,7 +188,7 @@
 
    When you use this method, consider the Flash Player security model,
 which is described in the Loader class description.
    
 
    In Flash Player 10 and later, if you use a multipart Content-Type(for
-example "multipart/form-data") that contains an upload(indicated by a
+example "multipart/form-data") that contains an upload (indicated by a
 "filename" parameter in a "content-disposition" header within the POST
 body), the POST operation is subject to the security rules applied to
 uploads:
    • The POST operation must be performed in response to a user-initiated
@@ -227,7 +226,7 @@
 digest property of a URLRequest
 object when calling the
 URLLoader.load() method when
-loading a SWZ file(an Adobe platform
+loading a SWZ file (an Adobe platform
 component).
    IllegalOperationError

    If the requestedContentParent property of the context parameter is a Loader.

    IllegalOperationError

    If the LoaderContext.parameters @@ -238,7 +237,7 @@ SecurityDomain.currentDomain. This reflects the fact that you can only place the loaded media in its natural -security sandbox or your own(the latter +security sandbox or your own (the latter requires a policy file).

    SecurityError

    Local SWF files may not set LoaderContext.securityDomain to anything other than null. It is not @@ -247,7 +246,7 @@ in anything other than its natural sandbox.

    SecurityError

    You cannot connect to commonly reserved ports. For a complete list of blocked ports, see "Restricting Networking APIs" in the -ActionScript 3.0 Developer's Guide.

    SecurityError

    If the applicationDomain or +OpenFL Developer's Guide.

    SecurityError

    If the applicationDomain or securityDomain properties of the context parameter are from a disallowed domain.

    SecurityError

    If a local SWF file is attempting to use the @@ -318,7 +317,7 @@ disallowed domain.

    SecurityError

    You cannot connect to commonly reserved ports. For a complete list of blocked ports, see "Restricting Networking APIs" in the -ActionScript 3.0 Developer's Guide.

    Events:

    asyncError

    Dispatched by the contentLoaderInfo +OpenFL Developer's Guide.

    Events:

    asyncError

    Dispatched by the contentLoaderInfo object if the LoaderContext.requestedContentParent property has been specified and it is not possible to @@ -374,7 +373,7 @@ file's display list:

    • Sounds are stopped.
    • Stage event listeners are removed.
    • Event listeners for enterFrame, frameConstructed, exitFrame, activate and deactivate are removed.
    • Timers are stopped.
    • Camera and Microphone instances are detached
    • Movie clips are stopped.

    Parameters:

    gc

    Provides a hint to the garbage collector to run on the child SWF -objects(true) or not(false). If you +objects (true) or not (false). If you are unloading many objects asynchronously, setting the gc paramter to false might improve application performance. However, if the parameter is set to @@ -385,7 +384,7 @@ it by using a mouse or user input device. The default is true.

    This property is useful when you create a button with an instance of -the Sprite class(instead of using the SimpleButton class). When you use a +the Sprite class (instead of using the SimpleButton class). When you use a Sprite instance to create a button, you can choose to decorate the button by using the addChild() method to add additional Sprite instances. This process can cause unexpected behavior with mouse events @@ -422,14 +421,14 @@ default any InteractiveObject instance that is on the display list receives mouse events or other user input events. If mouseEnabled is set to false, the instance does -not receive any mouse events(or other user input events like keyboard +not receive any mouse events (or other user input events like keyboard events). Any children of this instance on the display list are not affected. To change the mouseEnabled behavior for all children of an object on the display list, use openfl.display.DisplayObjectContainer.mouseChildren.

    No event is dispatched by setting this property. You must use the addEventListener() method to create interactive -functionality.

    needsSoftKeyboard:Bool

    Specifies whether a virtual keyboard(an on-screen, software keyboard) +functionality.

    needsSoftKeyboard:Bool

    Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.

    By default, the value is false and focusing an InteractiveObject instance does not raise a soft keyboard. If the @@ -489,7 +488,7 @@ cast(tlfInstance2.getChildAt(1), InteractiveObject).tabIndex = 2; cast(tlfInstance3.getChildAt(1), InteractiveObject).tabIndex = 1;

    Defined by DisplayObject

    @:keepalpha:Float

    Indicates the alpha transparency value of the object specified. Valid values are 0 (fully transparent) to 1 (fully opaque). The default value is 1. -Display objects with alpha set to 0 are active, even though they are invisible.

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A +Display objects with alpha set to 0 are active, even though they are invisible.

    See also:

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A bitmap can be drawn internally in two ways. If you have a blend mode enabled or an external clipping mask, the bitmap is drawn by adding a bitmap-filled square shape to the vector render. If you attempt to set @@ -509,7 +508,7 @@ BlendMode class defines string values you can use. The illustrations in the table show blendMode values applied to a circular display object(2) superimposed on another display object(1).

    -

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn +

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    See also:

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn to the bitmap instead of the main display. If cacheAsBitmapMatrix is null or unsupported, the bitmap is then copied to the main display as unstretched, unrotated pixels snapped @@ -540,12 +539,12 @@ number of pixels cannot exceed 16,777,215 pixels.(So, if a bitmap image is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is is 2880 pixels in height and 2,880 pixels -in width.

  • The bitmap fails to allocate(out of memory error).
    • +in width.
  • The bitmap fails to allocate (out of memory error).

    • The cacheAsBitmap property is best used with movie clips that have mostly static content and that do not scale and rotate frequently. With such movie clips, cacheAsBitmap can lead to -performance increases when the movie clip is translated(when its x -and y position is changed).

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to +performance increases when the movie clip is translated (when its x +and y position is changed).

    See also:

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. The application uses this matrix as a transformation matrix that is applied when rendering the bitmap version of the display object.

    Adobe AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop @@ -579,16 +578,16 @@

    Note: The cacheAsBitmapMatrix property is suitable for 2D transformations. If you need to apply transformations in 3D, you may do so by setting a 3D property of the object and manipulating its transform.matrix3D property. If the application is packaged using GPU mode, this allows the 3D transforms -to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated +to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    See also:

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated with the display object. The openfl.filters package contains several classes that define specific filters you can use.

    Filters can be applied in Flash Professional at design time, or at run -time by using ActionScript code. To apply a filter by using ActionScript, +time by using Haxe code. To apply a filter by using Haxe, you must make a temporary copy of the entire filters array, modify the temporary array, then assign the value of the temporary array back to the filters array. You cannot directly add a new filter object to the filters array.

    -

    To add a filter by using ActionScript, perform the following steps +

    To add a filter by using Haxe, perform the following steps (assume that the target display object is named myDisplayObject):

    1. Create a new filter object by using the constructor method of your chosen filter class.
    2. Assign the value of the myDisplayObject.filters array @@ -619,7 +618,7 @@

      The openfl.filters package includes classes for filters. For example, to create a DropShadow filter, you would write:

      Throws:

      ArgumentError

      When filters includes a ShaderFilter and the shader output type is not compatible with -this operation(the shader must specify a +this operation (the shader must specify a pixel4 output).

      ArgumentError

      When filters includes a ShaderFilter and the shader doesn't specify any image input or the first input is not an image4 input.

      ArgumentError

      When filters includes a ShaderFilter @@ -637,10 +636,10 @@ is adjusted accordingly, as shown in the following code:

      Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a height of 0, even if you try to -set height to a different value.

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file +set height to a different value.

      See also:

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file to which this display object belongs. The loaderInfo property is defined only for the root display object of a SWF file or for a loaded -Bitmap(not for a Bitmap that is drawn with ActionScript). To find the +Bitmap (not for a Bitmap that is drawn with Haxe). To find the loaderInfo object associated with the SWF file that contains a display object named myDisplayObject, use myDisplayObject.root.loaderInfo.

      @@ -652,7 +651,7 @@ list. The mask object itself is not drawn. Set mask to null to remove the mask.

      To be able to scale a mask object, it must be on the display list. To -be able to drag a mask Sprite object(by calling its +be able to drag a mask Sprite object (by calling its startDrag() method), it must be on the display list. To call the startDrag() method for a mask sprite based on a mouseDown event being dispatched by the sprite, set the @@ -671,23 +670,23 @@ more than one calling display object. When the mask is assigned to a second display object, it is removed as the mask of the first object, and that object's mask property becomes -null.

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in +null.

      See also:

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned x -coordinate will reflect the non-rotated object.

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in +coordinate will reflect the non-rotated object.

      See also:

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned y -coordinate will reflect the non-rotated object.

      name:String

      Indicates the instance name of the DisplayObject. The object can be +coordinate will reflect the non-rotated object.

      See also:

      name:String

      Indicates the instance name of the DisplayObject. The object can be identified in the child list of its parent display object container by calling the getChildByName() method of the display object container.

      Throws:

      IllegalOperationError

      If you are attempting to set this property on an object that was placed on the timeline in the Flash authoring tool.

      opaqueBackground:Null<Int>

      Specifies whether the display object is opaque with a certain background color. A transparent bitmap contains alpha channel data and is drawn -transparently. An opaque bitmap has no alpha channel(and renders faster +transparently. An opaque bitmap has no alpha channel (and renders faster than a transparent bitmap). If the bitmap is opaque, you specify its own background color to use.

      -

      If set to a number value, the surface is opaque(not transparent) with +

      If set to a number value, the surface is opaque (not transparent) with the RGB background color that the number specifies. If set to null(the default value), the display object has a transparent background.

      @@ -699,7 +698,7 @@

      The opaque background region is not matched when calling the hitTestPoint() method with the shapeFlag parameter set to true.

      -

      The opaque background region does not respond to mouse events.

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display +

      The opaque background region does not respond to mouse events.

      See also:

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display object. Use the parent property to specify a relative path to display objects that are above the current display object in the display list hierarchy.

      @@ -708,7 +707,7 @@ 
      this.parent.parent.alpha = 20;

      Throws:

      SecurityError

      The parent display object belongs to a security sandbox to which you do not have access. You can avoid this situation by having the parent movie call -the Security.allowDomain() method.

      read onlyroot:DisplayObject

      For a display object in a loaded SWF file, the root property +the Security.allowDomain() method.

      See also:

    read onlyroot:DisplayObject

    For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. For a Bitmap object representing a loaded image file, the root property is the Bitmap object @@ -721,7 +720,7 @@ is a child of the top-most display object in a loaded SWF file.

    For example, if you create a new Sprite object by calling the Sprite() constructor method, its root property -is null until you add it to the display list(or to a display +is null until you add it to the display list (or to a display object container that is off the display list but that is a child of the top-most display object in a SWF file).

    For a loaded SWF file, even though the Loader object used to load the @@ -729,12 +728,12 @@ SWF file has its root property set to itself. The Loader object does not have its root property set until it is added as a child of a display object for which the root property is -set.

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its +set.

    See also:

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement my_video.rotation = 450 -is the same as my_video.rotation = 90.

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, +is the same as my_video.rotation = 90.

    See also:

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, the entire display object is scaled normally when any scale transformation is applied.

    When you define the scale9Grid property, the display @@ -762,11 +761,11 @@ the registration point. The default registration point is (0,0). 1.0 equals 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the +y property values, which are defined in whole pixels.

    See also:

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. The default registration point is (0,0). 1.0 is 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is +y property values, which are defined in whole pixels.

    See also:

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is cropped to the size defined by the rectangle, and it scrolls within the rectangle when you change the x and y properties of the scrollRect object.

    @@ -783,17 +782,17 @@ an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated 90° and you scroll it left and right, the display object actually scrolls -up and down.

    @:betashader:Shader

    BETA**

    +up and down.

    See also:

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to apply a post-process effect to multiple display objects at once, enable cacheAsBitmap or use the filters property with a ShaderFilter

    read onlystage:Stage

    The Stage of the display object. A Flash runtime application has only one Stage object. For example, you can create and load multiple display objects into the display list, and the stage property of each -display object refers to the same Stage object(even if the display object +display object refers to the same Stage object (even if the display object belongs to a loaded SWF file).

    If a display object is not added to the display list, its -stage property is set to null.

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color +stage property is set to null.

    See also:

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. The specific properties - matrix, colorTransform, and three read-only properties (concatenatedMatrix, concatenatedColorTransform, @@ -830,21 +829,21 @@ is adjusted accordingly, as shown in the following code:

    Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a width of 0, even if you try to set -width to a different value.

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative +width to a different value.

    See also:

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative +registration point position.

    See also:

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    Inherited Methods

    Defined by DisplayObjectContainer

    areInaccessibleObjectsUnderPoint(point:Point):Bool

    Indicates whether the security restrictions would cause any display +registration point position.

    See also:

    Inherited Methods

    Defined by DisplayObjectContainer

    areInaccessibleObjectsUnderPoint(point:Point):Bool

    Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point. By default, content from one domain @@ -868,7 +867,7 @@ list.

    SecurityError

    This child display object belongs to a sandbox to which you do not have access. You can avoid this situation by having the child movie call -Security.allowDomain().

    getChildByName(name:String):DisplayObject

    Returns the child display object that exists with the specified name. If +Security.allowDomain().

    See also:

    getChildByName(name:String):DisplayObject

    Returns the child display object that exists with the specified name. If more that one child display object has the specified name, the method returns the first object in the child list.

    The getChildAt() method is faster than the @@ -878,7 +877,7 @@ access a child.

    Parameters:

    name

    The name of the child to return.

    Returns:

    The child display object with the specified name.

    Throws:

    SecurityError

    This child display object belongs to a sandbox to which you do not have access. You can avoid this situation by having the child movie call the -Security.allowDomain() method.

    getChildIndex(child:DisplayObject):Int

    Returns the index position of a child DisplayObject instance.

    Parameters:

    child

    The DisplayObject instance to identify.

    Returns:

    The index position of the child display object to identify.

    Throws:

    ArgumentError

    Throws if the child parameter is not a child of this +Security.allowDomain() method.

    See also:

    getChildIndex(child:DisplayObject):Int

    Returns the index position of a child DisplayObject instance.

    Parameters:

    child

    The DisplayObject instance to identify.

    Returns:

    The index position of the child display object to identify.

    Throws:

    ArgumentError

    Throws if the child parameter is not a child of this object.

    getObjectsUnderPoint(point:Point):Array<DisplayObject>

    Returns an array of objects that lie under the specified point and are children(or grandchildren, and so on) of this DisplayObjectContainer instance. Any child objects that are inaccessible for security reasons are @@ -941,8 +940,8 @@ coordinates, respectively.

    Parameters:

    targetCoordinateSpace

    The display object that defines the coordinate system to use.

    Returns:

    The rectangle that defines the area of the display object relative to the targetCoordinateSpace object's coordinate -system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage(global) coordinates -to the display object's(local) coordinates.

    +system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage (global) coordinates +to the display object's (local) coordinates.

    To use this method, first create an instance of the Point class. The x and y values that you assign represent global coordinates because they relate to the origin(0,0) of the main display area. Then @@ -957,17 +956,17 @@ point specified by the x and y parameters. The x and y parameters specify a point in the coordinate space of the Stage, not the display object container that -contains the display object(unless that display object container is the +contains the display object (unless that display object container is the Stage).

    Parameters:

    x

    The x coordinate to test against this object.

    y

    The y coordinate to test against this object.

    shapeFlag

    Whether to check against the actual pixels of the object (true) or the bounding box (false).

    Returns:

    true if the display object overlaps or intersects with the specified point; false otherwise.

    invalidate():Void

    Calling the invalidate() method signals to have the current object -redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's(local) -coordinates to the Stage(global) coordinates.

    +redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's (local) +coordinates to the Stage (global) coordinates.

    This method allows you to convert any given x and y coordinates from values that are relative to the origin(0,0) of a -specific display object(local coordinates) to values that are relative to -the origin of the Stage(global coordinates).

    +specific display object (local coordinates) to values that are relative to +the origin of the Stage (global coordinates).

    To use this method, first create an instance of the Point class. The x and y values that you assign represent local coordinates because they relate to the origin of the display object.

    diff --git a/openfl/display/LoaderInfo.html b/openfl/display/LoaderInfo.html index 2f88a94..f80e1fb 100644 --- a/openfl/display/LoaderInfo.html +++ b/openfl/display/LoaderInfo.html @@ -1,7 +1,7 @@ -openfl.display.LoaderInfo - API Referenceopenfl.display.LoaderInfo - OpenFL API Reference
    API Reference
    View source

    class LoaderInfo

    package openfl.display

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The LoaderInfo class provides information about a loaded SWF file or a +

    View source

    class LoaderInfo

    package openfl.display

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The LoaderInfo class provides information about a loaded SWF file or a loaded image file(JPEG, GIF, or PNG). LoaderInfo objects are available for any display object. The information provided includes load progress, the URLs of the loader and loaded content, the number of bytes total for the @@ -71,7 +71,7 @@ information about the content that the Loader object is loading, whereas the loaderInfo property of a DisplayObject provides information about the root SWF file for that display object.

    -

    When you use a Loader object to load a display object(such as a SWF +

    When you use a Loader object to load a display object (such as a SWF file or a bitmap), the loaderInfo property of the display object is the same as the contentLoaderInfo property of the Loader object(DisplayObject.loaderInfo = @@ -123,7 +123,7 @@ object is removed by using the unload() method of the Loader object, or when a second load is performed by the same Loader object and the original -content is removed prior to the load beginning.

    Variables

    read onlyapplicationDomain:ApplicationDomain

    When an external SWF file is loaded, all ActionScript 3.0 definitions +content is removed prior to the load beginning.

    See also:

    Variables

    read onlyapplicationDomain:ApplicationDomain

    When an external SWF file is loaded, all ActionScript 3.0 definitions contained in the loaded class are stored in the applicationDomain property.

    All code in a SWF file is defined to exist in an application domain. @@ -136,7 +136,7 @@ defined only when their parent doesn't already define them. You cannot override a loaded class definition with a newer definition.

    For usage examples of application domains, see the "Client System -Environment" chapter in the ActionScript 3.0 Developer's Guide.

    Throws:

    SecurityError

    This security sandbox of the caller is not allowed +Environment" chapter in the OpenFL Developer's Guide.

    Throws:

    SecurityError

    This security sandbox of the caller is not allowed to access this ApplicationDomain.

    read onlybytes:ByteArray

    The bytes associated with a LoaderInfo object.

    Throws:

    SecurityError

    If the object accessing this API is prevented from accessing the loaded object due to security restrictions. This situation can occur, for @@ -152,7 +152,7 @@ LoaderInfo object's corresponding Loader object, bytesTotal is 0. After the first progress event from the Loader object, bytesTotal reflects the actual number of bytes to be -downloaded.

    read onlychildAllowsParent:Bool

    Expresses the trust relationship from content(child) to the Loader +downloaded.

    read onlychildAllowsParent:Bool

    Expresses the trust relationship from content (child) to the Loader (parent). If the child has allowed the parent access, true; otherwise, false. This property is set to true if the child object has called the allowDomain() method to @@ -209,7 +209,7 @@

    The value of the parameters property is null for Loader objects that contain SWF files that use ActionScript 1.0 or 2.0. It is only non-null for Loader objects that contain SWF files that use -ActionScript 3.0.

    read onlyparentAllowsChild:Bool

    Expresses the trust relationship from Loader(parent) to the content +ActionScript 3.0.

    read onlyparentAllowsChild:Bool

    Expresses the trust relationship from Loader (parent) to the content (child). If the parent has allowed the child access, true; otherwise, false. This property is set to true if the parent object called the allowDomain() method to grant @@ -321,7 +321,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/display/MovieClip.html b/openfl/display/MovieClip.html index afb0b40..30a3dd0 100644 --- a/openfl/display/MovieClip.html +++ b/openfl/display/MovieClip.html @@ -1,7 +1,7 @@ -openfl.display.MovieClip - API Referenceopenfl.display.MovieClip - OpenFL API Reference

    View source

    class MovieClip

    package openfl.display

    extends Sprite › DisplayObjectContainer › InteractiveObject › DisplayObject › EventDispatcher

    @:directlyUsed@:build(openfl.utils._internal.AssetsMacro.initBinding())@:autoBuild(openfl.utils._internal.AssetsMacro.initBinding())@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Timeline)@:access(openfl.geom.ColorTransform)

    Available on all platforms

    The MovieClip class inherits from the following classes: Sprite, +

    View source

    class MovieClip

    package openfl.display

    extends Sprite › DisplayObjectContainer › InteractiveObject › DisplayObject › EventDispatcher

    @:directlyUsed@:build(openfl.utils._internal.AssetsMacro.initBinding())@:autoBuild(openfl.utils._internal.AssetsMacro.initBinding())@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Timeline)@:access(openfl.geom.ColorTransform)

    Available on all platforms

    The MovieClip class inherits from the following classes: Sprite, DisplayObjectContainer, InteractiveObject, DisplayObject, and EventDispatcher.

    Unlike the Sprite object, a MovieClip object has a timeline.

    @@ -81,7 +81,7 @@ property only if FEATURE_BITMAPCACHE is defined. The default configuration of Flash Lite 4 does not define FEATURE_BITMAPCACHE. To enable the MovieClip.opaqueBackground property for a suitable device, define -FEATURE_BITMAPCACHE in your project.

    Static methods

    staticfromTimeline(timeline:Timeline):MovieClip

    Creates a new MovieClip based upon a Timeline instance.

    Parameters:

    timeline

    A Timeline object

    Returns:

    A new Sprite

    Constructor

    new()

    Creates a new MovieClip instance. After creating the MovieClip, call the +FEATURE_BITMAPCACHE in your project.

    See also:

    Static methods

    staticfromTimeline(timeline:Timeline):MovieClip

    Creates a new MovieClip based upon a Timeline instance.

    Parameters:

    timeline

    A Timeline object

    Returns:

    A new Sprite

    Constructor

    new()

    Creates a new MovieClip instance. After creating the MovieClip, call the addChild() or addChildAt() method of a display object container that is onstage.

    Variables

    read onlycurrentFrame:Int

    Specifies the number of the frame in which the playhead is located in the timeline of the MovieClip instance. If the movie clip has multiple scenes, @@ -93,7 +93,7 @@ includes a label. If the current frame and previous frames do not include a label, currentLabel returns null.

    read onlycurrentLabels:Array<FrameLabel>

    Returns an array of FrameLabel objects from the current scene. If the MovieClip instance does not use scenes, the array includes all frame -labels from the entire MovieClip instance.

    read onlycurrentScene:Scene

    The current scene in which the playhead is located in the timeline of +labels from the entire MovieClip instance.

    read onlycurrentScene:Scene

    The current scene in which the playhead is located in the timeline of the MovieClip instance.

    enabled:Bool

    A Boolean value that indicates whether a movie clip is enabled. The default value of enabled is true. If enabled is set to false, the movie clip's Over, @@ -113,7 +113,7 @@ frame in the SWF file finishes loading.

    If the movie clip contains multiple scenes, the framesLoaded property returns the number of frames loaded for -all scenes in the movie clip.

    read onlyisPlaying:Bool

    A Boolean value that indicates whether a movie clip is curently playing.

    read onlyscenes:Array<Scene>

    An array of Scene objects, each listing the name, the number of frames, +all scenes in the movie clip.

    read onlyisPlaying:Bool

    A Boolean value that indicates whether a movie clip is curently playing.

    read onlyscenes:Array<Scene>

    An array of Scene objects, each listing the name, the number of frames, and the frame labels for a scene in the MovieClip instance.

    read onlytotalFrames:Int

    The total number of frames in the MovieClip instance.

    If the movie clip contains multiple frames, the totalFrames property returns the total number of frames in @@ -131,7 +131,7 @@ you specify. If you do not specify a scene, the current scene determines the global frame number to play. If you do specify a scene, the playhead jumps to the frame number in the -specified scene.

    scene

    The name of the scene to play. This parameter is optional.

    @:value({ scene : null })gotoAndStop(frame:Any, ?scene:String):Void

    Brings the playhead to the specified frame of the movie clip and stops it +specified scene.

    scene

    The name of the scene to play. This parameter is optional.

    See also:

    @:value({ scene : null })gotoAndStop(frame:Any, ?scene:String):Void

    Brings the playhead to the specified frame of the movie clip and stops it there. This happens after all remaining actions in the frame have finished executing. If you want to specify a scene in addition to a frame, specify a scene parameter.

    Parameters:

    frame

    A number representing the frame number, or a string @@ -141,9 +141,9 @@ determines the global frame number at which to go to and stop. If you do specify a scene, the playhead goes to the frame number in the specified scene and stops.

    scene

    The name of the scene. This parameter is optional.

    Throws:

    ArgumentError

    If the scene or frame -specified are not found in this movie clip.

    nextFrame():Void

    Sends the playhead to the next frame and stops it. This happens after all -remaining actions in the frame have finished executing.

    nextScene():Void

    play():Void

    Moves the playhead in the timeline of the movie clip.

    prevFrame():Void

    Sends the playhead to the previous frame and stops it. This happens after -all remaining actions in the frame have finished executing.

    prevScene():Void

    stop():Void

    Stops the playhead in the movie clip.

    Inherited Variables

    Defined by Sprite

    buttonMode:Bool

    Specifies the button mode of this sprite. If true, this +specified are not found in this movie clip.

    See also:

    nextFrame():Void

    Sends the playhead to the next frame and stops it. This happens after all +remaining actions in the frame have finished executing.

    See also:

    nextScene():Void

    play():Void

    Moves the playhead in the timeline of the movie clip.

    See also:

    prevFrame():Void

    Sends the playhead to the previous frame and stops it. This happens after +all remaining actions in the frame have finished executing.

    See also:

    prevScene():Void

    stop():Void

    Stops the playhead in the movie clip.

    See also:

    Inherited Variables

    Defined by Sprite

    buttonMode:Bool

    Specifies the button mode of this sprite. If true, this sprite behaves as a button, which means that it triggers the display of the hand cursor when the pointer passes over the sprite and can receive a click event if the enter or space keys are pressed when the @@ -180,7 +180,7 @@

    Note: You must set to false the mouseEnabled property of the sprite designated as the hit area. Otherwise, your sprite button might not work because the sprite designated as the hit area receives the -user input events instead of your sprite button.

    useHandCursor:Bool

    A Boolean value that indicates whether the pointing hand(hand cursor) +user input events instead of your sprite button.

    useHandCursor:Bool

    A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true. The default value of the useHandCursor property is true. If @@ -200,7 +200,7 @@ it by using a mouse or user input device. The default is true.

    This property is useful when you create a button with an instance of -the Sprite class(instead of using the SimpleButton class). When you use a +the Sprite class (instead of using the SimpleButton class). When you use a Sprite instance to create a button, you can choose to decorate the button by using the addChild() method to add additional Sprite instances. This process can cause unexpected behavior with mouse events @@ -237,14 +237,14 @@ default any InteractiveObject instance that is on the display list receives mouse events or other user input events. If mouseEnabled is set to false, the instance does -not receive any mouse events(or other user input events like keyboard +not receive any mouse events (or other user input events like keyboard events). Any children of this instance on the display list are not affected. To change the mouseEnabled behavior for all children of an object on the display list, use openfl.display.DisplayObjectContainer.mouseChildren.

    No event is dispatched by setting this property. You must use the addEventListener() method to create interactive -functionality.

    needsSoftKeyboard:Bool

    Specifies whether a virtual keyboard(an on-screen, software keyboard) +functionality.

    needsSoftKeyboard:Bool

    Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.

    By default, the value is false and focusing an InteractiveObject instance does not raise a soft keyboard. If the @@ -304,7 +304,7 @@ cast(tlfInstance2.getChildAt(1), InteractiveObject).tabIndex = 2; cast(tlfInstance3.getChildAt(1), InteractiveObject).tabIndex = 1;

    Defined by DisplayObject

    @:keepalpha:Float

    Indicates the alpha transparency value of the object specified. Valid values are 0 (fully transparent) to 1 (fully opaque). The default value is 1. -Display objects with alpha set to 0 are active, even though they are invisible.

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A +Display objects with alpha set to 0 are active, even though they are invisible.

    See also:

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A bitmap can be drawn internally in two ways. If you have a blend mode enabled or an external clipping mask, the bitmap is drawn by adding a bitmap-filled square shape to the vector render. If you attempt to set @@ -324,7 +324,7 @@ BlendMode class defines string values you can use. The illustrations in the table show blendMode values applied to a circular display object(2) superimposed on another display object(1).

    -

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn +

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    See also:

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn to the bitmap instead of the main display. If cacheAsBitmapMatrix is null or unsupported, the bitmap is then copied to the main display as unstretched, unrotated pixels snapped @@ -355,12 +355,12 @@ number of pixels cannot exceed 16,777,215 pixels.(So, if a bitmap image is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is is 2880 pixels in height and 2,880 pixels -in width.

  • The bitmap fails to allocate(out of memory error).
    • +in width.
  • The bitmap fails to allocate (out of memory error).

    • The cacheAsBitmap property is best used with movie clips that have mostly static content and that do not scale and rotate frequently. With such movie clips, cacheAsBitmap can lead to -performance increases when the movie clip is translated(when its x -and y position is changed).

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to +performance increases when the movie clip is translated (when its x +and y position is changed).

    See also:

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. The application uses this matrix as a transformation matrix that is applied when rendering the bitmap version of the display object.

    Adobe AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop @@ -394,16 +394,16 @@

    Note: The cacheAsBitmapMatrix property is suitable for 2D transformations. If you need to apply transformations in 3D, you may do so by setting a 3D property of the object and manipulating its transform.matrix3D property. If the application is packaged using GPU mode, this allows the 3D transforms -to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated +to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    See also:

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated with the display object. The openfl.filters package contains several classes that define specific filters you can use.

    Filters can be applied in Flash Professional at design time, or at run -time by using ActionScript code. To apply a filter by using ActionScript, +time by using Haxe code. To apply a filter by using Haxe, you must make a temporary copy of the entire filters array, modify the temporary array, then assign the value of the temporary array back to the filters array. You cannot directly add a new filter object to the filters array.

    -

    To add a filter by using ActionScript, perform the following steps +

    To add a filter by using Haxe, perform the following steps (assume that the target display object is named myDisplayObject):

    1. Create a new filter object by using the constructor method of your chosen filter class.
    2. Assign the value of the myDisplayObject.filters array @@ -434,7 +434,7 @@

      The openfl.filters package includes classes for filters. For example, to create a DropShadow filter, you would write:

      Throws:

      ArgumentError

      When filters includes a ShaderFilter and the shader output type is not compatible with -this operation(the shader must specify a +this operation (the shader must specify a pixel4 output).

      ArgumentError

      When filters includes a ShaderFilter and the shader doesn't specify any image input or the first input is not an image4 input.

      ArgumentError

      When filters includes a ShaderFilter @@ -452,10 +452,10 @@ is adjusted accordingly, as shown in the following code:

      Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a height of 0, even if you try to -set height to a different value.

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file +set height to a different value.

      See also:

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file to which this display object belongs. The loaderInfo property is defined only for the root display object of a SWF file or for a loaded -Bitmap(not for a Bitmap that is drawn with ActionScript). To find the +Bitmap (not for a Bitmap that is drawn with Haxe). To find the loaderInfo object associated with the SWF file that contains a display object named myDisplayObject, use myDisplayObject.root.loaderInfo.

      @@ -467,7 +467,7 @@ list. The mask object itself is not drawn. Set mask to null to remove the mask.

      To be able to scale a mask object, it must be on the display list. To -be able to drag a mask Sprite object(by calling its +be able to drag a mask Sprite object (by calling its startDrag() method), it must be on the display list. To call the startDrag() method for a mask sprite based on a mouseDown event being dispatched by the sprite, set the @@ -486,23 +486,23 @@ more than one calling display object. When the mask is assigned to a second display object, it is removed as the mask of the first object, and that object's mask property becomes -null.

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in +null.

      See also:

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned x -coordinate will reflect the non-rotated object.

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in +coordinate will reflect the non-rotated object.

      See also:

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned y -coordinate will reflect the non-rotated object.

      name:String

      Indicates the instance name of the DisplayObject. The object can be +coordinate will reflect the non-rotated object.

      See also:

      name:String

      Indicates the instance name of the DisplayObject. The object can be identified in the child list of its parent display object container by calling the getChildByName() method of the display object container.

      Throws:

      IllegalOperationError

      If you are attempting to set this property on an object that was placed on the timeline in the Flash authoring tool.

      opaqueBackground:Null<Int>

      Specifies whether the display object is opaque with a certain background color. A transparent bitmap contains alpha channel data and is drawn -transparently. An opaque bitmap has no alpha channel(and renders faster +transparently. An opaque bitmap has no alpha channel (and renders faster than a transparent bitmap). If the bitmap is opaque, you specify its own background color to use.

      -

      If set to a number value, the surface is opaque(not transparent) with +

      If set to a number value, the surface is opaque (not transparent) with the RGB background color that the number specifies. If set to null(the default value), the display object has a transparent background.

      @@ -514,7 +514,7 @@

      The opaque background region is not matched when calling the hitTestPoint() method with the shapeFlag parameter set to true.

      -

      The opaque background region does not respond to mouse events.

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display +

      The opaque background region does not respond to mouse events.

      See also:

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display object. Use the parent property to specify a relative path to display objects that are above the current display object in the display list hierarchy.

      @@ -523,7 +523,7 @@ 
      this.parent.parent.alpha = 20;

      Throws:

      SecurityError

      The parent display object belongs to a security sandbox to which you do not have access. You can avoid this situation by having the parent movie call -the Security.allowDomain() method.

      read onlyroot:DisplayObject

      For a display object in a loaded SWF file, the root property +the Security.allowDomain() method.

      See also:

    read onlyroot:DisplayObject

    For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. For a Bitmap object representing a loaded image file, the root property is the Bitmap object @@ -536,7 +536,7 @@ is a child of the top-most display object in a loaded SWF file.

    For example, if you create a new Sprite object by calling the Sprite() constructor method, its root property -is null until you add it to the display list(or to a display +is null until you add it to the display list (or to a display object container that is off the display list but that is a child of the top-most display object in a SWF file).

    For a loaded SWF file, even though the Loader object used to load the @@ -544,12 +544,12 @@ SWF file has its root property set to itself. The Loader object does not have its root property set until it is added as a child of a display object for which the root property is -set.

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its +set.

    See also:

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement my_video.rotation = 450 -is the same as my_video.rotation = 90.

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, +is the same as my_video.rotation = 90.

    See also:

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, the entire display object is scaled normally when any scale transformation is applied.

    When you define the scale9Grid property, the display @@ -577,11 +577,11 @@ the registration point. The default registration point is (0,0). 1.0 equals 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the +y property values, which are defined in whole pixels.

    See also:

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. The default registration point is (0,0). 1.0 is 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is +y property values, which are defined in whole pixels.

    See also:

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is cropped to the size defined by the rectangle, and it scrolls within the rectangle when you change the x and y properties of the scrollRect object.

    @@ -598,17 +598,17 @@ an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated 90° and you scroll it left and right, the display object actually scrolls -up and down.

    @:betashader:Shader

    BETA**

    +up and down.

    See also:

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to apply a post-process effect to multiple display objects at once, enable cacheAsBitmap or use the filters property with a ShaderFilter

    read onlystage:Stage

    The Stage of the display object. A Flash runtime application has only one Stage object. For example, you can create and load multiple display objects into the display list, and the stage property of each -display object refers to the same Stage object(even if the display object +display object refers to the same Stage object (even if the display object belongs to a loaded SWF file).

    If a display object is not added to the display list, its -stage property is set to null.

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color +stage property is set to null.

    See also:

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. The specific properties - matrix, colorTransform, and three read-only properties (concatenatedMatrix, concatenatedColorTransform, @@ -645,21 +645,21 @@ is adjusted accordingly, as shown in the following code:

    Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a width of 0, even if you try to set -width to a different value.

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative +width to a different value.

    See also:

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative +registration point position.

    See also:

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    Inherited Methods

    Defined by Sprite

    @:value({ bounds : null, lockCenter : false })startDrag(lockCenter:Bool = false, ?bounds:Rectangle):Void

    Lets the user drag the specified sprite. The sprite remains draggable +registration point position.

    See also:

    Inherited Methods

    Defined by Sprite

    @:value({ bounds : null, lockCenter : false })startDrag(lockCenter:Bool = false, ?bounds:Rectangle):Void

    Lets the user drag the specified sprite. The sprite remains draggable until explicitly stopped through a call to the Sprite.stopDrag() method, or until another sprite is made draggable. Only one sprite is draggable at a time.

    @@ -669,14 +669,14 @@ object is a two-dimensional object and the child of a three-dimensional object, the two-dimensional object moves within the three dimensional plane defined by the three-dimensional parent object.

    Parameters:

    lockCenter

    Specifies whether the draggable sprite is locked to the -center of the pointer position(true), or +center of the pointer position (true), or locked to the point where the user first clicked the -sprite(false).

    bounds

    Value relative to the coordinates of the Sprite's parent +sprite (false).

    bounds

    Value relative to the coordinates of the Sprite's parent that specify a constraint rectangle for the Sprite.

    stopDrag():Void

    Ends the startDrag() method. A sprite that was made draggable with the startDrag() method remains draggable until a stopDrag() method is added, or until another sprite becomes draggable. Only one sprite is draggable at a time.

    Defined by DisplayObjectContainer

    addChild(child:DisplayObject):DisplayObject

    Adds a child DisplayObject instance to this DisplayObjectContainer -instance. The child is added to the front(top) of all other children in +instance. The child is added to the front (top) of all other children in this DisplayObjectContainer instance.(To add a child to a specific index position, use the addChildAt() method.)

    If you add a child object that already has a different display object @@ -693,11 +693,11 @@ to the Stage.

    Parameters:

    child

    The DisplayObject instance to add as a child of this DisplayObjectContainer instance.

    Returns:

    The DisplayObject instance that you pass in the child parameter.

    Throws:

    ArgumentError

    Throws if the child is the same as the parent. Also -throws if the caller is a child(or grandchild etc.) +throws if the caller is a child (or grandchild etc.) of the child being added.

    Events:

    added

    Dispatched when a display object is added to the display -list.

    addChildAt(child:DisplayObject, index:Int):DisplayObject

    Adds a child DisplayObject instance to this DisplayObjectContainer +list.

    See also:

    addChildAt(child:DisplayObject, index:Int):DisplayObject

    Adds a child DisplayObject instance to this DisplayObjectContainer instance. The child is added at the index position specified. An index of -0 represents the back(bottom) of the display list for this +0 represents the back (bottom) of the display list for this DisplayObjectContainer object.

    For example, the following example shows three display objects, labeled a, b, and c, at index positions 0, 2, and 1, respectively:

    @@ -710,10 +710,10 @@ that exists at that position and all higher positions are moved up one position in the child list.

    Returns:

    The DisplayObject instance that you pass in the child parameter.

    Throws:

    ArgumentError

    Throws if the child is the same as the parent. Also -throws if the caller is a child(or grandchild etc.) +throws if the caller is a child (or grandchild etc.) of the child being added.

    RangeError

    Throws if the index position does not exist in the child list.

    Events:

    added

    Dispatched when a display object is added to the display -list.

    areInaccessibleObjectsUnderPoint(point:Point):Bool

    Indicates whether the security restrictions would cause any display +list.

    See also:

    areInaccessibleObjectsUnderPoint(point:Point):Bool

    Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point. By default, content from one domain @@ -737,7 +737,7 @@ list.

    SecurityError

    This child display object belongs to a sandbox to which you do not have access. You can avoid this situation by having the child movie call -Security.allowDomain().

    getChildByName(name:String):DisplayObject

    Returns the child display object that exists with the specified name. If +Security.allowDomain().

    See also:

    getChildByName(name:String):DisplayObject

    Returns the child display object that exists with the specified name. If more that one child display object has the specified name, the method returns the first object in the child list.

    The getChildAt() method is faster than the @@ -747,7 +747,7 @@ access a child.

    Parameters:

    name

    The name of the child to return.

    Returns:

    The child display object with the specified name.

    Throws:

    SecurityError

    This child display object belongs to a sandbox to which you do not have access. You can avoid this situation by having the child movie call the -Security.allowDomain() method.

    getChildIndex(child:DisplayObject):Int

    Returns the index position of a child DisplayObject instance.

    Parameters:

    child

    The DisplayObject instance to identify.

    Returns:

    The index position of the child display object to identify.

    Throws:

    ArgumentError

    Throws if the child parameter is not a child of this +Security.allowDomain() method.

    See also:

    getChildIndex(child:DisplayObject):Int

    Returns the index position of a child DisplayObject instance.

    Parameters:

    child

    The DisplayObject instance to identify.

    Returns:

    The index position of the child display object to identify.

    Throws:

    ArgumentError

    Throws if the child parameter is not a child of this object.

    getObjectsUnderPoint(point:Point):Array<DisplayObject>

    Returns an array of objects that lie under the specified point and are children(or grandchildren, and so on) of this DisplayObjectContainer instance. Any child objects that are inaccessible for security reasons are @@ -855,8 +855,8 @@ coordinates, respectively.

    Parameters:

    targetCoordinateSpace

    The display object that defines the coordinate system to use.

    Returns:

    The rectangle that defines the area of the display object relative to the targetCoordinateSpace object's coordinate -system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage(global) coordinates -to the display object's(local) coordinates.

    +system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage (global) coordinates +to the display object's (local) coordinates.

    To use this method, first create an instance of the Point class. The x and y values that you assign represent global coordinates because they relate to the origin(0,0) of the main display area. Then @@ -871,17 +871,17 @@ point specified by the x and y parameters. The x and y parameters specify a point in the coordinate space of the Stage, not the display object container that -contains the display object(unless that display object container is the +contains the display object (unless that display object container is the Stage).

    Parameters:

    x

    The x coordinate to test against this object.

    y

    The y coordinate to test against this object.

    shapeFlag

    Whether to check against the actual pixels of the object (true) or the bounding box (false).

    Returns:

    true if the display object overlaps or intersects with the specified point; false otherwise.

    invalidate():Void

    Calling the invalidate() method signals to have the current object -redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's(local) -coordinates to the Stage(global) coordinates.

    +redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's (local) +coordinates to the Stage (global) coordinates.

    This method allows you to convert any given x and y coordinates from values that are relative to the origin(0,0) of a -specific display object(local coordinates) to values that are relative to -the origin of the Stage(global coordinates).

    +specific display object (local coordinates) to values that are relative to +the origin of the Stage (global coordinates).

    To use this method, first create an instance of the Point class. The x and y values that you assign represent local coordinates because they relate to the origin of the display object.

    diff --git a/openfl/display/NativeWindow.html b/openfl/display/NativeWindow.html index a1adb7a..647707a 100644 --- a/openfl/display/NativeWindow.html +++ b/openfl/display/NativeWindow.html @@ -1,7 +1,7 @@ -openfl.display.NativeWindow - API Referenceopenfl.display.NativeWindow - OpenFL API Reference
    View source

    class NativeWindow

    package openfl.display

    extends EventDispatcher

    @:directlyUsed@:access(openfl.desktop.NativeApplication)@:access(openfl.display.NativeWindowInitOptions)@:access(openfl.display.Stage)@:access(lime.ui.Window)

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The NativeWindow class provides an interface for creating and controlling +

    View source

    class NativeWindow

    package openfl.display

    extends EventDispatcher

    @:directlyUsed@:access(openfl.desktop.NativeApplication)@:access(openfl.display.NativeWindowInitOptions)@:access(openfl.display.Stage)@:access(lime.ui.Window)

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The NativeWindow class provides an interface for creating and controlling native desktop windows.

    You can test for support at run time on desktop devices using the NativeWindow.isSupported property.

    @@ -201,7 +201,7 @@

    Setting minSize, will change the window bounds if the current bounds are smaller than the new minimum size.

    The minSize restriction is enforced for window resizing operations -invoked both through ActionScript code and through the operating system.

    +invoked both through Haxe code and through the operating system.

    Note: The width and height of any displayed system chrome may make it impossible to set a window as small as the specified minimum size.

    See also:

    read onlyminimizable:Bool

    Reports the minimizable setting used to create this window.

    The minimizable setting cannot be changed after a window is created.

    @@ -439,7 +439,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/display/NativeWindowDisplayState.html b/openfl/display/NativeWindowDisplayState.html index 8a5bc60..d46d80a 100644 --- a/openfl/display/NativeWindowDisplayState.html +++ b/openfl/display/NativeWindowDisplayState.html @@ -1,7 +1,7 @@ -openfl.display.NativeWindowDisplayState - API Referenceopenfl.display.NativeWindowDisplayState - OpenFL API Reference

    View source

    enum abstract NativeWindowDisplayState(Null<Int>)

    package openfl.display

    @:enum

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The NativeWindowDisplayState class defines constants for the names of the +

    View source

    enum abstract NativeWindowDisplayState(Null<Int>)

    package openfl.display

    @:enum

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The NativeWindowDisplayState class defines constants for the names of the window display states.

    Note: The fullscreen modes are set using the Stage object displayState property, not the window displayState.

    See also:

    Variables

    @:value(cast 1)@:impl@:enuminlineread onlyMAXIMIZED:NativeWindowDisplayState = 1

    The maximized display state.

    @:value(cast 2)@:impl@:enuminlineread onlyMINIMIZED:NativeWindowDisplayState = 2

    The minimized display state.

    @:value(cast 0)@:impl@:enuminlineread onlyNORMAL:NativeWindowDisplayState = 0

    The normal display state.

    \ No newline at end of file diff --git a/openfl/display/NativeWindowInitOptions.html b/openfl/display/NativeWindowInitOptions.html index 40ca90c..c7a9d17 100644 --- a/openfl/display/NativeWindowInitOptions.html +++ b/openfl/display/NativeWindowInitOptions.html @@ -1,7 +1,7 @@ -openfl.display.NativeWindowInitOptions - API Referenceopenfl.display.NativeWindowInitOptions - OpenFL API Reference
    View source

    class NativeWindowInitOptions

    package openfl.display

    @:directlyUsed

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The NativeWindowInitOptions class defines the initialization options used +

    View source

    class NativeWindowInitOptions

    package openfl.display

    @:directlyUsed

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The NativeWindowInitOptions class defines the initialization options used to construct a new NativeWindow instance.

    The properties defined in the initialization options cannot be changed after a window is created.

    diff --git a/openfl/display/NativeWindowSystemChrome.html b/openfl/display/NativeWindowSystemChrome.html index c4e5213..9c971bf 100644 --- a/openfl/display/NativeWindowSystemChrome.html +++ b/openfl/display/NativeWindowSystemChrome.html @@ -1,7 +1,7 @@ -openfl.display.NativeWindowSystemChrome - API Referenceopenfl.display.NativeWindowSystemChrome - OpenFL API Reference
    View source

    enum abstract NativeWindowSystemChrome(Null<Int>)

    package openfl.display

    @:enum

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The NativeWindowSystemChrome class defines constants for the systemChrome +

    View source

    enum abstract NativeWindowSystemChrome(Null<Int>)

    package openfl.display

    @:enum

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The NativeWindowSystemChrome class defines constants for the systemChrome property of the NativeWindowInitOptions object used to create a native window.

    System chrome refers to the operating system-specific elements of a window such as a title bar, minimize, maximize, and close buttons.

    diff --git a/openfl/display/NativeWindowType.html b/openfl/display/NativeWindowType.html index 4748bc2..9a2ac53 100644 --- a/openfl/display/NativeWindowType.html +++ b/openfl/display/NativeWindowType.html @@ -1,7 +1,7 @@ -openfl.display.NativeWindowType - API Referenceopenfl.display.NativeWindowType - OpenFL API Reference
    View source

    enum abstract NativeWindowType(Null<Int>)

    package openfl.display

    @:enum

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The NativeWindowType class defines constants for the type property of the +

    View source

    enum abstract NativeWindowType(Null<Int>)

    package openfl.display

    @:enum

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The NativeWindowType class defines constants for the type property of the NativeWindowInitOptions object used to create a native window.

    Note: The type value is specified when a window is created and cannot be changed.

    See also:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyLIGHTWEIGHT:NativeWindowType = 0

    A minimal window. Lightweight windows cannot have system chrome and do diff --git a/openfl/display/OpenGLRenderer.html b/openfl/display/OpenGLRenderer.html index 55eac4c..051cd44 100644 --- a/openfl/display/OpenGLRenderer.html +++ b/openfl/display/OpenGLRenderer.html @@ -1,7 +1,7 @@ -openfl.display.OpenGLRenderer - API Reference

    View source

    class OpenGLRenderer

    package openfl.display

    extends DisplayObjectRenderer › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(lime.graphics.GLRenderContext)@:access(openfl.display._internal.ShaderBuffer)@:access(openfl.display3D.Context3D)@:access(openfl.display.BitmapData)@:access(openfl.display.DisplayObject)@:access(openfl.display.Graphics)@:access(openfl.display.IBitmapDrawable)@:access(openfl.display.Shader)@:access(openfl.display.ShaderParameter)@:access(openfl.display.Stage3D)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)@:allow(openfl.display._internal)@:allow(openfl.display3D.textures)@:allow(openfl.display3D)@:allow(openfl.display)@:allow(openfl.text)

    Available on all platforms

    BETA**

    +
    View source

    class OpenGLRenderer

    package openfl.display

    extends DisplayObjectRenderer › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(lime.graphics.GLRenderContext)@:access(openfl.display._internal.ShaderBuffer)@:access(openfl.display3D.Context3D)@:access(openfl.display.BitmapData)@:access(openfl.display.DisplayObject)@:access(openfl.display.Graphics)@:access(openfl.display.IBitmapDrawable)@:access(openfl.display.Shader)@:access(openfl.display.ShaderParameter)@:access(openfl.display.Stage3D)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)@:allow(openfl.display._internal)@:allow(openfl.display3D.textures)@:allow(openfl.display3D)@:allow(openfl.display)@:allow(openfl.text)

    Available on all platforms

    BETA**

    The OpenGLRenderer API exposes support for OpenGL render instructions within the RenderEvent.RENDER_OPENGL event.

    Variables

    @SuppressWarnings("checkstyle:Dynamic")gl:WebGLRenderContext

    The current OpenGL render context

    Methods

    applyAlpha(alpha:Float):Void

    Applies an alpha value to the active shader, if compatible with OpenFL core shaders

    @:value({ repeat : false })applyBitmapData(bitmapData:BitmapData, smooth:Bool, repeat:Bool = false):Void

    Binds a BitmapData object as the first active texture of the current active shader, if compatible with OpenFL core shaders

    applyColorTransform(colorTransform:ColorTransform):Void

    Applies a color transform value to the active shader, if compatible with OpenFL @@ -137,7 +137,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/display/PNGEncoderOptions.html b/openfl/display/PNGEncoderOptions.html index 60262ac..f384331 100644 --- a/openfl/display/PNGEncoderOptions.html +++ b/openfl/display/PNGEncoderOptions.html @@ -1,7 +1,7 @@ -openfl.display.PNGEncoderOptions - API Referenceopenfl.display.PNGEncoderOptions - OpenFL API Reference

    View source

    final class PNGEncoderOptions

    package openfl.display

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The PNGEncoderOptions class defines a compression algorithm for the +

    View source

    final class PNGEncoderOptions

    package openfl.display

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The PNGEncoderOptions class defines a compression algorithm for the openfl.display.BitmapData.encode() method.

    Constructor

    @:value({ fastCompression : false })new(fastCompression:Bool = false)

    Creates a PNGEncoderOptions object, optionally specifying compression settings.

    Parameters:

    fastCompression

    The initial compression mode.

    Variables

    fastCompression:Bool

    Chooses compression speed over file size. Setting this property to true improves compression speed but creates larger files.

    \ No newline at end of file diff --git a/openfl/display/PixelSnapping.html b/openfl/display/PixelSnapping.html index 053059d..b86c7aa 100644 --- a/openfl/display/PixelSnapping.html +++ b/openfl/display/PixelSnapping.html @@ -1,7 +1,7 @@ -openfl.display.PixelSnapping - API Referenceopenfl.display.PixelSnapping - OpenFL API Reference
    View source

    enum abstract PixelSnapping(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The PixelSnapping class is an enumeration of constant values for setting +

    View source

    enum abstract PixelSnapping(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The PixelSnapping class is an enumeration of constant values for setting the pixel snapping options by using the pixelSnapping property of a Bitmap object.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyALWAYS:PixelSnapping = 0

    A constant value used in the pixelSnapping property of a Bitmap object to specify that the bitmap image is always snapped to the diff --git a/openfl/display/Preloader.html b/openfl/display/Preloader.html index d24a984..466b1a0 100644 --- a/openfl/display/Preloader.html +++ b/openfl/display/Preloader.html @@ -1,7 +1,7 @@ -openfl.display.Preloader - API Referenceopenfl.display.Preloader - OpenFL API Reference

    View source

    class Preloader

    package openfl.display

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.LoaderInfo)@SuppressWarnings("checkstyle:FieldDocComment")

    Available on all platforms

    The Preloader class is a Lime Preloader instance that uses an OpenFL +

    View source

    class Preloader

    package openfl.display

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.LoaderInfo)@SuppressWarnings("checkstyle:FieldDocComment")

    Available on all platforms

    The Preloader class is a Lime Preloader instance that uses an OpenFL display object to display loading progress.

    Constructor

    @:value({ display : null })new(?display:Sprite)

    Variables

    @:value(new lime.app.Event<Void>())@SuppressWarnings("checkstyle:Dynamic")onComplete:_Event_Void_Void<() ‑> Void> = new lime.app.Event<Void>()

    \ No newline at end of file diff --git a/openfl/display/Scene.html b/openfl/display/Scene.html index 1fb081c..3ff2f25 100644 --- a/openfl/display/Scene.html +++ b/openfl/display/Scene.html @@ -1,7 +1,15 @@ -openfl.display.Scene - API Reference
    View source

    final class Scene

    package openfl.display

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    Constructor

    new(name:String, labels:Array<FrameLabel>, numFrames:Int)

    Variables

    read onlylabels:Array<FrameLabel>

    read onlyname:String

    read onlynumFrames:Int

    \ No newline at end of file +
    View source

    final class Scene

    package openfl.display

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The Scene class includes properties for identifying the name, labels, and +number of frames in a scene. A Scene object instance is created in Adobe +Animate (formerly Adobe Flash Professional), not by writing ActionScript +code. The MovieClip class includes a currentScene property, which is a +Scene object that identifies the scene in which the playhead is located in +the timeline of the MovieClip instance. The scenes property of the +MovieClip class is an array of Scene objects. Also, the gotoAndPlay() and +gotoAndStop() methods of the MovieClip class use Scene objects as +parameters.

    See also:

    Constructor

    new(name:String, labels:Array<FrameLabel>, numFrames:Int)

    Variables

    read onlylabels:Array<FrameLabel>

    An array of FrameLabel objects for the scene. Each FrameLabel object +contains a frame property, which specifies the frame number +corresponding to the label, and a name property.

    See also:

    • openfl.display.FrameLabel

    read onlyname:String

    The name of the scene.

    read onlynumFrames:Int

    The number of frames in the scene.

    \ No newline at end of file diff --git a/openfl/display/Screen.html b/openfl/display/Screen.html index c769928..483f62e 100644 --- a/openfl/display/Screen.html +++ b/openfl/display/Screen.html @@ -1,7 +1,7 @@ -openfl.display.Screen - API Referenceopenfl.display.Screen - OpenFL API Reference
    View source

    class Screen

    package openfl.display

    extends EventDispatcher

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The Screen class provides information about the display screens available to +

    View source

    class Screen

    package openfl.display

    extends EventDispatcher

    @:access(openfl.display.ScreenMode)

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The Screen class provides information about the display screens available to this application.

    Screens are independent desktop areas within a possibly larger "virtual desktop." The origin of the virtual desktop is the top-left corner of the @@ -73,7 +73,11 @@ rectangle.

    Variables

    read onlybounds:Rectangle

    The bounds of this screen.

    The screen location is relative to the virtual desktop.

    On Linux systems that use certain window managers, this property returns -the desktop bounds, not the screen's visible bounds.

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that +the desktop bounds, not the screen's visible bounds.

    read onlymode:ScreenMode

    The current screen mode of the Screen object.

    read onlymodes:Array<ScreenMode>

    The array of ScreenMode objects of the Screen object.

    read onlyvisibleBounds:Rectangle

    The bounds of the area on this screen in which windows can be visible.

    +

    The visibleBounds of a screen excludes the task bar (and other docked desk bars) on Windows, +and excludes the menu bar and, depending on system settings, the dock on Mac OS X. On some Linux +configurations, it is not possible to determine the visible bounds.

    +

    In these cases, the visibleBounds property returns the same value as the screenBounds property.

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

    @@ -146,7 +150,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/display/ScreenMode.html b/openfl/display/ScreenMode.html new file mode 100644 index 0000000..c90cdc7 --- /dev/null +++ b/openfl/display/ScreenMode.html @@ -0,0 +1,55 @@ + + + +openfl.display.ScreenMode - OpenFL API Reference

    View source

    class ScreenMode

    package openfl.display

    @:directlyUsed

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The ScreenMode object provides information about the width, height and refresh rate of a Screen.

    Variables

    read onlyheight:Int

    The screen height of the ScreenMode in pixels.

    read onlyrefreshRate:Int

    The screen refresh rate of the ScreenMode in hertz.

    read onlywidth:Int

    The screen width of the ScreenMode in pixels.

    \ No newline at end of file diff --git a/openfl/display/Shader.html b/openfl/display/Shader.html index d3bcc7f..231fb6e 100644 --- a/openfl/display/Shader.html +++ b/openfl/display/Shader.html @@ -1,7 +1,7 @@ -openfl.display.Shader - API Referenceopenfl.display.Shader - OpenFL API Reference
    API Reference
    View source

    class Shader

    package openfl.display

    extended by Context3DAlphaMaskShader, Context3DMaskShader, DisplayObjectShader, GraphicsShader, BitmapFilterShader

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display3D.Program3D)@:access(openfl.display.ShaderInput)@:access(openfl.display.ShaderParameter)@:autoBuild(openfl.utils._internal.ShaderMacro.build())

    Available on all platforms

    // TODO: Document GLSL Shaders +

    View source

    class Shader

    package openfl.display

    extended by Context3DAlphaMaskShader, Context3DMaskShader, DisplayObjectShader, GraphicsShader, BitmapFilterShader

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display3D.Program3D)@:access(openfl.display.ShaderInput)@:access(openfl.display.ShaderParameter)@:autoBuild(openfl.utils._internal.ShaderMacro.build())

    Available on all platforms

    // TODO: Document GLSL Shaders A Shader instance represents a Pixel Bender shader kernel in ActionScript. To use a shader in your application, you create a Shader instance for it. You then use that Shader instance in the appropriate way according to the diff --git a/openfl/display/ShaderData.html b/openfl/display/ShaderData.html index 9922f83..fa46566 100644 --- a/openfl/display/ShaderData.html +++ b/openfl/display/ShaderData.html @@ -1,7 +1,7 @@ -openfl.display.ShaderData - API Referenceopenfl.display.ShaderData - OpenFL API Reference

    API Reference
    View source

    abstract ShaderData(Dynamic)

    package openfl.display

    from Dynamic to Dynamic

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:forward@SuppressWarnings("checkstyle:Dynamic")

    Available on all platforms

    // TODO: Document GLSL Shaders +

    View source

    abstract ShaderData(Dynamic)

    package openfl.display

    from Dynamic to Dynamic

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:forward@SuppressWarnings("checkstyle:Dynamic")

    Available on all platforms

    // TODO: Document GLSL Shaders A ShaderData object contains properties representing any parameters and inputs for a shader kernel, as well as properties containing any metadata specified for the shader. diff --git a/openfl/display/ShaderInput.html b/openfl/display/ShaderInput.html index 0cd5529..8494171 100644 --- a/openfl/display/ShaderInput.html +++ b/openfl/display/ShaderInput.html @@ -1,7 +1,7 @@ -openfl.display.ShaderInput - API Referenceopenfl.display.ShaderInput - OpenFL API Reference

    API Reference
    View source

    final class ShaderInput<T>

    package openfl.display

    @:directlyUsed@:access(openfl.display3D.Context3D)@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    // TODO: Document GLSL Shaders +

    View source

    final class ShaderInput<T>

    package openfl.display

    @:directlyUsed@:access(openfl.display3D.Context3D)@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    // TODO: Document GLSL Shaders A ShaderInput instance represents a single input image for a shader kernel. A kernel can be defined to accept zero, one, or more source images that are used in the kernel execution. A ShaderInput instance provides a diff --git a/openfl/display/ShaderJob.html b/openfl/display/ShaderJob.html index a112e0c..6f7c545 100644 --- a/openfl/display/ShaderJob.html +++ b/openfl/display/ShaderJob.html @@ -1,7 +1,7 @@ -openfl.display.ShaderJob - API Referenceopenfl.display.ShaderJob - OpenFL API Reference

    API Reference
    View source

    class ShaderJob

    package openfl.display

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    // TODO: Document GLSL Shaders +

    View source

    class ShaderJob

    package openfl.display

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    // TODO: Document GLSL Shaders A ShaderJob instance is used to execute a shader operation in stand-alone mode. The shader operation executes and returns its result data. It is up to the developer to determine how to use the result. @@ -241,7 +241,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/display/ShaderParameter.html b/openfl/display/ShaderParameter.html index c957579..ad3cf6c 100644 --- a/openfl/display/ShaderParameter.html +++ b/openfl/display/ShaderParameter.html @@ -1,7 +1,7 @@ -openfl.display.ShaderParameter - API Reference

    View source

    final class ShaderParameter<T>

    package openfl.display

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:final

    Available on all platforms

    TODO: Document GLSL Shaders

    +
    View source

    final class ShaderParameter<T>

    package openfl.display

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:final

    Available on all platforms

    TODO: Document GLSL Shaders

    A ShaderParameter instance represents a single input parameter of a shader kernel. A kernel can be defined to accept zero, one, or more parameters that are used in the kernel execution. A ShaderParameter provides diff --git a/openfl/display/ShaderParameterType.html b/openfl/display/ShaderParameterType.html index 04955cf..33fb561 100644 --- a/openfl/display/ShaderParameterType.html +++ b/openfl/display/ShaderParameterType.html @@ -1,7 +1,7 @@ -openfl.display.ShaderParameterType - API Referenceopenfl.display.ShaderParameterType - OpenFL API Reference

    View source

    enum abstract ShaderParameterType(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    This class defines the constants that represent the possible values for +

    View source

    enum abstract ShaderParameterType(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    This class defines the constants that represent the possible values for the ShaderParameter class's type property. Each constant represents one of the data types available in Flash Player for parameters in the Pixel Bender shader language.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBOOL:ShaderParameterType = 0

    Indicates that the shader parameter is defined as a bool value, diff --git a/openfl/display/ShaderPrecision.html b/openfl/display/ShaderPrecision.html index 55e7c62..46d539f 100644 --- a/openfl/display/ShaderPrecision.html +++ b/openfl/display/ShaderPrecision.html @@ -1,7 +1,7 @@ -openfl.display.ShaderPrecision - API Referenceopenfl.display.ShaderPrecision - OpenFL API Reference

    API Reference
    View source

    enum abstract ShaderPrecision(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    This class defines the constants that represent the possible values for +

    View source

    enum abstract ShaderPrecision(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    This class defines the constants that represent the possible values for the Shader class's precisionHint property. Each constant represents one of the precision modes for executing shader operations. The precision mode selection affects the following shader operations. diff --git a/openfl/display/Shape.html b/openfl/display/Shape.html index 15a6514..2e485ac 100644 --- a/openfl/display/Shape.html +++ b/openfl/display/Shape.html @@ -1,8 +1,8 @@ -openfl.display.Shape - API Referenceopenfl.display.Shape - OpenFL API Reference

    View source

    class Shape

    package openfl.display

    extends DisplayObject › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Graphics)

    Available on all platforms

    This class is used to create lightweight shapes using the ActionScript -drawing application program interface(API). The Shape class includes a +

    View source

    class Shape

    package openfl.display

    extends DisplayObject › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Graphics)

    Available on all platforms

    This class is used to create lightweight shapes using the OpenFL +drawing application program interface (API). The Shape class includes a graphics property, which lets you access methods from the Graphics class.

    The Sprite class also includes a graphicsproperty, and it @@ -68,7 +68,7 @@ does not.

    Constructor

    new()

    Creates a new Shape object.

    Variables

    read onlygraphics:Graphics

    Specifies the Graphics object belonging to this Shape object, where vector drawing commands can occur.

    Inherited Variables

    Defined by DisplayObject

    @:keepalpha:Float

    Indicates the alpha transparency value of the object specified. Valid values are 0 (fully transparent) to 1 (fully opaque). The default value is 1. -Display objects with alpha set to 0 are active, even though they are invisible.

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A +Display objects with alpha set to 0 are active, even though they are invisible.

    See also:

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A bitmap can be drawn internally in two ways. If you have a blend mode enabled or an external clipping mask, the bitmap is drawn by adding a bitmap-filled square shape to the vector render. If you attempt to set @@ -88,7 +88,7 @@ BlendMode class defines string values you can use. The illustrations in the table show blendMode values applied to a circular display object(2) superimposed on another display object(1).

    -

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn +

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    See also:

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn to the bitmap instead of the main display. If cacheAsBitmapMatrix is null or unsupported, the bitmap is then copied to the main display as unstretched, unrotated pixels snapped @@ -119,12 +119,12 @@ number of pixels cannot exceed 16,777,215 pixels.(So, if a bitmap image is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is is 2880 pixels in height and 2,880 pixels -in width.

  • The bitmap fails to allocate(out of memory error).
    • +in width.
  • The bitmap fails to allocate (out of memory error).

    • The cacheAsBitmap property is best used with movie clips that have mostly static content and that do not scale and rotate frequently. With such movie clips, cacheAsBitmap can lead to -performance increases when the movie clip is translated(when its x -and y position is changed).

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to +performance increases when the movie clip is translated (when its x +and y position is changed).

    See also:

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. The application uses this matrix as a transformation matrix that is applied when rendering the bitmap version of the display object.

    Adobe AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop @@ -158,16 +158,16 @@

    Note: The cacheAsBitmapMatrix property is suitable for 2D transformations. If you need to apply transformations in 3D, you may do so by setting a 3D property of the object and manipulating its transform.matrix3D property. If the application is packaged using GPU mode, this allows the 3D transforms -to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated +to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    See also:

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated with the display object. The openfl.filters package contains several classes that define specific filters you can use.

    Filters can be applied in Flash Professional at design time, or at run -time by using ActionScript code. To apply a filter by using ActionScript, +time by using Haxe code. To apply a filter by using Haxe, you must make a temporary copy of the entire filters array, modify the temporary array, then assign the value of the temporary array back to the filters array. You cannot directly add a new filter object to the filters array.

    -

    To add a filter by using ActionScript, perform the following steps +

    To add a filter by using Haxe, perform the following steps (assume that the target display object is named myDisplayObject):

    1. Create a new filter object by using the constructor method of your chosen filter class.
    2. Assign the value of the myDisplayObject.filters array @@ -198,7 +198,7 @@

      The openfl.filters package includes classes for filters. For example, to create a DropShadow filter, you would write:

      Throws:

      ArgumentError

      When filters includes a ShaderFilter and the shader output type is not compatible with -this operation(the shader must specify a +this operation (the shader must specify a pixel4 output).

      ArgumentError

      When filters includes a ShaderFilter and the shader doesn't specify any image input or the first input is not an image4 input.

      ArgumentError

      When filters includes a ShaderFilter @@ -216,10 +216,10 @@ is adjusted accordingly, as shown in the following code:

      Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a height of 0, even if you try to -set height to a different value.

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file +set height to a different value.

      See also:

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file to which this display object belongs. The loaderInfo property is defined only for the root display object of a SWF file or for a loaded -Bitmap(not for a Bitmap that is drawn with ActionScript). To find the +Bitmap (not for a Bitmap that is drawn with Haxe). To find the loaderInfo object associated with the SWF file that contains a display object named myDisplayObject, use myDisplayObject.root.loaderInfo.

      @@ -231,7 +231,7 @@ list. The mask object itself is not drawn. Set mask to null to remove the mask.

      To be able to scale a mask object, it must be on the display list. To -be able to drag a mask Sprite object(by calling its +be able to drag a mask Sprite object (by calling its startDrag() method), it must be on the display list. To call the startDrag() method for a mask sprite based on a mouseDown event being dispatched by the sprite, set the @@ -250,23 +250,23 @@ more than one calling display object. When the mask is assigned to a second display object, it is removed as the mask of the first object, and that object's mask property becomes -null.

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in +null.

      See also:

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned x -coordinate will reflect the non-rotated object.

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in +coordinate will reflect the non-rotated object.

      See also:

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned y -coordinate will reflect the non-rotated object.

      name:String

      Indicates the instance name of the DisplayObject. The object can be +coordinate will reflect the non-rotated object.

      See also:

      name:String

      Indicates the instance name of the DisplayObject. The object can be identified in the child list of its parent display object container by calling the getChildByName() method of the display object container.

      Throws:

      IllegalOperationError

      If you are attempting to set this property on an object that was placed on the timeline in the Flash authoring tool.

      opaqueBackground:Null<Int>

      Specifies whether the display object is opaque with a certain background color. A transparent bitmap contains alpha channel data and is drawn -transparently. An opaque bitmap has no alpha channel(and renders faster +transparently. An opaque bitmap has no alpha channel (and renders faster than a transparent bitmap). If the bitmap is opaque, you specify its own background color to use.

      -

      If set to a number value, the surface is opaque(not transparent) with +

      If set to a number value, the surface is opaque (not transparent) with the RGB background color that the number specifies. If set to null(the default value), the display object has a transparent background.

      @@ -278,7 +278,7 @@

      The opaque background region is not matched when calling the hitTestPoint() method with the shapeFlag parameter set to true.

      -

      The opaque background region does not respond to mouse events.

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display +

      The opaque background region does not respond to mouse events.

      See also:

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display object. Use the parent property to specify a relative path to display objects that are above the current display object in the display list hierarchy.

      @@ -287,7 +287,7 @@ 
      this.parent.parent.alpha = 20;

      Throws:

      SecurityError

      The parent display object belongs to a security sandbox to which you do not have access. You can avoid this situation by having the parent movie call -the Security.allowDomain() method.

      read onlyroot:DisplayObject

      For a display object in a loaded SWF file, the root property +the Security.allowDomain() method.

      See also:

    read onlyroot:DisplayObject

    For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. For a Bitmap object representing a loaded image file, the root property is the Bitmap object @@ -300,7 +300,7 @@ is a child of the top-most display object in a loaded SWF file.

    For example, if you create a new Sprite object by calling the Sprite() constructor method, its root property -is null until you add it to the display list(or to a display +is null until you add it to the display list (or to a display object container that is off the display list but that is a child of the top-most display object in a SWF file).

    For a loaded SWF file, even though the Loader object used to load the @@ -308,12 +308,12 @@ SWF file has its root property set to itself. The Loader object does not have its root property set until it is added as a child of a display object for which the root property is -set.

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its +set.

    See also:

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement my_video.rotation = 450 -is the same as my_video.rotation = 90.

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, +is the same as my_video.rotation = 90.

    See also:

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, the entire display object is scaled normally when any scale transformation is applied.

    When you define the scale9Grid property, the display @@ -341,11 +341,11 @@ the registration point. The default registration point is (0,0). 1.0 equals 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the +y property values, which are defined in whole pixels.

    See also:

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. The default registration point is (0,0). 1.0 is 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is +y property values, which are defined in whole pixels.

    See also:

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is cropped to the size defined by the rectangle, and it scrolls within the rectangle when you change the x and y properties of the scrollRect object.

    @@ -362,17 +362,17 @@ an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated 90° and you scroll it left and right, the display object actually scrolls -up and down.

    @:betashader:Shader

    BETA**

    +up and down.

    See also:

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to apply a post-process effect to multiple display objects at once, enable cacheAsBitmap or use the filters property with a ShaderFilter

    read onlystage:Stage

    The Stage of the display object. A Flash runtime application has only one Stage object. For example, you can create and load multiple display objects into the display list, and the stage property of each -display object refers to the same Stage object(even if the display object +display object refers to the same Stage object (even if the display object belongs to a loaded SWF file).

    If a display object is not added to the display list, its -stage property is set to null.

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color +stage property is set to null.

    See also:

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. The specific properties - matrix, colorTransform, and three read-only properties (concatenatedMatrix, concatenatedColorTransform, @@ -409,21 +409,21 @@ is adjusted accordingly, as shown in the following code:

    Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a width of 0, even if you try to set -width to a different value.

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative +width to a different value.

    See also:

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative +registration point position.

    See also:

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative +registration point position.

    See also:

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. Consider the following code, which shows how the rectangle returned can vary depending on the targetCoordinateSpace parameter that @@ -450,8 +450,8 @@ coordinates, respectively.

    Parameters:

    targetCoordinateSpace

    The display object that defines the coordinate system to use.

    Returns:

    The rectangle that defines the area of the display object relative to the targetCoordinateSpace object's coordinate -system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage(global) coordinates -to the display object's(local) coordinates.

    +system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage (global) coordinates +to the display object's (local) coordinates.

    To use this method, first create an instance of the Point class. The x and y values that you assign represent global coordinates because they relate to the origin(0,0) of the main display area. Then @@ -466,17 +466,17 @@ point specified by the x and y parameters. The x and y parameters specify a point in the coordinate space of the Stage, not the display object container that -contains the display object(unless that display object container is the +contains the display object (unless that display object container is the Stage).

    Parameters:

    x

    The x coordinate to test against this object.

    y

    The y coordinate to test against this object.

    shapeFlag

    Whether to check against the actual pixels of the object (true) or the bounding box (false).

    Returns:

    true if the display object overlaps or intersects with the specified point; false otherwise.

    invalidate():Void

    Calling the invalidate() method signals to have the current object -redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's(local) -coordinates to the Stage(global) coordinates.

    +redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's (local) +coordinates to the Stage (global) coordinates.

    This method allows you to convert any given x and y coordinates from values that are relative to the origin(0,0) of a -specific display object(local coordinates) to values that are relative to -the origin of the Stage(global coordinates).

    +specific display object (local coordinates) to values that are relative to +the origin of the Stage (global coordinates).

    To use this method, first create an instance of the Point class. The x and y values that you assign represent local coordinates because they relate to the origin of the display object.

    diff --git a/openfl/display/SimpleButton.html b/openfl/display/SimpleButton.html index 1f980e1..17c2223 100644 --- a/openfl/display/SimpleButton.html +++ b/openfl/display/SimpleButton.html @@ -1,7 +1,7 @@ -openfl.display.SimpleButton - API Referenceopenfl.display.SimpleButton - OpenFL API Reference
    View source

    class SimpleButton

    package openfl.display

    extends InteractiveObject › DisplayObject › EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.MovieClip)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)@:autoBuild(openfl.utils._internal.AssetsMacro.initBinding())

    Available on all platforms

    The SimpleButton class lets you control all instances of button symbols in +

    View source

    class SimpleButton

    package openfl.display

    extends InteractiveObject › DisplayObject › EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.MovieClip)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)@:autoBuild(openfl.utils._internal.AssetsMacro.initBinding())

    Available on all platforms

    The SimpleButton class lets you control all instances of button symbols in a SWF file.

    In Flash Professional, you can give a button an instance name in the Property inspector. SimpleButton instance names are displayed in the Movie Explorer and in the Insert Target Path dialog box in the Actions panel. After you create an instance of a button in Flash Professional, you can use the methods and properties of the SimpleButton class to manipulate buttons -with ActionScript.

    -

    In ActionScript 3.0, you use the new SimpleButton() -constructor to create a SimpleButton instance.

    +with Haxe.

    +

    In Haxe, you use the new SimpleButton() constructor to create a +SimpleButton instance.

    The SimpleButton class inherits from the InteractiveObject class.

    Constructor

    @:value({ hitTestState : null, downState : null, overState : null, upState : null })new(?upState:DisplayObject, ?overState:DisplayObject, ?downState:DisplayObject, ?hitTestState:DisplayObject)

    Creates a new SimpleButton instance. Any or all of the display objects that represent the various button states can be set as parameters in the constructor.

    Parameters:

    upState

    The initial value for the SimpleButton up state.

    overState

    The initial value for the SimpleButton over state.

    downState

    The initial value for the SimpleButton down state.

    hitTestState

    The initial value for the SimpleButton hitTest state.

    Variables

    downState:DisplayObject

    Specifies a display object that is used as the visual object for the button "Down" state - the state that the button is in when the user selects the hitTestState object.

    enabled:Bool

    A Boolean value that specifies whether a button is enabled. When a button -is disabled(the enabled property is set to false), the +is disabled (the enabled property is set to false), the button is visible but cannot be clicked. The default value is true. This property is useful if you want to disable part of your navigation; for example, you might want to disable a button in the @@ -119,14 +119,14 @@ default any InteractiveObject instance that is on the display list receives mouse events or other user input events. If mouseEnabled is set to false, the instance does -not receive any mouse events(or other user input events like keyboard +not receive any mouse events (or other user input events like keyboard events). Any children of this instance on the display list are not affected. To change the mouseEnabled behavior for all children of an object on the display list, use openfl.display.DisplayObjectContainer.mouseChildren.

    No event is dispatched by setting this property. You must use the addEventListener() method to create interactive -functionality.

    needsSoftKeyboard:Bool

    Specifies whether a virtual keyboard(an on-screen, software keyboard) +functionality.

    needsSoftKeyboard:Bool

    Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.

    By default, the value is false and focusing an InteractiveObject instance does not raise a soft keyboard. If the @@ -186,7 +186,7 @@ cast(tlfInstance2.getChildAt(1), InteractiveObject).tabIndex = 2; cast(tlfInstance3.getChildAt(1), InteractiveObject).tabIndex = 1;

    Defined by DisplayObject

    @:keepalpha:Float

    Indicates the alpha transparency value of the object specified. Valid values are 0 (fully transparent) to 1 (fully opaque). The default value is 1. -Display objects with alpha set to 0 are active, even though they are invisible.

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A +Display objects with alpha set to 0 are active, even though they are invisible.

    See also:

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A bitmap can be drawn internally in two ways. If you have a blend mode enabled or an external clipping mask, the bitmap is drawn by adding a bitmap-filled square shape to the vector render. If you attempt to set @@ -206,7 +206,7 @@ BlendMode class defines string values you can use. The illustrations in the table show blendMode values applied to a circular display object(2) superimposed on another display object(1).

    -

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn +

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    See also:

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn to the bitmap instead of the main display. If cacheAsBitmapMatrix is null or unsupported, the bitmap is then copied to the main display as unstretched, unrotated pixels snapped @@ -237,12 +237,12 @@ number of pixels cannot exceed 16,777,215 pixels.(So, if a bitmap image is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is is 2880 pixels in height and 2,880 pixels -in width.

  • The bitmap fails to allocate(out of memory error).
    • +in width.
  • The bitmap fails to allocate (out of memory error).

    • The cacheAsBitmap property is best used with movie clips that have mostly static content and that do not scale and rotate frequently. With such movie clips, cacheAsBitmap can lead to -performance increases when the movie clip is translated(when its x -and y position is changed).

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to +performance increases when the movie clip is translated (when its x +and y position is changed).

    See also:

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. The application uses this matrix as a transformation matrix that is applied when rendering the bitmap version of the display object.

    Adobe AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop @@ -276,16 +276,16 @@

    Note: The cacheAsBitmapMatrix property is suitable for 2D transformations. If you need to apply transformations in 3D, you may do so by setting a 3D property of the object and manipulating its transform.matrix3D property. If the application is packaged using GPU mode, this allows the 3D transforms -to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated +to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    See also:

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated with the display object. The openfl.filters package contains several classes that define specific filters you can use.

    Filters can be applied in Flash Professional at design time, or at run -time by using ActionScript code. To apply a filter by using ActionScript, +time by using Haxe code. To apply a filter by using Haxe, you must make a temporary copy of the entire filters array, modify the temporary array, then assign the value of the temporary array back to the filters array. You cannot directly add a new filter object to the filters array.

    -

    To add a filter by using ActionScript, perform the following steps +

    To add a filter by using Haxe, perform the following steps (assume that the target display object is named myDisplayObject):

    1. Create a new filter object by using the constructor method of your chosen filter class.
    2. Assign the value of the myDisplayObject.filters array @@ -316,7 +316,7 @@

      The openfl.filters package includes classes for filters. For example, to create a DropShadow filter, you would write:

      Throws:

      ArgumentError

      When filters includes a ShaderFilter and the shader output type is not compatible with -this operation(the shader must specify a +this operation (the shader must specify a pixel4 output).

      ArgumentError

      When filters includes a ShaderFilter and the shader doesn't specify any image input or the first input is not an image4 input.

      ArgumentError

      When filters includes a ShaderFilter @@ -334,10 +334,10 @@ is adjusted accordingly, as shown in the following code:

      Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a height of 0, even if you try to -set height to a different value.

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file +set height to a different value.

      See also:

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file to which this display object belongs. The loaderInfo property is defined only for the root display object of a SWF file or for a loaded -Bitmap(not for a Bitmap that is drawn with ActionScript). To find the +Bitmap (not for a Bitmap that is drawn with Haxe). To find the loaderInfo object associated with the SWF file that contains a display object named myDisplayObject, use myDisplayObject.root.loaderInfo.

      @@ -349,7 +349,7 @@ list. The mask object itself is not drawn. Set mask to null to remove the mask.

      To be able to scale a mask object, it must be on the display list. To -be able to drag a mask Sprite object(by calling its +be able to drag a mask Sprite object (by calling its startDrag() method), it must be on the display list. To call the startDrag() method for a mask sprite based on a mouseDown event being dispatched by the sprite, set the @@ -368,23 +368,23 @@ more than one calling display object. When the mask is assigned to a second display object, it is removed as the mask of the first object, and that object's mask property becomes -null.

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in +null.

      See also:

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned x -coordinate will reflect the non-rotated object.

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in +coordinate will reflect the non-rotated object.

      See also:

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned y -coordinate will reflect the non-rotated object.

      name:String

      Indicates the instance name of the DisplayObject. The object can be +coordinate will reflect the non-rotated object.

      See also:

      name:String

      Indicates the instance name of the DisplayObject. The object can be identified in the child list of its parent display object container by calling the getChildByName() method of the display object container.

      Throws:

      IllegalOperationError

      If you are attempting to set this property on an object that was placed on the timeline in the Flash authoring tool.

      opaqueBackground:Null<Int>

      Specifies whether the display object is opaque with a certain background color. A transparent bitmap contains alpha channel data and is drawn -transparently. An opaque bitmap has no alpha channel(and renders faster +transparently. An opaque bitmap has no alpha channel (and renders faster than a transparent bitmap). If the bitmap is opaque, you specify its own background color to use.

      -

      If set to a number value, the surface is opaque(not transparent) with +

      If set to a number value, the surface is opaque (not transparent) with the RGB background color that the number specifies. If set to null(the default value), the display object has a transparent background.

      @@ -396,7 +396,7 @@

      The opaque background region is not matched when calling the hitTestPoint() method with the shapeFlag parameter set to true.

      -

      The opaque background region does not respond to mouse events.

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display +

      The opaque background region does not respond to mouse events.

      See also:

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display object. Use the parent property to specify a relative path to display objects that are above the current display object in the display list hierarchy.

      @@ -405,7 +405,7 @@ 
      this.parent.parent.alpha = 20;

      Throws:

      SecurityError

      The parent display object belongs to a security sandbox to which you do not have access. You can avoid this situation by having the parent movie call -the Security.allowDomain() method.

      read onlyroot:DisplayObject

      For a display object in a loaded SWF file, the root property +the Security.allowDomain() method.

      See also:

    read onlyroot:DisplayObject

    For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. For a Bitmap object representing a loaded image file, the root property is the Bitmap object @@ -418,7 +418,7 @@ is a child of the top-most display object in a loaded SWF file.

    For example, if you create a new Sprite object by calling the Sprite() constructor method, its root property -is null until you add it to the display list(or to a display +is null until you add it to the display list (or to a display object container that is off the display list but that is a child of the top-most display object in a SWF file).

    For a loaded SWF file, even though the Loader object used to load the @@ -426,12 +426,12 @@ SWF file has its root property set to itself. The Loader object does not have its root property set until it is added as a child of a display object for which the root property is -set.

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its +set.

    See also:

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement my_video.rotation = 450 -is the same as my_video.rotation = 90.

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, +is the same as my_video.rotation = 90.

    See also:

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, the entire display object is scaled normally when any scale transformation is applied.

    When you define the scale9Grid property, the display @@ -459,11 +459,11 @@ the registration point. The default registration point is (0,0). 1.0 equals 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the +y property values, which are defined in whole pixels.

    See also:

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. The default registration point is (0,0). 1.0 is 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is +y property values, which are defined in whole pixels.

    See also:

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is cropped to the size defined by the rectangle, and it scrolls within the rectangle when you change the x and y properties of the scrollRect object.

    @@ -480,17 +480,17 @@ an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated 90° and you scroll it left and right, the display object actually scrolls -up and down.

    @:betashader:Shader

    BETA**

    +up and down.

    See also:

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to apply a post-process effect to multiple display objects at once, enable cacheAsBitmap or use the filters property with a ShaderFilter

    read onlystage:Stage

    The Stage of the display object. A Flash runtime application has only one Stage object. For example, you can create and load multiple display objects into the display list, and the stage property of each -display object refers to the same Stage object(even if the display object +display object refers to the same Stage object (even if the display object belongs to a loaded SWF file).

    If a display object is not added to the display list, its -stage property is set to null.

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color +stage property is set to null.

    See also:

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. The specific properties - matrix, colorTransform, and three read-only properties (concatenatedMatrix, concatenatedColorTransform, @@ -527,21 +527,21 @@ is adjusted accordingly, as shown in the following code:

    Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a width of 0, even if you try to set -width to a different value.

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative +width to a different value.

    See also:

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative +registration point position.

    See also:

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    Inherited Methods

    Defined by InteractiveObject

    requestSoftKeyboard():Bool

    Raises a virtual keyboard.

    +registration point position.

    See also:

    Inherited Methods

    Defined by InteractiveObject

    requestSoftKeyboard():Bool

    Raises a virtual keyboard.

    Calling this method focuses the InteractiveObject instance and raises the soft keyboard, if necessary. The needsSoftKeyboard must also be true. A keyboard is not raised if a hardware keyboard @@ -577,8 +577,8 @@ coordinates, respectively.

    Parameters:

    targetCoordinateSpace

    The display object that defines the coordinate system to use.

    Returns:

    The rectangle that defines the area of the display object relative to the targetCoordinateSpace object's coordinate -system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage(global) coordinates -to the display object's(local) coordinates.

    +system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage (global) coordinates +to the display object's (local) coordinates.

    To use this method, first create an instance of the Point class. The x and y values that you assign represent global coordinates because they relate to the origin(0,0) of the main display area. Then @@ -593,17 +593,17 @@ point specified by the x and y parameters. The x and y parameters specify a point in the coordinate space of the Stage, not the display object container that -contains the display object(unless that display object container is the +contains the display object (unless that display object container is the Stage).

    Parameters:

    x

    The x coordinate to test against this object.

    y

    The y coordinate to test against this object.

    shapeFlag

    Whether to check against the actual pixels of the object (true) or the bounding box (false).

    Returns:

    true if the display object overlaps or intersects with the specified point; false otherwise.

    invalidate():Void

    Calling the invalidate() method signals to have the current object -redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's(local) -coordinates to the Stage(global) coordinates.

    +redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's (local) +coordinates to the Stage (global) coordinates.

    This method allows you to convert any given x and y coordinates from values that are relative to the origin(0,0) of a -specific display object(local coordinates) to values that are relative to -the origin of the Stage(global coordinates).

    +specific display object (local coordinates) to values that are relative to +the origin of the Stage (global coordinates).

    To use this method, first create an instance of the Point class. The x and y values that you assign represent local coordinates because they relate to the origin of the display object.

    diff --git a/openfl/display/SpreadMethod.html b/openfl/display/SpreadMethod.html index 0c9f13d..7ac6c6b 100644 --- a/openfl/display/SpreadMethod.html +++ b/openfl/display/SpreadMethod.html @@ -1,7 +1,7 @@ -openfl.display.SpreadMethod - API Referenceopenfl.display.SpreadMethod - OpenFL API Reference
    View source

    enum abstract SpreadMethod(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The SpreadMethod class provides values for the spreadMethod +

    View source

    enum abstract SpreadMethod(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The SpreadMethod class provides values for the spreadMethod parameter in the beginGradientFill() and lineGradientStyle() methods of the Graphics class.

    The following example shows the same gradient fill using various spread diff --git a/openfl/display/Sprite.html b/openfl/display/Sprite.html index 6ce0632..a273683 100644 --- a/openfl/display/Sprite.html +++ b/openfl/display/Sprite.html @@ -1,7 +1,7 @@ -openfl.display.Sprite - API Referenceopenfl.display.Sprite - OpenFL API Reference

    View source

    class Sprite

    package openfl.display

    extends DisplayObjectContainer › InteractiveObject › DisplayObject › EventDispatcher

    extended by MovieClip

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Graphics)@:access(openfl.display.Stage)@:access(openfl.geom.Matrix)@:access(openfl.geom.Point)@:autoBuild(openfl.utils._internal.AssetsMacro.initBinding())

    Available on all platforms

    The Sprite class is a basic display list building block: a display list +

    View source

    class Sprite

    package openfl.display

    extends DisplayObjectContainer › InteractiveObject › DisplayObject › EventDispatcher

    extended by MovieClip

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Graphics)@:access(openfl.display.Stage)@:access(openfl.geom.Matrix)@:access(openfl.geom.Point)@:autoBuild(openfl.utils._internal.AssetsMacro.initBinding())

    Available on all platforms

    The Sprite class is a basic display list building block: a display list node that can display graphics and can also contain children.

    A Sprite object is similar to a movie clip, but does not have a timeline. Sprite is an appropriate base class for objects that do not require timelines. For example, Sprite would be a logical base class for -user interface(UI) components that typically do not use the timeline.

    -

    The Sprite class is new in ActionScript 3.0. It provides an alternative +user interface (UI) components that typically do not use the timeline.

    +

    The Sprite class is new in OpenFL (compared to ActionScript 2.0). It +provides an alternative to the functionality of the MovieClip class, which retains all the functionality of previous ActionScript releases to provide backward -compatibility.

    Static methods

    staticfromTimeline(timeline:Timeline):Sprite

    Creates a new Sprite based upon the first frame of a Timeline instance.

    Parameters:

    timeline

    A Timeline object

    Returns:

    A new Sprite

    Constructor

    new()

    Creates a new Sprite instance. After you create the Sprite instance, call +compatibility.

    See also:

    Static methods

    staticfromTimeline(timeline:Timeline):Sprite

    Creates a new Sprite based upon the first frame of a Timeline instance.

    Parameters:

    timeline

    A Timeline object

    Returns:

    A new Sprite

    Constructor

    new()

    Creates a new Sprite instance. After you create the Sprite instance, call the DisplayObjectContainer.addChild() or DisplayObjectContainer.addChildAt() method to add the Sprite to a parent DisplayObjectContainer.

    Variables

    buttonMode:Bool

    Specifies the button mode of this sprite. If true, this @@ -102,7 +103,7 @@

    Note: You must set to false the mouseEnabled property of the sprite designated as the hit area. Otherwise, your sprite button might not work because the sprite designated as the hit area receives the -user input events instead of your sprite button.

    useHandCursor:Bool

    A Boolean value that indicates whether the pointing hand(hand cursor) +user input events instead of your sprite button.

    useHandCursor:Bool

    A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true. The default value of the useHandCursor property is true. If @@ -127,9 +128,9 @@ object is a two-dimensional object and the child of a three-dimensional object, the two-dimensional object moves within the three dimensional plane defined by the three-dimensional parent object.

    Parameters:

    lockCenter

    Specifies whether the draggable sprite is locked to the -center of the pointer position(true), or +center of the pointer position (true), or locked to the point where the user first clicked the -sprite(false).

    bounds

    Value relative to the coordinates of the Sprite's parent +sprite (false).

    bounds

    Value relative to the coordinates of the Sprite's parent that specify a constraint rectangle for the Sprite.

    stopDrag():Void

    Ends the startDrag() method. A sprite that was made draggable with the startDrag() method remains draggable until a stopDrag() method is added, or until another sprite becomes @@ -138,7 +139,7 @@ it by using a mouse or user input device. The default is true.

    This property is useful when you create a button with an instance of -the Sprite class(instead of using the SimpleButton class). When you use a +the Sprite class (instead of using the SimpleButton class). When you use a Sprite instance to create a button, you can choose to decorate the button by using the addChild() method to add additional Sprite instances. This process can cause unexpected behavior with mouse events @@ -175,14 +176,14 @@ default any InteractiveObject instance that is on the display list receives mouse events or other user input events. If mouseEnabled is set to false, the instance does -not receive any mouse events(or other user input events like keyboard +not receive any mouse events (or other user input events like keyboard events). Any children of this instance on the display list are not affected. To change the mouseEnabled behavior for all children of an object on the display list, use openfl.display.DisplayObjectContainer.mouseChildren.

    No event is dispatched by setting this property. You must use the addEventListener() method to create interactive -functionality.

    needsSoftKeyboard:Bool

    Specifies whether a virtual keyboard(an on-screen, software keyboard) +functionality.

    needsSoftKeyboard:Bool

    Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.

    By default, the value is false and focusing an InteractiveObject instance does not raise a soft keyboard. If the @@ -242,7 +243,7 @@ cast(tlfInstance2.getChildAt(1), InteractiveObject).tabIndex = 2; cast(tlfInstance3.getChildAt(1), InteractiveObject).tabIndex = 1;

    Defined by DisplayObject

    @:keepalpha:Float

    Indicates the alpha transparency value of the object specified. Valid values are 0 (fully transparent) to 1 (fully opaque). The default value is 1. -Display objects with alpha set to 0 are active, even though they are invisible.

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A +Display objects with alpha set to 0 are active, even though they are invisible.

    See also:

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A bitmap can be drawn internally in two ways. If you have a blend mode enabled or an external clipping mask, the bitmap is drawn by adding a bitmap-filled square shape to the vector render. If you attempt to set @@ -262,7 +263,7 @@ BlendMode class defines string values you can use. The illustrations in the table show blendMode values applied to a circular display object(2) superimposed on another display object(1).

    -

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn +

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    See also:

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn to the bitmap instead of the main display. If cacheAsBitmapMatrix is null or unsupported, the bitmap is then copied to the main display as unstretched, unrotated pixels snapped @@ -293,12 +294,12 @@ number of pixels cannot exceed 16,777,215 pixels.(So, if a bitmap image is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is is 2880 pixels in height and 2,880 pixels -in width.

  • The bitmap fails to allocate(out of memory error).
    • +in width.
  • The bitmap fails to allocate (out of memory error).

    • The cacheAsBitmap property is best used with movie clips that have mostly static content and that do not scale and rotate frequently. With such movie clips, cacheAsBitmap can lead to -performance increases when the movie clip is translated(when its x -and y position is changed).

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to +performance increases when the movie clip is translated (when its x +and y position is changed).

    See also:

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. The application uses this matrix as a transformation matrix that is applied when rendering the bitmap version of the display object.

    Adobe AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop @@ -332,16 +333,16 @@

    Note: The cacheAsBitmapMatrix property is suitable for 2D transformations. If you need to apply transformations in 3D, you may do so by setting a 3D property of the object and manipulating its transform.matrix3D property. If the application is packaged using GPU mode, this allows the 3D transforms -to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated +to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    See also:

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated with the display object. The openfl.filters package contains several classes that define specific filters you can use.

    Filters can be applied in Flash Professional at design time, or at run -time by using ActionScript code. To apply a filter by using ActionScript, +time by using Haxe code. To apply a filter by using Haxe, you must make a temporary copy of the entire filters array, modify the temporary array, then assign the value of the temporary array back to the filters array. You cannot directly add a new filter object to the filters array.

    -

    To add a filter by using ActionScript, perform the following steps +

    To add a filter by using Haxe, perform the following steps (assume that the target display object is named myDisplayObject):

    1. Create a new filter object by using the constructor method of your chosen filter class.
    2. Assign the value of the myDisplayObject.filters array @@ -372,7 +373,7 @@

      The openfl.filters package includes classes for filters. For example, to create a DropShadow filter, you would write:

      Throws:

      ArgumentError

      When filters includes a ShaderFilter and the shader output type is not compatible with -this operation(the shader must specify a +this operation (the shader must specify a pixel4 output).

      ArgumentError

      When filters includes a ShaderFilter and the shader doesn't specify any image input or the first input is not an image4 input.

      ArgumentError

      When filters includes a ShaderFilter @@ -390,10 +391,10 @@ is adjusted accordingly, as shown in the following code:

      Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a height of 0, even if you try to -set height to a different value.

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file +set height to a different value.

      See also:

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file to which this display object belongs. The loaderInfo property is defined only for the root display object of a SWF file or for a loaded -Bitmap(not for a Bitmap that is drawn with ActionScript). To find the +Bitmap (not for a Bitmap that is drawn with Haxe). To find the loaderInfo object associated with the SWF file that contains a display object named myDisplayObject, use myDisplayObject.root.loaderInfo.

      @@ -405,7 +406,7 @@ list. The mask object itself is not drawn. Set mask to null to remove the mask.

      To be able to scale a mask object, it must be on the display list. To -be able to drag a mask Sprite object(by calling its +be able to drag a mask Sprite object (by calling its startDrag() method), it must be on the display list. To call the startDrag() method for a mask sprite based on a mouseDown event being dispatched by the sprite, set the @@ -424,23 +425,23 @@ more than one calling display object. When the mask is assigned to a second display object, it is removed as the mask of the first object, and that object's mask property becomes -null.

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in +null.

      See also:

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned x -coordinate will reflect the non-rotated object.

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in +coordinate will reflect the non-rotated object.

      See also:

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned y -coordinate will reflect the non-rotated object.

      name:String

      Indicates the instance name of the DisplayObject. The object can be +coordinate will reflect the non-rotated object.

      See also:

      name:String

      Indicates the instance name of the DisplayObject. The object can be identified in the child list of its parent display object container by calling the getChildByName() method of the display object container.

      Throws:

      IllegalOperationError

      If you are attempting to set this property on an object that was placed on the timeline in the Flash authoring tool.

      opaqueBackground:Null<Int>

      Specifies whether the display object is opaque with a certain background color. A transparent bitmap contains alpha channel data and is drawn -transparently. An opaque bitmap has no alpha channel(and renders faster +transparently. An opaque bitmap has no alpha channel (and renders faster than a transparent bitmap). If the bitmap is opaque, you specify its own background color to use.

      -

      If set to a number value, the surface is opaque(not transparent) with +

      If set to a number value, the surface is opaque (not transparent) with the RGB background color that the number specifies. If set to null(the default value), the display object has a transparent background.

      @@ -452,7 +453,7 @@

      The opaque background region is not matched when calling the hitTestPoint() method with the shapeFlag parameter set to true.

      -

      The opaque background region does not respond to mouse events.

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display +

      The opaque background region does not respond to mouse events.

      See also:

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display object. Use the parent property to specify a relative path to display objects that are above the current display object in the display list hierarchy.

      @@ -461,7 +462,7 @@ 
      this.parent.parent.alpha = 20;

      Throws:

      SecurityError

      The parent display object belongs to a security sandbox to which you do not have access. You can avoid this situation by having the parent movie call -the Security.allowDomain() method.

      read onlyroot:DisplayObject

      For a display object in a loaded SWF file, the root property +the Security.allowDomain() method.

      See also:

    read onlyroot:DisplayObject

    For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. For a Bitmap object representing a loaded image file, the root property is the Bitmap object @@ -474,7 +475,7 @@ is a child of the top-most display object in a loaded SWF file.

    For example, if you create a new Sprite object by calling the Sprite() constructor method, its root property -is null until you add it to the display list(or to a display +is null until you add it to the display list (or to a display object container that is off the display list but that is a child of the top-most display object in a SWF file).

    For a loaded SWF file, even though the Loader object used to load the @@ -482,12 +483,12 @@ SWF file has its root property set to itself. The Loader object does not have its root property set until it is added as a child of a display object for which the root property is -set.

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its +set.

    See also:

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement my_video.rotation = 450 -is the same as my_video.rotation = 90.

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, +is the same as my_video.rotation = 90.

    See also:

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, the entire display object is scaled normally when any scale transformation is applied.

    When you define the scale9Grid property, the display @@ -515,11 +516,11 @@ the registration point. The default registration point is (0,0). 1.0 equals 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the +y property values, which are defined in whole pixels.

    See also:

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. The default registration point is (0,0). 1.0 is 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is +y property values, which are defined in whole pixels.

    See also:

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is cropped to the size defined by the rectangle, and it scrolls within the rectangle when you change the x and y properties of the scrollRect object.

    @@ -536,17 +537,17 @@ an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated 90° and you scroll it left and right, the display object actually scrolls -up and down.

    @:betashader:Shader

    BETA**

    +up and down.

    See also:

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to apply a post-process effect to multiple display objects at once, enable cacheAsBitmap or use the filters property with a ShaderFilter

    read onlystage:Stage

    The Stage of the display object. A Flash runtime application has only one Stage object. For example, you can create and load multiple display objects into the display list, and the stage property of each -display object refers to the same Stage object(even if the display object +display object refers to the same Stage object (even if the display object belongs to a loaded SWF file).

    If a display object is not added to the display list, its -stage property is set to null.

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color +stage property is set to null.

    See also:

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. The specific properties - matrix, colorTransform, and three read-only properties (concatenatedMatrix, concatenatedColorTransform, @@ -583,22 +584,22 @@ is adjusted accordingly, as shown in the following code:

    Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a width of 0, even if you try to set -width to a different value.

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative +width to a different value.

    See also:

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative +registration point position.

    See also:

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    Inherited Methods

    Defined by DisplayObjectContainer

    addChild(child:DisplayObject):DisplayObject

    Adds a child DisplayObject instance to this DisplayObjectContainer -instance. The child is added to the front(top) of all other children in +registration point position.

    See also:

    Inherited Methods

    Defined by DisplayObjectContainer

    addChild(child:DisplayObject):DisplayObject

    Adds a child DisplayObject instance to this DisplayObjectContainer +instance. The child is added to the front (top) of all other children in this DisplayObjectContainer instance.(To add a child to a specific index position, use the addChildAt() method.)

    If you add a child object that already has a different display object @@ -615,11 +616,11 @@ to the Stage.

    Parameters:

    child

    The DisplayObject instance to add as a child of this DisplayObjectContainer instance.

    Returns:

    The DisplayObject instance that you pass in the child parameter.

    Throws:

    ArgumentError

    Throws if the child is the same as the parent. Also -throws if the caller is a child(or grandchild etc.) +throws if the caller is a child (or grandchild etc.) of the child being added.

    Events:

    added

    Dispatched when a display object is added to the display -list.

    addChildAt(child:DisplayObject, index:Int):DisplayObject

    Adds a child DisplayObject instance to this DisplayObjectContainer +list.

    See also:

    addChildAt(child:DisplayObject, index:Int):DisplayObject

    Adds a child DisplayObject instance to this DisplayObjectContainer instance. The child is added at the index position specified. An index of -0 represents the back(bottom) of the display list for this +0 represents the back (bottom) of the display list for this DisplayObjectContainer object.

    For example, the following example shows three display objects, labeled a, b, and c, at index positions 0, 2, and 1, respectively:

    @@ -632,10 +633,10 @@ that exists at that position and all higher positions are moved up one position in the child list.

    Returns:

    The DisplayObject instance that you pass in the child parameter.

    Throws:

    ArgumentError

    Throws if the child is the same as the parent. Also -throws if the caller is a child(or grandchild etc.) +throws if the caller is a child (or grandchild etc.) of the child being added.

    RangeError

    Throws if the index position does not exist in the child list.

    Events:

    added

    Dispatched when a display object is added to the display -list.

    areInaccessibleObjectsUnderPoint(point:Point):Bool

    Indicates whether the security restrictions would cause any display +list.

    See also:

    areInaccessibleObjectsUnderPoint(point:Point):Bool

    Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point. By default, content from one domain @@ -659,7 +660,7 @@ list.

    SecurityError

    This child display object belongs to a sandbox to which you do not have access. You can avoid this situation by having the child movie call -Security.allowDomain().

    getChildByName(name:String):DisplayObject

    Returns the child display object that exists with the specified name. If +Security.allowDomain().

    See also:

    getChildByName(name:String):DisplayObject

    Returns the child display object that exists with the specified name. If more that one child display object has the specified name, the method returns the first object in the child list.

    The getChildAt() method is faster than the @@ -669,7 +670,7 @@ access a child.

    Parameters:

    name

    The name of the child to return.

    Returns:

    The child display object with the specified name.

    Throws:

    SecurityError

    This child display object belongs to a sandbox to which you do not have access. You can avoid this situation by having the child movie call the -Security.allowDomain() method.

    getChildIndex(child:DisplayObject):Int

    Returns the index position of a child DisplayObject instance.

    Parameters:

    child

    The DisplayObject instance to identify.

    Returns:

    The index position of the child display object to identify.

    Throws:

    ArgumentError

    Throws if the child parameter is not a child of this +Security.allowDomain() method.

    See also:

    getChildIndex(child:DisplayObject):Int

    Returns the index position of a child DisplayObject instance.

    Parameters:

    child

    The DisplayObject instance to identify.

    Returns:

    The index position of the child display object to identify.

    Throws:

    ArgumentError

    Throws if the child parameter is not a child of this object.

    getObjectsUnderPoint(point:Point):Array<DisplayObject>

    Returns an array of objects that lie under the specified point and are children(or grandchildren, and so on) of this DisplayObjectContainer instance. Any child objects that are inaccessible for security reasons are @@ -777,8 +778,8 @@ coordinates, respectively.

    Parameters:

    targetCoordinateSpace

    The display object that defines the coordinate system to use.

    Returns:

    The rectangle that defines the area of the display object relative to the targetCoordinateSpace object's coordinate -system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage(global) coordinates -to the display object's(local) coordinates.

    +system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage (global) coordinates +to the display object's (local) coordinates.

    To use this method, first create an instance of the Point class. The x and y values that you assign represent global coordinates because they relate to the origin(0,0) of the main display area. Then @@ -793,17 +794,17 @@ point specified by the x and y parameters. The x and y parameters specify a point in the coordinate space of the Stage, not the display object container that -contains the display object(unless that display object container is the +contains the display object (unless that display object container is the Stage).

    Parameters:

    x

    The x coordinate to test against this object.

    y

    The y coordinate to test against this object.

    shapeFlag

    Whether to check against the actual pixels of the object (true) or the bounding box (false).

    Returns:

    true if the display object overlaps or intersects with the specified point; false otherwise.

    invalidate():Void

    Calling the invalidate() method signals to have the current object -redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's(local) -coordinates to the Stage(global) coordinates.

    +redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's (local) +coordinates to the Stage (global) coordinates.

    This method allows you to convert any given x and y coordinates from values that are relative to the origin(0,0) of a -specific display object(local coordinates) to values that are relative to -the origin of the Stage(global coordinates).

    +specific display object (local coordinates) to values that are relative to +the origin of the Stage (global coordinates).

    To use this method, first create an instance of the Point class. The x and y values that you assign represent local coordinates because they relate to the origin of the display object.

    diff --git a/openfl/display/Stage.html b/openfl/display/Stage.html index d0102b3..d7d2e10 100644 --- a/openfl/display/Stage.html +++ b/openfl/display/Stage.html @@ -1,7 +1,7 @@ -openfl.display.Stage - API Reference
    View source

    class Stage

    package openfl.display

    extends DisplayObjectContainer › InteractiveObject › DisplayObject › EventDispatcher

    implements IModule

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display.DisplayObjectRenderer)@:access(openfl.display.LoaderInfo)@:access(openfl.display.Sprite)@:access(openfl.display.Stage3D)@:access(openfl.events.Event)@:access(openfl.events.UncaughtErrorEvents)@:access(openfl.geom.Matrix)@:access(openfl.geom.Point)@:access(openfl.ui.GameInput)@:access(openfl.ui.Keyboard)@:access(openfl.ui.Mouse)@:access(lime.ui.Window)

    Available on all platforms

    The Stage class represents the main drawing area.

    -

    For SWF content running in the browser(in Flash® Player), +

    View source

    class Stage

    package openfl.display

    extends DisplayObjectContainer › InteractiveObject › DisplayObject › EventDispatcher

    implements IModule

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display.DisplayObjectRenderer)@:access(openfl.display.LoaderInfo)@:access(openfl.display.Sprite)@:access(openfl.display.Stage3D)@:access(openfl.events.Event)@:access(openfl.events.UncaughtErrorEvents)@:access(openfl.geom.Matrix)@:access(openfl.geom.Point)@:access(openfl.ui.GameInput)@:access(openfl.ui.Keyboard)@:access(openfl.ui.Mouse)@:access(lime.ui.Window)

    Available on all platforms

    The Stage class represents the main drawing area.

    +

    For SWF content running in the browser (in Flash® Player), the Stage represents the entire area where Flash content is shown. For content running in AIR on desktop operating systems, each NativeWindow object has a corresponding Stage object.

    @@ -89,7 +89,7 @@ the DisplayObject class.

    Events:

    fullScreen

    Dispatched when the Stage object enters, or leaves, full-screen mode. A change in full-screen mode can be initiated through -ActionScript, or the user invoking a keyboard +Haxe code, or the user invoking a keyboard shortcut, or if the current focus leaves the full-screen window.

    mouseLeave

    Dispatched by the Stage object when the pointer moves out of the stage area. If the @@ -126,11 +126,11 @@ of the stageVideos property changes.

    Constructor

    @:value({ color : null })new(window:Window, ?color:Int)

    Variables

    align:StageAlign

    A value from the StageAlign class that specifies the alignment of the stage in Flash Player or the browser. The following are valid values:

    The align property is only available to an object that is -in the same security sandbox as the Stage owner(the main SWF file). To +in the same security sandbox as the Stage owner (the main SWF file). To avoid this, the Stage owner can grant permission to the domain of the calling object by calling the Security.allowDomain() method or the Security.alowInsecureDomain() method. For more -information, see the "Security" chapter in the ActionScript 3.0 +information, see the "Security" chapter in the OpenFL Developer's Guide.

    read onlyallowsFullScreen:Bool

    Specifies whether this stage allows the use of the full screen mode

    read onlyallowsFullScreenInteractive:Bool

    Specifies whether this stage allows the use of the full screen with text input mode

    read onlyapplication:Application

    The associated Lime Application instance.

    color:Null<Int>

    The window background color.

    read onlycontentsScaleFactor:Float

    Specifies the effective pixel scaling factor of the stage. This value is 1 on standard screens and HiDPI (Retina display) screens. When the stage is rendered on HiDPI screens the pixel @@ -195,7 +195,7 @@ Security.allowDomain() method or the Security.allowInsecureDomain() method. For more information, see the "Security" chapter in -the ActionScript 3.0 Developer's Guide. +the OpenFL Developer's Guide. Trying to set the displayState property while the settings dialog is displayed, without a user response, or if the param or @@ -224,7 +224,7 @@ Security.allowDomain() method or the Security.allowInsecureDomain() method. For more information, see the "Security" chapter in -the ActionScript 3.0 Developer's Guide.

    read onlyfullScreenHeight:UInt

    Returns the height of the monitor that will be used when going to full +the OpenFL Developer's Guide.

    read onlyfullScreenHeight:UInt

    Returns the height of the monitor that will be used when going to full screen size, if that state is entered immediately. If the user has multiple monitors, the monitor that's used is the monitor that most of the stage is on at the time. @@ -235,18 +235,18 @@ StageDisplayState.FULL_SCREEN, the value will be correct.

    This is the pixel height of the monitor and is the same as the stage height would be if Stage.align is set to StageAlign.TOP_LEFT and -Stage.scaleMode is set to StageScaleMode.NO_SCALE.

    fullScreenSourceRect:Rectangle

    Sets the Flash runtime to scale a specific region of the stage to -full-screen mode. If available, the Flash runtime scales in hardware, +Stage.scaleMode is set to StageScaleMode.NO_SCALE.

    fullScreenSourceRect:Rectangle

    Sets OpenFL to scale a specific region of the stage to +full-screen mode. If available, the OpenFL scales in hardware, which uses the graphics and video card on a user's computer, and generally displays content more quickly than software scaling. When this property is set to a valid rectangle and the displayState -property is set to full-screen mode, the Flash runtime scales the -specified area. The actual Stage size in pixels within ActionScript -does not change. The Flash runtime enforces a minimum limit for the +property is set to full-screen mode, OpenFL scales the +specified area. The actual Stage size in pixels within Haxe +does not change. OpenFL enforces a minimum limit for the size of the rectangle to accommodate the standard "Press Esc to exit full-screen mode" message. This limit is usually around 260 by 30 -pixels but can vary on platform and Flash runtime version.

    -

    This property can only be set when the Flash runtime is not in +pixels but can vary on platform and OpenFL version.

    +

    This property can only be set when the OpenFL is not in full-screen mode. To use this property correctly, set this property first, then set the displayState property to full-screen mode, as shown in the code examples.

    @@ -270,7 +270,7 @@ StageDisplayState.FULL_SCREEN, the value will be correct.

    This is the pixel width of the monitor and is the same as the stage width would be if Stage.align is set to StageAlign.TOP_LEFT and -Stage.scaleMode is set to StageScaleMode.NO_SCALE.

    read onlynativeWindow:NativeWindow

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    quality:StageQuality

    A value from the StageQuality class that specifies which rendering quality +Stage.scaleMode is set to StageScaleMode.NO_SCALE.

    read onlynativeWindow:NativeWindow

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    quality:StageQuality

    A value from the StageQuality class that specifies which rendering quality is used. The following are valid values:

    • StageQuality.LOW - Low rendering quality. Graphics are not anti-aliased, and bitmaps are not smoothed, but runtimes still use mip-mapping.
    • StageQuality.MEDIUM - Medium rendering quality. @@ -295,7 +295,7 @@

      In the desktop profile of Adobe AIR, quality can be set to StageQuality.BEST or StageQuality.HIGH(and the default value is StageQuality.HIGH). Attempting to set it to -another value has no effect(and the property remains unchanged). In the +another value has no effect (and the property remains unchanged). In the moble profile of AIR, all four quality settings are available. The default value on mobile devices is StageQuality.MEDIUM.

      For content running in Adobe AIR, setting the quality @@ -312,7 +312,7 @@ method or the Security.allowInsecureDomain() method. For more information, see the "Security" chapter in -the ActionScript 3.0 Developer's Guide.

    scaleMode:StageScaleMode

    A value from the StageScaleMode class that specifies which scale mode to +the OpenFL Developer's Guide.

    scaleMode:StageScaleMode

    A value from the StageScaleMode class that specifies which scale mode to use. The following are valid values:

    • StageScaleMode.EXACT_FIT - The entire application is visible in the specified area without trying to preserve the original aspect ratio. Distortion can occur, and the application may appear @@ -333,7 +333,7 @@ Security.allowDomain() method or the Security.allowInsecureDomain() method. For more information, see the "Security" chapter in -the ActionScript 3.0 Developer's Guide.

    showDefaultContextMenu:Bool

    Specifies whether to show or hide the default items in the Flash +the OpenFL Developer's Guide.

    showDefaultContextMenu:Bool

    Specifies whether to show or hide the default items in the Flash runtime context menu. If the showDefaultContextMenu property is set to true (the default), all context menu items appear. If the @@ -347,7 +347,7 @@ Security.allowDomain() method or the Security.allowInsecureDomain() method. For more information, see the "Security" chapter in -the ActionScript 3.0 Developer's Guide.

    softKeyboardRect:Rectangle

    The area of the stage that is currently covered by the software +the OpenFL Developer's Guide.

    softKeyboardRect:Rectangle

    The area of the stage that is currently covered by the software keyboard. The area has a size of zero (0,0,0,0) when the soft keyboard is not visible.

    @@ -367,13 +367,13 @@ focus.

    Throws:

    SecurityError

    Calling the stageFocusRect property of a Stage object throws an exception for any caller that is not in the same security sandbox as the -Stage owner(the main SWF file). To avoid this, the +Stage owner (the main SWF file). To avoid this, the Stage owner can grant permission to the domain of the caller by calling the Security.allowDomain() method or the Security.allowInsecureDomain() method. For more information, see the "Security" chapter in -the ActionScript 3.0 Developer's Guide.

    read onlystageHeight:Int

    The current height, in pixels, of the Stage.

    +the OpenFL Developer's Guide.

    read onlystageHeight:Int

    The current height, in pixels, of the Stage.

    If the value of the Stage.scaleMode property is set to StageScaleMode.NO_SCALE when the user resizes the window, the Stage content maintains its size while the stageHeight @@ -393,7 +393,7 @@ the next frame of the SWF.

    Note: In an HTML page hosting the SWF file, both the object and embed tags' height -attributes must be set to a percentage(such as 100%), not +attributes must be set to a percentage (such as 100%), not pixels. If the settings are generated by JavaScript code, the height parameter of the AC_FL_RunContent() method must be set to a percentage, too. This percentage is applied to the @@ -406,7 +406,7 @@ Security.allowDomain() method or the Security.allowInsecureDomain() method. For more information, see the "Security" chapter in -the ActionScript 3.0 Developer's Guide.

    read onlystageWidth:Int

    Specifies the current width, in pixels, of the Stage.

    +the OpenFL Developer's Guide.

    read onlystageWidth:Int

    Specifies the current width, in pixels, of the Stage.

    If the value of the Stage.scaleMode property is set to StageScaleMode.NO_SCALE when the user resizes the window, the Stage content maintains its defined size while the stageWidth @@ -426,7 +426,7 @@ the next frame of the SWF.

    Note: In an HTML page hosting the SWF file, both the object and embed tags' width -attributes must be set to a percentage(such as 100%), not +attributes must be set to a percentage (such as 100%), not pixels. If the settings are generated by JavaScript code, the width parameter of the AC_FL_RunContent() method must be set to a percentage, too. This percentage is applied to the @@ -439,7 +439,7 @@ Security.allowDomain() method or the Security.allowInsecureDomain() method. For more information, see the "Security" chapter in -the ActionScript 3.0 Developer's Guide.

    read onlywindow:Window

    The associated Lime Window instance for this Stage.

    Methods

    invalidate():Void

    Calling the invalidate() method signals Flash runtimes to +the OpenFL Developer's Guide.

    read onlywindow:Window

    The associated Lime Window instance for this Stage.

    Methods

    invalidate():Void

    Calling the invalidate() method signals Flash runtimes to alert display objects on the next opportunity it has to render the display list(for example, when the playhead advances to a new frame). After you call the invalidate() method, when the display list is next @@ -460,7 +460,7 @@ it by using a mouse or user input device. The default is true.

    This property is useful when you create a button with an instance of -the Sprite class(instead of using the SimpleButton class). When you use a +the Sprite class (instead of using the SimpleButton class). When you use a Sprite instance to create a button, you can choose to decorate the button by using the addChild() method to add additional Sprite instances. This process can cause unexpected behavior with mouse events @@ -497,14 +497,14 @@ default any InteractiveObject instance that is on the display list receives mouse events or other user input events. If mouseEnabled is set to false, the instance does -not receive any mouse events(or other user input events like keyboard +not receive any mouse events (or other user input events like keyboard events). Any children of this instance on the display list are not affected. To change the mouseEnabled behavior for all children of an object on the display list, use openfl.display.DisplayObjectContainer.mouseChildren.

    No event is dispatched by setting this property. You must use the addEventListener() method to create interactive -functionality.

    needsSoftKeyboard:Bool

    Specifies whether a virtual keyboard(an on-screen, software keyboard) +functionality.

    needsSoftKeyboard:Bool

    Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.

    By default, the value is false and focusing an InteractiveObject instance does not raise a soft keyboard. If the @@ -564,7 +564,7 @@ cast(tlfInstance2.getChildAt(1), InteractiveObject).tabIndex = 2; cast(tlfInstance3.getChildAt(1), InteractiveObject).tabIndex = 1;

    Defined by DisplayObject

    @:keepalpha:Float

    Indicates the alpha transparency value of the object specified. Valid values are 0 (fully transparent) to 1 (fully opaque). The default value is 1. -Display objects with alpha set to 0 are active, even though they are invisible.

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A +Display objects with alpha set to 0 are active, even though they are invisible.

    See also:

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A bitmap can be drawn internally in two ways. If you have a blend mode enabled or an external clipping mask, the bitmap is drawn by adding a bitmap-filled square shape to the vector render. If you attempt to set @@ -584,7 +584,7 @@ BlendMode class defines string values you can use. The illustrations in the table show blendMode values applied to a circular display object(2) superimposed on another display object(1).

    -

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn +

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    See also:

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn to the bitmap instead of the main display. If cacheAsBitmapMatrix is null or unsupported, the bitmap is then copied to the main display as unstretched, unrotated pixels snapped @@ -615,12 +615,12 @@ number of pixels cannot exceed 16,777,215 pixels.(So, if a bitmap image is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is is 2880 pixels in height and 2,880 pixels -in width.

  • The bitmap fails to allocate(out of memory error).
    • +in width.
  • The bitmap fails to allocate (out of memory error).

    • The cacheAsBitmap property is best used with movie clips that have mostly static content and that do not scale and rotate frequently. With such movie clips, cacheAsBitmap can lead to -performance increases when the movie clip is translated(when its x -and y position is changed).

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to +performance increases when the movie clip is translated (when its x +and y position is changed).

    See also:

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. The application uses this matrix as a transformation matrix that is applied when rendering the bitmap version of the display object.

    Adobe AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop @@ -654,16 +654,16 @@

    Note: The cacheAsBitmapMatrix property is suitable for 2D transformations. If you need to apply transformations in 3D, you may do so by setting a 3D property of the object and manipulating its transform.matrix3D property. If the application is packaged using GPU mode, this allows the 3D transforms -to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated +to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    See also:

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated with the display object. The openfl.filters package contains several classes that define specific filters you can use.

    Filters can be applied in Flash Professional at design time, or at run -time by using ActionScript code. To apply a filter by using ActionScript, +time by using Haxe code. To apply a filter by using Haxe, you must make a temporary copy of the entire filters array, modify the temporary array, then assign the value of the temporary array back to the filters array. You cannot directly add a new filter object to the filters array.

    -

    To add a filter by using ActionScript, perform the following steps +

    To add a filter by using Haxe, perform the following steps (assume that the target display object is named myDisplayObject):

    1. Create a new filter object by using the constructor method of your chosen filter class.
    2. Assign the value of the myDisplayObject.filters array @@ -694,7 +694,7 @@

      The openfl.filters package includes classes for filters. For example, to create a DropShadow filter, you would write:

      Throws:

      ArgumentError

      When filters includes a ShaderFilter and the shader output type is not compatible with -this operation(the shader must specify a +this operation (the shader must specify a pixel4 output).

      ArgumentError

      When filters includes a ShaderFilter and the shader doesn't specify any image input or the first input is not an image4 input.

      ArgumentError

      When filters includes a ShaderFilter @@ -712,10 +712,10 @@ is adjusted accordingly, as shown in the following code:

      Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a height of 0, even if you try to -set height to a different value.

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file +set height to a different value.

      See also:

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file to which this display object belongs. The loaderInfo property is defined only for the root display object of a SWF file or for a loaded -Bitmap(not for a Bitmap that is drawn with ActionScript). To find the +Bitmap (not for a Bitmap that is drawn with Haxe). To find the loaderInfo object associated with the SWF file that contains a display object named myDisplayObject, use myDisplayObject.root.loaderInfo.

      @@ -727,7 +727,7 @@ list. The mask object itself is not drawn. Set mask to null to remove the mask.

      To be able to scale a mask object, it must be on the display list. To -be able to drag a mask Sprite object(by calling its +be able to drag a mask Sprite object (by calling its startDrag() method), it must be on the display list. To call the startDrag() method for a mask sprite based on a mouseDown event being dispatched by the sprite, set the @@ -746,23 +746,23 @@ more than one calling display object. When the mask is assigned to a second display object, it is removed as the mask of the first object, and that object's mask property becomes -null.

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in +null.

      See also:

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned x -coordinate will reflect the non-rotated object.

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in +coordinate will reflect the non-rotated object.

      See also:

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned y -coordinate will reflect the non-rotated object.

      name:String

      Indicates the instance name of the DisplayObject. The object can be +coordinate will reflect the non-rotated object.

      See also:

      name:String

      Indicates the instance name of the DisplayObject. The object can be identified in the child list of its parent display object container by calling the getChildByName() method of the display object container.

      Throws:

      IllegalOperationError

      If you are attempting to set this property on an object that was placed on the timeline in the Flash authoring tool.

      opaqueBackground:Null<Int>

      Specifies whether the display object is opaque with a certain background color. A transparent bitmap contains alpha channel data and is drawn -transparently. An opaque bitmap has no alpha channel(and renders faster +transparently. An opaque bitmap has no alpha channel (and renders faster than a transparent bitmap). If the bitmap is opaque, you specify its own background color to use.

      -

      If set to a number value, the surface is opaque(not transparent) with +

      If set to a number value, the surface is opaque (not transparent) with the RGB background color that the number specifies. If set to null(the default value), the display object has a transparent background.

      @@ -774,7 +774,7 @@

      The opaque background region is not matched when calling the hitTestPoint() method with the shapeFlag parameter set to true.

      -

      The opaque background region does not respond to mouse events.

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display +

      The opaque background region does not respond to mouse events.

      See also:

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display object. Use the parent property to specify a relative path to display objects that are above the current display object in the display list hierarchy.

      @@ -783,7 +783,7 @@ 
      this.parent.parent.alpha = 20;

      Throws:

      SecurityError

      The parent display object belongs to a security sandbox to which you do not have access. You can avoid this situation by having the parent movie call -the Security.allowDomain() method.

      read onlyroot:DisplayObject

      For a display object in a loaded SWF file, the root property +the Security.allowDomain() method.

      See also:

    read onlyroot:DisplayObject

    For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. For a Bitmap object representing a loaded image file, the root property is the Bitmap object @@ -796,7 +796,7 @@ is a child of the top-most display object in a loaded SWF file.

    For example, if you create a new Sprite object by calling the Sprite() constructor method, its root property -is null until you add it to the display list(or to a display +is null until you add it to the display list (or to a display object container that is off the display list but that is a child of the top-most display object in a SWF file).

    For a loaded SWF file, even though the Loader object used to load the @@ -804,12 +804,12 @@ SWF file has its root property set to itself. The Loader object does not have its root property set until it is added as a child of a display object for which the root property is -set.

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its +set.

    See also:

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement my_video.rotation = 450 -is the same as my_video.rotation = 90.

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, +is the same as my_video.rotation = 90.

    See also:

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, the entire display object is scaled normally when any scale transformation is applied.

    When you define the scale9Grid property, the display @@ -837,11 +837,11 @@ the registration point. The default registration point is (0,0). 1.0 equals 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the +y property values, which are defined in whole pixels.

    See also:

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. The default registration point is (0,0). 1.0 is 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is +y property values, which are defined in whole pixels.

    See also:

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is cropped to the size defined by the rectangle, and it scrolls within the rectangle when you change the x and y properties of the scrollRect object.

    @@ -858,17 +858,17 @@ an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated 90° and you scroll it left and right, the display object actually scrolls -up and down.

    @:betashader:Shader

    BETA**

    +up and down.

    See also:

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to apply a post-process effect to multiple display objects at once, enable cacheAsBitmap or use the filters property with a ShaderFilter

    read onlystage:Stage

    The Stage of the display object. A Flash runtime application has only one Stage object. For example, you can create and load multiple display objects into the display list, and the stage property of each -display object refers to the same Stage object(even if the display object +display object refers to the same Stage object (even if the display object belongs to a loaded SWF file).

    If a display object is not added to the display list, its -stage property is set to null.

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color +stage property is set to null.

    See also:

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. The specific properties - matrix, colorTransform, and three read-only properties (concatenatedMatrix, concatenatedColorTransform, @@ -905,22 +905,22 @@ is adjusted accordingly, as shown in the following code:

    Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a width of 0, even if you try to set -width to a different value.

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative +width to a different value.

    See also:

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative +registration point position.

    See also:

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    Inherited Methods

    Defined by DisplayObjectContainer

    addChild(child:DisplayObject):DisplayObject

    Adds a child DisplayObject instance to this DisplayObjectContainer -instance. The child is added to the front(top) of all other children in +registration point position.

    See also:

    Inherited Methods

    Defined by DisplayObjectContainer

    addChild(child:DisplayObject):DisplayObject

    Adds a child DisplayObject instance to this DisplayObjectContainer +instance. The child is added to the front (top) of all other children in this DisplayObjectContainer instance.(To add a child to a specific index position, use the addChildAt() method.)

    If you add a child object that already has a different display object @@ -937,11 +937,11 @@ to the Stage.

    Parameters:

    child

    The DisplayObject instance to add as a child of this DisplayObjectContainer instance.

    Returns:

    The DisplayObject instance that you pass in the child parameter.

    Throws:

    ArgumentError

    Throws if the child is the same as the parent. Also -throws if the caller is a child(or grandchild etc.) +throws if the caller is a child (or grandchild etc.) of the child being added.

    Events:

    added

    Dispatched when a display object is added to the display -list.

    addChildAt(child:DisplayObject, index:Int):DisplayObject

    Adds a child DisplayObject instance to this DisplayObjectContainer +list.

    See also:

    addChildAt(child:DisplayObject, index:Int):DisplayObject

    Adds a child DisplayObject instance to this DisplayObjectContainer instance. The child is added at the index position specified. An index of -0 represents the back(bottom) of the display list for this +0 represents the back (bottom) of the display list for this DisplayObjectContainer object.

    For example, the following example shows three display objects, labeled a, b, and c, at index positions 0, 2, and 1, respectively:

    @@ -954,10 +954,10 @@ that exists at that position and all higher positions are moved up one position in the child list.

    Returns:

    The DisplayObject instance that you pass in the child parameter.

    Throws:

    ArgumentError

    Throws if the child is the same as the parent. Also -throws if the caller is a child(or grandchild etc.) +throws if the caller is a child (or grandchild etc.) of the child being added.

    RangeError

    Throws if the index position does not exist in the child list.

    Events:

    added

    Dispatched when a display object is added to the display -list.

    areInaccessibleObjectsUnderPoint(point:Point):Bool

    Indicates whether the security restrictions would cause any display +list.

    See also:

    areInaccessibleObjectsUnderPoint(point:Point):Bool

    Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point. By default, content from one domain @@ -981,7 +981,7 @@ list.

    SecurityError

    This child display object belongs to a sandbox to which you do not have access. You can avoid this situation by having the child movie call -Security.allowDomain().

    getChildByName(name:String):DisplayObject

    Returns the child display object that exists with the specified name. If +Security.allowDomain().

    See also:

    getChildByName(name:String):DisplayObject

    Returns the child display object that exists with the specified name. If more that one child display object has the specified name, the method returns the first object in the child list.

    The getChildAt() method is faster than the @@ -991,7 +991,7 @@ access a child.

    Parameters:

    name

    The name of the child to return.

    Returns:

    The child display object with the specified name.

    Throws:

    SecurityError

    This child display object belongs to a sandbox to which you do not have access. You can avoid this situation by having the child movie call the -Security.allowDomain() method.

    getChildIndex(child:DisplayObject):Int

    Returns the index position of a child DisplayObject instance.

    Parameters:

    child

    The DisplayObject instance to identify.

    Returns:

    The index position of the child display object to identify.

    Throws:

    ArgumentError

    Throws if the child parameter is not a child of this +Security.allowDomain() method.

    See also:

    getChildIndex(child:DisplayObject):Int

    Returns the index position of a child DisplayObject instance.

    Parameters:

    child

    The DisplayObject instance to identify.

    Returns:

    The index position of the child display object to identify.

    Throws:

    ArgumentError

    Throws if the child parameter is not a child of this object.

    getObjectsUnderPoint(point:Point):Array<DisplayObject>

    Returns an array of objects that lie under the specified point and are children(or grandchildren, and so on) of this DisplayObjectContainer instance. Any child objects that are inaccessible for security reasons are @@ -1099,8 +1099,8 @@ coordinates, respectively.

    Parameters:

    targetCoordinateSpace

    The display object that defines the coordinate system to use.

    Returns:

    The rectangle that defines the area of the display object relative to the targetCoordinateSpace object's coordinate -system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage(global) coordinates -to the display object's(local) coordinates.

    +system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage (global) coordinates +to the display object's (local) coordinates.

    To use this method, first create an instance of the Point class. The x and y values that you assign represent global coordinates because they relate to the origin(0,0) of the main display area. Then @@ -1115,7 +1115,7 @@ point specified by the x and y parameters. The x and y parameters specify a point in the coordinate space of the Stage, not the display object container that -contains the display object(unless that display object container is the +contains the display object (unless that display object container is the Stage).

    Parameters:

    x

    The x coordinate to test against this object.

    y

    The y coordinate to test against this object.

    shapeFlag

    Whether to check against the actual pixels of the object (true) or the bounding box (false).

    Returns:

    true if the display object overlaps or intersects diff --git a/openfl/display/Stage3D.html b/openfl/display/Stage3D.html index 7eb3cc1..889252b 100644 --- a/openfl/display/Stage3D.html +++ b/openfl/display/Stage3D.html @@ -1,7 +1,7 @@ -openfl.display.Stage3D - API Referenceopenfl.display.Stage3D - OpenFL API Reference

    API Reference
    View source

    class Stage3D

    package openfl.display

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(lime.graphics.opengl.GL)@:access(openfl.display3D.Context3D)@:access(openfl.display3D.Program3D)@:access(openfl.display.Bitmap)@:access(openfl.display.BitmapData)@:access(openfl.display.Stage)

    Available on all platforms

    The Stage class represents the main drawing area. +

    View source

    class Stage3D

    package openfl.display

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(lime.graphics.opengl.GL)@:access(openfl.display3D.Context3D)@:access(openfl.display3D.Program3D)@:access(openfl.display.Bitmap)@:access(openfl.display.BitmapData)@:access(openfl.display.Stage)

    Available on all platforms

    The Stage class represents the main drawing area. For SWF content running in the browser (in Flash® Player), the Stage represents the entire area where Flash content is shown. For content running in AIR on desktop operating systems, each NativeWindow object has @@ -92,7 +92,7 @@ DisplayObject class.

    Events:

    fullScreen

    Dispatched when the Stage object enters, or leaves, full-screen mode. A change in full-screen mode can be initiated through -ActionScript, or the user invoking a +Haxe code, or the user invoking a keyboard shortcut, or if the current focus leaves the full-screen window.

    mouseLeave

    Dispatched by the Stage object when the pointer moves out of the stage area. If the @@ -286,7 +286,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/display/StageAlign.html b/openfl/display/StageAlign.html index 666be51..229c350 100644 --- a/openfl/display/StageAlign.html +++ b/openfl/display/StageAlign.html @@ -1,7 +1,7 @@ -openfl.display.StageAlign - API Referenceopenfl.display.StageAlign - OpenFL API Reference

    View source

    enum abstract StageAlign(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The StageAlign class provides constant values to use for the +

    View source

    enum abstract StageAlign(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The StageAlign class provides constant values to use for the Stage.align property.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBOTTOM:StageAlign = 0

    Specifies that the Stage is aligned at the bottom.

    @:value(cast 1)@:impl@:enuminlineread onlyBOTTOM_LEFT:StageAlign = 1

    Specifies that the Stage is aligned on the left.

    @:value(cast 2)@:impl@:enuminlineread onlyBOTTOM_RIGHT:StageAlign = 2

    Specifies that the Stage is aligned to the right.

    @:value(cast 3)@:impl@:enuminlineread onlyLEFT:StageAlign = 3

    Specifies that the Stage is aligned on the left.

    @:value(cast 4)@:impl@:enuminlineread onlyRIGHT:StageAlign = 4

    Specifies that the Stage is aligned to the right.

    @:value(cast 5)@:impl@:enuminlineread onlyTOP:StageAlign = 5

    Specifies that the Stage is aligned at the top.

    @:value(cast 6)@:impl@:enuminlineread onlyTOP_LEFT:StageAlign = 6

    Specifies that the Stage is aligned on the left.

    @:value(cast 7)@:impl@:enuminlineread onlyTOP_RIGHT:StageAlign = 7

    Specifies that the Stage is aligned to the right.

    \ No newline at end of file diff --git a/openfl/display/StageDisplayState.html b/openfl/display/StageDisplayState.html index f56d8fc..c0520d4 100644 --- a/openfl/display/StageDisplayState.html +++ b/openfl/display/StageDisplayState.html @@ -1,7 +1,7 @@ -openfl.display.StageDisplayState - API Referenceopenfl.display.StageDisplayState - OpenFL API Reference
    View source

    enum abstract StageDisplayState(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The StageDisplayState class provides values for the +

    View source

    enum abstract StageDisplayState(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The StageDisplayState class provides values for the Stage.displayState property.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFULL_SCREEN:StageDisplayState = 0

    Specifies that the Stage is in full-screen mode.

    @:value(cast 1)@:impl@:enuminlineread onlyFULL_SCREEN_INTERACTIVE:StageDisplayState = 1

    Specifies that the Stage is in full-screen mode with keyboard interactivity enabled.

    @:value(cast 2)@:impl@:enuminlineread onlyNORMAL:StageDisplayState = 2

    Specifies that the Stage is in normal mode.

    \ No newline at end of file diff --git a/openfl/display/StageQuality.html b/openfl/display/StageQuality.html index f1a8aa2..026eedc 100644 --- a/openfl/display/StageQuality.html +++ b/openfl/display/StageQuality.html @@ -1,7 +1,7 @@ -openfl.display.StageQuality - API Referenceopenfl.display.StageQuality - OpenFL API Reference
    View source

    enum abstract StageQuality(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The StageQuality class provides values for the Stage.quality +

    View source

    enum abstract StageQuality(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The StageQuality class provides values for the Stage.quality property.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBEST:StageQuality = 0

    Specifies very high rendering quality: graphics are anti-aliased using a 4 x 4 pixel grid and bitmaps are always smoothed.

    @:value(cast 1)@:impl@:enuminlineread onlyHIGH:StageQuality = 1

    Specifies high rendering quality: graphics are anti-aliased using a 4 x 4 pixel grid, and bitmaps are smoothed if the movie is static.

    @:value(cast 2)@:impl@:enuminlineread onlyLOW:StageQuality = 2

    Specifies low rendering quality: graphics are not anti-aliased, and diff --git a/openfl/display/StageScaleMode.html b/openfl/display/StageScaleMode.html index b0b297d..21208c8 100644 --- a/openfl/display/StageScaleMode.html +++ b/openfl/display/StageScaleMode.html @@ -1,7 +1,7 @@ -openfl.display.StageScaleMode - API Referenceopenfl.display.StageScaleMode - OpenFL API Reference

    View source

    enum abstract StageScaleMode(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The StageScaleMode class provides values for the +

    View source

    enum abstract StageScaleMode(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    The StageScaleMode class provides values for the Stage.scaleMode property.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyEXACT_FIT:StageScaleMode = 0

    Specifies that the entire application be visible in the specified area without trying to preserve the original aspect ratio. Distortion can occur.

    @:value(cast 1)@:impl@:enuminlineread onlyNO_BORDER:StageScaleMode = 1

    Specifies that the entire application fill the specified area, without distortion but possibly with some cropping, while maintaining the original diff --git a/openfl/display/Tile.html b/openfl/display/Tile.html index c80a2ad..c31e38a 100644 --- a/openfl/display/Tile.html +++ b/openfl/display/Tile.html @@ -1,7 +1,7 @@ -openfl.display.Tile - API Referenceopenfl.display.Tile - OpenFL API Reference

    API Reference
    View source

    class Tile

    package openfl.display

    extended by TileContainer

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)

    Available on all platforms

    The Tile class is the base class for all objects that can be contained in a +

    View source

    class Tile

    package openfl.display

    extended by TileContainer

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)

    Available on all platforms

    The Tile class is the base class for all objects that can be contained in a ITileContainer object. Use the Tilemap or TileContainer class to arrange the tile objects in the tile list. Tilemap or TileContainer objects can contain tile' objects, while other the Tile class is a "leaf" node that have only parents and @@ -79,7 +79,7 @@ If a tile has a height of zero, no change is applied

    id:Int

    The ID of the tile to draw from the Tileset

    matrix:Matrix

    A Matrix object containing values that alter the scaling, rotation, and translation of the tile object.

    If the matrix property is set to a value (not null), the x, y, -scaleX, scaleY and the rotation values will be overwritten.

    @:keeporiginX:Float

    Modifies the origin x coordinate for this tile, which is the center value +scaleX, scaleY and the rotation values will be overwritten.

    See also:

    @:keeporiginX:Float

    Modifies the origin x coordinate for this tile, which is the center value used when determining position, scale and rotation.

    @:keeporiginY:Float

    Modifies the origin y coordinate for this tile, which is the center value used when determining position, scale and rotation.

    read onlyparent:TileContainer

    Indicates the ITileContainer object that contains this display object. Use the parent property to specify a relative path to diff --git a/openfl/display/TileContainer.html b/openfl/display/TileContainer.html index 061b9ec..6aff04a 100644 --- a/openfl/display/TileContainer.html +++ b/openfl/display/TileContainer.html @@ -1,7 +1,7 @@ -openfl.display.TileContainer - API Referenceopenfl.display.TileContainer - OpenFL API Reference

    View source

    class TileContainer

    package openfl.display

    extends Tile

    implements ITileContainer

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)

    Available on all platforms

    The TileContainer type is a special kind of Tile that can hold +

    View source

    class TileContainer

    package openfl.display

    extends Tile

    implements ITileContainer

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)

    Available on all platforms

    The TileContainer type is a special kind of Tile that can hold other tiles within it.

    Tile and TileContainer objects can be rendered by adding them to a Tilemap instance.

    Constructor

    @:value({ originY : 0, originX : 0, rotation : 0, scaleY : 1, scaleX : 1, y : 0, x : 0 })new(x:Float = 0, y:Float = 0, scaleX:Float = 1, scaleY:Float = 1, rotation:Float = 0, originX:Float = 0, originY:Float = 0)

    Variables

    read onlynumTiles:Int

    Returns the number of tiles of this object.

    Methods

    addTile(tile:Tile):Tile

    Adds a Tile instance to this TileContainer instance. The tile is @@ -117,7 +117,7 @@ If a tile has a height of zero, no change is applied

    id:Int

    The ID of the tile to draw from the Tileset

    matrix:Matrix

    A Matrix object containing values that alter the scaling, rotation, and translation of the tile object.

    If the matrix property is set to a value (not null), the x, y, -scaleX, scaleY and the rotation values will be overwritten.

    @:keeporiginX:Float

    Modifies the origin x coordinate for this tile, which is the center value +scaleX, scaleY and the rotation values will be overwritten.

    See also:

    @:keeporiginX:Float

    Modifies the origin x coordinate for this tile, which is the center value used when determining position, scale and rotation.

    @:keeporiginY:Float

    Modifies the origin y coordinate for this tile, which is the center value used when determining position, scale and rotation.

    read onlyparent:TileContainer

    Indicates the ITileContainer object that contains this display object. Use the parent property to specify a relative path to diff --git a/openfl/display/Tilemap.html b/openfl/display/Tilemap.html index 7d071a5..02e8b90 100644 --- a/openfl/display/Tilemap.html +++ b/openfl/display/Tilemap.html @@ -1,7 +1,7 @@ -openfl.display.Tilemap - API Referenceopenfl.display.Tilemap - OpenFL API Reference

    API Reference
    View source

    class Tilemap

    package openfl.display

    extends DisplayObject › EventDispatcher

    implements ITileContainer

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Tile)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)

    Available on all platforms

    The Tilemap class represents a "quad batch", or series of objects that are +

    View source

    class Tilemap

    package openfl.display

    extends DisplayObject › EventDispatcher

    implements ITileContainer

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Tile)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)

    Available on all platforms

    The Tilemap class represents a "quad batch", or series of objects that are rendered from the same bitmap. The Tilemap class is designed to encourage the use of a single Tileset reference for best performance, but it is possible to use unique Tileset references for each Tile or TileContainer within a @@ -132,7 +132,7 @@ specified index positions in the tile list. All other tile objects in the tile container remain in the same index positions.

    Parameters:

    index1

    The index position of the first tile object.

    index2

    The index position of the second tile object.

    Inherited Variables

    Defined by DisplayObject

    @:keepalpha:Float

    Indicates the alpha transparency value of the object specified. Valid values are 0 (fully transparent) to 1 (fully opaque). The default value is 1. -Display objects with alpha set to 0 are active, even though they are invisible.

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A +Display objects with alpha set to 0 are active, even though they are invisible.

    See also:

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A bitmap can be drawn internally in two ways. If you have a blend mode enabled or an external clipping mask, the bitmap is drawn by adding a bitmap-filled square shape to the vector render. If you attempt to set @@ -152,7 +152,7 @@ BlendMode class defines string values you can use. The illustrations in the table show blendMode values applied to a circular display object(2) superimposed on another display object(1).

    -

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn +

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    See also:

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn to the bitmap instead of the main display. If cacheAsBitmapMatrix is null or unsupported, the bitmap is then copied to the main display as unstretched, unrotated pixels snapped @@ -183,12 +183,12 @@ number of pixels cannot exceed 16,777,215 pixels.(So, if a bitmap image is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is is 2880 pixels in height and 2,880 pixels -in width.

  • The bitmap fails to allocate(out of memory error).
    • +in width.
  • The bitmap fails to allocate (out of memory error).

    • The cacheAsBitmap property is best used with movie clips that have mostly static content and that do not scale and rotate frequently. With such movie clips, cacheAsBitmap can lead to -performance increases when the movie clip is translated(when its x -and y position is changed).

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to +performance increases when the movie clip is translated (when its x +and y position is changed).

    See also:

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. The application uses this matrix as a transformation matrix that is applied when rendering the bitmap version of the display object.

    Adobe AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop @@ -222,16 +222,16 @@

    Note: The cacheAsBitmapMatrix property is suitable for 2D transformations. If you need to apply transformations in 3D, you may do so by setting a 3D property of the object and manipulating its transform.matrix3D property. If the application is packaged using GPU mode, this allows the 3D transforms -to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated +to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    See also:

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated with the display object. The openfl.filters package contains several classes that define specific filters you can use.

    Filters can be applied in Flash Professional at design time, or at run -time by using ActionScript code. To apply a filter by using ActionScript, +time by using Haxe code. To apply a filter by using Haxe, you must make a temporary copy of the entire filters array, modify the temporary array, then assign the value of the temporary array back to the filters array. You cannot directly add a new filter object to the filters array.

    -

    To add a filter by using ActionScript, perform the following steps +

    To add a filter by using Haxe, perform the following steps (assume that the target display object is named myDisplayObject):

    1. Create a new filter object by using the constructor method of your chosen filter class.
    2. Assign the value of the myDisplayObject.filters array @@ -262,7 +262,7 @@

      The openfl.filters package includes classes for filters. For example, to create a DropShadow filter, you would write:

      Throws:

      ArgumentError

      When filters includes a ShaderFilter and the shader output type is not compatible with -this operation(the shader must specify a +this operation (the shader must specify a pixel4 output).

      ArgumentError

      When filters includes a ShaderFilter and the shader doesn't specify any image input or the first input is not an image4 input.

      ArgumentError

      When filters includes a ShaderFilter @@ -280,10 +280,10 @@ is adjusted accordingly, as shown in the following code:

      Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a height of 0, even if you try to -set height to a different value.

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file +set height to a different value.

      See also:

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file to which this display object belongs. The loaderInfo property is defined only for the root display object of a SWF file or for a loaded -Bitmap(not for a Bitmap that is drawn with ActionScript). To find the +Bitmap (not for a Bitmap that is drawn with Haxe). To find the loaderInfo object associated with the SWF file that contains a display object named myDisplayObject, use myDisplayObject.root.loaderInfo.

      @@ -295,7 +295,7 @@ list. The mask object itself is not drawn. Set mask to null to remove the mask.

      To be able to scale a mask object, it must be on the display list. To -be able to drag a mask Sprite object(by calling its +be able to drag a mask Sprite object (by calling its startDrag() method), it must be on the display list. To call the startDrag() method for a mask sprite based on a mouseDown event being dispatched by the sprite, set the @@ -314,23 +314,23 @@ more than one calling display object. When the mask is assigned to a second display object, it is removed as the mask of the first object, and that object's mask property becomes -null.

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in +null.

      See also:

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned x -coordinate will reflect the non-rotated object.

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in +coordinate will reflect the non-rotated object.

      See also:

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned y -coordinate will reflect the non-rotated object.

      name:String

      Indicates the instance name of the DisplayObject. The object can be +coordinate will reflect the non-rotated object.

      See also:

      name:String

      Indicates the instance name of the DisplayObject. The object can be identified in the child list of its parent display object container by calling the getChildByName() method of the display object container.

      Throws:

      IllegalOperationError

      If you are attempting to set this property on an object that was placed on the timeline in the Flash authoring tool.

      opaqueBackground:Null<Int>

      Specifies whether the display object is opaque with a certain background color. A transparent bitmap contains alpha channel data and is drawn -transparently. An opaque bitmap has no alpha channel(and renders faster +transparently. An opaque bitmap has no alpha channel (and renders faster than a transparent bitmap). If the bitmap is opaque, you specify its own background color to use.

      -

      If set to a number value, the surface is opaque(not transparent) with +

      If set to a number value, the surface is opaque (not transparent) with the RGB background color that the number specifies. If set to null(the default value), the display object has a transparent background.

      @@ -342,7 +342,7 @@

      The opaque background region is not matched when calling the hitTestPoint() method with the shapeFlag parameter set to true.

      -

      The opaque background region does not respond to mouse events.

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display +

      The opaque background region does not respond to mouse events.

      See also:

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display object. Use the parent property to specify a relative path to display objects that are above the current display object in the display list hierarchy.

      @@ -351,7 +351,7 @@ 
      this.parent.parent.alpha = 20;

      Throws:

      SecurityError

      The parent display object belongs to a security sandbox to which you do not have access. You can avoid this situation by having the parent movie call -the Security.allowDomain() method.

      read onlyroot:DisplayObject

      For a display object in a loaded SWF file, the root property +the Security.allowDomain() method.

      See also:

    read onlyroot:DisplayObject

    For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. For a Bitmap object representing a loaded image file, the root property is the Bitmap object @@ -364,7 +364,7 @@ is a child of the top-most display object in a loaded SWF file.

    For example, if you create a new Sprite object by calling the Sprite() constructor method, its root property -is null until you add it to the display list(or to a display +is null until you add it to the display list (or to a display object container that is off the display list but that is a child of the top-most display object in a SWF file).

    For a loaded SWF file, even though the Loader object used to load the @@ -372,12 +372,12 @@ SWF file has its root property set to itself. The Loader object does not have its root property set until it is added as a child of a display object for which the root property is -set.

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its +set.

    See also:

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement my_video.rotation = 450 -is the same as my_video.rotation = 90.

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, +is the same as my_video.rotation = 90.

    See also:

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, the entire display object is scaled normally when any scale transformation is applied.

    When you define the scale9Grid property, the display @@ -405,11 +405,11 @@ the registration point. The default registration point is (0,0). 1.0 equals 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the +y property values, which are defined in whole pixels.

    See also:

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. The default registration point is (0,0). 1.0 is 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is +y property values, which are defined in whole pixels.

    See also:

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is cropped to the size defined by the rectangle, and it scrolls within the rectangle when you change the x and y properties of the scrollRect object.

    @@ -426,17 +426,17 @@ an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated 90° and you scroll it left and right, the display object actually scrolls -up and down.

    @:betashader:Shader

    BETA**

    +up and down.

    See also:

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to apply a post-process effect to multiple display objects at once, enable cacheAsBitmap or use the filters property with a ShaderFilter

    read onlystage:Stage

    The Stage of the display object. A Flash runtime application has only one Stage object. For example, you can create and load multiple display objects into the display list, and the stage property of each -display object refers to the same Stage object(even if the display object +display object refers to the same Stage object (even if the display object belongs to a loaded SWF file).

    If a display object is not added to the display list, its -stage property is set to null.

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color +stage property is set to null.

    See also:

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. The specific properties - matrix, colorTransform, and three read-only properties (concatenatedMatrix, concatenatedColorTransform, @@ -473,21 +473,21 @@ is adjusted accordingly, as shown in the following code:

    Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a width of 0, even if you try to set -width to a different value.

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative +width to a different value.

    See also:

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative +registration point position.

    See also:

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative +registration point position.

    See also:

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. Consider the following code, which shows how the rectangle returned can vary depending on the targetCoordinateSpace parameter that @@ -514,8 +514,8 @@ coordinates, respectively.

    Parameters:

    targetCoordinateSpace

    The display object that defines the coordinate system to use.

    Returns:

    The rectangle that defines the area of the display object relative to the targetCoordinateSpace object's coordinate -system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage(global) coordinates -to the display object's(local) coordinates.

    +system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage (global) coordinates +to the display object's (local) coordinates.

    To use this method, first create an instance of the Point class. The x and y values that you assign represent global coordinates because they relate to the origin(0,0) of the main display area. Then @@ -530,17 +530,17 @@ point specified by the x and y parameters. The x and y parameters specify a point in the coordinate space of the Stage, not the display object container that -contains the display object(unless that display object container is the +contains the display object (unless that display object container is the Stage).

    Parameters:

    x

    The x coordinate to test against this object.

    y

    The y coordinate to test against this object.

    shapeFlag

    Whether to check against the actual pixels of the object (true) or the bounding box (false).

    Returns:

    true if the display object overlaps or intersects with the specified point; false otherwise.

    invalidate():Void

    Calling the invalidate() method signals to have the current object -redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's(local) -coordinates to the Stage(global) coordinates.

    +redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's (local) +coordinates to the Stage (global) coordinates.

    This method allows you to convert any given x and y coordinates from values that are relative to the origin(0,0) of a -specific display object(local coordinates) to values that are relative to -the origin of the Stage(global coordinates).

    +specific display object (local coordinates) to values that are relative to +the origin of the Stage (global coordinates).

    To use this method, first create an instance of the Point class. The x and y values that you assign represent local coordinates because they relate to the origin of the display object.

    diff --git a/openfl/display/Tileset.html b/openfl/display/Tileset.html index 0d156da..868d28e 100644 --- a/openfl/display/Tileset.html +++ b/openfl/display/Tileset.html @@ -1,7 +1,7 @@ -openfl.display.Tileset - API Referenceopenfl.display.Tileset - OpenFL API Reference
    View source

    class Tileset

    package openfl.display

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.geom.Rectangle)

    Available on all platforms

    The Tileset class lets you specify logical rectangles within a larger +

    View source

    class Tileset

    package openfl.display

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.geom.Rectangle)

    Available on all platforms

    The Tileset class lets you specify logical rectangles within a larger BitmapData object, to be rendered using a Tilemap instance.

    The Tileset() constructor allows you to create a Tileset object that contains a reference to a BitmapData object. After you create a diff --git a/openfl/display/Timeline.html b/openfl/display/Timeline.html index d5f1ea8..cadd460 100644 --- a/openfl/display/Timeline.html +++ b/openfl/display/Timeline.html @@ -1,7 +1,7 @@ -openfl.display.Timeline - API Referenceopenfl.display.Timeline - OpenFL API Reference

    View source

    class Timeline

    package openfl.display

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Provides support for MovieClip animations (or a single frame Sprite) when +

    View source

    class Timeline

    package openfl.display

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Provides support for MovieClip animations (or a single frame Sprite) when this class is overridden.

    For example, the OpenFL SWF library provides a Timeline generated from SWF assets. However, any editor that may provide UI or display elements could @@ -66,7 +66,7 @@ which can be overridden to implement a new type of Timeline:

    attachMovieClip(); enterFrame(); -initializeSprite();

    Variables

    frameRate:Null<Float>

    The original frame rate for this Timeline.

    scenes:Array<Scene>

    An Array of Scenes contained within this Timeline.

    +initializeSprite();

    Variables

    frameRate:Null<Float>

    The original frame rate for this Timeline.

    scenes:Array<Scene>

    An Array of Scenes contained within this Timeline.

    Scenes are assumed to occur in order, so if the first Scene contains 10 frames, then the beginning of the second Scene will be treated as frame 11 when setting FrameScripts or implementing diff --git a/openfl/display/TriangleCulling.html b/openfl/display/TriangleCulling.html index c8cde99..2244c0c 100644 --- a/openfl/display/TriangleCulling.html +++ b/openfl/display/TriangleCulling.html @@ -1,7 +1,7 @@ -openfl.display.TriangleCulling - API Referenceopenfl.display.TriangleCulling - OpenFL API Reference

    View source

    enum abstract TriangleCulling(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    Defines codes for culling algorithms that determine which triangles not to +

    View source

    enum abstract TriangleCulling(Null<Int>)

    package openfl.display

    @:enum

    Available on all platforms

    Defines codes for culling algorithms that determine which triangles not to render when drawing triangle paths.

    The terms POSITIVE and NEGATIVE refer to the sign of a triangle's normal along the z-axis. The normal is a 3D vector diff --git a/openfl/display/Window.html b/openfl/display/Window.html index 4637705..3c57417 100644 --- a/openfl/display/Window.html +++ b/openfl/display/Window.html @@ -1,7 +1,7 @@ -openfl.display.Window - API Referenceopenfl.display.Window - OpenFL API Reference

    View source

    class Window

    package openfl.display

    extends Window

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.LoaderInfo)@:access(openfl.display.Stage)@SuppressWarnings("checkstyle:FieldDocComment")

    Available on all platforms

    The Window class is a Lime Window instance that automatically +

    View source

    class Window

    package openfl.display

    extends Window

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.LoaderInfo)@:access(openfl.display.Stage)@SuppressWarnings("checkstyle:FieldDocComment")

    Available on all platforms

    The Window class is a Lime Window instance that automatically initializes an OpenFL stage for the current window.

    Methods

    \ No newline at end of file diff --git a/openfl/display/index.html b/openfl/display/index.html index 87c7d40..5c5ce02 100644 --- a/openfl/display/index.html +++ b/openfl/display/index.html @@ -1,7 +1,7 @@ -openfl.display - API Reference

    openfl.display

    -
    ..
    AVM1Movie

    AVM1Movie is a simple class that represents AVM1 movie clips, which use +

    openfl.display

    Here are some selections from the OpenFL Developer's Guide to help you get started with the openfl.display package:

    ..
    AVM1Movie

    AVM1Movie is a simple class that represents AVM1 movie clips, which use ActionScript 1.0 or 2.0. (AVM1 is the ActionScript virtual machine used to run ActionScript 1.0 and 2.0. AVM2 is the ActionScript virtual machine used to run ActionScript 3.0.) When a Flash Player 8, or older, SWF file @@ -161,7 +128,22 @@

    package ::full::

    point of the triangle. The triangle vertices do not contain z coordinates and do not necessarily represent 3D faces. However a triangle path can be used to support the -rendering of 3D geometry in a 2D space.

    IBitmapDrawable

    IGraphicsData

    IGraphicsFill

    IGraphicsPath

    IGraphicsStroke

    ITileContainer

    ITileContainer is an interface implemented by compatible tile container +rendering of 3D geometry in a 2D space.

    IBitmapDrawable

    The IBitmapDrawable interface is implemented by objects that can be passed +as the source parameter of the draw() method of the BitmapData class. +These objects are of type BitmapData or DisplayObject.

    IGraphicsData

    This interface is used to define objects that can be used as parameters in +the openfl.display.Graphics methods, including fills, strokes, and paths. +Use the implementor classes of this interface to create and manage drawing +property data, and to reuse the same data for different instances. Then, use +the methods of the Graphics class to render the drawing objects.

    IGraphicsFill

    This interface is used to define objects that can be used as fill parameters +in the openfl.display.Graphics methods and drawing classes. Use the +implementor classes of this interface to create and manage fill property +data, and to reuse the same data for different instances.

    IGraphicsPath

    This interface is used to define objects that can be used as path parameters +in the openfl.display.Graphics methods and drawing classes. Use the +implementor classes of this interface to create and manage path property +data, and to reuse the same data for different instances.

    IGraphicsStroke

    This interface is used to define objects that can be used as strok +parameters in the openfl.display.Graphics methods and drawing classes. Use +the implementor classes of this interface to create and manage stroke +property data, and to reuse the same data for different instances.

    ITileContainer

    ITileContainer is an interface implemented by compatible tile container objects, including the Tilemap and TileContainer classes.

    InteractiveObject

    The InteractiveObject class is the abstract base class for all display objects with which the user can interact, using the mouse, keyboard, or other user input device.

    InterpolationMethod

    The InterpolationMethod class provides values for the @@ -192,8 +174,16 @@

    package ::full::

    openfl.display.BitmapData.encode() method.

    PixelSnapping

    The PixelSnapping class is an enumeration of constant values for setting the pixel snapping options by using the pixelSnapping property of a Bitmap object.

    Preloader

    The Preloader class is a Lime Preloader instance that uses an OpenFL -display object to display loading progress.

    Scene

    Screen

    The Screen class provides information about the display screens available to -this application.

    Shader

    // TODO: Document GLSL Shaders +display object to display loading progress.

    Scene

    The Scene class includes properties for identifying the name, labels, and +number of frames in a scene. A Scene object instance is created in Adobe +Animate (formerly Adobe Flash Professional), not by writing ActionScript +code. The MovieClip class includes a currentScene property, which is a +Scene object that identifies the scene in which the playhead is located in +the timeline of the MovieClip instance. The scenes property of the +MovieClip class is an array of Scene objects. Also, the gotoAndPlay() and +gotoAndStop() methods of the MovieClip class use Scene objects as +parameters.

    Screen

    The Screen class provides information about the display screens available to +this application.

    ScreenMode

    The ScreenMode object provides information about the width, height and refresh rate of a Screen.

    Shader

    // TODO: Document GLSL Shaders A Shader instance represents a Pixel Bender shader kernel in ActionScript. To use a shader in your application, you create a Shader instance for it. You then use that Shader instance in the appropriate way according to the @@ -247,8 +237,8 @@

    package ::full::

    of the precision modes for executing shader operations. The precision mode selection affects the following shader operations. These operations are faster on an Intel processor with the SSE instruction -set:

    Shape

    This class is used to create lightweight shapes using the ActionScript -drawing application program interface(API). The Shape class includes a +set:

    Shape

    This class is used to create lightweight shapes using the OpenFL +drawing application program interface (API). The Shape class includes a graphics property, which lets you access methods from the Graphics class.

    SimpleButton

    The SimpleButton class lets you control all instances of button symbols in a SWF file.

    SpreadMethod

    The SpreadMethod class provides values for the spreadMethod diff --git a/openfl/display3D/Context3D.html b/openfl/display3D/Context3D.html index 6082190..14caf19 100644 --- a/openfl/display3D/Context3D.html +++ b/openfl/display3D/Context3D.html @@ -1,7 +1,7 @@ -openfl.display3D.Context3D - API Referenceopenfl.display3D.Context3D - OpenFL API Reference

    API Reference
    View source

    final class Context3D

    package openfl.display3D

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D._internal.Context3DState)@:access(openfl.display3D.textures.CubeTexture)@:access(openfl.display3D.textures.RectangleTexture)@:access(openfl.display3D.textures.TextureBase)@:access(openfl.display3D.textures.Texture)@:access(openfl.display3D.textures.VideoTexture)@:access(openfl.display3D.IndexBuffer3D)@:access(openfl.display3D.Program3D)@:access(openfl.display3D.VertexBuffer3D)@:access(openfl.display.BitmapData)@:access(openfl.display.Bitmap)@:access(openfl.display.DisplayObjectRenderer)@:access(openfl.display.Shader)@:access(openfl.display.Stage)@:access(openfl.display.Stage3D)@:access(openfl.geom.Point)@:access(openfl.geom.Rectangle)@:final

    Available on all platforms

    The Context3D class provides a context for rendering geometrically defined graphics. +

    View source

    final class Context3D

    package openfl.display3D

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D._internal.Context3DState)@:access(openfl.display3D.textures.CubeTexture)@:access(openfl.display3D.textures.RectangleTexture)@:access(openfl.display3D.textures.TextureBase)@:access(openfl.display3D.textures.Texture)@:access(openfl.display3D.textures.VideoTexture)@:access(openfl.display3D.IndexBuffer3D)@:access(openfl.display3D.Program3D)@:access(openfl.display3D.VertexBuffer3D)@:access(openfl.display.BitmapData)@:access(openfl.display.Bitmap)@:access(openfl.display.DisplayObjectRenderer)@:access(openfl.display.Shader)@:access(openfl.display.Stage)@:access(openfl.display.Stage3D)@:access(openfl.geom.Point)@:access(openfl.geom.Rectangle)@:final

    Available on all platforms

    The Context3D class provides a context for rendering geometrically defined graphics. A rendering context includes a drawing surface and its associated resources and state. When possible, the rendering context uses the hardware graphics processing unit (GPU). Otherwise, the rendering context uses software. (If rendering through @@ -741,7 +741,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/display3D/Context3DBlendFactor.html b/openfl/display3D/Context3DBlendFactor.html index 700e6f6..618d701 100644 --- a/openfl/display3D/Context3DBlendFactor.html +++ b/openfl/display3D/Context3DBlendFactor.html @@ -1,7 +1,7 @@ -openfl.display3D.Context3DBlendFactor - API Reference

    View source

    enum abstract Context3DBlendFactor(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying the source and destination blend factors.

    +
    View source

    enum abstract Context3DBlendFactor(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying the source and destination blend factors.

    A blend factor represents a particular four-value vector that is multiplied with the source or destination color in the blending formula. The blending formula is:

    result = source * sourceFactor + destination * destinationFactor
    diff --git a/openfl/display3D/Context3DBufferUsage.html b/openfl/display3D/Context3DBufferUsage.html index e6ce033..10e909a 100644 --- a/openfl/display3D/Context3DBufferUsage.html +++ b/openfl/display3D/Context3DBufferUsage.html @@ -1,7 +1,7 @@ -openfl.display3D.Context3DBufferUsage - API Reference
    View source

    enum abstract Context3DBufferUsage(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying the buffer usage type.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyDYNAMIC_DRAW:Context3DBufferUsage = 0

    Indicates the buffer will be used for drawing and be updated frequently

    @:value(cast 1)@:impl@:enuminlineread onlySTATIC_DRAW:Context3DBufferUsage = 1

    Indicates the buffer will be used for drawing and be updated once

    +
    View source

    enum abstract Context3DBufferUsage(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying the buffer usage type.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyDYNAMIC_DRAW:Context3DBufferUsage = 0

    Indicates the buffer will be used for drawing and be updated frequently

    @:value(cast 1)@:impl@:enuminlineread onlySTATIC_DRAW:Context3DBufferUsage = 1

    Indicates the buffer will be used for drawing and be updated once

    This type is the default value for buffers in Stage3D.

    \ No newline at end of file diff --git a/openfl/display3D/Context3DClearMask.html b/openfl/display3D/Context3DClearMask.html index 27656bf..f12f134 100644 --- a/openfl/display3D/Context3DClearMask.html +++ b/openfl/display3D/Context3DClearMask.html @@ -1,7 +1,7 @@ -openfl.display3D.Context3DClearMask - API Reference
    View source

    enum abstract Context3DClearMask(UInt)

    package openfl.display3D

    from UInt, Int to UInt, Int

    @:enum

    Available on all platforms

    Defines the values to use for specifying Context3D clear masks.

    Variables

    @:value(cast 0x07)@:impl@:enuminlineread onlyALL:Context3DClearMask = 0x07

    Clear all buffers.

    @:value(cast 0x01)@:impl@:enuminlineread onlyCOLOR:Context3DClearMask = 0x01

    Clear only the color buffer.

    @:value(cast 0x02)@:impl@:enuminlineread onlyDEPTH:Context3DClearMask = 0x02

    Clear only the depth buffer.

    @:value(cast 0x04)@:impl@:enuminlineread onlySTENCIL:Context3DClearMask = 0x04

    Clear only the stencil buffer.

    \ No newline at end of file +
    View source

    enum abstract Context3DClearMask(UInt)

    package openfl.display3D

    from UInt, Int to UInt, Int

    @:enum

    Available on all platforms

    Defines the values to use for specifying Context3D clear masks.

    Variables

    @:value(cast 0x07)@:impl@:enuminlineread onlyALL:Context3DClearMask = 0x07

    Clear all buffers.

    @:value(cast 0x01)@:impl@:enuminlineread onlyCOLOR:Context3DClearMask = 0x01

    Clear only the color buffer.

    @:value(cast 0x02)@:impl@:enuminlineread onlyDEPTH:Context3DClearMask = 0x02

    Clear only the depth buffer.

    @:value(cast 0x04)@:impl@:enuminlineread onlySTENCIL:Context3DClearMask = 0x04

    Clear only the stencil buffer.

    \ No newline at end of file diff --git a/openfl/display3D/Context3DCompareMode.html b/openfl/display3D/Context3DCompareMode.html index 73f7c1b..d54b9f3 100644 --- a/openfl/display3D/Context3DCompareMode.html +++ b/openfl/display3D/Context3DCompareMode.html @@ -1,7 +1,7 @@ -openfl.display3D.Context3DCompareMode - API Referenceopenfl.display3D.Context3DCompareMode - OpenFL API Reference
    View source

    enum abstract Context3DCompareMode(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying 3D buffer comparisons in the +

    View source

    enum abstract Context3DCompareMode(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying 3D buffer comparisons in the setDepthTest() and setStencilAction() methods of a Context3D instance.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyALWAYS:Context3DCompareMode = 0

    The comparison always evaluates as true.

    @:value(cast 1)@:impl@:enuminlineread onlyEQUAL:Context3DCompareMode = 1

    Equal (==).

    @:value(cast 2)@:impl@:enuminlineread onlyGREATER:Context3DCompareMode = 2

    Greater than (>).

    @:value(cast 3)@:impl@:enuminlineread onlyGREATER_EQUAL:Context3DCompareMode = 3

    Greater than or equal (>=).

    @:value(cast 4)@:impl@:enuminlineread onlyLESS:Context3DCompareMode = 4

    Less than (<).

    @:value(cast 5)@:impl@:enuminlineread onlyLESS_EQUAL:Context3DCompareMode = 5

    Less than or equal (<=).

    @:value(cast 6)@:impl@:enuminlineread onlyNEVER:Context3DCompareMode = 6

    The comparison never evaluates as true.

    @:value(cast 7)@:impl@:enuminlineread onlyNOT_EQUAL:Context3DCompareMode = 7

    Not equal (!=).

    \ No newline at end of file diff --git a/openfl/display3D/Context3DMipFilter.html b/openfl/display3D/Context3DMipFilter.html index 7302baf..bed301b 100644 --- a/openfl/display3D/Context3DMipFilter.html +++ b/openfl/display3D/Context3DMipFilter.html @@ -1,7 +1,7 @@ -openfl.display3D.Context3DMipFilter - API Reference
    View source

    enum abstract Context3DMipFilter(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for sampler mipmap filter mode

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyMIPLINEAR:Context3DMipFilter = 0

    Select the two closest MIP levels and linearly blend between them (the highest +

    View source

    enum abstract Context3DMipFilter(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for sampler mipmap filter mode

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyMIPLINEAR:Context3DMipFilter = 0

    Select the two closest MIP levels and linearly blend between them (the highest quality mode, but has some performance cost).

    @:value(cast 1)@:impl@:enuminlineread onlyMIPNEAREST:Context3DMipFilter = 1

    Use the nearest neighbor metric to select MIP levels (the fastest rendering method).

    @:value(cast 2)@:impl@:enuminlineread onlyMIPNONE:Context3DMipFilter = 2

    Always use the top level texture (has a performance penalty when downscaling).

    \ No newline at end of file diff --git a/openfl/display3D/Context3DProfile.html b/openfl/display3D/Context3DProfile.html index 9c46150..d49fd54 100644 --- a/openfl/display3D/Context3DProfile.html +++ b/openfl/display3D/Context3DProfile.html @@ -1,7 +1,7 @@ -openfl.display3D.Context3DProfile - API Reference
    View source

    enum abstract Context3DProfile(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying the Context3D profile.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBASELINE:Context3DProfile = 0

    Use the default feature support profile.

    +
    View source

    enum abstract Context3DProfile(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying the Context3D profile.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBASELINE:Context3DProfile = 0

    Use the default feature support profile.

    This profile most closely resembles Stage3D support used in previous releases.

    @:value(cast 1)@:impl@:enuminlineread onlyBASELINE_CONSTRAINED:Context3DProfile = 1

    Use a constrained feature support profile to target older GPUs

    This profile is primarily targeted at devices that only support PS_2.0 level shaders like the Intel GMA 9xx series. In addition, this mode tries to improve diff --git a/openfl/display3D/Context3DProgramFormat.html b/openfl/display3D/Context3DProgramFormat.html index a901259..912a6ea 100644 --- a/openfl/display3D/Context3DProgramFormat.html +++ b/openfl/display3D/Context3DProgramFormat.html @@ -1,7 +1,7 @@ -openfl.display3D.Context3DProgramFormat - API Reference

    View source

    enum abstract Context3DProgramFormat(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying a Program3D source format.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyAGAL:Context3DProgramFormat = 0

    The program will use the AGAL (Adobe Graphics Assembly Language) format

    @:value(cast 1)@:impl@:enuminlineread onlyGLSL:Context3DProgramFormat = 1

    The program will use the GLSL (GL Shader Language) format

    \ No newline at end of file +
    View source

    enum abstract Context3DProgramFormat(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying a Program3D source format.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyAGAL:Context3DProgramFormat = 0

    The program will use the AGAL (Adobe Graphics Assembly Language) format

    @:value(cast 1)@:impl@:enuminlineread onlyGLSL:Context3DProgramFormat = 1

    The program will use the GLSL (GL Shader Language) format

    \ No newline at end of file diff --git a/openfl/display3D/Context3DProgramType.html b/openfl/display3D/Context3DProgramType.html index 9c8479f..065591a 100644 --- a/openfl/display3D/Context3DProgramType.html +++ b/openfl/display3D/Context3DProgramType.html @@ -1,7 +1,7 @@ -openfl.display3D.Context3DProgramType - API Referenceopenfl.display3D.Context3DProgramType - OpenFL API Reference
    View source

    enum abstract Context3DProgramType(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying whether a shader program is a fragment +

    View source

    enum abstract Context3DProgramType(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying whether a shader program is a fragment or a vertex program.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFRAGMENT:Context3DProgramType = 0

    A fragment (or pixel) program.

    @:value(cast 1)@:impl@:enuminlineread onlyVERTEX:Context3DProgramType = 1

    A vertex program.

    \ No newline at end of file diff --git a/openfl/display3D/Context3DRenderMode.html b/openfl/display3D/Context3DRenderMode.html index 095cfc1..a95c408 100644 --- a/openfl/display3D/Context3DRenderMode.html +++ b/openfl/display3D/Context3DRenderMode.html @@ -1,7 +1,7 @@ -openfl.display3D.Context3DRenderMode - API Reference
    View source

    enum abstract Context3DRenderMode(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying the Context3D render mode.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyAUTO:Context3DRenderMode = 0

    Automatically choose rendering engine.

    +
    View source

    enum abstract Context3DRenderMode(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying the Context3D render mode.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyAUTO:Context3DRenderMode = 0

    Automatically choose rendering engine.

    A hardware-accelerated rendering engine is used if available on the current device. Availability of hardware acceleration is influenced by the device capabilites, the wmode when running under Flash Player, and the render mode when diff --git a/openfl/display3D/Context3DStencilAction.html b/openfl/display3D/Context3DStencilAction.html index ab1a33d..24b4264 100644 --- a/openfl/display3D/Context3DStencilAction.html +++ b/openfl/display3D/Context3DStencilAction.html @@ -1,7 +1,7 @@ -openfl.display3D.Context3DStencilAction - API Reference

    View source

    enum abstract Context3DStencilAction(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying stencil actions.

    +
    View source

    enum abstract Context3DStencilAction(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying stencil actions.

    A stencil action specifies how the values in the stencil buffer should be changed.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyDECREMENT_SATURATE:Context3DStencilAction = 0

    Decrement the stencil buffer value, clamping at 0, the minimum value.

    @:value(cast 1)@:impl@:enuminlineread onlyDECREMENT_WRAP:Context3DStencilAction = 1

    Decrement the stencil buffer value. If the result is less than 0, the minimum value, then the buffer value is "wrapped around" to 255.

    @:value(cast 2)@:impl@:enuminlineread onlyINCREMENT_SATURATE:Context3DStencilAction = 2

    Increment the stencil buffer value, clamping at 255, the maximum value.

    @:value(cast 3)@:impl@:enuminlineread onlyINCREMENT_WRAP:Context3DStencilAction = 3

    Increment the stencil buffer value. If the result exceeds 255, the maximum value, then the buffer value is "wrapped around" to 0.

    @:value(cast 4)@:impl@:enuminlineread onlyINVERT:Context3DStencilAction = 4

    Invert the stencil buffer value, bitwise.

    diff --git a/openfl/display3D/Context3DTextureFilter.html b/openfl/display3D/Context3DTextureFilter.html index 531e1ee..e749cdd 100644 --- a/openfl/display3D/Context3DTextureFilter.html +++ b/openfl/display3D/Context3DTextureFilter.html @@ -1,7 +1,7 @@ -openfl.display3D.Context3DTextureFilter - API Reference
    View source

    enum abstract Context3DTextureFilter(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for sampler filter mode.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyANISOTROPIC16X:Context3DTextureFilter = 0

    Use anisotropic filter with radio 16 when upsampling textures

    @:value(cast 1)@:impl@:enuminlineread onlyANISOTROPIC2X:Context3DTextureFilter = 1

    Use anisotropic filter with radio 2 when upsampling textures

    @:value(cast 2)@:impl@:enuminlineread onlyANISOTROPIC4X:Context3DTextureFilter = 2

    Use anisotropic filter with radio 4 when upsampling textures

    @:value(cast 3)@:impl@:enuminlineread onlyANISOTROPIC8X:Context3DTextureFilter = 3

    Use anisotropic filter with radio 8 when upsampling textures

    @:value(cast 4)@:impl@:enuminlineread onlyLINEAR:Context3DTextureFilter = 4

    Use linear interpolation when upsampling textures (gives a smooth, blurry look).

    @:value(cast 5)@:impl@:enuminlineread onlyNEAREST:Context3DTextureFilter = 5

    Use nearest neighbor sampling when upsampling textures (gives a pixelated, +

    View source

    enum abstract Context3DTextureFilter(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for sampler filter mode.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyANISOTROPIC16X:Context3DTextureFilter = 0

    Use anisotropic filter with radio 16 when upsampling textures

    @:value(cast 1)@:impl@:enuminlineread onlyANISOTROPIC2X:Context3DTextureFilter = 1

    Use anisotropic filter with radio 2 when upsampling textures

    @:value(cast 2)@:impl@:enuminlineread onlyANISOTROPIC4X:Context3DTextureFilter = 2

    Use anisotropic filter with radio 4 when upsampling textures

    @:value(cast 3)@:impl@:enuminlineread onlyANISOTROPIC8X:Context3DTextureFilter = 3

    Use anisotropic filter with radio 8 when upsampling textures

    @:value(cast 4)@:impl@:enuminlineread onlyLINEAR:Context3DTextureFilter = 4

    Use linear interpolation when upsampling textures (gives a smooth, blurry look).

    @:value(cast 5)@:impl@:enuminlineread onlyNEAREST:Context3DTextureFilter = 5

    Use nearest neighbor sampling when upsampling textures (gives a pixelated, sharp mosaic look).

    \ No newline at end of file diff --git a/openfl/display3D/Context3DTextureFormat.html b/openfl/display3D/Context3DTextureFormat.html index 77da82c..ed61f81 100644 --- a/openfl/display3D/Context3DTextureFormat.html +++ b/openfl/display3D/Context3DTextureFormat.html @@ -1,7 +1,7 @@ -openfl.display3D.Context3DTextureFormat - API Reference
    View source

    enum abstract Context3DTextureFormat(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying a texture format.

    Variables

    @:value(cast 1)@:impl@:enuminlineread onlyBGRA:Context3DTextureFormat = 1

    32 bit

    @:value(cast 2)@:impl@:enuminlineread onlyBGRA_PACKED:Context3DTextureFormat = 2

    16 bit, bgra packed as 4:4:4:4

    @:value(cast 0)@:impl@:enuminlineread onlyBGR_PACKED:Context3DTextureFormat = 0

    16 bit, bgr packed as 5:6:5

    @:value(cast 3)@:impl@:enuminlineread onlyCOMPRESSED:Context3DTextureFormat = 3

    ATF (Adobe Texture Format)

    @:value(cast 4)@:impl@:enuminlineread onlyCOMPRESSED_ALPHA:Context3DTextureFormat = 4

    ATF (Adobe Texture Format), with alpha

    @:value(cast 5)@:impl@:enuminlineread onlyRGBA_HALF_FLOAT:Context3DTextureFormat = 5

    64 bit, rgba as 16:16:16:16

    \ No newline at end of file +
    View source

    enum abstract Context3DTextureFormat(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for specifying a texture format.

    Variables

    @:value(cast 1)@:impl@:enuminlineread onlyBGRA:Context3DTextureFormat = 1

    32 bit

    @:value(cast 2)@:impl@:enuminlineread onlyBGRA_PACKED:Context3DTextureFormat = 2

    16 bit, bgra packed as 4:4:4:4

    @:value(cast 0)@:impl@:enuminlineread onlyBGR_PACKED:Context3DTextureFormat = 0

    16 bit, bgr packed as 5:6:5

    @:value(cast 3)@:impl@:enuminlineread onlyCOMPRESSED:Context3DTextureFormat = 3

    ATF (Adobe Texture Format)

    @:value(cast 4)@:impl@:enuminlineread onlyCOMPRESSED_ALPHA:Context3DTextureFormat = 4

    ATF (Adobe Texture Format), with alpha

    @:value(cast 5)@:impl@:enuminlineread onlyRGBA_HALF_FLOAT:Context3DTextureFormat = 5

    64 bit, rgba as 16:16:16:16

    \ No newline at end of file diff --git a/openfl/display3D/Context3DTriangleFace.html b/openfl/display3D/Context3DTriangleFace.html index 42e73a2..017cc7f 100644 --- a/openfl/display3D/Context3DTriangleFace.html +++ b/openfl/display3D/Context3DTriangleFace.html @@ -1,7 +1,7 @@ -openfl.display3D.Context3DTriangleFace - API Reference
    View source

    enum abstract Context3DTriangleFace(Null<Int>)

    package openfl.display3D

    @:enum@SuppressWarnings("checkstyle:FieldDocComment")

    Available on all platforms

    Constants to specify the orientation of a triangle relative to the view point.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBACK:Context3DTriangleFace = 0

    @:value(cast 1)@:impl@:enuminlineread onlyFRONT:Context3DTriangleFace = 1

    @:value(cast 2)@:impl@:enuminlineread onlyFRONT_AND_BACK:Context3DTriangleFace = 2

    @:value(cast 3)@:impl@:enuminlineread onlyNONE:Context3DTriangleFace = 3

    \ No newline at end of file +
    View source

    enum abstract Context3DTriangleFace(Null<Int>)

    package openfl.display3D

    @:enum@SuppressWarnings("checkstyle:FieldDocComment")

    Available on all platforms

    Constants to specify the orientation of a triangle relative to the view point.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBACK:Context3DTriangleFace = 0

    @:value(cast 1)@:impl@:enuminlineread onlyFRONT:Context3DTriangleFace = 1

    @:value(cast 2)@:impl@:enuminlineread onlyFRONT_AND_BACK:Context3DTriangleFace = 2

    @:value(cast 3)@:impl@:enuminlineread onlyNONE:Context3DTriangleFace = 3

    \ No newline at end of file diff --git a/openfl/display3D/Context3DVertexBufferFormat.html b/openfl/display3D/Context3DVertexBufferFormat.html index b20c8c3..0fc9a01 100644 --- a/openfl/display3D/Context3DVertexBufferFormat.html +++ b/openfl/display3D/Context3DVertexBufferFormat.html @@ -1,7 +1,7 @@ -openfl.display3D.Context3DVertexBufferFormat - API Reference
    View source

    enum abstract Context3DVertexBufferFormat(Null<Int>)

    package openfl.display3D

    @:enum@SuppressWarnings("checkstyle:FieldDocComment")

    Available on all platforms

    Defines the values to use for specifying vertex buffers.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBYTES_4:Context3DVertexBufferFormat = 0

    @:value(cast 1)@:impl@:enuminlineread onlyFLOAT_1:Context3DVertexBufferFormat = 1

    @:value(cast 2)@:impl@:enuminlineread onlyFLOAT_2:Context3DVertexBufferFormat = 2

    @:value(cast 3)@:impl@:enuminlineread onlyFLOAT_3:Context3DVertexBufferFormat = 3

    @:value(cast 4)@:impl@:enuminlineread onlyFLOAT_4:Context3DVertexBufferFormat = 4

    \ No newline at end of file +
    View source

    enum abstract Context3DVertexBufferFormat(Null<Int>)

    package openfl.display3D

    @:enum@SuppressWarnings("checkstyle:FieldDocComment")

    Available on all platforms

    Defines the values to use for specifying vertex buffers.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBYTES_4:Context3DVertexBufferFormat = 0

    @:value(cast 1)@:impl@:enuminlineread onlyFLOAT_1:Context3DVertexBufferFormat = 1

    @:value(cast 2)@:impl@:enuminlineread onlyFLOAT_2:Context3DVertexBufferFormat = 2

    @:value(cast 3)@:impl@:enuminlineread onlyFLOAT_3:Context3DVertexBufferFormat = 3

    @:value(cast 4)@:impl@:enuminlineread onlyFLOAT_4:Context3DVertexBufferFormat = 4

    \ No newline at end of file diff --git a/openfl/display3D/Context3DWrapMode.html b/openfl/display3D/Context3DWrapMode.html index 71c2786..820d97a 100644 --- a/openfl/display3D/Context3DWrapMode.html +++ b/openfl/display3D/Context3DWrapMode.html @@ -1,7 +1,7 @@ -openfl.display3D.Context3DWrapMode - API Reference
    View source

    enum abstract Context3DWrapMode(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for sampler wrap mode

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyCLAMP:Context3DWrapMode = 0

    Clamp texture coordinates outside the 0..1 range.

    +
    View source

    enum abstract Context3DWrapMode(Null<Int>)

    package openfl.display3D

    @:enum

    Available on all platforms

    Defines the values to use for sampler wrap mode

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyCLAMP:Context3DWrapMode = 0

    Clamp texture coordinates outside the 0..1 range.

    The function is x = max(min(x,0),1)

    @:value(cast 1)@:impl@:enuminlineread onlyCLAMP_U_REPEAT_V:Context3DWrapMode = 1

    Clamp in U axis but Repeat in V axis.

    @:value(cast 2)@:impl@:enuminlineread onlyREPEAT:Context3DWrapMode = 2

    Repeat (tile) texture coordinates outside the 0..1 range.

    The function is x = x<0?1.0-frac(abs(x)):frac(x)

    @:value(cast 3)@:impl@:enuminlineread onlyREPEAT_U_CLAMP_V:Context3DWrapMode = 3

    Repeat in U axis but Clamp in V axis.

    \ No newline at end of file diff --git a/openfl/display3D/IndexBuffer3D.html b/openfl/display3D/IndexBuffer3D.html index f5c69ff..65b089b 100644 --- a/openfl/display3D/IndexBuffer3D.html +++ b/openfl/display3D/IndexBuffer3D.html @@ -1,7 +1,7 @@ -openfl.display3D.IndexBuffer3D - API Referenceopenfl.display3D.IndexBuffer3D - OpenFL API Reference
    View source

    final class IndexBuffer3D

    package openfl.display3D

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display.Stage)@:final

    Available on all platforms

    IndexBuffer3D is used to represent lists of vertex indices comprising graphic elements +

    View source

    final class IndexBuffer3D

    package openfl.display3D

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display.Stage)@:final

    Available on all platforms

    IndexBuffer3D is used to represent lists of vertex indices comprising graphic elements retained by the graphics subsystem.

    Indices managed by an IndexBuffer3D object may be used to select vertices from a vertex stream. Indices are 16-bit unsigned integers. The maximum allowable index diff --git a/openfl/display3D/Program3D.html b/openfl/display3D/Program3D.html index dd6cc46..2ac4868 100644 --- a/openfl/display3D/Program3D.html +++ b/openfl/display3D/Program3D.html @@ -1,7 +1,7 @@ -openfl.display3D.Program3D - API Referenceopenfl.display3D.Program3D - OpenFL API Reference

    View source

    final class Program3D

    package openfl.display3D

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display.ShaderInput)@:access(openfl.display.ShaderParameter)@:access(openfl.display.Stage)@:final

    Available on all platforms

    The Program3D class represents a pair of rendering programs (also called "shaders") +

    View source

    final class Program3D

    package openfl.display3D

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display.ShaderInput)@:access(openfl.display.ShaderParameter)@:access(openfl.display.Stage)@:final

    Available on all platforms

    The Program3D class represents a pair of rendering programs (also called "shaders") uploaded to the rendering context.

    Programs managed by a Program3D object control the entire rendering of triangles during a Context3D drawTriangles() call. Upload the binary bytecode to the rendering diff --git a/openfl/display3D/VertexBuffer3D.html b/openfl/display3D/VertexBuffer3D.html index 3e33480..f6a837d 100644 --- a/openfl/display3D/VertexBuffer3D.html +++ b/openfl/display3D/VertexBuffer3D.html @@ -1,7 +1,7 @@ -openfl.display3D.VertexBuffer3D - API Reference

    View source

    class VertexBuffer3D

    package openfl.display3D

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display.Stage)

    Available on all platforms

    The VertexBuffer3D class represents a set of vertex data uploaded to a rendering context.

    +
    View source

    class VertexBuffer3D

    package openfl.display3D

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display.Stage)

    Available on all platforms

    The VertexBuffer3D class represents a set of vertex data uploaded to a rendering context.

    Use a VertexBuffer3D object to define the data associated with each point in a set of vertexes. You can upload the vertex data either from a Vector array or a ByteArray. (Once uploaded, the data in the original array is no longer referenced; changing or diff --git a/openfl/display3D/index.html b/openfl/display3D/index.html index c8617fa..3828770 100644 --- a/openfl/display3D/index.html +++ b/openfl/display3D/index.html @@ -1,7 +1,7 @@ -openfl.display3D - API Reference

    openfl.display3D

    -
    ..
    textures
    Context3D

    The Context3D class provides a context for rendering geometrically defined graphics. +

    openfl.display3D

    ..
    textures
    Context3D

    The Context3D class provides a context for rendering geometrically defined graphics. A rendering context includes a drawing surface and its associated resources and state. When possible, the rendering context uses the hardware graphics processing unit (GPU). Otherwise, the rendering context uses software. (If rendering through diff --git a/openfl/display3D/textures/CubeTexture.html b/openfl/display3D/textures/CubeTexture.html index a7e2420..d111007 100644 --- a/openfl/display3D/textures/CubeTexture.html +++ b/openfl/display3D/textures/CubeTexture.html @@ -1,7 +1,7 @@ -openfl.display3D.textures.CubeTexture - API Reference

    View source

    final class CubeTexture

    package openfl.display3D.textures

    extends TextureBase › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display.Stage)@:access(openfl.events.Event)@:final

    Available on all platforms

    The CubeTexture class represents a cube texture uploaded to a rendering context.

    +
    View source

    final class CubeTexture

    package openfl.display3D.textures

    extends TextureBase › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display.Stage)@:access(openfl.events.Event)@:final

    Available on all platforms

    The CubeTexture class represents a cube texture uploaded to a rendering context.

    Defines a cube map texture for use during rendering. Cube mapping is used for many rendering techniques, such as environment maps, skyboxes, and skylight illumination.

    You cannot create a CubeTexture object directly; use the Context3D @@ -183,7 +183,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/display3D/textures/RectangleTexture.html b/openfl/display3D/textures/RectangleTexture.html index d1b1633..283fb9b 100644 --- a/openfl/display3D/textures/RectangleTexture.html +++ b/openfl/display3D/textures/RectangleTexture.html @@ -1,7 +1,7 @@ -openfl.display3D.textures.RectangleTexture - API Referenceopenfl.display3D.textures.RectangleTexture - OpenFL API Reference

    View source

    final class RectangleTexture

    package openfl.display3D.textures

    extends TextureBase › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display.Stage)@:final

    Available on all platforms

    The Rectangle Texture class represents a 2-dimensional texture uploaded to a rendering +

    View source

    final class RectangleTexture

    package openfl.display3D.textures

    extends TextureBase › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display.Stage)@:final

    Available on all platforms

    The Rectangle Texture class represents a 2-dimensional texture uploaded to a rendering context.

    Defines a 2D texture for use during rendering.

    Texture cannot be instantiated directly. Create instances by using Context3D @@ -142,7 +142,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/display3D/textures/Texture.html b/openfl/display3D/textures/Texture.html index 333ebde..f93c32e 100644 --- a/openfl/display3D/textures/Texture.html +++ b/openfl/display3D/textures/Texture.html @@ -1,7 +1,7 @@ -openfl.display3D.textures.Texture - API Reference

    View source

    final class Texture

    package openfl.display3D.textures

    extends TextureBase › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display.Stage)@:access(openfl.events.Event)@:final

    Available on all platforms

    The Texture class represents a 2-dimensional texture uploaded to a rendering context.

    +
    View source

    final class Texture

    package openfl.display3D.textures

    extends TextureBase › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display.Stage)@:access(openfl.events.Event)@:final

    Available on all platforms

    The Texture class represents a 2-dimensional texture uploaded to a rendering context.

    Defines a 2D texture for use during rendering.

    Texture cannot be instantiated directly. Create instances by using Context3D createTexture() method.

    Methods

    @:value({ async : false })uploadCompressedTextureFromByteArray(data:ByteArray, byteArrayOffset:UInt, async:Bool = false):Void

    Uploads a compressed texture in Adobe Texture Format (ATF) from a ByteArray @@ -169,7 +169,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/display3D/textures/TextureBase.html b/openfl/display3D/textures/TextureBase.html index 51f2745..7c59940 100644 --- a/openfl/display3D/textures/TextureBase.html +++ b/openfl/display3D/textures/TextureBase.html @@ -1,7 +1,7 @@ -openfl.display3D.textures.TextureBase - API Reference

    View source

    class TextureBase

    package openfl.display3D.textures

    extends EventDispatcher

    extended by CubeTexture, RectangleTexture, Texture, VideoTexture

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display._internal.SamplerState)@:access(openfl.display3D.Context3D)@:access(openfl.display.BitmapData)@:access(openfl.display.Stage)

    Available on all platforms

    The TextureBase class is the base class for Context3D texture objects.

    +
    View source

    class TextureBase

    package openfl.display3D.textures

    extends EventDispatcher

    extended by CubeTexture, RectangleTexture, Texture, VideoTexture

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display._internal.SamplerState)@:access(openfl.display3D.Context3D)@:access(openfl.display.BitmapData)@:access(openfl.display.Stage)

    Available on all platforms

    The TextureBase class is the base class for Context3D texture objects.

    Note: You cannot create your own texture classes using TextureBase. To add functionality to a texture class, extend either Texture or CubeTexture instead.

    Methods

    dispose():Void

    Frees all GPU resources associated with this texture. After disposal, calling upload() or rendering with this object fails.

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that @@ -128,7 +128,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/display3D/textures/VideoTexture.html b/openfl/display3D/textures/VideoTexture.html index ff27927..4fc2bac 100644 --- a/openfl/display3D/textures/VideoTexture.html +++ b/openfl/display3D/textures/VideoTexture.html @@ -1,7 +1,7 @@ -openfl.display3D.textures.VideoTexture - API Referenceopenfl.display3D.textures.VideoTexture - OpenFL API Reference

    API Reference
    View source

    final class VideoTexture

    package openfl.display3D.textures

    extends TextureBase › EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display.Stage)@:access(openfl.net.NetStream)@:access(openfl.events.Event)@:final

    Available on all platforms

    Prior to Flash Player 21, the use of video in Stage3D required the use of the Video +

    View source

    final class VideoTexture

    package openfl.display3D.textures

    extends TextureBase › EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.Context3D)@:access(openfl.display.Stage)@:access(openfl.net.NetStream)@:access(openfl.events.Event)@:final

    Available on all platforms

    Prior to Flash Player 21, the use of video in Stage3D required the use of the Video object (which is not hardware accelerated), copying of video frame to a BitmapData object, and loading of the data onto the GPU which is CPU intensive. Thus, Video texture object was introduced. It allows hardware decoded video to be used in Stage 3D @@ -155,7 +155,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/display3D/textures/index.html b/openfl/display3D/textures/index.html index 671735b..4368bd7 100644 --- a/openfl/display3D/textures/index.html +++ b/openfl/display3D/textures/index.html @@ -1,7 +1,7 @@ -openfl.display3D.textures - API Reference

    openfl.display3D.textures

    -
    ..
    CubeTexture

    The CubeTexture class represents a cube texture uploaded to a rendering context.

    RectangleTexture

    The Rectangle Texture class represents a 2-dimensional texture uploaded to a rendering +

    openfl.display3D.textures

    ..
    CubeTexture

    The CubeTexture class represents a cube texture uploaded to a rendering context.

    RectangleTexture

    The Rectangle Texture class represents a 2-dimensional texture uploaded to a rendering context.

    Texture

    The Texture class represents a 2-dimensional texture uploaded to a rendering context.

    TextureBase

    The TextureBase class is the base class for Context3D texture objects.

    VideoTexture

    Prior to Flash Player 21, the use of video in Stage3D required the use of the Video object (which is not hardware accelerated), copying of video frame to a BitmapData object, and loading of the data onto the GPU which is CPU intensive. Thus, Video diff --git a/openfl/errors/ArgumentError.html b/openfl/errors/ArgumentError.html index df036da..b65ca3a 100644 --- a/openfl/errors/ArgumentError.html +++ b/openfl/errors/ArgumentError.html @@ -1,7 +1,11 @@ -openfl.errors.ArgumentError - API Reference

    View source

    class ArgumentError

    package openfl.errors

    extends Error

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Constructor

    @:value({ message : "" })new(message:String = "")

    Inherited Variables

    Defined by Error

    read onlyerrorID:Int

    Contains the reference number associated with the specific error message. For a +

    View source

    class ArgumentError

    package openfl.errors

    extends Error

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The ArgumentError class represents an error that occurs when the arguments +supplied in a function do not match the arguments defined for that function. +This error occurs, for example, when a function is called with the wrong +number of arguments, an argument of the incorrect type, or an invalid +argument.

    Constructor

    @:value({ message : "" })new(message:String = "")

    Creates an ArgumentError object.

    Inherited Variables

    Defined by Error

    read onlyerrorID:Int

    Contains the reference number associated with the specific error message. For a custom Error object, this number is the value from the id parameter supplied in the constructor.

    name:String

    Contains the message associated with the Error object. By default, the value of this property is "Error". You can specify a message property when you create an diff --git a/openfl/errors/EOFError.html b/openfl/errors/EOFError.html index 27fec6e..1f57a6c 100644 --- a/openfl/errors/EOFError.html +++ b/openfl/errors/EOFError.html @@ -1,7 +1,7 @@ -openfl.errors.EOFError - API Referenceopenfl.errors.EOFError - OpenFL API Reference

    View source

    class EOFError

    package openfl.errors

    extends IOError › Error

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An EOFError exception is thrown when you attempt to read past the end of +

    View source

    class EOFError

    package openfl.errors

    extends IOError › Error

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An EOFError exception is thrown when you attempt to read past the end of the available data. For example, an EOFError is thrown when one of the read methods in the IDataInput interface is called and there is insufficient data to satisfy the read request.

    Constructor

    @:value({ id : 0, message : null })new(?message:String, id:Int = 0)

    Creates a new EOFError object.

    Parameters:

    message

    A string associated with the error object.

    Inherited Variables

    Defined by Error

    read onlyerrorID:Int

    Contains the reference number associated with the specific error message. For a diff --git a/openfl/errors/Error.html b/openfl/errors/Error.html index 9f4e2d1..0164a87 100644 --- a/openfl/errors/Error.html +++ b/openfl/errors/Error.html @@ -1,9 +1,9 @@ -openfl.errors.Error - API Referenceopenfl.errors.Error - OpenFL API Reference

    View source

    class Error

    package openfl.errors

    extends Exception

    extended by ArgumentError, IOError, IllegalOperationError, PermissionError, RangeError, SecurityError, TypeError

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Error class contains information about an error that occurred in a script. In -developing ActionScript 3.0 applications, when you run your compiled code in the -debugger version of a Flash runtime, a dialog box displays exceptions of type Error, +

    View source

    class Error

    package openfl.errors

    extends Exception

    extended by ArgumentError, IOError, IllegalOperationError, PermissionError, RangeError, SecurityError, TypeError

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Error class contains information about an error that occurred in a script. In +developing OpenFL applications, when you run your compiled code in a +debugger, a message displays exceptions of type Error, or of a subclass, to help you troubleshoot the code. You create an Error object by using the Error constructor function. Typically, you throw a new Error object from within a try code block that is caught by a catch code block.

    diff --git a/openfl/errors/IOError.html b/openfl/errors/IOError.html index 25c2da6..43de29f 100644 --- a/openfl/errors/IOError.html +++ b/openfl/errors/IOError.html @@ -1,7 +1,7 @@ -openfl.errors.IOError - API Referenceopenfl.errors.IOError - OpenFL API Reference
    View source

    class IOError

    package openfl.errors

    extends Error

    extended by EOFError

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The IOError exception is thrown when some type of input or output failure +

    View source

    class IOError

    package openfl.errors

    extends Error

    extended by EOFError

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The IOError exception is thrown when some type of input or output failure occurs. For example, an IOError exception is thrown if a read/write operation is attempted on a socket that has not connected or that has become disconnected.

    Constructor

    @:value({ message : "" })new(message:String = "")

    Creates a new IOError object.

    Parameters:

    message

    A string associated with the error object.

    Inherited Variables

    Defined by Error

    read onlyerrorID:Int

    Contains the reference number associated with the specific error message. For a diff --git a/openfl/errors/IllegalOperationError.html b/openfl/errors/IllegalOperationError.html index f7b6b5e..32b42d4 100644 --- a/openfl/errors/IllegalOperationError.html +++ b/openfl/errors/IllegalOperationError.html @@ -1,7 +1,7 @@ -openfl.errors.IllegalOperationError - API Referenceopenfl.errors.IllegalOperationError - OpenFL API Reference

    View source

    class IllegalOperationError

    package openfl.errors

    extends Error

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The IllegalOperationError exception is thrown when a method is not +

    View source

    class IllegalOperationError

    package openfl.errors

    extends Error

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The IllegalOperationError exception is thrown when a method is not implemented or the implementation doesn't cover the current usage.

    Examples of illegal operation error exceptions include:

    • A base class, such as DisplayObjectContainer, provides more -functionality than a Stage can support(such as masks)
    • Certain accessibility methods are called when the player is compiled -without accessibility support
    • The mms.cfg setting prohibits a FileReference action
    • ActionScript tries to run a FileReference.browse() call -when a browse dialog box is already open
    • ActionScript tries to use an unsupported protocol for a FileReference +functionality than a Stage can support (such as masks)
    • Certain accessibility methods are called when the player is compiled +without accessibility support
    • The mms.cfg setting prohibits a FileReference action
    • Haxe code tries to run a FileReference.browse() call +when a browse dialog box is already open
    • Haxe code tries to use an unsupported protocol for a FileReference object(such as FTP)
    • Authoring-only features are invoked from a run-time player
    • An attempt is made to set the name of a Timeline-placed object

    Constructor

    @:value({ message : "" })new(message:String = "")

    Creates a new IllegalOperationError object.

    Parameters:

    message

    A string associated with the error object.

    Inherited Variables

    Defined by Error

    read onlyerrorID:Int

    Contains the reference number associated with the specific error message. For a diff --git a/openfl/errors/PermissionError.html b/openfl/errors/PermissionError.html index 7f41107..b1fba5b 100644 --- a/openfl/errors/PermissionError.html +++ b/openfl/errors/PermissionError.html @@ -1,7 +1,7 @@ -openfl.errors.PermissionError - API Referenceopenfl.errors.PermissionError - OpenFL API Reference

    View source

    class PermissionError

    package openfl.errors

    extends Error

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Permission error is dispatched when the application tries to access a +

    View source

    class PermissionError

    package openfl.errors

    extends Error

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Permission error is dispatched when the application tries to access a resource without requesting appropriate permissions.

    Constructor

    @:value({ id : 0, message : "" })new(message:String = "", id:Int = 0)

    Creates a new instance of the PermissionError class.

    Parameters:

    message

    The error description

    id

    The general error number

    Inherited Variables

    Defined by Error

    read onlyerrorID:Int

    Contains the reference number associated with the specific error message. For a custom Error object, this number is the value from the id parameter supplied in the constructor.

    name:String

    Contains the message associated with the Error object. By default, the value of diff --git a/openfl/errors/RangeError.html b/openfl/errors/RangeError.html index 35ef205..ec53e3f 100644 --- a/openfl/errors/RangeError.html +++ b/openfl/errors/RangeError.html @@ -1,7 +1,8 @@ -openfl.errors.RangeError - API Reference

    View source

    class RangeError

    package openfl.errors

    extends Error

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Constructor

    @:value({ message : "" })new(message:String = "")

    Inherited Variables

    Defined by Error

    read onlyerrorID:Int

    Contains the reference number associated with the specific error message. For a +

    View source

    class RangeError

    package openfl.errors

    extends Error

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    A RangeError exception is thrown when a numeric value is outside the +acceptable range.

    +

    Some situations that cause this exception to be thrown include the +following:

    • Any OpenFL API that expects a depth number is invoked with an invalid depth number.
    • Any OpenFL API that expects a frame number is invoked with an invalid frame number.
    • Any OpenFL API that expects a layer number is invoked with an invalid layer number.

    Constructor

    @:value({ message : "" })new(message:String = "")

    Inherited Variables

    Defined by Error

    read onlyerrorID:Int

    Contains the reference number associated with the specific error message. For a custom Error object, this number is the value from the id parameter supplied in the constructor.

    name:String

    Contains the message associated with the Error object. By default, the value of this property is "Error". You can specify a message property when you create an diff --git a/openfl/errors/SecurityError.html b/openfl/errors/SecurityError.html index f9a27d2..1469db4 100644 --- a/openfl/errors/SecurityError.html +++ b/openfl/errors/SecurityError.html @@ -1,7 +1,8 @@ -openfl.errors.SecurityError - API Reference

    View source

    class SecurityError

    package openfl.errors

    extends Error

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Constructor

    @:value({ message : "" })new(message:String = "")

    Inherited Variables

    Defined by Error

    read onlyerrorID:Int

    Contains the reference number associated with the specific error message. For a +

    View source

    class SecurityError

    package openfl.errors

    extends Error

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The SecurityError exception is thrown when some type of security violation +takes place.

    +

    Examples of security errors:

    • An unauthorized property access or method call is made across a security sandbox boundary.
    • An attempt was made to access a URL not permitted by the security sandbox.
    • A socket connection was attempted to an unauthorized port number, e.g. a port above 65535.
    • An attempt was made to access the user's camera or microphone, and the request to access the device was denied by the user.

    Constructor

    @:value({ message : "" })new(message:String = "")

    Inherited Variables

    Defined by Error

    read onlyerrorID:Int

    Contains the reference number associated with the specific error message. For a custom Error object, this number is the value from the id parameter supplied in the constructor.

    name:String

    Contains the message associated with the Error object. By default, the value of this property is "Error". You can specify a message property when you create an diff --git a/openfl/errors/TypeError.html b/openfl/errors/TypeError.html index 6221930..31ab36d 100644 --- a/openfl/errors/TypeError.html +++ b/openfl/errors/TypeError.html @@ -1,7 +1,8 @@ -openfl.errors.TypeError - API Reference

    View source

    class TypeError

    package openfl.errors

    extends Error

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Constructor

    @:value({ message : "" })new(message:String = "")

    Inherited Variables

    Defined by Error

    read onlyerrorID:Int

    Contains the reference number associated with the specific error message. For a +

    View source

    class TypeError

    package openfl.errors

    extends Error

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    A TypeError exception is thrown when the actual type of an operand is +different from the expected type.

    Constructor

    @:value({ message : "" })new(message:String = "")

    Inherited Variables

    Defined by Error

    read onlyerrorID:Int

    Contains the reference number associated with the specific error message. For a custom Error object, this number is the value from the id parameter supplied in the constructor.

    name:String

    Contains the message associated with the Error object. By default, the value of this property is "Error". You can specify a message property when you create an diff --git a/openfl/errors/index.html b/openfl/errors/index.html index bdf1bc2..f92cdeb 100644 --- a/openfl/errors/index.html +++ b/openfl/errors/index.html @@ -1,7 +1,7 @@ -openfl.errors - API Reference

    openfl.errors

    -
    ..
    ArgumentError

    EOFError

    An EOFError exception is thrown when you attempt to read past the end of +

    openfl.errors

    Here are some selections from the Haxe Manual to help you get started with the openfl.errors package:

    ..
    ArgumentError

    The ArgumentError class represents an error that occurs when the arguments +supplied in a function do not match the arguments defined for that function. +This error occurs, for example, when a function is called with the wrong +number of arguments, an argument of the incorrect type, or an invalid +argument.

    EOFError

    An EOFError exception is thrown when you attempt to read past the end of the available data. For example, an EOFError is thrown when one of the read methods in the IDataInput interface is called and there is insufficient data to satisfy the read request.

    Error

    The Error class contains information about an error that occurred in a script. In -developing ActionScript 3.0 applications, when you run your compiled code in the -debugger version of a Flash runtime, a dialog box displays exceptions of type Error, +developing OpenFL applications, when you run your compiled code in a +debugger, a message displays exceptions of type Error, or of a subclass, to help you troubleshoot the code. You create an Error object by using the Error constructor function. Typically, you throw a new Error object from within a try code block that is caught by a catch code block.

    IOError

    The IOError exception is thrown when some type of input or output failure @@ -98,4 +69,7 @@

    package ::full::

    operation is attempted on a socket that has not connected or that has become disconnected.

    IllegalOperationError

    The IllegalOperationError exception is thrown when a method is not implemented or the implementation doesn't cover the current usage.

    PermissionError

    Permission error is dispatched when the application tries to access a -resource without requesting appropriate permissions.

    RangeError

    SecurityError

    TypeError

    \ No newline at end of file +resource without requesting appropriate permissions.

    RangeError

    A RangeError exception is thrown when a numeric value is outside the +acceptable range.

    SecurityError

    The SecurityError exception is thrown when some type of security violation +takes place.

    TypeError

    A TypeError exception is thrown when the actual type of an operand is +different from the expected type.

    \ No newline at end of file diff --git a/openfl/events/AccelerometerEvent.html b/openfl/events/AccelerometerEvent.html index d168b05..0b6f5dd 100644 --- a/openfl/events/AccelerometerEvent.html +++ b/openfl/events/AccelerometerEvent.html @@ -1,7 +1,7 @@ -openfl.events.AccelerometerEvent - API Referenceopenfl.events.AccelerometerEvent - OpenFL API Reference
    View source

    class AccelerometerEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Accelerometer class dispatches AccelerometerEvent objects when +

    View source

    class AccelerometerEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Accelerometer class dispatches AccelerometerEvent objects when acceleration updates are obtained from the Accelerometer sensor installed on the device.

    Static variables

    @:value("update")staticinlineread onlyUPDATE:EventType<AccelerometerEvent> = "update"

    Defines the value of the type property of a AccelerometerEvent event object. @@ -101,7 +101,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -126,13 +126,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/ActivityEvent.html b/openfl/events/ActivityEvent.html index 1124fc2..66c00bf 100644 --- a/openfl/events/ActivityEvent.html +++ b/openfl/events/ActivityEvent.html @@ -1,7 +1,7 @@ -openfl.events.ActivityEvent - API Referenceopenfl.events.ActivityEvent - OpenFL API Reference
    View source

    class ActivityEvent

    package openfl.events

    extends Event

    extended by FullScreenEvent

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    A Camera or Microphone object dispatches an ActivityEvent object whenever +

    View source

    class ActivityEvent

    package openfl.events

    extends Event

    extended by FullScreenEvent

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    A Camera or Microphone object dispatches an ActivityEvent object whenever a camera or microphone reports that it has become active or inactive. There is only one type of activity event: ActivityEvent.ACTIVITY.

    Static variables

    @:value("activity")staticinlineread onlyACTIVITY:EventType<ActivityEvent> = "activity"

    The ActivityEvent.ACTIVITY constant defines the value of the type property of an activity event object. @@ -90,7 +90,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -115,13 +115,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/AsyncErrorEvent.html b/openfl/events/AsyncErrorEvent.html index 89a8b46..2173b5f 100644 --- a/openfl/events/AsyncErrorEvent.html +++ b/openfl/events/AsyncErrorEvent.html @@ -1,7 +1,7 @@ -openfl.events.AsyncErrorEvent - API Referenceopenfl.events.AsyncErrorEvent - OpenFL API Reference
    View source

    class AsyncErrorEvent

    package openfl.events

    extends ErrorEvent › TextEvent › Event

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An object dispatches an AsyncErrorEvent when an exception is thrown from +

    View source

    class AsyncErrorEvent

    package openfl.events

    extends ErrorEvent › TextEvent › Event

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An object dispatches an AsyncErrorEvent when an exception is thrown from native asynchronous code, which could be from, for example, LocalConnection, NetConnection, SharedObject, or NetStream. There is only one type of asynchronous error event: AsyncErrorEvent.ASYNC_ERROR.

    Static variables

    @:value("asyncError")staticinlineread onlyASYNC_ERROR:EventType<AsyncErrorEvent> = "asyncError"

    The AsyncErrorEvent.ASYNC_ERROR constant defines the value of the type property of an asyncError event object. -This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event object with an event listener.
    targetThe object dispatching the event.
    errorThe error that triggered the event.

    Constructor

    @:value({ error : null, text : "", cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, text:String = "", ?error:Error)

    Creates an AsyncErrorEvent object that contains information about +This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event object with an event listener.
    targetThe object dispatching the event.
    errorThe error that triggered the event.

    Constructor

    @:value({ error : null, text : "", cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, text:String = "", ?error:Dynamic)

    Creates an AsyncErrorEvent object that contains information about asyncError events. AsyncErrorEvent objects are passed as parameters to event listeners.

    Parameters:

    type

    The type of the event. Event listeners can access this information through the inherited type @@ -73,7 +73,7 @@ listeners can access this information through the text property.

    error

    The exception that occurred. If error is non-null, the event's errorId property is set from the -error's errorId property.

    Variables

    error:Error

    The exception that was thrown.

    Methods

    Inherited Variables

    Defined by ErrorEvent

    read onlyerrorID:Int

    Contains the reference number associated with the specific error. For a +error's errorId property.

    Variables

    error:Dynamic

    The exception that was thrown.

    Methods

    Inherited Variables

    Defined by ErrorEvent

    read onlyerrorID:Int

    Contains the reference number associated with the specific error. For a custom ErrorEvent object, this number is the value from the id parameter supplied in the constructor.

    Defined by TextEvent

    text:String

    For a textInput event, the character or sequence of characters entered by the user. For a link event, the text of @@ -97,7 +97,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -122,13 +122,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/ContextMenuEvent.html b/openfl/events/ContextMenuEvent.html index 43090eb..564bc96 100644 --- a/openfl/events/ContextMenuEvent.html +++ b/openfl/events/ContextMenuEvent.html @@ -1,7 +1,7 @@ -openfl.events.ContextMenuEvent - API Referenceopenfl.events.ContextMenuEvent - OpenFL API Reference
    API Reference
    View source

    class ContextMenuEvent

    package openfl.events

    extends Event

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An InteractiveObject dispatches a ContextMenuEvent object when the user +

    View source

    class ContextMenuEvent

    package openfl.events

    extends Event

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An InteractiveObject dispatches a ContextMenuEvent object when the user opens or interacts with the context menu. There are two types of ContextMenuEvent objects: ContextMenuEvent.MENU_ITEM_SELECT @@ -109,7 +109,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -134,13 +134,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/DNSResolverEvent.html b/openfl/events/DNSResolverEvent.html index f66da74..1846387 100644 --- a/openfl/events/DNSResolverEvent.html +++ b/openfl/events/DNSResolverEvent.html @@ -1,7 +1,7 @@ -openfl.events.DNSResolverEvent - API Referenceopenfl.events.DNSResolverEvent - OpenFL API Reference
    View source

    class DNSResolverEvent

    package openfl.events

    extends Event

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The DNSResolverEvent class represents the results of a Domain Name System +

    View source

    class DNSResolverEvent

    package openfl.events

    extends Event

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The DNSResolverEvent class represents the results of a Domain Name System (DNS) lookup operation.

    Use the DNSResolver lookup() method to initiate a DNS query. Resource records returned by the query are placed in the resourceRecords array of @@ -79,7 +79,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -104,15 +104,15 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    toString():String

    Returns a string containing all the properties of the Event object. The string is in the following format:

    [Event type=_value_ bubbles=_value_ diff --git a/openfl/events/DataEvent.html b/openfl/events/DataEvent.html index 3cc5e7b..1592a4e 100644 --- a/openfl/events/DataEvent.html +++ b/openfl/events/DataEvent.html @@ -1,7 +1,7 @@ -openfl.events.DataEvent - API Referenceopenfl.events.DataEvent - OpenFL API Reference

    API Reference
    View source

    class DataEvent

    package openfl.events

    extends TextEvent › Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An object dispatches a DataEvent object when raw data has completed +

    View source

    class DataEvent

    package openfl.events

    extends TextEvent › Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An object dispatches a DataEvent object when raw data has completed loading. There are two types of data event: DataEvent.DATA: dispatched for data sent or received. DataEvent.UPLOAD_COMPLETE_DATA: dispatched when data is sent and the @@ -96,7 +96,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -121,13 +121,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/DatagramSocketDataEvent.html b/openfl/events/DatagramSocketDataEvent.html index b2b1db3..3b5b00b 100644 --- a/openfl/events/DatagramSocketDataEvent.html +++ b/openfl/events/DatagramSocketDataEvent.html @@ -1,7 +1,7 @@ -openfl.events.DatagramSocketDataEvent - API Reference
    View source

    class DatagramSocketDataEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    A DatagramSocketDataEvent object is dispatched when Datagram socket has received data.

    Static variables

    @:value("data")staticinlineread onlyDATA:EventType<DatagramSocketDataEvent> = "data"

    Defines the value of the type property of a data event object.

    Constructor

    @:value({ data : null, dstPort : 0, dstAddress : "", srcPort : 0, srcAddress : "", cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, srcAddress:String = "", srcPort:Int = 0, dstAddress:String = "", dstPort:Int = 0, ?data:ByteArray)

    Creates an Event object that contains information about datagram events. Event objects are passed as parameters +

    View source

    class DatagramSocketDataEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    A DatagramSocketDataEvent object is dispatched when Datagram socket has received data.

    Static variables

    @:value("data")staticinlineread onlyDATA:EventType<DatagramSocketDataEvent> = "data"

    Defines the value of the type property of a data event object.

    Constructor

    @:value({ data : null, dstPort : 0, dstAddress : "", srcPort : 0, srcAddress : "", cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, srcAddress:String = "", srcPort:Int = 0, dstAddress:String = "", dstPort:Int = 0, ?data:ByteArray)

    Creates an Event object that contains information about datagram events. Event objects are passed as parameters to event listeners.

    Parameters:

    type

    The type of the event. Possible values are:DatagramSocketDataEvent.DATA

    bubbles

    Determines whether the Event object participates in the bubbling stage of the event flow.

    cancelable

    Determines whether the Event object can be canceled.

    srcAddress

    The IP address of the machine that sent the packet.

    srcPort

    The port on the machine that sent the packet.

    dstAddress

    The IP address to which the packet is addressed.

    dstPort

    The port to which the packet is addressed.

    data

    The datagram packet data.

    Variables

    read onlydata:ByteArray

    The datagram packet data.

    read onlydstAddress:String

    The IP address of the DatagramSocket object that dispatched this event.

    Note: If the socket is bound to the special address: 0.0.0.0, then this property will return 0.0.0.0. In order to know the specific IP to which the datagram message is sent, you must bind @@ -76,7 +76,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -101,13 +101,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/DeviceRotationEvent.html b/openfl/events/DeviceRotationEvent.html index 5b0672d..f738efc 100644 --- a/openfl/events/DeviceRotationEvent.html +++ b/openfl/events/DeviceRotationEvent.html @@ -1,7 +1,7 @@ -openfl.events.DeviceRotationEvent - API Referenceopenfl.events.DeviceRotationEvent - OpenFL API Reference
    View source

    class DeviceRotationEvent

    package openfl.events

    extends Event

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The DeviceRotation class dispatches DeviceRotationEvent and returns roll, +

    View source

    class DeviceRotationEvent

    package openfl.events

    extends Event

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The DeviceRotation class dispatches DeviceRotationEvent and returns roll, yaw, pitch and quaternion data when DeviceRotation updates are obtained from the combined readings from Accelerometer and Gyroscope sensors' readings installed on the device.

    See also:

    Static variables

    @:value("update")staticinlineread onlyUPDATE:EventType<DeviceRotationEvent> = "update"

    Defines the value of the type property of a update event object.

    Constructor

    @:value({ quaternion : null, yaw : 0, pitch : 0, roll : 0, timestamp : 0, cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, timestamp:Float = 0, roll:Float = 0, pitch:Float = 0, yaw:Float = 0, ?quaternion:Array<Float>)

    Creates an DeviceRotationEvent object that contains information about @@ -82,7 +82,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -107,15 +107,15 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    toString():String

    Returns a string containing all the properties of the Event object. The string is in the following format:

    [Event type=_value_ bubbles=_value_ diff --git a/openfl/events/ErrorEvent.html b/openfl/events/ErrorEvent.html index 6fcdc88..d754127 100644 --- a/openfl/events/ErrorEvent.html +++ b/openfl/events/ErrorEvent.html @@ -1,7 +1,7 @@ -openfl.events.ErrorEvent - API Referenceopenfl.events.ErrorEvent - OpenFL API Reference

    View source

    class ErrorEvent

    package openfl.events

    extends TextEvent › Event

    extended by AsyncErrorEvent, IOErrorEvent, SecurityErrorEvent, UncaughtErrorEvent

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An object dispatches an ErrorEvent object when an error causes an +

    View source

    class ErrorEvent

    package openfl.events

    extends TextEvent › Event

    extended by AsyncErrorEvent, IOErrorEvent, SecurityErrorEvent, UncaughtErrorEvent

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An object dispatches an ErrorEvent object when an error causes an asynchronous operation to fail.

    The ErrorEvent class defines only one type of error event: ErrorEvent.ERROR. The ErrorEvent class also serves as the base @@ -65,7 +65,7 @@ (UncaughtErrorEvent.UNCAUGHT_ERROR) event.

    An uncaught error also causes an error dialog box displaying the error event to appear when content is running in the debugger version of Flash -Player or the AIR Debug Launcher(ADL) application.

    Static variables

    @:value("error")staticinlineread onlyERROR:EventType<ErrorEvent> = "error"

    Defines the value of the type property of an error event object. +Player or the AIR Debug Launcher (ADL) application.

    Static variables

    @:value("error")staticinlineread onlyERROR:EventType<ErrorEvent> = "error"

    Defines the value of the type property of an error event object. This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event object with an event listener.
    targetThe object experiencing a network operation failure.
    textText to be displayed as an error message.

    Constructor

    @:value({ id : 0, text : "", cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, text:String = "", id:Int = 0)

    Creates an Event object that contains information about error events. Event objects are passed as parameters to event listeners.

    Parameters:

    type

    The type of the event. Event listeners can access this information through the inherited type @@ -101,7 +101,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -126,13 +126,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/Event.html b/openfl/events/Event.html index ed9a3e8..e00374b 100644 --- a/openfl/events/Event.html +++ b/openfl/events/Event.html @@ -1,7 +1,7 @@ -openfl.events.Event - API Referenceopenfl.events.Event - OpenFL API Reference
    View source

    class Event

    package openfl.events

    extended by AccelerometerEvent, ActivityEvent, ContextMenuEvent, DNSResolverEvent, DatagramSocketDataEvent, DeviceRotationEvent, FileListEvent, FocusEvent, GameInputEvent, GeolocationEvent, HTTPStatusEvent, InvokeEvent, KeyboardEvent, MouseEvent, NativeProcessExitEvent, NativeWindowBoundsEvent, NativeWindowDisplayStateEvent, NetStatusEvent, OutputProgressEvent, PermissionEvent, ProgressEvent, RenderEvent, SampleDataEvent, ServerSocketConnectEvent, TextEvent, TimerEvent, TouchEvent, VideoTextureEvent

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Event class is used as the base class for the creation of Event +

    View source

    class Event

    package openfl.events

    extended by AccelerometerEvent, ActivityEvent, ContextMenuEvent, DNSResolverEvent, DatagramSocketDataEvent, DeviceRotationEvent, FileListEvent, FocusEvent, GameInputEvent, GeolocationEvent, HTTPStatusEvent, InvokeEvent, KeyboardEvent, MouseEvent, NativeProcessExitEvent, NativeWindowBoundsEvent, NativeWindowDisplayStateEvent, NetStatusEvent, OutputProgressEvent, PermissionEvent, ProgressEvent, RenderEvent, SampleDataEvent, ServerSocketConnectEvent, TextEvent, TimerEvent, TouchEvent, VideoTextureEvent

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Event class is used as the base class for the creation of Event objects, which are passed as parameters to event listeners when an event occurs.

    The properties of the Event class carry basic information about an @@ -66,7 +66,7 @@ location of the click event and whether any keys were pressed during the click event. You can pass such additional information to event listeners by extending the Event class, which is what the MouseEvent class does. -ActionScript 3.0 API defines several Event subclasses for common events +The OpenFL API defines several Event subclasses for common events that require additional information. Events associated with each of the Event subclasses are described in the documentation for each class.

    The methods of the Event class can be used in event listener functions @@ -83,7 +83,7 @@ Flash Player Mental Model - The Elastic Racetrack.

  • A blog entry by Johannes Tacskovics about the timing of frame events, such as ENTER_FRAME, EXIT_FRAME: The MovieClip Lifecycle.
  • An article by Trevor McCauley about the order of ActionScript operations: Order of Operations in ActionScript.
  • A blog entry by Matt Przybylski on creating custom events: -AS3: Custom Events.

    • Static variables

    @:value("activate")staticinlineread onlyACTIVATE:EventType<Event> = "activate"

    The ACTIVATE constant defines the value of the type property of an +AS3: Custom Events.

    See also:

    Static variables

    @:value("activate")staticinlineread onlyACTIVATE:EventType<Event> = "activate"

    The ACTIVATE constant defines the value of the type property of an activate event object. Note: This event has neither a "capture phase" nor a "bubble phase", which means that event listeners must be added directly to any @@ -272,7 +272,7 @@

    In this example, PingEvent is a subclass of Event and therefore implements its own version of clone().

    Returns:

    A new Event object that is identical to the original.

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -297,15 +297,15 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    toString():String

    Returns a string containing all the properties of the Event object. The string is in the following format:

    [Event type=_value_ bubbles=_value_ diff --git a/openfl/events/EventDispatcher.html b/openfl/events/EventDispatcher.html index bd52674..e85db67 100644 --- a/openfl/events/EventDispatcher.html +++ b/openfl/events/EventDispatcher.html @@ -1,7 +1,7 @@ -openfl.events.EventDispatcher - API Referenceopenfl.events.EventDispatcher - OpenFL API Reference

    API Reference
    View source

    class EventDispatcher

    package openfl.events

    implements IEventDispatcher

    extended by Icon, NativeApplication, NativeProcess, DisplayObject, DisplayObjectRenderer, FrameLabel, LoaderInfo, NativeWindow, Screen, ShaderJob, Stage3D, TextureBase, Context3D, UncaughtErrorEvents, FileStream, Sound, SoundChannel, DNSResolver, DatagramSocket, FileReference, FileReferenceList, NetConnection, NetStream, ServerSocket, SharedObject, Socket, URLLoader, URLStream, XMLSocket, Accelerometer, StageText, StyleSheet, GameInput, GameInputControl, Timer

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.events.Event)

    Available on all platforms

    The EventDispatcher class is the base class for all classes that dispatch +

    View source

    class EventDispatcher

    package openfl.events

    implements IEventDispatcher

    extended by Icon, NativeApplication, NativeProcess, DisplayObject, DisplayObjectRenderer, FrameLabel, LoaderInfo, NativeWindow, Screen, ShaderJob, Stage3D, TextureBase, Context3D, UncaughtErrorEvents, FileStream, Sound, SoundChannel, DNSResolver, DatagramSocket, FileReference, FileReferenceList, NetConnection, NetStream, ServerSocket, SharedObject, Socket, URLLoader, URLStream, XMLSocket, Accelerometer, StageText, StyleSheet, GameInput, GameInputControl, Timer

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Stage)@:access(openfl.events.Event)@:access(openfl.events.UncaughtErrorEvents)

    Available on all platforms

    The EventDispatcher class is the base class for all classes that dispatch events. The EventDispatcher class implements the IEventDispatcher interface and is the base class for the DisplayObject class. The EventDispatcher class allows any object on the display list to be an event target and as @@ -89,7 +89,7 @@ that it is dispatched by all EventDispatcher objects with a listener registered for this event. For more information about broadcast events, see the DisplayObject -class.

    Constructor

    @:value({ target : null })new(?target:IEventDispatcher)

    Aggregates an instance of the EventDispatcher class.

    +class.

    See also:

    Constructor

    @:value({ target : null })new(?target:IEventDispatcher)

    Aggregates an instance of the EventDispatcher class.

    The EventDispatcher class is generally used as a base class, which means that most developers do not need to use this constructor function. However, advanced developers who are implementing the IEventDispatcher @@ -175,7 +175,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/events/EventPhase.html b/openfl/events/EventPhase.html index 56eb767..2dbf972 100644 --- a/openfl/events/EventPhase.html +++ b/openfl/events/EventPhase.html @@ -1,7 +1,7 @@ -openfl.events.EventPhase - API Referenceopenfl.events.EventPhase - OpenFL API Reference

    View source

    enum abstract EventPhase(Int)

    package openfl.events

    from Int, UInt to Int, UInt

    @:enum

    Available on all platforms

    The EventPhase class provides values for the eventPhase -property of the Event class.

    Variables

    @:value(cast 2)@:impl@:enuminlineread onlyAT_TARGET:EventPhase = 2

    The target phase, which is the second phase of the event flow.

    @:value(cast 3)@:impl@:enuminlineread onlyBUBBLING_PHASE:EventPhase = 3

    The bubbling phase, which is the third phase of the event flow.

    @:value(cast 1)@:impl@:enuminlineread onlyCAPTURING_PHASE:EventPhase = 1

    The capturing phase, which is the first phase of the event flow.

    \ No newline at end of file +
    View source

    enum abstract EventPhase(Int)

    package openfl.events

    from Int, UInt to Int, UInt

    @:enum

    Available on all platforms

    The EventPhase class provides values for the eventPhase +property of the Event class.

    See also:

    Variables

    @:value(cast 2)@:impl@:enuminlineread onlyAT_TARGET:EventPhase = 2

    The target phase, which is the second phase of the event flow.

    @:value(cast 3)@:impl@:enuminlineread onlyBUBBLING_PHASE:EventPhase = 3

    The bubbling phase, which is the third phase of the event flow.

    @:value(cast 1)@:impl@:enuminlineread onlyCAPTURING_PHASE:EventPhase = 1

    The capturing phase, which is the first phase of the event flow.

    \ No newline at end of file diff --git a/openfl/events/EventType.html b/openfl/events/EventType.html index ba31737..f35a6c6 100644 --- a/openfl/events/EventType.html +++ b/openfl/events/EventType.html @@ -1,7 +1,7 @@ -openfl.events.EventType - API Referenceopenfl.events.EventType - OpenFL API Reference
    View source

    abstract EventType<T>(String)

    package openfl.events

    from String to String

    Available on all platforms

    The EventType abstract type provides type safety when +

    View source

    abstract EventType<T>(String)

    package openfl.events

    from String to String

    Available on all platforms

    The EventType abstract type provides type safety when matching dispatch events with the correct type of listener

    For example, the following code has the wrong type in the event listener, it should be a MouseEvent:

    addEventListener(MouseEvent.CLICK, function(event:TouchEvent) {});

    OpenFL uses the EventType abstract for standard event types -to turn these logical errors into a compile-time errors.

    \ No newline at end of file +to turn these logical errors into a compile-time errors.

    See also:

    \ No newline at end of file diff --git a/openfl/events/FileListEvent.html b/openfl/events/FileListEvent.html index 7e08927..323c9a4 100644 --- a/openfl/events/FileListEvent.html +++ b/openfl/events/FileListEvent.html @@ -1,7 +1,10 @@ -openfl.events.FileListEvent - API Reference
    View source

    class FileListEvent

    package openfl.events

    extends Event

    @:directlyUsed

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    Static variables

    @:value("directoryListing")staticinlineread onlyDIRECTORY_LISTING:EventType<FileListEvent> = "directoryListing"

    @:value("selectMultiple")staticinlineread onlySELECT_MULTIPLE:EventType<FileListEvent> = "selectMultiple"

    Constructor

    @:value({ cancelable : false, bubbles : false })new(type:String, files:Array<File>, bubbles:Bool = false, cancelable:Bool = false)

    Variables

    files:Array<File>

    Methods

    Inherited Variables

    Defined by Event

    read onlybubbles:Bool

    Indicates whether an event is a bubbling event. If the event can bubble, +

    View source

    class FileListEvent

    package openfl.events

    extends Event

    @:directlyUsed

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    A File object dispatches a FileListEvent object when a call to the +getDirectoryListingAsync() method of a File object successfully enumerates +a set of files and directories or when a user selects files after a call to +the browseForOpenMultiple() method.

    See also:

    Static variables

    @:value("directoryListing")staticinlineread onlyDIRECTORY_LISTING:EventType<FileListEvent> = "directoryListing"

    The FileListEvent.DIRECTORY_LISTING constant defines the value of the +type property of the event object for a directoryListing event.

    @:value("selectMultiple")staticinlineread onlySELECT_MULTIPLE:EventType<FileListEvent> = "selectMultiple"

    The FileListEvent.SELECT_MULTIPLE constant defines the value of the +type property of the event object for a selectMultiple event.

    Constructor

    @:value({ cancelable : false, bubbles : false })new(type:String, files:Array<File>, bubbles:Bool = false, cancelable:Bool = false)

    The constructor function for a FileListEvent object.

    +

    OpenFL uses this class to create FileListEvent objects. You will not use +this constructor directly in your code.

    Variables

    files:Array<File>

    An array of File objects representing the files and directories found or +selected.

    +

    For the File.getDirectoryListingAsync() method, this is the list of +files and directories found at the root level of the directory +represented by the File object that called the method. For the +File.browseForOpenMultiple() method, this is the list of files +selected by the user.

    Methods

    Inherited Variables

    Defined by Event

    read onlybubbles:Bool

    Indicates whether an event is a bubbling event. If the event can bubble, this value is true; otherwise it is false.

    When an event occurs, it moves through the three phases of the event flow: the capture phase, which flows from the top of the display list @@ -71,7 +87,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -96,15 +112,15 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    toString():String

    Returns a string containing all the properties of the Event object. The string is in the following format:

    [Event type=_value_ bubbles=_value_ diff --git a/openfl/events/FocusEvent.html b/openfl/events/FocusEvent.html index ed543d8..989e5b8 100644 --- a/openfl/events/FocusEvent.html +++ b/openfl/events/FocusEvent.html @@ -1,7 +1,7 @@ -openfl.events.FocusEvent - API Referenceopenfl.events.FocusEvent - OpenFL API Reference

    View source

    class FocusEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An object dispatches a FocusEvent object when the user changes the focus +

    View source

    class FocusEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An object dispatches a FocusEvent object when the user changes the focus from one object in the display list to another. There are four types of focus events:

    Static variables

    @:value("focusIn")staticinlineread onlyFOCUS_IN:EventType<FocusEvent> = "focusIn"

    Defines the value of the type property of a focusIn event object. This event has the following properties:

    PropertyValue
    bubblestrue
    cancelablefalse; there is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event object with an event listener.
    keyCode0; applies only to keyFocusChange events.
    relatedObjectThe complementary InteractiveObject instance that is affected by the change in focus.
    shiftKeyfalse; applies only to keyFocusChange events.
    targetThe InteractiveObject instance that has just received focus. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
    directionThe direction from which focus was assigned. This property reports the value of the direction parameter of the assignFocus() method of the stage. If the focus changed through some other means, the value will always be FocusDirection.NONE. Applies only to focusIn events. For all other focus events the value will be FocusDirection.NONE.

    @:value("focusOut")staticinlineread onlyFOCUS_OUT:EventType<FocusEvent> = "focusOut"

    Defines the value of the type property of a focusOut event object.

    @@ -121,7 +121,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -146,13 +146,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/FullScreenEvent.html b/openfl/events/FullScreenEvent.html index db84c46..b8c1c8a 100644 --- a/openfl/events/FullScreenEvent.html +++ b/openfl/events/FullScreenEvent.html @@ -1,7 +1,7 @@ -openfl.events.FullScreenEvent - API Referenceopenfl.events.FullScreenEvent - OpenFL API Reference
    View source

    class FullScreenEvent

    package openfl.events

    extends ActivityEvent › Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Stage object dispatches a FullScreenEvent object whenever the Stage +

    View source

    class FullScreenEvent

    package openfl.events

    extends ActivityEvent › Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Stage object dispatches a FullScreenEvent object whenever the Stage enters or leaves full-screen display mode. There is only one type of fullScreen event: FullScreenEvent.FULL_SCREEN.

    Static variables

    @:value("fullScreen")staticinlineread onlyFULL_SCREEN:EventType<FullScreenEvent> = "fullScreen"

    The FullScreenEvent.FULL_SCREEN constant defines the value of the type property of a fullScreen event object. @@ -94,7 +94,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -119,13 +119,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/GameInputEvent.html b/openfl/events/GameInputEvent.html index 03fb193..44c8e0a 100644 --- a/openfl/events/GameInputEvent.html +++ b/openfl/events/GameInputEvent.html @@ -1,7 +1,7 @@ -openfl.events.GameInputEvent - API Reference
    View source

    final class GameInputEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The GameInputEvent class represents an event that is dispatched when a game input device has either been added or removed from the application platform. A game input device also dispatches events when it is turned on or off.

    Static variables

    @:value("deviceAdded")staticinlineread onlyDEVICE_ADDED:EventType<GameInputEvent> = "deviceAdded"

    Indicates that a compatible device has been connected or turned on.

    @:value("deviceRemoved")staticinlineread onlyDEVICE_REMOVED:EventType<GameInputEvent> = "deviceRemoved"

    Indicates that one of the enumerated devices has been disconnected or turned off.

    @:value("deviceUnusable")staticinlineread onlyDEVICE_UNUSABLE:EventType<GameInputEvent> = "deviceUnusable"

    Dispatched when a game input device is connected but is not usable.

    Constructor

    @:value({ device : null, cancelable : false, bubbles : true })new(type:String, bubbles:Bool = true, cancelable:Bool = false, ?device:GameInputDevice)

    Variables

    read onlydevice:GameInputDevice

    Returns a reference to the device that was added or removed. When a device is added, use this property to get a reference to the new device, instead of enumerating all of the devices to find the new one.

    Methods

    Inherited Variables

    Defined by Event

    read onlybubbles:Bool

    Indicates whether an event is a bubbling event. If the event can bubble, +

    View source

    final class GameInputEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The GameInputEvent class represents an event that is dispatched when a game input device has either been added or removed from the application platform. A game input device also dispatches events when it is turned on or off.

    Static variables

    @:value("deviceAdded")staticinlineread onlyDEVICE_ADDED:EventType<GameInputEvent> = "deviceAdded"

    Indicates that a compatible device has been connected or turned on.

    @:value("deviceRemoved")staticinlineread onlyDEVICE_REMOVED:EventType<GameInputEvent> = "deviceRemoved"

    Indicates that one of the enumerated devices has been disconnected or turned off.

    @:value("deviceUnusable")staticinlineread onlyDEVICE_UNUSABLE:EventType<GameInputEvent> = "deviceUnusable"

    Dispatched when a game input device is connected but is not usable.

    Constructor

    @:value({ device : null, cancelable : false, bubbles : true })new(type:String, bubbles:Bool = true, cancelable:Bool = false, ?device:GameInputDevice)

    Variables

    read onlydevice:GameInputDevice

    Returns a reference to the device that was added or removed. When a device is added, use this property to get a reference to the new device, instead of enumerating all of the devices to find the new one.

    Methods

    Inherited Variables

    Defined by Event

    read onlybubbles:Bool

    Indicates whether an event is a bubbling event. If the event can bubble, this value is true; otherwise it is false.

    When an event occurs, it moves through the three phases of the event flow: the capture phase, which flows from the top of the display list @@ -71,7 +71,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -96,13 +96,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/GeolocationEvent.html b/openfl/events/GeolocationEvent.html index 44bb7c5..16cca2c 100644 --- a/openfl/events/GeolocationEvent.html +++ b/openfl/events/GeolocationEvent.html @@ -1,7 +1,7 @@ -openfl.events.GeolocationEvent - API Referenceopenfl.events.GeolocationEvent - OpenFL API Reference
    View source

    class GeolocationEvent

    package openfl.events

    extends Event

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    A Geolocation object dispatches GeolocationEvent objects when it receives +

    View source

    class GeolocationEvent

    package openfl.events

    extends Event

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    A Geolocation object dispatches GeolocationEvent objects when it receives updates from the location sensor installed on the device.

    See also:

    Static variables

    @:value("update")staticinlineread onlyUPDATE:EventType<DeviceRotationEvent> = "update"

    Defines the value of the type property of a update event object.

    Constructor

    @:value({ timestamp : 0, heading : 0, speed : 0, vAccuracy : 0, hAccuracy : 0, altitude : 0, longitude : 0, latitude : 0, cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, latitude:Float = 0, longitude:Float = 0, altitude:Float = 0, hAccuracy:Float = 0, vAccuracy:Float = 0, speed:Float = 0, heading:Float = 0, timestamp:Float = 0)

    Creates a GeolocationEvent object that contains information about the location of the device. Event objects are passed as parameters to event listeners.

    Variables

    altitude:Float

    The altitude in meters.

    @@ -87,7 +87,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -112,15 +112,15 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    toString():String

    Returns a string containing all the properties of the Event object. The string is in the following format:

    [Event type=_value_ bubbles=_value_ diff --git a/openfl/events/HTTPStatusEvent.html b/openfl/events/HTTPStatusEvent.html index a0d476f..362e11a 100644 --- a/openfl/events/HTTPStatusEvent.html +++ b/openfl/events/HTTPStatusEvent.html @@ -1,7 +1,7 @@ -openfl.events.HTTPStatusEvent - API Referenceopenfl.events.HTTPStatusEvent - OpenFL API Reference

    View source

    class HTTPStatusEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The application dispatches HTTPStatusEvent objects when a network request +

    View source

    class HTTPStatusEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The application dispatches HTTPStatusEvent objects when a network request returns an HTTP status code.

    HTTPStatusEvent objects are always sent before error or completion events. An HTTPStatusEvent object does not necessarily indicate an error -condition; it simply reflects the HTTP status code(if any) that is +condition; it simply reflects the HTTP status code (if any) that is provided by the networking stack. Some Flash Player environments may be unable to detect HTTP status codes; a status code of 0 is always reported in these cases.

    @@ -94,7 +94,7 @@ specification at [http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).

    If Flash Player or AIR cannot get a status code from the server, or if it cannot communicate with the server, the default value of 0 is passed to -your code. A value of 0 can be generated in any player(for example, if a +your code. A value of 0 can be generated in any player (for example, if a malformed URL is requested), and a value of 0 is always generated by the Flash Player plug-in when it is run in the following browsers, which do not pass HTTP status codes to the player: Netscape, Mozilla, Safari, @@ -117,7 +117,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -142,13 +142,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/IEventDispatcher.html b/openfl/events/IEventDispatcher.html index 34ebbf6..9b4e6ce 100644 --- a/openfl/events/IEventDispatcher.html +++ b/openfl/events/IEventDispatcher.html @@ -1,7 +1,7 @@ -openfl.events.IEventDispatcher - API Referenceopenfl.events.IEventDispatcher - OpenFL API Reference
    View source

    interface IEventDispatcher

    package openfl.events

    extended by EventDispatcher

    @:directlyUsed

    Available on all platforms

    The IEventDispatcher interface defines methods for adding or removing event listeners, +

    View source

    interface IEventDispatcher

    package openfl.events

    extended by EventDispatcher

    @:directlyUsed

    Available on all platforms

    The IEventDispatcher interface defines methods for adding or removing event listeners, checks whether specific types of event listeners are registered, and dispatches events.

    Event targets are an important part of the OpenFL event model. The event target serves as the focal point for how events flow through the display list @@ -68,7 +68,7 @@ capabilities is to extend EventDispatcher. If this is impossible (that is, if the class is already extending another class), you can instead implement the IEventDispatcher interface, create an EventDispatcher member, and write simple hooks to route calls -into the aggregated EventDispatcher.

    Methods

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that the +into the aggregated EventDispatcher.

    See also:

    Methods

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

    After you successfully register an event listener, you cannot change its priority diff --git a/openfl/events/IOErrorEvent.html b/openfl/events/IOErrorEvent.html index 684e8ea..4c7d359 100644 --- a/openfl/events/IOErrorEvent.html +++ b/openfl/events/IOErrorEvent.html @@ -1,7 +1,7 @@ -openfl.events.IOErrorEvent - API Referenceopenfl.events.IOErrorEvent - OpenFL API Reference

    View source

    class IOErrorEvent

    package openfl.events

    extends ErrorEvent › TextEvent › Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An IOErrorEvent object is dispatched when an error causes input or output +

    View source

    class IOErrorEvent

    package openfl.events

    extends ErrorEvent › TextEvent › Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An IOErrorEvent object is dispatched when an error causes input or output operations to fail.

    You can check for error events that do not have any listeners by using -the debugger version of Flash Player or the AIR Debug Launcher(ADL). The +the debugger version of Flash Player or the AIR Debug Launcher (ADL). The string defined by the text parameter of the IOErrorEvent constructor is displayed.

    Static variables

    @:value("ioError")staticinlineread onlyIO_ERROR:EventType<IOErrorEvent> = "ioError"

    Defines the value of the type property of an ioError event object.

    -

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event object with an event listener.
    errorIDA reference number associated with the specific error (AIR only).
    targetThe network object experiencing the input/output error.
    textText to be displayed as an error message.

    @:value("standardErrorIoError")staticinlineread onlySTANDARD_ERROR_IO_ERROR:EventType<IOErrorEvent> = "standardErrorIoError"

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The standardErrorIoError event is dispatched when an error occurs +

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event object with an event listener.
    errorIDA reference number associated with the specific error (AIR only).
    targetThe network object experiencing the input/output error.
    textText to be displayed as an error message.

    @:value("standardErrorIoError")staticinlineread onlySTANDARD_ERROR_IO_ERROR:EventType<IOErrorEvent> = "standardErrorIoError"

    Available on AIR, Android, Flash, HashLink, Linux, Neko, Windows, iOS, macOS

    The standardErrorIoError event is dispatched when an error occurs while reading data from the standardError stream of a NativeProcess object.

    -

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event.
    errorIDThe reference number associated with the specific error.
    targetThe object on which the error occurred.
    textText to be displayed as an error message.

    @:value("standardOutputIoError")staticinlineread onlySTANDARD_OUTPUT_IO_ERROR:EventType<IOErrorEvent> = "standardOutputIoError"

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The standardOutputIoError event is dispatched when an error occurs +

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event.
    errorIDThe reference number associated with the specific error.
    targetThe object on which the error occurred.
    textText to be displayed as an error message.

    @:value("standardOutputIoError")staticinlineread onlySTANDARD_OUTPUT_IO_ERROR:EventType<IOErrorEvent> = "standardOutputIoError"

    Available on AIR, Android, Flash, HashLink, Linux, Neko, Windows, iOS, macOS

    The standardOutputIoError event is dispatched when an error occurs while reading data from the standardOutput stream of a NativeProcess object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event.
    errorIDThe reference number associated with the specific error.
    targetThe object on which the error occurred.
    textText to be displayed as an error message.

    Constructor

    @:value({ id : 0, text : "", cancelable : false, bubbles : true })new(type:String, bubbles:Bool = true, cancelable:Bool = false, text:String = "", id:Int = 0)

    Creates an Event object that contains specific information about @@ -102,7 +102,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -127,13 +127,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/InvokeEvent.html b/openfl/events/InvokeEvent.html index 47b655a..49b5735 100644 --- a/openfl/events/InvokeEvent.html +++ b/openfl/events/InvokeEvent.html @@ -1,7 +1,8 @@ -openfl.events.InvokeEvent - API Reference
    View source

    class InvokeEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    Static variables

    @:value("invoke")staticinlineread onlyINVOKE:EventType<InvokeEvent> = "invoke"

    Constructor

    @:value({ reason : STANDARD, cancelable : false, bubbles : false })new(type:EventType<InvokeEvent>, bubbles:Bool = false, cancelable:Bool = false, ?dir:File, ?argv:Array<Dynamic>, reason:InvokeEventReason = STANDARD)

    Variables

    read onlyarguments:Array<String>

    read onlycurrentDirectory:File

    read onlyreason:InvokeEventReason

    Methods

    Inherited Variables

    Defined by Event

    read onlybubbles:Bool

    Indicates whether an event is a bubbling event. If the event can bubble, +

    View source

    class InvokeEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The NativeApplication object of an OpenFL application dispatches an invoke +event when the application is invoked.

    +

    The NativeApplication object always dispatches an invoke event when an +application is launched, but the event may be dispatched at other times as +well. For example, a running application dispatches an additional InvokeEvent +when a user activates a file associated with the application.

    +

    Only a single instance of a particular application can be launched. +Subsequent attempts to launch the application will result in a new invoke +event dispatched by the NativeApplication object of the running instance. It +is an application's responsibility to handle this event and take the +appropriate action, such as opening a new application window to display the +data in a file.

    +

    InvokeEvent objects are dispatched by the global NativeApplication object +(NativeApplication.nativeApplication). To receive invoke events, call +the addEventListener() method of the NativeApplication object. When an +event listener registers for an invoke event, it will also receive all +invoke events that occurred before the registration. These earlier events +are dispatched after the call to addEventListener() returns, but not +necessarily before a new invoke event that might be might be dispatched +after registration. Thus, you should not rely on dispatch order.

    Static variables

    @:value("invoke")staticinlineread onlyINVOKE:EventType<InvokeEvent> = "invoke"

    The InvokeEvent.INVOKE constant defines the value of the type +property of an InvokeEvent object.

    Constructor

    @:value({ reason : STANDARD, cancelable : false, bubbles : false })new(type:EventType<InvokeEvent>, bubbles:Bool = false, cancelable:Bool = false, ?dir:File, ?argv:Array<Dynamic>, reason:InvokeEventReason = STANDARD)

    Variables

    read onlyarguments:Array<String>

    The array of string arguments passed during this invocation. If this is +a command line invocation, the array contains the command line arguments +(excluding the process name).

    +

    On mobile platforms, this property contains the array of options with +which the application was launched, not the command-line arguments. +Additionally, on mobile platforms, when reason is +InvokeEventReason.OPEN_URL, the contents of the arguments array +vary, as follows:

    +

    Note: When multiple files are selected and opened on macOS, OpenFL +dispatches a single invoke event containing the names of all the +selected files in the arguments array. On Windows and Linux, however, +OpenFL dispatches a separate invoke event for each selected file +containing only that filename in the arguments array.

    read onlycurrentDirectory:File

    The directory that should be used to resolve any relative paths in the +arguments array.

    +

    If an application is started from the command line, this property is +typically set to the current working directory of the command line shell +from which the application was started. If an application is launched +from the GUI shell, this is typically the file system root.

    read onlyreason:InvokeEventReason

    The reason for this InvokeEvent. This property indicates whether the +application was launched manually by the user or automatically at login. +Possible values are enumerated as constants in the InvokeEventReason +class:

    InvokeEventReason constantMeaning
    LOGINLaunched automatically at at login.
    NOTIFICATIONLaunched in reponse to a notification (iOS only).
    OPEN_URLLaunched because the application was invoked by another application.
    STANDARDLaunched for any other reason.
    +

    Note: On mobile platforms, the reason property is never set to +LOGIN.

    Methods

    Inherited Variables

    Defined by Event

    read onlybubbles:Bool

    Indicates whether an event is a bubbling event. If the event can bubble, this value is true; otherwise it is false.

    When an event occurs, it moves through the three phases of the event flow: the capture phase, which flows from the top of the display list @@ -71,7 +120,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -96,15 +145,15 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    toString():String

    Returns a string containing all the properties of the Event object. The string is in the following format:

    [Event type=_value_ bubbles=_value_ diff --git a/openfl/events/KeyboardEvent.html b/openfl/events/KeyboardEvent.html index 302ceaa..d8e4a1c 100644 --- a/openfl/events/KeyboardEvent.html +++ b/openfl/events/KeyboardEvent.html @@ -1,7 +1,7 @@ -openfl.events.KeyboardEvent - API Referenceopenfl.events.KeyboardEvent - OpenFL API Reference

    View source

    class KeyboardEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    A KeyboardEvent object id dispatched in response to user input through a +

    View source

    class KeyboardEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    A KeyboardEvent object id dispatched in response to user input through a keyboard. There are two types of keyboard events: KeyboardEvent.KEY_DOWN and KeyboardEvent.KEY_UP

    Because mappings between keys and specific characters vary by device and operating system, use the TextEvent event type for processing character input.

    To listen globally for key events, listen on the Stage for the capture -and target or bubble phase.

    Static variables

    @:value("keyDown")staticinlineread onlyKEY_DOWN:EventType<KeyboardEvent> = "keyDown"

    The KeyboardEvent.KEY_DOWN constant defines the value of the type +and target or bubble phase.

    See also:

    Static variables

    @:value("keyDown")staticinlineread onlyKEY_DOWN:EventType<KeyboardEvent> = "keyDown"

    The KeyboardEvent.KEY_DOWN constant defines the value of the type property of a keyDown event object. This event has the following properties:

    PropertyValue
    bubblestrue
    cancelabletrue in AIR, false in Flash Player; in AIR, canceling this event prevents the character from being entered into a text field.
    charCodeThe character code value of the key pressed or released.
    commandKeytrue on Mac if the Command key is active. Otherwise, false
    controlKeytrue on Windows and Linux if the Ctrl key is active. true on Mac if either the Control key is active. Otherwise, false
    ctrlKeytrue on Windows and Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    keyCodeThe key code value of the key pressed or released.
    keyLocationThe location of the key on the keyboard.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    targetThe InteractiveObject instance with focus. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.

    @:value("keyUp")staticinlineread onlyKEY_UP:EventType<KeyboardEvent> = "keyUp"

    The KeyboardEvent.KEY_UP constant defines the value of the type property of a keyUp event object. @@ -80,21 +80,21 @@ Ctrl key or the Command key is activated.

    altKeyValue

    Indicates whether the Alt key modifier is activated(Windows only).

    shiftKeyValue

    Indicates whether the Shift key modifier is activated.

    commandKeyValue

    Indicates whether the Command key modifier is -activated.

    Variables

    altKey:Bool

    Indicates whether the Alt key is active(true) or inactive +activated.

    Variables

    altKey:Bool

    Indicates whether the Alt key is active (true) or inactive (false) on Windows; indicates whether the Option key is active on Mac OS.

    charCode:Int

    Contains the character code value of the key pressed or released. The character code values are English keyboard values. For example, if you press Shift+3, charCode is # on a Japanese keyboard, just as it is on an English keyboard.

    -

    Note: When an input method editor(IME) is running, -charCode does not report accurate character codes.

    commandKey:Bool

    Available on AIR, Android, HTML5, Linux, Neko, Windows, iOS, macOS

    Indicates whether the Command key is active (true) or inactive +

    Note: When an input method editor (IME) is running, +charCode does not report accurate character codes.

    commandKey:Bool

    Available on AIR, Android, HTML5, HashLink, Linux, Neko, Windows, iOS, macOS

    Indicates whether the Command key is active (true) or inactive (false). Supported for Mac OS only. On Mac OS, the commandKey -property has the same value as the ctrlKey property.

    controlKey:Bool

    Available on AIR, Android, HTML5, Linux, Neko, Windows, iOS, macOS

    Indicates whether the Control key is active (true) or inactive +property has the same value as the ctrlKey property.

    controlKey:Bool

    Available on AIR, Android, HTML5, HashLink, Linux, Neko, Windows, iOS, macOS

    Indicates whether the Control key is active (true) or inactive (false). On Windows and Linux, this is also true when the Ctrl key is active.

    ctrlKey:Bool

    On Windows and Linux, indicates whether the Ctrl key is active -(true) or inactive(false); On Mac OS, indicates +(true) or inactive (false); On Mac OS, indicates whether either the Ctrl key or the Command key is active.

    keyCode:Int

    The key code value of the key pressed or released.

    -

    Note: When an input method editor(IME) is running, +

    Note: When an input method editor (IME) is running, keyCode does not report accurate key codes.

    keyLocation:KeyLocation

    Indicates the location of the key on the keyboard. This is useful for differentiating keys that appear more than once on a keyboard. For example, you can differentiate between the left and right Shift keys by @@ -102,8 +102,8 @@ KeyLocation.RIGHT for the right. Another example is differentiating between number keys pressed on the standard keyboard (KeyLocation.STANDARD) versus the numeric keypad -(KeyLocation.NUM_PAD).

    shiftKey:Bool

    Indicates whether the Shift key modifier is active(true) or -inactive(false).

    Methods

    updateAfterEvent():Void

    Instructs OpenFL to render after processing of this event completes, if +(KeyLocation.NUM_PAD).

    shiftKey:Bool

    Indicates whether the Shift key modifier is active (true) or +inactive (false).

    Methods

    updateAfterEvent():Void

    Instructs OpenFL to render after processing of this event completes, if the display list has been modified.

    Inherited Variables

    Defined by Event

    read onlybubbles:Bool

    Indicates whether an event is a bubbling event. If the event can bubble, this value is true; otherwise it is false.

    When an event occurs, it moves through the three phases of the event @@ -123,7 +123,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -148,13 +148,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/MouseEvent.html b/openfl/events/MouseEvent.html index 5341d91..020816b 100644 --- a/openfl/events/MouseEvent.html +++ b/openfl/events/MouseEvent.html @@ -1,7 +1,7 @@ -openfl.events.MouseEvent - API Referenceopenfl.events.MouseEvent - OpenFL API Reference
    View source

    class MouseEvent

    package openfl.events

    extends Event

    extended by ScreenMouseEvent

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    A MouseEvent object is dispatched into the event flow whenever mouse events +

    View source

    class MouseEvent

    package openfl.events

    extends Event

    extended by ScreenMouseEvent

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    A MouseEvent object is dispatched into the event flow whenever mouse events occur. A mouse event is usually generated by a user input device, such as a mouse or a trackball, that uses a pointer.

    When nested nodes are involved, mouse events target the deepest possible @@ -62,7 +62,7 @@ target node. To have a target node's ancestor receive notification of a mouse event, use EventDispatcher.addEventListener() on the ancestor node with the type parameter set to the specific -mouse event you want to detect.

    Static variables

    @:value("click")staticinlineread onlyCLICK:EventType<MouseEvent> = "click"

    Defines the value of the type property of a click event object. +mouse event you want to detect.

    See also:

    Static variables

    @:value("click")staticinlineread onlyCLICK:EventType<MouseEvent> = "click"

    Defines the value of the type property of a click event object. This event has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows).
    bubblestrue
    buttonDownFor click events, this value is always false.
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
    localYThe vertical coordinate at which the event occurred relative to the containing sprite.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
    stageYThe vertical coordinate at which the event occurred in global stage coordinates.
    targetThe InteractiveObject instance under the pointing device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.

    @:value("doubleClick")staticinlineread onlyDOUBLE_CLICK:EventType<MouseEvent> = "doubleClick"

    Defines the value of the type property of a doubleClick event object. The doubleClickEnabled property must be true for an object to generate the doubleClick event. @@ -126,10 +126,10 @@ value indicates a downward scroll. Typical values are 1 to 3, but faster rotation may produce larger values. This parameter is used only for the -MouseEvent.mouseWheel event.

    Variables

    altKey:Bool

    Indicates whether the Alt key is active(true) or inactive +MouseEvent.mouseWheel event.

    Variables

    altKey:Bool

    Indicates whether the Alt key is active (true) or inactive (false). Supported for Windows only. On other operating -systems, this property is always set to false.

    buttonDown:Bool

    Indicates whether the primary mouse button is pressed(true) -or not(false).

    clickCount:Int

    Indicates whether or not the mouse down event is part of a multi-click sequence. +systems, this property is always set to false.

    buttonDown:Bool

    Indicates whether the primary mouse button is pressed (true) +or not (false).

    clickCount:Int

    Indicates whether or not the mouse down event is part of a multi-click sequence. This parameter will be zero for all mouse events other than MouseEvent.mouseDown, MouseEvent.mouseUp, MouseEvent.middleMouseDown, MouseEvent.middleMouseUp, MouseEvent.rightMouseDown, and MouseEvent.rightMouseUp. Listening for single @@ -144,7 +144,7 @@

    The value of property commandKey will have the same value as property ctrlKey on the Mac. Always false on Windows or Linux.

    controlKey:Bool

    Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.

    ctrlKey:Bool

    On Windows or Linux, indicates whether the Ctrl key is active -(true) or inactive(false). On Macintosh, +(true) or inactive (false). On Macintosh, indicates whether either the Control key or the Command key is activated.

    delta:Int

    Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel. A positive delta value indicates an upward scroll; a negative value indicates a downward scroll. Typical values are 1 to 3, but @@ -168,7 +168,7 @@ circumstances: if there no related object, or there is a related object, but it is in a security sandbox to which you don't have access. Use the isRelatedObjectInaccessible() property to determine which of -these reasons applies.

    shiftKey:Bool

    Indicates whether the Shift key is active(true) or inactive +these reasons applies.

    shiftKey:Bool

    Indicates whether the Shift key is active (true) or inactive (false).

    stageX:Float

    The horizontal coordinate at which the event occurred in global Stage coordinates. This property is calculated when the localX property is set.

    stageY:Float

    The vertical coordinate at which the event occurred in global Stage @@ -196,7 +196,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -221,13 +221,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/NativeProcessExitEvent.html b/openfl/events/NativeProcessExitEvent.html index 493b542..8a77701 100644 --- a/openfl/events/NativeProcessExitEvent.html +++ b/openfl/events/NativeProcessExitEvent.html @@ -1,7 +1,7 @@ -openfl.events.NativeProcessExitEvent - API Referenceopenfl.events.NativeProcessExitEvent - OpenFL API Reference
    View source

    class NativeProcessExitEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    This event is dispatched by the NativeProcess object when the process exits. +

    View source

    class NativeProcessExitEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, Flash, HashLink, Linux, Neko, Windows, iOS, macOS

    This event is dispatched by the NativeProcess object when the process exits. It is possible that this event will never be dispatched. For example, if the child process outlives the OpenFL application that created it, the event will not dispatch.

    See also:

    Static variables

    @:value("exit")staticinlineread onlyEXIT:EventType<NativeProcessExitEvent> = "exit"

    Defines the value of the type property of a exit event object.

    Constructor

    @:value({ cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, ?exitCodeValue:Float)

    Creates a NativeProcessExitEvent which contains specific information @@ -88,7 +88,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -113,13 +113,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/NativeWindowBoundsEvent.html b/openfl/events/NativeWindowBoundsEvent.html index 6aee266..0c7cddf 100644 --- a/openfl/events/NativeWindowBoundsEvent.html +++ b/openfl/events/NativeWindowBoundsEvent.html @@ -1,7 +1,7 @@ -openfl.events.NativeWindowBoundsEvent - API Referenceopenfl.events.NativeWindowBoundsEvent - OpenFL API Reference
    View source

    class NativeWindowBoundsEvent

    package openfl.events

    extends Event

    @:directlyUsed

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    A NativeWindow object dispatches a NativeWindowBoundsEvent object when the +

    View source

    class NativeWindowBoundsEvent

    package openfl.events

    extends Event

    @:directlyUsed

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    A NativeWindow object dispatches a NativeWindowBoundsEvent object when the size or location of the window changes.

    See also:

    Static variables

    @:value("move")staticinlineread onlyMOVE:EventType<NativeWindowBoundsEvent> = "move"

    Defines the value of the type property of a move event object.

    This event has the following properties:

    PropertyValue
    afterBoundsThe new bounds of the window.
    beforeBoundsThe old bounds of the window.
    targetThe NativeWindow object that has just changed state.
    bubblesfalse
    cancelablefalse; There is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event object with an event listener.

    @:value("moving")staticinlineread onlyMOVING:EventType<NativeWindowBoundsEvent> = "moving"

    Defines the value of the type property of a moving event object.

    This event has the following properties:

    PropertyValue
    afterBoundsThe new bounds of the window.
    beforeBoundsThe old bounds of the window.
    targetThe NativeWindow object that has just changed state.
    bubblesfalse
    cancelabletrue; canceling this event object stops the move operation.
    currentTargetThe object that is actively processing the Event object with an event listener.

    @:value("resize")staticinlineread onlyRESIZE:EventType<NativeWindowBoundsEvent> = "resize"

    Defines the value of the type property of a resize event object.

    @@ -85,7 +85,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -110,13 +110,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/NativeWindowDisplayStateEvent.html b/openfl/events/NativeWindowDisplayStateEvent.html index 5ccdf01..ccb136c 100644 --- a/openfl/events/NativeWindowDisplayStateEvent.html +++ b/openfl/events/NativeWindowDisplayStateEvent.html @@ -1,7 +1,7 @@ -openfl.events.NativeWindowDisplayStateEvent - API Referenceopenfl.events.NativeWindowDisplayStateEvent - OpenFL API Reference
    View source

    class NativeWindowDisplayStateEvent

    package openfl.events

    extends Event

    @:directlyUsed

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    A NativeWindow object dispatches events of the NativeWindowDisplayStateEvent +

    View source

    class NativeWindowDisplayStateEvent

    package openfl.events

    extends Event

    @:directlyUsed

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    A NativeWindow object dispatches events of the NativeWindowDisplayStateEvent class when the window display state changes.

    See also:

    Static variables

    @:value("displayStateChange")staticinlineread onlyDISPLAY_STATE_CHANGE:EventType<NativeWindowDisplayStateEvent> = "displayStateChange"

    Defines the value of the type property of a displayStateChange event object.

    This event has the following properties:

    PropertyValue
    afterDisplayStateThe old display state of the window.
    beforeDisplayStateThe new display state of the window.
    targetThe NativeWindow object that has just changed state.
    bubblesfalse
    cancelablefalse; There is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event object with an event listener.

    @:value("displayStateChanging")staticinlineread onlyDISPLAY_STATE_CHANGING:EventType<NativeWindowDisplayStateEvent> = "displayStateChanging"

    Defines the value of the type property of a displayStateChanging event object.

    This event has the following properties:

    PropertyValue
    afterDisplayStateThe display state of the window before the pending change.
    beforeDisplayStateThe display state of the window after the pending change.
    targetThe NativeWindow object that has just changed state.
    bubblesfalse
    cancelabletrue; canceling the event will prevent the change.
    currentTargetThe object that is actively processing the Event object with an event listener.

    Constructor

    @:value({ afterDisplayState : null, beforeDisplayState : null, cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, ?beforeDisplayState:NativeWindowDisplayState, ?afterDisplayState:NativeWindowDisplayState)

    Creates an Event object with specific information relevant to window @@ -85,7 +85,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -110,13 +110,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/NetStatusEvent.html b/openfl/events/NetStatusEvent.html index 78118e4..bf4a3a8 100644 --- a/openfl/events/NetStatusEvent.html +++ b/openfl/events/NetStatusEvent.html @@ -1,7 +1,7 @@ -openfl.events.NetStatusEvent - API Referenceopenfl.events.NetStatusEvent - OpenFL API Reference
    View source

    class NetStatusEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    A NetConnection, NetStream, or SharedObject object dispatches +

    View source

    class NetStatusEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    A NetConnection, NetStream, or SharedObject object dispatches NetStatusEvent objects when a it reports its status. There is only one type of status event: NetStatusEvent.NET_STATUS.

    Static variables

    @:value("netStatus")staticinlineread onlyNET_STATUS:EventType<NetStatusEvent> = "netStatus"

    Defines the value of the type property of a netStatus event object. @@ -104,7 +104,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -129,13 +129,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/OutputProgressEvent.html b/openfl/events/OutputProgressEvent.html index c8143d4..50f15ac 100644 --- a/openfl/events/OutputProgressEvent.html +++ b/openfl/events/OutputProgressEvent.html @@ -1,7 +1,9 @@ -openfl.events.OutputProgressEvent - API Reference
    View source

    class OutputProgressEvent

    package openfl.events

    extends Event

    @:directlyUsed

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    Static variables

    @:value("outputProgress")staticinlineread onlyOUTPUT_PROGRESS:EventType<OutputProgressEvent> = "outputProgress"

    Constructor

    @:value({ bytesTotal : 0, bytesPending : 0, cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, bytesPending:Float = 0, bytesTotal:Float = 0)

    Variables

    bytesPending:Float

    bytesTotal:Float

    Methods

    Inherited Variables

    Defined by Event

    read onlybubbles:Bool

    Indicates whether an event is a bubbling event. If the event can bubble, +

    View source

    class OutputProgressEvent

    package openfl.events

    extends Event

    @:directlyUsed

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    A FileStream object dispatches OutputProgressEvent objects as pendin +asynchronous file write operations are performed. There is one type of +output progress event: OutputProgressEvent.OUTPUT_PROGRESS.

    Static variables

    @:value("outputProgress")staticinlineread onlyOUTPUT_PROGRESS:EventType<OutputProgressEvent> = "outputProgress"

    Defines the value of the type property of an outputProgress event +object.

    Constructor

    @:value({ bytesTotal : 0, bytesPending : 0, cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, bytesPending:Float = 0, bytesTotal:Float = 0)

    Creates an Event object that contains information about output progress +events. Event objects are passed as parameters to event listeners.

    Variables

    bytesPending:Float

    The number of bytes not yet written when the listener processes the +event.

    bytesTotal:Float

    The total number of bytes written so far, plus the number of pending +bytes to be written.

    Methods

    Inherited Variables

    Defined by Event

    read onlybubbles:Bool

    Indicates whether an event is a bubbling event. If the event can bubble, this value is true; otherwise it is false.

    When an event occurs, it moves through the three phases of the event flow: the capture phase, which flows from the top of the display list @@ -71,7 +79,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -96,13 +104,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/PermissionEvent.html b/openfl/events/PermissionEvent.html index 6465212..9af47b2 100644 --- a/openfl/events/PermissionEvent.html +++ b/openfl/events/PermissionEvent.html @@ -1,7 +1,7 @@ -openfl.events.PermissionEvent - API Referenceopenfl.events.PermissionEvent - OpenFL API Reference
    View source

    class PermissionEvent

    package openfl.events

    extends Event

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    This event is dispatched when permission status changes for certain +

    View source

    class PermissionEvent

    package openfl.events

    extends Event

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    This event is dispatched when permission status changes for certain operations.

    Static variables

    @:value("permissionStatus")staticinlineread onlyPERMISSION_STATUS:EventType<PermissionEvent> = "permissionStatus"

    Constructor

    @:value({ status : DENIED, cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, status:PermissionStatus = DENIED)

    Creates an PermissionEvent object that contains information about the name of the permission and its status.

    Parameters:

    type

    The type of the event. Event listeners can access this information through the inherited type property. There is only one type of Permission event: @@ -82,7 +82,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -107,13 +107,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/ProgressEvent.html b/openfl/events/ProgressEvent.html index d6a9c62..90a5204 100644 --- a/openfl/events/ProgressEvent.html +++ b/openfl/events/ProgressEvent.html @@ -1,7 +1,7 @@ -openfl.events.ProgressEvent - API Referenceopenfl.events.ProgressEvent - OpenFL API Reference
    API Reference
    View source

    class ProgressEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    A ProgressEvent object is dispatched when a load operation has begun or a +

    View source

    class ProgressEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    A ProgressEvent object is dispatched when a load operation has begun or a socket has received data. These events are usually generated when SWF files, images or data are loaded into an application. There are two types of progress events: ProgressEvent.PROGRESS and @@ -67,9 +67,9 @@ the NativeProcess class.

    Static variables

    @:value("progress")staticinlineread onlyPROGRESS:EventType<ProgressEvent> = "progress"

    Defines the value of the type property of a progress event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
    bytesTotalThe total number of items or bytes that ultimately will be loaded if the loading process succeeds.
    cancelablefalse; there is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event object with an event listener.
    targetThe object reporting progress.

    @:value("socketData")staticinlineread onlySOCKET_DATA:EventType<ProgressEvent> = "socketData"

    Defines the value of the type property of a socketData event object. -This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event.
    bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
    bytesTotal0; this property is not used by socketData event objects.
    targetThe socket reporting progress.

    @:value("standardErrorData")staticinlineread onlySTANDARD_ERROR_DATA:EventType<ProgressEvent> = "standardErrorData"

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    Defines the value of the type property of a standardErrorData event +This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event.
    bytesLoadedThe number of items or bytes loaded at the time the listener processes the event.
    bytesTotal0; this property is not used by socketData event objects.
    targetThe socket reporting progress.

    @:value("standardErrorData")staticinlineread onlySTANDARD_ERROR_DATA:EventType<ProgressEvent> = "standardErrorData"

    Available on AIR, Android, Flash, HashLink, Linux, Neko, Windows, iOS, macOS

    Defines the value of the type property of a standardErrorData event object. -This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event.
    bytesLoadedThe number of bytes of output data buffered by the NativeProcessObject.standardError due to this event.
    bytesTotal0; this property is not used by standardErrorData event objects.
    targetThe NativeProcess object reporting output data.

    @:value("standardOutputData")staticinlineread onlySTANDARD_OUTPUT_DATA:EventType<ProgressEvent> = "standardOutputData"

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    Defines the value of the type property of a standardOutputData event +This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event.
    bytesLoadedThe number of bytes of output data buffered by the NativeProcessObject.standardError due to this event.
    bytesTotal0; this property is not used by standardErrorData event objects.
    targetThe NativeProcess object reporting output data.

    @:value("standardOutputData")staticinlineread onlySTANDARD_OUTPUT_DATA:EventType<ProgressEvent> = "standardOutputData"

    Available on AIR, Android, Flash, HashLink, Linux, Neko, Windows, iOS, macOS

    Defines the value of the type property of a standardOutputData event object. This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event.
    bytesLoadedThe number of bytes of output data buffered by the NativeProcessObject.standardOutput due to this event.
    bytesTotal0; this property is not used by standardOutputData event objects.
    targetThe NativeProcess object reporting output data.

    Constructor

    @:value({ bytesTotal : 0, bytesLoaded : 0, cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, bytesLoaded:Float = 0, bytesTotal:Float = 0)

    Creates an Event object that contains information about progress events. Event objects are passed as parameters to event listeners.

    Parameters:

    type

    The type of the event. Possible values @@ -103,7 +103,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -128,13 +128,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/RenderEvent.html b/openfl/events/RenderEvent.html index 9d9ce50..637d287 100644 --- a/openfl/events/RenderEvent.html +++ b/openfl/events/RenderEvent.html @@ -1,7 +1,7 @@ -openfl.events.RenderEvent - API Reference
    View source

    class RenderEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.geom.ColorTransform)@:beta

    Available on all platforms

    BETA**

    +
    View source

    class RenderEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.geom.ColorTransform)@:beta

    Available on all platforms

    BETA**

    RenderEvent is dispatched (optionally) once a listener is added to a DisplayObject. When the internal Stage renderer is ready to draw the specified object, a RenderEvent will be dispatched.

    @@ -99,7 +99,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -124,13 +124,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/SampleDataEvent.html b/openfl/events/SampleDataEvent.html index 36b9063..280931b 100644 --- a/openfl/events/SampleDataEvent.html +++ b/openfl/events/SampleDataEvent.html @@ -1,7 +1,7 @@ -openfl.events.SampleDataEvent - API Referenceopenfl.events.SampleDataEvent - OpenFL API Reference
    View source

    class SampleDataEvent

    package openfl.events

    extends Event

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Dispatched when a Sound object requests new audio data or when a +

    View source

    class SampleDataEvent

    package openfl.events

    extends Event

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Dispatched when a Sound object requests new audio data or when a Microphone object has new audio data to provide. This event has two uses:

    • To provide dynamically generated audio data for a Sound object
    • To get audio data for a Microphone object

    Dynamically generating audio using the Sound object Use the @@ -130,7 +130,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -155,13 +155,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/ScreenMouseEvent.html b/openfl/events/ScreenMouseEvent.html index 8578fb5..39a3313 100644 --- a/openfl/events/ScreenMouseEvent.html +++ b/openfl/events/ScreenMouseEvent.html @@ -1,7 +1,7 @@ -openfl.events.ScreenMouseEvent - API Referenceopenfl.events.ScreenMouseEvent - OpenFL API Reference
    View source

    class ScreenMouseEvent

    package openfl.events

    extends MouseEvent › Event

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The SystemTrayIcon object dispatches events of type ScreenMouseEvent in +

    View source

    class ScreenMouseEvent

    package openfl.events

    extends MouseEvent › Event

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The SystemTrayIcon object dispatches events of type ScreenMouseEvent in response to mouse interaction.

    The ScreenMouseEvent object extends the MouseEvent class to provide two additional properties, screenX and screenY, that report the mouse @@ -64,10 +64,10 @@ This event has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows).
    bubblestrue
    buttonDowntrue if the primary mouse button is pressed; false otherwise.
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    screenXThe horizontal coordinate at which the event occurred in screen coordinates.
    screenYThe vertical coordinate at which the event occurred in screen coordinates.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    targetThe SystemTrayIcon instance under the pointing device.

    @:value("rightClick")staticinlineread onlyRIGHT_CLICK:EventType<ScreenMouseEvent> = "rightClick"

    Defines the value of the type property of a rightClick event object. This event has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows).
    bubblestrue
    buttonDowntrue if the primary mouse button is pressed; false otherwise.
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    screenXThe horizontal coordinate at which the event occurred in screen coordinates.
    screenYThe vertical coordinate at which the event occurred in screen coordinates.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    targetThe SystemTrayIcon instance under the pointing device.

    @:value("rightMouseDown")staticinlineread onlyRIGHT_MOUSE_DOWN:EventType<ScreenMouseEvent> = "rightMouseDown"

    Defines the value of the type property of a rightMouseDown event object. This event has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows).
    bubblestrue
    buttonDowntrue if the primary mouse button is pressed; false otherwise.
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    screenXThe horizontal coordinate at which the event occurred in screen coordinates.
    screenYThe vertical coordinate at which the event occurred in screen coordinates.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    targetThe SystemTrayIcon instance under the pointing device.

    @:value("rightMouseUp")staticinlineread onlyRIGHT_MOUSE_UP:EventType<ScreenMouseEvent> = "rightMouseUp"

    Defines the value of the type property of a rightMouseUp event object. -This event has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows).
    bubblestrue
    buttonDowntrue if the primary mouse button is pressed; false otherwise.
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    screenXThe horizontal coordinate at which the event occurred in screen coordinates.
    screenYThe vertical coordinate at which the event occurred in screen coordinates.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    targetThe SystemTrayIcon instance under the pointing device.

    Constructor

    @:value({ controlKey : false, commandKey : false, buttonDown : false, shiftKey : false, altKey : false, ctrlKey : false, screenY : 0, screenX : 0, cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, screenX:Float = 0, screenY:Float = 0, ctrlKey:Bool = false, altKey:Bool = false, shiftKey:Bool = false, buttonDown:Bool = false, commandKey:Bool = false, controlKey:Bool = false)

    Variables

    read onlyscreenX:Float

    The X position of the click in screen coordinates.

    read onlyscreenY:Float

    The Y position of the click in screen coordinates.

    Methods

    Inherited Variables

    Defined by MouseEvent

    altKey:Bool

    Indicates whether the Alt key is active(true) or inactive +This event has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows).
    bubblestrue
    buttonDowntrue if the primary mouse button is pressed; false otherwise.
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    screenXThe horizontal coordinate at which the event occurred in screen coordinates.
    screenYThe vertical coordinate at which the event occurred in screen coordinates.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    targetThe SystemTrayIcon instance under the pointing device.

    Constructor

    @:value({ controlKey : false, commandKey : false, buttonDown : false, shiftKey : false, altKey : false, ctrlKey : false, screenY : 0, screenX : 0, cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, screenX:Float = 0, screenY:Float = 0, ctrlKey:Bool = false, altKey:Bool = false, shiftKey:Bool = false, buttonDown:Bool = false, commandKey:Bool = false, controlKey:Bool = false)

    Variables

    read onlyscreenX:Float

    The X position of the click in screen coordinates.

    read onlyscreenY:Float

    The Y position of the click in screen coordinates.

    Methods

    Inherited Variables

    Defined by MouseEvent

    altKey:Bool

    Indicates whether the Alt key is active (true) or inactive (false). Supported for Windows only. On other operating -systems, this property is always set to false.

    buttonDown:Bool

    Indicates whether the primary mouse button is pressed(true) -or not(false).

    clickCount:Int

    Indicates whether or not the mouse down event is part of a multi-click sequence. +systems, this property is always set to false.

    buttonDown:Bool

    Indicates whether the primary mouse button is pressed (true) +or not (false).

    clickCount:Int

    Indicates whether or not the mouse down event is part of a multi-click sequence. This parameter will be zero for all mouse events other than MouseEvent.mouseDown, MouseEvent.mouseUp, MouseEvent.middleMouseDown, MouseEvent.middleMouseUp, MouseEvent.rightMouseDown, and MouseEvent.rightMouseUp. Listening for single @@ -82,7 +82,7 @@

    The value of property commandKey will have the same value as property ctrlKey on the Mac. Always false on Windows or Linux.

    controlKey:Bool

    Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.

    ctrlKey:Bool

    On Windows or Linux, indicates whether the Ctrl key is active -(true) or inactive(false). On Macintosh, +(true) or inactive (false). On Macintosh, indicates whether either the Control key or the Command key is activated.

    delta:Int

    Indicates how many lines should be scrolled for each unit the user rotates the mouse wheel. A positive delta value indicates an upward scroll; a negative value indicates a downward scroll. Typical values are 1 to 3, but @@ -106,7 +106,7 @@ circumstances: if there no related object, or there is a related object, but it is in a security sandbox to which you don't have access. Use the isRelatedObjectInaccessible() property to determine which of -these reasons applies.

    shiftKey:Bool

    Indicates whether the Shift key is active(true) or inactive +these reasons applies.

    shiftKey:Bool

    Indicates whether the Shift key is active (true) or inactive (false).

    stageX:Float

    The horizontal coordinate at which the event occurred in global Stage coordinates. This property is calculated when the localX property is set.

    stageY:Float

    The vertical coordinate at which the event occurred in global Stage @@ -134,7 +134,7 @@

    On all targets except Flash/AIR, requires openfl_always_dispatch_mouse_events to be defined because OpenFL will throttle mouse events to the frame rate.

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -159,13 +159,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/SecurityErrorEvent.html b/openfl/events/SecurityErrorEvent.html index 98318a2..d29857d 100644 --- a/openfl/events/SecurityErrorEvent.html +++ b/openfl/events/SecurityErrorEvent.html @@ -1,7 +1,7 @@ -openfl.events.SecurityErrorEvent - API Referenceopenfl.events.SecurityErrorEvent - OpenFL API Reference
    API Reference
    View source

    class SecurityErrorEvent

    package openfl.events

    extends ErrorEvent › TextEvent › Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An object dispatches a SecurityErrorEvent object to report the occurrence +

    View source

    class SecurityErrorEvent

    package openfl.events

    extends ErrorEvent › TextEvent › Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An object dispatches a SecurityErrorEvent object to report the occurrence of a security error. Security errors reported through this class are generally from asynchronous operations, such as loading data, in which security violations may not manifest immediately. Your event listener can @@ -111,7 +111,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -136,13 +136,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/ServerSocketConnectEvent.html b/openfl/events/ServerSocketConnectEvent.html index 070d5c0..b00e987 100644 --- a/openfl/events/ServerSocketConnectEvent.html +++ b/openfl/events/ServerSocketConnectEvent.html @@ -1,7 +1,7 @@ -openfl.events.ServerSocketConnectEvent - API Referenceopenfl.events.ServerSocketConnectEvent - OpenFL API Reference
    View source

    class ServerSocketConnectEvent

    package openfl.events

    extends Event

    @:directlyUsed

    Available on all platforms

    A ServerSocket object dispatches a ServerSocketConnectEvent object when a client attempts to +

    View source

    class ServerSocketConnectEvent

    package openfl.events

    extends Event

    @:directlyUsed

    Available on all platforms

    A ServerSocket object dispatches a ServerSocketConnectEvent object when a client attempts to connect to the server socket.

    The socket property of the ServerSocketConnectEvent object provides the Socket object to use for subsequent communication between the server and the client. To deny the connection, call @@ -81,7 +81,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -106,13 +106,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/TextEvent.html b/openfl/events/TextEvent.html index 4582824..8b1f3dc 100644 --- a/openfl/events/TextEvent.html +++ b/openfl/events/TextEvent.html @@ -1,7 +1,7 @@ -openfl.events.TextEvent - API Referenceopenfl.events.TextEvent - OpenFL API Reference
    View source

    class TextEvent

    package openfl.events

    extends Event

    extended by DataEvent, ErrorEvent

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An object dispatches a TextEvent object when a user enters text in a text +

    View source

    class TextEvent

    package openfl.events

    extends Event

    extended by DataEvent, ErrorEvent

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An object dispatches a TextEvent object when a user enters text in a text field or clicks a hyperlink in an HTML-enabled text field. There are two types of text events: TextEvent.LINK and TextEvent.TEXT_INPUT.

    Static variables

    @:value("link")staticinlineread onlyLINK:EventType<TextEvent> = "link"

    Defines the value of the type property of a link event object. @@ -97,7 +97,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -122,13 +122,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/TimerEvent.html b/openfl/events/TimerEvent.html index 840cd77..4222018 100644 --- a/openfl/events/TimerEvent.html +++ b/openfl/events/TimerEvent.html @@ -1,7 +1,7 @@ -openfl.events.TimerEvent - API Referenceopenfl.events.TimerEvent - OpenFL API Reference
    View source

    class TimerEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    A Timer object dispatches a TimerEvent objects whenever the Timer object +

    View source

    class TimerEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    A Timer object dispatches a TimerEvent objects whenever the Timer object reaches the interval specified by the Timer.delay property.

    Static variables

    @:value("timer")staticinlineread onlyTIMER:EventType<TimerEvent> = "timer"

    Defines the value of the type property of a timer event object. This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    currentTargetThe object that is actively processing the Event object with an event listener.
    targetThe Timer object that has reached its interval.

    @:value("timerComplete")staticinlineread onlyTIMER_COMPLETE:EventType<TimerEvent> = "timerComplete"

    Defines the value of the type property of a timerComplete event object. @@ -85,7 +85,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -110,13 +110,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/TouchEvent.html b/openfl/events/TouchEvent.html index a1f60e9..deaea1b 100644 --- a/openfl/events/TouchEvent.html +++ b/openfl/events/TouchEvent.html @@ -1,14 +1,14 @@ -openfl.events.TouchEvent - API Referenceopenfl.events.TouchEvent - OpenFL API Reference
    API Reference
    View source

    class TouchEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The TouchEvent class lets you handle events on devices that detect user -contact with the device(such as a finger on a touch screen). When a user +

    View source

    class TouchEvent

    package openfl.events

    extends Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The TouchEvent class lets you handle events on devices that detect user +contact with the device (such as a finger on a touch screen). When a user interacts with a device such as a mobile phone or tablet with a touch screen, the user typically touches the screen with his or her fingers or a pointing device. You can develop applications that respond to basic touch events(such as a single finger tap) with the TouchEvent class. Create event listeners using the event types defined in this class. For user -interaction with multiple points of contact(such as several fingers moving +interaction with multiple points of contact (such as several fingers moving across a touch screen at the same time) use the related GestureEvent, PressAndTapGestureEvent, and TransformGestureEvent classes. And, use the properties and methods of these classes to construct event handlers that @@ -84,21 +84,21 @@ ancestor(an object containing the target node in the display list) receive notification of a touch event, use EventDispatcher.addEventListener() on the ancestor node with -the type parameter set to the specific touch event you want to detect.

    Static variables

    @:value("touchBegin")staticinlineread onlyTOUCH_BEGIN:EventType<TouchEvent> = "touchBegin"

    Defines the value of the type property of a TOUCH_BEGIN touch +the type parameter set to the specific touch event you want to detect.

    See also:

    Static variables

    @:value("touchBegin")staticinlineread onlyTOUCH_BEGIN:EventType<TouchEvent> = "touchBegin"

    Defines the value of the type property of a TOUCH_BEGIN touch event object. -The dispatched TouchEvent object has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows or Linux).
    bubblestrue
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    eventPhaseThe current phase in the event flow.
    isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
    localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
    localYThe vertical coordinate at which the event occurred relative to the containing sprite.
    pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
    relatedObjectA reference to a display list object related to the event.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    sizeXWidth of the contact area.
    sizeYHeight of the contact area.
    stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
    stageYThe vertical coordinate at which the event occurred in global stage coordinates.
    targetThe InteractiveObject instance under the touching device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
    touchPointIDA unique identification number (as an int) assigned to the touch point.

    @:value("touchEnd")staticinlineread onlyTOUCH_END:EventType<TouchEvent> = "touchEnd"

    Defines the value of the type property of a TOUCH_END touch event +The dispatched TouchEvent object has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows or Linux).
    bubblestrue
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    eventPhaseThe current phase in the event flow.
    isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
    localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
    localYThe vertical coordinate at which the event occurred relative to the containing sprite.
    pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
    relatedObjectA reference to a display list object related to the event.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    sizeXWidth of the contact area.
    sizeYHeight of the contact area.
    stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
    stageYThe vertical coordinate at which the event occurred in global stage coordinates.
    targetThe InteractiveObject instance under the touching device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
    touchPointIDA unique identification number (as an int) assigned to the touch point.

    @:value("touchEnd")staticinlineread onlyTOUCH_END:EventType<TouchEvent> = "touchEnd"

    Defines the value of the type property of a TOUCH_END touch event object. -The dispatched TouchEvent object has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows or Linux).
    bubblestrue
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    eventPhaseThe current phase in the event flow.
    isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
    localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
    localYThe vertical coordinate at which the event occurred relative to the containing sprite.
    pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
    relatedObjectA reference to a display list object related to the event.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    sizeXWidth of the contact area.
    sizeYHeight of the contact area.
    stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
    stageYThe vertical coordinate at which the event occurred in global stage coordinates.
    targetThe InteractiveObject instance under the touching device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
    touchPointIDA unique identification number (as an int) assigned to the touch point.

    @:value("touchMove")staticinlineread onlyTOUCH_MOVE:EventType<TouchEvent> = "touchMove"

    Defines the value of the type property of a TOUCH_MOVE touch event +The dispatched TouchEvent object has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows or Linux).
    bubblestrue
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    eventPhaseThe current phase in the event flow.
    isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
    localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
    localYThe vertical coordinate at which the event occurred relative to the containing sprite.
    pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
    relatedObjectA reference to a display list object related to the event.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    sizeXWidth of the contact area.
    sizeYHeight of the contact area.
    stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
    stageYThe vertical coordinate at which the event occurred in global stage coordinates.
    targetThe InteractiveObject instance under the touching device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
    touchPointIDA unique identification number (as an int) assigned to the touch point.

    @:value("touchMove")staticinlineread onlyTOUCH_MOVE:EventType<TouchEvent> = "touchMove"

    Defines the value of the type property of a TOUCH_MOVE touch event object. -The dispatched TouchEvent object has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows or Linux).
    bubblestrue
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    eventPhaseThe current phase in the event flow.
    isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
    localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
    localYThe vertical coordinate at which the event occurred relative to the containing sprite.
    pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
    relatedObjectA reference to a display list object related to the event.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    sizeXWidth of the contact area.
    sizeYHeight of the contact area.
    stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
    stageYThe vertical coordinate at which the event occurred in global stage coordinates.
    targetThe InteractiveObject instance under the touching device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
    touchPointIDA unique identification number (as an int) assigned to the touch point.

    @:value("touchOut")staticinlineread onlyTOUCH_OUT:EventType<TouchEvent> = "touchOut"

    Defines the value of the type property of a TOUCH_OUT touch event +The dispatched TouchEvent object has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows or Linux).
    bubblestrue
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    eventPhaseThe current phase in the event flow.
    isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
    localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
    localYThe vertical coordinate at which the event occurred relative to the containing sprite.
    pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
    relatedObjectA reference to a display list object related to the event.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    sizeXWidth of the contact area.
    sizeYHeight of the contact area.
    stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
    stageYThe vertical coordinate at which the event occurred in global stage coordinates.
    targetThe InteractiveObject instance under the touching device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
    touchPointIDA unique identification number (as an int) assigned to the touch point.

    @:value("touchOut")staticinlineread onlyTOUCH_OUT:EventType<TouchEvent> = "touchOut"

    Defines the value of the type property of a TOUCH_OUT touch event object. -The dispatched TouchEvent object has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows or Linux).
    bubblestrue
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    eventPhaseThe current phase in the event flow.
    isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
    localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
    localYThe vertical coordinate at which the event occurred relative to the containing sprite.
    pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
    relatedObjectA reference to a display list object related to the event.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    sizeXWidth of the contact area.
    sizeYHeight of the contact area.
    stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
    stageYThe vertical coordinate at which the event occurred in global stage coordinates.
    targetThe InteractiveObject instance under the touching device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
    touchPointIDA unique identification number (as an int) assigned to the touch point.

    @:value("touchOver")staticinlineread onlyTOUCH_OVER:EventType<TouchEvent> = "touchOver"

    Defines the value of the type property of a TOUCH_OVER touch event +The dispatched TouchEvent object has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows or Linux).
    bubblestrue
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    eventPhaseThe current phase in the event flow.
    isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
    localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
    localYThe vertical coordinate at which the event occurred relative to the containing sprite.
    pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
    relatedObjectA reference to a display list object related to the event.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    sizeXWidth of the contact area.
    sizeYHeight of the contact area.
    stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
    stageYThe vertical coordinate at which the event occurred in global stage coordinates.
    targetThe InteractiveObject instance under the touching device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
    touchPointIDA unique identification number (as an int) assigned to the touch point.

    @:value("touchOver")staticinlineread onlyTOUCH_OVER:EventType<TouchEvent> = "touchOver"

    Defines the value of the type property of a TOUCH_OVER touch event object. -The dispatched TouchEvent object has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows or Linux).
    bubblestrue
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    eventPhaseThe current phase in the event flow.
    isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
    localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
    localYThe vertical coordinate at which the event occurred relative to the containing sprite.
    pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
    relatedObjectA reference to a display list object related to the event.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    sizeXWidth of the contact area.
    sizeYHeight of the contact area.
    stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
    stageYThe vertical coordinate at which the event occurred in global stage coordinates.
    targetThe InteractiveObject instance under the touching device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
    touchPointIDA unique identification number (as an int) assigned to the touch point.

    @:value("touchRollOut")staticinlineread onlyTOUCH_ROLL_OUT:EventType<TouchEvent> = "touchRollOut"

    Defines the value of the type property of a TOUCH_ROLL_OUT touch +The dispatched TouchEvent object has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows or Linux).
    bubblestrue
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    eventPhaseThe current phase in the event flow.
    isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
    localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
    localYThe vertical coordinate at which the event occurred relative to the containing sprite.
    pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
    relatedObjectA reference to a display list object related to the event.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    sizeXWidth of the contact area.
    sizeYHeight of the contact area.
    stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
    stageYThe vertical coordinate at which the event occurred in global stage coordinates.
    targetThe InteractiveObject instance under the touching device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
    touchPointIDA unique identification number (as an int) assigned to the touch point.

    @:value("touchRollOut")staticinlineread onlyTOUCH_ROLL_OUT:EventType<TouchEvent> = "touchRollOut"

    Defines the value of the type property of a TOUCH_ROLL_OUT touch event object. -The dispatched TouchEvent object has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows or Linux).
    bubblestrue
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    eventPhaseThe current phase in the event flow.
    isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
    localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
    localYThe vertical coordinate at which the event occurred relative to the containing sprite.
    pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
    relatedObjectA reference to a display list object related to the event.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    sizeXWidth of the contact area.
    sizeYHeight of the contact area.
    stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
    stageYThe vertical coordinate at which the event occurred in global stage coordinates.
    targetThe InteractiveObject instance under the touching device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
    touchPointIDA unique identification number (as an int) assigned to the touch point.

    @:value("touchRollOver")staticinlineread onlyTOUCH_ROLL_OVER:EventType<TouchEvent> = "touchRollOver"

    Defines the value of the type property of a TOUCH_ROLL_OVER touch +The dispatched TouchEvent object has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows or Linux).
    bubblestrue
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    eventPhaseThe current phase in the event flow.
    isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
    localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
    localYThe vertical coordinate at which the event occurred relative to the containing sprite.
    pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
    relatedObjectA reference to a display list object related to the event.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    sizeXWidth of the contact area.
    sizeYHeight of the contact area.
    stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
    stageYThe vertical coordinate at which the event occurred in global stage coordinates.
    targetThe InteractiveObject instance under the touching device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
    touchPointIDA unique identification number (as an int) assigned to the touch point.

    @:value("touchRollOver")staticinlineread onlyTOUCH_ROLL_OVER:EventType<TouchEvent> = "touchRollOver"

    Defines the value of the type property of a TOUCH_ROLL_OVER touch event object. -The dispatched TouchEvent object has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows or Linux).
    bubblestrue
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    eventPhaseThe current phase in the event flow.
    isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
    localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
    localYThe vertical coordinate at which the event occurred relative to the containing sprite.
    pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
    relatedObjectA reference to a display list object related to the event.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    sizeXWidth of the contact area.
    sizeYHeight of the contact area.
    stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
    stageYThe vertical coordinate at which the event occurred in global stage coordinates.
    targetThe InteractiveObject instance under the touching device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
    touchPointIDA unique identification number (as an int) assigned to the touch point.

    @:value("touchTap")staticinlineread onlyTOUCH_TAP:EventType<TouchEvent> = "touchTap"

    Defines the value of the type property of a TOUCH_TAP touch event +The dispatched TouchEvent object has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows or Linux).
    bubblestrue
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    eventPhaseThe current phase in the event flow.
    isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
    localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
    localYThe vertical coordinate at which the event occurred relative to the containing sprite.
    pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
    relatedObjectA reference to a display list object related to the event.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    sizeXWidth of the contact area.
    sizeYHeight of the contact area.
    stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
    stageYThe vertical coordinate at which the event occurred in global stage coordinates.
    targetThe InteractiveObject instance under the touching device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
    touchPointIDA unique identification number (as an int) assigned to the touch point.

    @:value("touchTap")staticinlineread onlyTOUCH_TAP:EventType<TouchEvent> = "touchTap"

    Defines the value of the type property of a TOUCH_TAP touch event object. The dispatched TouchEvent object has the following properties:

    PropertyValue
    altKeytrue if the Alt key is active (Windows or Linux).
    bubblestrue
    cancelablefalse; there is no default behavior to cancel.
    commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
    controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
    ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
    currentTargetThe object that is actively processing the Event object with an event listener.
    eventPhaseThe current phase in the event flow.
    isRelatedObjectInaccessibletrue if the relatedObject property is set to null because of security sandbox rules.
    localXThe horizontal coordinate at which the event occurred relative to the containing sprite.
    localYThe vertical coordinate at which the event occurred relative to the containing sprite.
    pressureA value between 0.0 and 1.0 indicating force of the contact with the device. If the device does not support detecting the pressure, the value is 1.0.
    relatedObjectA reference to a display list object related to the event.
    shiftKeytrue if the Shift key is active; false if it is inactive.
    sizeXWidth of the contact area.
    sizeYHeight of the contact area.
    stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
    stageYThe vertical coordinate at which the event occurred in global stage coordinates.
    targetThe InteractiveObject instance under the touching device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
    touchPointIDA unique identification number (as an int) assigned to the touch point.

    Constructor

    @:value({ isTouchPointCanceled : false, samples : null, touchIntent : null, timestamp : 0, controlKey : false, commandKey : false, shiftKey : false, altKey : false, ctrlKey : false, relatedObject : null, pressure : 0, sizeY : 0, sizeX : 0, localY : 0, localX : 0, isPrimaryTouchPoint : false, touchPointID : 0, cancelable : false, bubbles : true })new(type:String, bubbles:Bool = true, cancelable:Bool = false, touchPointID:Int = 0, isPrimaryTouchPoint:Bool = false, localX:Float = 0, localY:Float = 0, sizeX:Float = 0, sizeY:Float = 0, pressure:Float = 0, ?relatedObject:InteractiveObject, ctrlKey:Bool = false, altKey:Bool = false, shiftKey:Bool = false, commandKey:Bool = false, controlKey:Bool = false, timestamp:Float = 0, ?touchIntent:String, ?samples:ByteArray, isTouchPointCanceled:Bool = false)

    Creates an Event object that contains information about touch events. Event objects are passed as parameters to event listeners.

    Parameters:

    type

    The type of the event. Possible values are: @@ -112,7 +112,7 @@ TouchEvent.TOUCH_TAP.

    bubbles

    Determines whether the Event object participates in the bubbling phase of the event flow.

    cancelable

    Determines whether the Event object can be -canceled.

    touchPointID

    A unique identification number(as an int) +canceled.

    touchPointID

    A unique identification number (as an int) assigned to the touch point.

    isPrimaryTouchPoint

    Indicates whether the first point of contact is mapped to mouse events.

    relatedObject

    The complementary InteractiveObject instance that is affected by the event. For example, @@ -123,13 +123,13 @@ key is activated. On Mac, indicates whether either the Ctrl key or the Command key is activated.

    altKey

    Indicates whether the Alt key is activated -(Windows or Linux only).

    shiftKey

    Indicates whether the Shift key is activated.

    Variables

    altKey:Bool

    Indicates whether the Alt key is active(true) or inactive +(Windows or Linux only).

    shiftKey

    Indicates whether the Shift key is activated.

    Variables

    altKey:Bool

    Indicates whether the Alt key is active (true) or inactive (false). Supported for Windows and Linux operating systems only.

    commandKey:Bool

    Indicates whether the command key is activated (Mac only).

    On a Mac OS, the value of the commandKey property is the same value as the ctrlKey property. This property is always false on Windows or Linux.

    controlKey:Bool

    Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.

    ctrlKey:Bool

    On Windows or Linux, indicates whether the Ctrl key is active -(true) or inactive(false). On Macintosh, +(true) or inactive (false). On Macintosh, indicates whether either the Control key or the Command key is activated.

    isPrimaryTouchPoint:Bool

    Indicates whether the first point of contact is mapped to mouse events.

    localX:Float

    The horizontal coordinate at which the event occurred relative to the containing sprite.

    localY:Float

    The vertical coordinate at which the event occurred relative to the containing sprite.

    pressure:Float

    A value between 0.0 and 1.0 indicating force of @@ -144,14 +144,14 @@ circumstances: if there is no related object, or there is a related object, but it is in a security sandbox to which you don't have access. Use the isRelatedObjectInaccessible() property to determine -which of these reasons applies.

    shiftKey:Bool

    Indicates whether the Shift key is active(true) or inactive +which of these reasons applies.

    shiftKey:Bool

    Indicates whether the Shift key is active (true) or inactive (false).

    sizeX:Float

    Width of the contact area. Only supported on Android(C++ target), in the range of 0-1.

    sizeY:Float

    Height of the contact area. Only supported on Android(C++ target), in the range of 0-1.

    stageX:Float

    The horizontal coordinate at which the event occurred in global Stage coordinates. This property is calculated when the localX property is set.

    stageY:Float

    The vertical coordinate at which the event occurred in global Stage coordinates. This property is calculated when the localY -property is set.

    touchPointID:Int

    A unique identification number(as an int) assigned to the touch point.

    Methods

    updateAfterEvent():Void

    Instructs OpenFL to render after processing of this event completes, if +property is set.

    touchPointID:Int

    A unique identification number (as an int) assigned to the touch point.

    Methods

    updateAfterEvent():Void

    Instructs OpenFL to render after processing of this event completes, if the display list has been modified.

    Inherited Variables

    Defined by Event

    read onlybubbles:Bool

    Indicates whether an event is a bubbling event. If the event can bubble, this value is true; otherwise it is false.

    When an event occurs, it moves through the three phases of the event @@ -171,7 +171,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -196,13 +196,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/UncaughtErrorEvent.html b/openfl/events/UncaughtErrorEvent.html index a54fddc..c7c8b1b 100644 --- a/openfl/events/UncaughtErrorEvent.html +++ b/openfl/events/UncaughtErrorEvent.html @@ -1,7 +1,7 @@ -openfl.events.UncaughtErrorEvent - API Referenceopenfl.events.UncaughtErrorEvent - OpenFL API Reference
    API Reference
    View source

    class UncaughtErrorEvent

    package openfl.events

    extends ErrorEvent › TextEvent › Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An UncaughtErrorEvent object is dispatched by an instance of the +

    View source

    class UncaughtErrorEvent

    package openfl.events

    extends ErrorEvent › TextEvent › Event

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    An UncaughtErrorEvent object is dispatched by an instance of the UncaughtErrorEvents class when an uncaught error occurs. An uncaught error happens when an error is thrown outside of any try..catch blocks or when an ErrorEvent object is dispatched with no registered listeners. The @@ -129,7 +129,7 @@ error is an asynchronous error that dispatches an error event when the error happens

    However, the error property can potentially be an object of any data -type. ActionScript does not require a throw statement to be used +type. Haxe does not require a throw statement to be used only with Error objects. For example, the following code is legal both at compile time and run time:

    throw new Sprite();
    @@ -187,7 +187,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -212,13 +212,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/UncaughtErrorEvents.html b/openfl/events/UncaughtErrorEvents.html index 589ee17..a86ab2b 100644 --- a/openfl/events/UncaughtErrorEvents.html +++ b/openfl/events/UncaughtErrorEvents.html @@ -1,7 +1,7 @@ -openfl.events.UncaughtErrorEvents - API Referenceopenfl.events.UncaughtErrorEvents - OpenFL API Reference
    API Reference
    View source

    class UncaughtErrorEvents

    package openfl.events

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The UncaughtErrorEvents class provides a way to receive uncaught error +

    View source

    class UncaughtErrorEvents

    package openfl.events

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The UncaughtErrorEvents class provides a way to receive uncaught error events. An instance of this class dispatches an uncaughtError event when a runtime error occurs and the error isn't detected and handled in your code. diff --git a/openfl/events/VideoTextureEvent.html b/openfl/events/VideoTextureEvent.html index b7c4f16..dadfd16 100644 --- a/openfl/events/VideoTextureEvent.html +++ b/openfl/events/VideoTextureEvent.html @@ -1,7 +1,7 @@ -openfl.events.VideoTextureEvent - API Reference

    View source

    class VideoTextureEvent

    package openfl.events

    extends Event

    Available on all platforms

    Almost exactly StageVideoEvent.

    Static variables

    @:value("renderState")staticinlineread onlyRENDER_STATE:EventType<VideoTextureEvent> = "renderState"

    The VideoTextureEvent.RENDER_STATE constant defines the value of the type +

    View source

    class VideoTextureEvent

    package openfl.events

    extends Event

    Available on all platforms

    Almost exactly StageVideoEvent.

    Static variables

    @:value("renderState")staticinlineread onlyRENDER_STATE:EventType<VideoTextureEvent> = "renderState"

    The VideoTextureEvent.RENDER_STATE constant defines the value of the type property of a renderState event object.

    This event has the following properties:

    PropertyValue
    bubblesfalse
    cancelablefalse; there is no default behavior to cancel.
    colorSpaceThe available color spaces for displaying the video.
    currentTargetThe object that is actively processing the StageVideoEvent object with an event listener.
    statusIndicates whether the video is being rendered (decoded and displayed) by hardware or software, or not at all.
    targetThe VideoTexture object that changed state.

    Constructor

    @:value({ colorSpace : null, status : null, cancelable : false, bubbles : false })new(type:String, bubbles:Bool = false, cancelable:Bool = false, ?status:String, ?colorSpace:String)

    Variables

    @:isVarread onlycolorSpace:String

    The color space used by the video being displayed in the VideoTexture object.

    @:isVarread onlystatus:String

    The status of the VideoTexture object.

    Methods

    Inherited Variables

    Defined by Event

    read onlybubbles:Bool

    Indicates whether an event is a bubbling event. If the event can bubble, this value is true; otherwise it is false.

    @@ -73,7 +73,7 @@ following numeric values:

    read onlytarget:Object

    The event target. This property contains the target node. For example, if a user clicks an OK button, the target node is the display list node containing that button.

    read onlytype:String

    The type of event. The type is case-sensitive.

    Inherited Methods

    Defined by Event

    @:value({ p5 : null, p4 : null, p3 : null, p2 : null, p1 : null })formatToString(className:String, ?p1:String, ?p2:String, ?p3:String, ?p4:String, ?p5:String):String

    A utility function for implementing the toString() method in custom -ActionScript 3.0 Event classes. Overriding the toString() method is +OpenFL Event classes. Overriding the toString() method is recommended, but not required.

    class PingEvent extends Event {
 	var URL:String;
@@ -98,13 +98,13 @@
 and it affects event listeners in the current node. In contrast, the
 stopPropagation() method doesn't take effect until all the
 event listeners in the current node finish processing.
    
-
    Note:  This method does not cancel the behavior associated with
+
    Note: This method does not cancel the behavior associated with
 this event; see preventDefault() for that functionality.

    stopPropagation():Void

    Prevents processing of any event listeners in nodes subsequent to the current node in the event flow. This method does not affect any event -listeners in the current node(currentTarget). In contrast, +listeners in the current node (currentTarget). In contrast, the stopImmediatePropagation() method prevents processing of event listeners in both the current node and subsequent nodes. Additional calls to this method have no effect. This method can be called in any phase of the event flow.

    -

    Note: This method does not cancel the behavior associated with +

    Note: This method does not cancel the behavior associated with this event; see preventDefault() for that functionality.

    \ No newline at end of file diff --git a/openfl/events/index.html b/openfl/events/index.html index f508aa8..abd2703 100644 --- a/openfl/events/index.html +++ b/openfl/events/index.html @@ -1,7 +1,7 @@ -openfl.events - API Reference

    openfl.events

    -
    ..
    AccelerometerEvent

    The Accelerometer class dispatches AccelerometerEvent objects when +

    openfl.events

    Here are some selections from the OpenFL Developer's Guide to help you get started with the openfl.events package:

    ..
    AccelerometerEvent

    The Accelerometer class dispatches AccelerometerEvent objects when acceleration updates are obtained from the Accelerometer sensor installed on the device.

    ActivityEvent

    A Camera or Microphone object dispatches an ActivityEvent object whenever a camera or microphone reports that it has become active or inactive. @@ -113,7 +80,10 @@

    package ::full::

    class allows any object on the display list to be an event target and as such, to use the methods of the IEventDispatcher interface.

    EventPhase

    The EventPhase class provides values for the eventPhase property of the Event class.

    EventType

    The EventType abstract type provides type safety when -matching dispatch events with the correct type of listener

    FileListEvent

    FocusEvent

    An object dispatches a FocusEvent object when the user changes the focus +matching dispatch events with the correct type of listener

    FileListEvent

    A File object dispatches a FileListEvent object when a call to the +getDirectoryListingAsync() method of a File object successfully enumerates +a set of files and directories or when a user selects files after a call to +the browseForOpenMultiple() method.

    FocusEvent

    An object dispatches a FocusEvent object when the user changes the focus from one object in the display list to another. There are four types of focus events:

    FullScreenEvent

    The Stage object dispatches a FullScreenEvent object whenever the Stage enters or leaves full-screen display mode. There is only one type of @@ -121,7 +91,8 @@

    package ::full::

    updates from the location sensor installed on the device.

    HTTPStatusEvent

    The application dispatches HTTPStatusEvent objects when a network request returns an HTTP status code.

    IEventDispatcher

    The IEventDispatcher interface defines methods for adding or removing event listeners, checks whether specific types of event listeners are registered, and dispatches events.

    IOErrorEvent

    An IOErrorEvent object is dispatched when an error causes input or output -operations to fail.

    InvokeEvent
    KeyboardEvent

    A KeyboardEvent object id dispatched in response to user input through a +operations to fail.

    InvokeEvent

    The NativeApplication object of an OpenFL application dispatches an invoke +event when the application is invoked.

    KeyboardEvent

    A KeyboardEvent object id dispatched in response to user input through a keyboard. There are two types of keyboard events: KeyboardEvent.KEY_DOWN and KeyboardEvent.KEY_UP

    MouseEvent

    A MouseEvent object is dispatched into the event flow whenever mouse events occur. A mouse event is usually generated by a user input device, such as a @@ -132,7 +103,9 @@

    package ::full::

    size or location of the window changes.

    NativeWindowDisplayStateEvent

    A NativeWindow object dispatches events of the NativeWindowDisplayStateEvent class when the window display state changes.

    NetStatusEvent

    A NetConnection, NetStream, or SharedObject object dispatches NetStatusEvent objects when a it reports its status. There is only one -type of status event: NetStatusEvent.NET_STATUS.

    OutputProgressEvent

    PermissionEvent

    This event is dispatched when permission status changes for certain +type of status event: NetStatusEvent.NET_STATUS.

    OutputProgressEvent

    A FileStream object dispatches OutputProgressEvent objects as pendin +asynchronous file write operations are performed. There is one type of +output progress event: OutputProgressEvent.OUTPUT_PROGRESS.

    PermissionEvent

    This event is dispatched when permission status changes for certain operations.

    ProgressEvent

    A ProgressEvent object is dispatched when a load operation has begun or a socket has received data. These events are usually generated when SWF files, images or data are loaded into an application. There are two types @@ -157,13 +130,13 @@

    package ::full::

    types of text events: TextEvent.LINK and TextEvent.TEXT_INPUT.

    TimerEvent

    A Timer object dispatches a TimerEvent objects whenever the Timer object reaches the interval specified by the Timer.delay property.

    TouchEvent

    The TouchEvent class lets you handle events on devices that detect user -contact with the device(such as a finger on a touch screen). When a user +contact with the device (such as a finger on a touch screen). When a user interacts with a device such as a mobile phone or tablet with a touch screen, the user typically touches the screen with his or her fingers or a pointing device. You can develop applications that respond to basic touch events(such as a single finger tap) with the TouchEvent class. Create event listeners using the event types defined in this class. For user -interaction with multiple points of contact(such as several fingers moving +interaction with multiple points of contact (such as several fingers moving across a touch screen at the same time) use the related GestureEvent, PressAndTapGestureEvent, and TransformGestureEvent classes. And, use the properties and methods of these classes to construct event handlers that diff --git a/openfl/external/ExternalInterface.html b/openfl/external/ExternalInterface.html index 67625d3..570778a 100644 --- a/openfl/external/ExternalInterface.html +++ b/openfl/external/ExternalInterface.html @@ -1,7 +1,7 @@ -openfl.external.ExternalInterface - API Referenceopenfl.external.ExternalInterface - OpenFL API Reference

    View source

    final class ExternalInterface

    package openfl.external

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Stage)@:access(lime.ui.Window)@:final

    Available on all platforms

    The ExternalInterface class is an application programming interface that +

    View source

    final class ExternalInterface

    package openfl.external

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Stage)@:access(lime.ui.Window)@:final

    Available on all platforms

    The ExternalInterface class is an application programming interface that enables straightforward communication between ActionScript and the SWF container — for example, an HTML page with JavaScript or a desktop application that uses Flash Player to display a SWF file.

    @@ -82,11 +82,11 @@ id and name attributes.

    Note for Flash Player applications: In Flash Player 10 and later running in a browser, using this class programmatically to open a pop-up -window may not be successful. Various browsers(and browser configurations) +window may not be successful. Various browsers (and browser configurations) may block pop-up windows at any time; it is not possible to guarantee any pop-up window will appear. However, for the best chance of success, use this class to open a pop-up window only in code that executes as a direct -result of a user action(for example, in an event handler for a mouse click +result of a user action (for example, in an event handler for a mouse click or key-press event.)

    From ActionScript, you can do the following on the HTML page:

    • Call any JavaScript function.
    • Pass any number of arguments, with any names.
    • Pass various data types(Boolean, Number, String, and so on).
    • Receive a return value from the JavaScript function.

    From JavaScript on the HTML page, you can:

    • Call an ActionScript function.
    • Pass arguments using standard function call notation.
    • Return a value to the JavaScript function.
    @@ -160,7 +160,7 @@ interface to the native container application.

    Note: For local content running in a browser, calls to the ExternalInterface.call() method are permitted only if the -SWF file and the containing web page(if there is one) are in the +SWF file and the containing web page (if there is one) are in the local-trusted security sandbox. Also, you can prevent a SWF file from using this method by setting the allowNetworking parameter of the object and embed tags in the HTML page that @@ -169,13 +169,13 @@

    Note for Flash Player applications: In Flash Player 10 and Flash Player 9 Update 5, some web browsers restrict this method if a pop-up blocker is enabled. In this scenario, you can only call this method -successfully in response to a user event(for example, in an event handler +successfully in response to a user event (for example, in an event handler for a mouse click or keypress event).

    Parameters:

    functionName

    The alphanumeric name of the function to call in the container. Using a non-alphanumeric function name -causes a runtime error(error 2155). You can use a +causes a runtime error (error 2155). You can use a try..catch block to handle the error.

    Returns:

    The response received from the container. If the call failed — for example, if there is no such function in the container, the -interface is not available, a recursion occurred(with a Netscape +interface is not available, a recursion occurred (with a Netscape or Opera browser), or there is a security issue — null is returned and an error is thrown.

    Throws:

    Error

    The container does not support outgoing calls. Outgoing calls are supported only in Internet diff --git a/openfl/external/index.html b/openfl/external/index.html index b6bf32d..56cfd7e 100644 --- a/openfl/external/index.html +++ b/openfl/external/index.html @@ -1,7 +1,7 @@ -openfl.external - API Reference

    openfl.external

    -
    ..
    ExternalInterface

    The ExternalInterface class is an application programming interface that +

    openfl.external

    ..
    ExternalInterface

    The ExternalInterface class is an application programming interface that enables straightforward communication between ActionScript and the SWF container — for example, an HTML page with JavaScript or a desktop application that uses Flash Player to display a SWF file.

    \ No newline at end of file diff --git a/openfl/filesystem/File.html b/openfl/filesystem/File.html index c9dc6fd..77d080e 100644 --- a/openfl/filesystem/File.html +++ b/openfl/filesystem/File.html @@ -1,7 +1,7 @@ -openfl.filesystem.File - API Referenceopenfl.filesystem.File - OpenFL API Reference
    View source

    class File

    package openfl.filesystem

    extends FileReference › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    A File object represents a path to a file or directory. This can be an existing file +

    View source

    class File

    package openfl.filesystem

    extends FileReference › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    A File object represents a path to a file or directory. This can be an existing file or directory, or it can be one that does not yet exist; for instance, it can represent the path to a file or directory that you plan to create.

    The File class has a number of properties and methods for getting information about the @@ -83,7 +83,7 @@ property.

    Events:

    cancel

    Dispatched when a pending asynchronous operation is canceled.

    complete

    Dispatched when an asynchronous operation is complete.

    directoryListing

    Dispatched when a directory list is available as a result of a call to the getDirectoryListingAsync() method.

    ioError

    Dispatched when an error occurs during an asynchronous file operation.

    securityError

    Dispatched when an operation violates a security constraint.

    select

    Dispatched when the user selects a file or directory from a file- or directory-browsing dialog box.

    selectMultiple

    Dispatched when the user selects files from the dialog box opened -by a call to the browseForOpenMultiple() method.

    See also:

    Static variables

    staticread onlyapplicationDirectory:File

    The folder containing the application's installed files.

    +by a call to the browseForOpenMultiple() method.

    See also:

    Static variables

    staticread onlyapplicationDirectory:File

    The folder containing the application's installed files.

    The url property for this object uses the app URL scheme (not the file URL scheme). This means that the url string is specified starting with "app:" (not "file:"). Also, if you create a File object relative to the File.applicationDirectory directory (by using the @@ -102,7 +102,7 @@ directory using the nativePath or url property, it will only work on the platform for which that path is valid.

    On Android, the nativePath property of a File object pointing to the application directory -is an empty string. Use the url property to access application files.

    staticread onlyapplicationStorageDirectory:File

    The application's private storage directory.

    +is an empty string. Use the url property to access application files.

    See also:

    staticread onlyapplicationStorageDirectory:File

    The application's private storage directory.

    Each application has a unique, persistent application storage directory, which is created when you first access File.applicationStorageDirectory. This directory is unique to each application and user. This directory is a convenient location to store user-specific @@ -122,7 +122,7 @@ var tempFiles:File = File.applicationStorageDirectory; tempFiles = tempFiles.resolvePath("images/"); -trace(tempFiles.url); // app-storage:/images

    staticread onlydesktopDirectory:File

    The user's desktop directory.

    +trace(tempFiles.url); // app-storage:/images

    See also:

    staticread onlydesktopDirectory:File

    The user's desktop directory.

    The desktopDirectory property provides a way to reference the desktop directory that works across platforms. If you set a File object to reference the desktop directory using the nativePath or url property, it will only work on the platform for which that path is valid.

    @@ -135,7 +135,7 @@ for (i in 0...files.length) { trace(files[i].nativePath); -}

    staticread onlydocumentsDirectory:File

    The user's documents directory.

    +}

    See also:

    staticread onlydocumentsDirectory:File

    The user's documents directory.

    On Windows, this is the My Documents directory (for example, C:\Documents and Settings\userName\My Documents). On Mac OS, the default location is /Users/userName/Documents. On Linux, the default location is /home/userName/Documents (on an English system), and the property observes the xdg-user-dirs setting.

    @@ -152,17 +152,17 @@ directory = directory.resolvePath("OpenFL Test"); File.createDirectory(directory); -trace(directory.exists); // true

    staticread onlylineEnding:String

    The line-ending character sequence used by the host operating system.

    +trace(directory.exists); // true

    See also:

    staticread onlylineEnding:String

    The line-ending character sequence used by the host operating system.

    On Mac OS and Linux, this is the line-feed character (character code 0x0A hexadecimal). On Windows, this is the carriage return character (character code 0x0D hexadecimal) followed by the line-feed character -(character code 0x0A hexadecimal).

    staticread onlyseparator:String

    The host operating system's path component separator character.

    +(character code 0x0A hexadecimal).

    See also:

    staticread onlyseparator:String

    The host operating system's path component separator character.

    On Mac OS and Linux, this is the forward slash (/) character. On Windows, it is the backslash (\) character.

    Note: When using the backslash character in a String literal, remember to type the character twice (as in "directory\\file.ext"). Each pair of backslashes in a String literal represent a single backslash in the -String.

    staticread onlyuserDirectory:File

    The user's directory.

    +String.

    See also:

    staticread onlyuserDirectory:File

    The user's directory.

    On Windows, this is the parent of the My Documents directory (for example, C:\Documents and Settings\userName). On Mac OS, it is /Users/userName. On Linux, it is /home/userName.

    The userDirectory property provides a way to reference the user directory that works across platforms. If you @@ -176,47 +176,42 @@ var files:Array = File.userDirectory.listDirectory(); for (i in 0...files.length) { trace(files[i].nativePath); -}

    Static methods

    staticcreateTempDirectory():File

    Returns a reference to a new temporary directory. This is a new directory in the system's +}

    See also:

    staticread onlyworkingDirectory:File

    The application's working directory.

    Static methods

    staticcreateTempDirectory():File

    Returns a reference to a new temporary directory. This is a new directory in the system's temporary directory path.

    This method lets you identify a new, unique directory, without having to query the system to see that the directory is new and unique.

    You may want to delete the temporary directory before closing the application, since on some -devices it is not deleted automatically.

    Returns:

    File A File object referencing the new temporary directory. -The following code uses the createTempFile() method to obtain a reference to a new temporary +devices it is not deleted automatically.

    +

    The following code uses the createTempFile() method to obtain a reference to a new temporary directory.

    import openfl.File;
+
 var temp:File = File.createTempDirectory();
 trace(temp.nativePath);
    -

    Each time you run this code, a new (unique) file is created.

    staticcreateTempFile():File

    Returns a reference to a new temporary file. This is a new file in the system's temporary +

    Each time you run this code, a new (unique) file is created.

    Returns:

    File A File object referencing the new temporary directory.

    See also:

    staticcreateTempFile():File

    Returns a reference to a new temporary file. This is a new file in the system's temporary directory path.

    This method lets you identify a new, unique file, without having to query the system to see that the file is new and unique.

    You may want to delete the temporary file before closing the application, since it is not deleted -automatically.

    Returns:

    File A File object referencing the new temporary file; -The following code uses the createTempFile() method to obtain a reference to a new temporary file.

    +automatically.

    +

    The following code uses the createTempFile() method to obtain a reference to a new temporary file.

    import openfl.File;
+
 var temp:File = File.createTempFile();
-trace(temp.nativePath);

    staticgetRootDirectories():Array<File>

    Returns an array of File objects, listing the file system root directories.

    +trace(temp.nativePath);

    Returns:

    File A File object referencing the new temporary file;

    See also:

    staticgetRootDirectories():Array<File>

    Returns an array of File objects, listing the file system root directories.

    For example, on Windows this is a list of volumes such as the C: drive and the D: drive. An empty drive, such as a CD or DVD drive in which no disc is inserted, is not included in this array. On Mac OS and Linux, this method always returns the unique root directory for the machine (the "/" directory)

    -
    	On file systems for which the root is not readable, such as the Android file system, the properties of
-	the returned File object do not always reflect the true value. For example, on Android, the
-	spaceAvailable property reports 0.
-
-	@returns Array An array of File objects, listing the root directories.
-
-	The following code outputs a list of root directories:
+
    On file systems for which the root is not readable, such as the Android file system, the properties of
+the returned File object do not always reflect the true value. For example, on Android, the
+spaceAvailable property reports 0.
    
+
    The following code outputs a list of root directories:
    
+
    import flash.filesystem.File;
+var rootDirs:Array = File.getRootDirectories();
 
-	```haxe
-	import flash.filesystem.File;
-	var rootDirs:Array = File.getRootDirectories();
-
-	for (i in 0...rootDirs.length) {
-		trace(rootDirs[i].nativePath);
-	}
-	```
-

    Constructor

    @:value({ path : null })new(?path:String)

    The constructor function for the File class.

    +for (i in 0...rootDirs.length) { + trace(rootDirs[i].nativePath); +}

    Returns:

    Array An array of File objects, listing the root directories.

    Constructor

    @:value({ path : null })new(?path:String)

    The constructor function for the File class.

    If you pass a path argument, the File object points to the specified path, and the nativePath property and and url property are set to reflect that path.

    Although you can pass a path argument to specify a file path, consider whether doing so may result in platform-specific @@ -254,7 +249,7 @@ if (userDirFiles[i].isDirectory) { trace(userDirFiles[i].nativePath); } -}

    read onlyisHidden:Bool

    Indicates whether the referenced file or directory is "hidden." The value is true if the +}

    See also:

    read onlyisHidden:Bool

    Indicates whether the referenced file or directory is "hidden." The value is true if the referenced file or directory is hidden, false otherwise.

    The following code creates an array of File objects pointing to files and directories in the user directory and then uses the isHidden property to list hidden files and directories.

    @@ -295,7 +290,7 @@ var tempFile:File = File.createTempDirectory(); trace(tempFile.parent.nativePath); -tempFile.deleteFile();

    Methods

    @:value({ typeFilter : null })browse(?typeFilter:Array<FileFilter>):Bool

    Displays a file-browsing dialog box that lets the user select a file to upload.

    browseForDirectory(title:String):Void

    Displays a directory chooser dialog box, in which the user can select a directory. When the user selects the +tempFile.deleteFile();

    See also:

    read onlyurl:String

    Methods

    @:value({ typeFilter : null })browse(?typeFilter:Array<FileFilter>):Bool

    Displays a file-browsing dialog box that lets the user select a file to upload.

    browseForDirectory(title:String):Void

    Displays a directory chooser dialog box, in which the user can select a directory. When the user selects the directory, the select event is dispatched. The target property of the select event is the File object pointing to the selected directory.

    The directory chooser dialog is not always displayed in front of windows that are "owned" by another window @@ -466,7 +461,7 @@ catch (error:Error) { trace("Error:", error.message); -}

    @:value({ overwrite : false })copyToAsync(newLocation:FileReference, overwrite:Bool = false):Void

    Begins copying the file or directory at the location specified by this File object to the +}

    See also:

    @:value({ overwrite : false })copyToAsync(newLocation:FileReference, overwrite:Bool = false):Void

    Begins copying the file or directory at the location specified by this File object to the location specified by the destination parameter.

    Upon completion, either a complete event (successful) or an ioError event (unsuccessful) is dispatched. The copy process creates any required parent directories (if possible).

    Parameters:

    newLocation

    The target location of the new file. Note that this File object specifies the @@ -489,7 +484,7 @@ }

    Events:

    complete

    Dispatched when the file or directory has been successfully copied.

    ioError

    The source does not exist; or the source could not be copied to the target; or the source and destination refer to the same file or folder and overwrite is set to true. On Windows, you cannot copy a file that is open or a directory that contains a -file that is open.

    createDirectory():Void

    Creates the specified directory and any necessary parent directories. If the directory already exists, +file that is open.

    See also:

    createDirectory():Void

    Creates the specified directory and any necessary parent directories. If the directory already exists, no action is taken.

    Throws:

    IOError

    The directory did not exist and could not be created.

    SecurityError

    The application does not have the necessary permissions. The following code moves a file named test.txt on the desktop to the OpenFL Test subdirectory of the documents directory. The call to the createDirectory() method ensures that the OpenFL Test directory @@ -499,7 +494,7 @@ var target:File = File.documentsDirectory.resolvePath("OpenFL Test/test.txt"); var targetParent:File = target.parent; targetParent.createDirectory(); -source.moveTo(target, true);

    @:value({ deleteDirectoryContents : false })deleteDirectory(deleteDirectoryContents:Bool = false):Void

    Deletes the directory.

    Parameters:

    deleteDirectoryContents

    Specifies whether or not to delete a directory that contains files or +source.moveTo(target, true);

    See also:

    @:value({ deleteDirectoryContents : false })deleteDirectory(deleteDirectoryContents:Bool = false):Void

    Deletes the directory.

    Parameters:

    deleteDirectoryContents

    Specifies whether or not to delete a directory that contains files or subdirectories. When false, if the directory contains files or directories, a call to this method throws an exception.

    Throws:

    IOError

    The directory does not exist, or the directory could not be deleted. On Windows, you cannot delete a directory that contains a file that is open.

    SecurityError

    The application does not have the necessary permissions to delete the directory. @@ -509,27 +504,28 @@ File.createDirectory(directory); trace(directory.exists); // true directory.deleteDirectory(); -trace(directory.exists); // false

    @:value({ deleteDirectoryContents : false })deleteDirectoryAsync(deleteDirectoryContents:Bool = false):Void

    Deletes the directory asynchronously.

    Parameters:

    deleteDirectoryContents

    Specifies whether or not to delete a directory that contains files or +trace(directory.exists); // false

    See also:

    @:value({ deleteDirectoryContents : false })deleteDirectoryAsync(deleteDirectoryContents:Bool = false):Void

    Deletes the directory asynchronously.

    Parameters:

    deleteDirectoryContents

    Specifies whether or not to delete a directory that contains files or subdirectories. When false, if the directory contains files or directories, a call to this method throws an exception.

    Throws:

    SecurityError

    The application does not have the necessary permissions to delete the directory.

    Events:

    complete

    Dispatched when the directory has been deleted successfully.

    ioError

    The directory does not exist or could not be deleted. On Windows, you cannot delete a -directory that contains a file that is open.

    deleteFile():Void

    Deletes the file.

    Throws:

    IOError

    The directory does not exist, or the directory could not be deleted. On Windows, you +directory that contains a file that is open.

    See also:

    deleteFile():Void

    Deletes the file.

    Throws:

    IOError

    The directory does not exist, or the directory could not be deleted. On Windows, you cannot delete a directory that contains a file that is open.

    SecurityError

    The application does not have the necessary permissions to delete the directory. The following code creates a temporary file and then calls the deleteFile() method to delete it.

    import openfl.filesystem.*;
 var file:File = File.createTempFile();
 trace(file.exists); // true
 file.deleteFile();
-trace(file.exists); // false

    deleteFileAsync():Void

    Deletes the file asynchronously.

    Throws:

    SecurityError

    The application does not have the necessary permissions to delete the directory.

    Events:

    complete

    Dispatched when the directory has been deleted successfully.

    ioError

    The directory does not exist or could not be deleted. On Windows, you cannot delete a -directory that contains a file that is open.

    getDirectoryListing():Array<File>

    Returns an array of File objects corresponding to files and directories in the directory -represented by this File object. This method does not explore the contents of subdirectories.

    Returns:

    Array An array of File objects. -The following code shows how to use the getDirectoryListing() method to enumerate the contents of the +trace(file.exists); // false

    See also:

    deleteFileAsync():Void

    Deletes the file asynchronously.

    Throws:

    SecurityError

    The application does not have the necessary permissions to delete the directory.

    Events:

    complete

    Dispatched when the directory has been deleted successfully.

    ioError

    The directory does not exist or could not be deleted. On Windows, you cannot delete a +directory that contains a file that is open.

    See also:

    getDirectoryListing():Array<File>

    Returns an array of File objects corresponding to files and directories in the directory +represented by this File object. This method does not explore the contents of subdirectories.

    +

    The following code shows how to use the getDirectoryListing() method to enumerate the contents of the user directory.

    import openfl.filesystem.File;
+
 var directory:File = File.userDirectory;
 var list:Array = directory.getDirectoryListing();
 for (i in 0...list.length) {
 	trace(list[i].nativePath);
-}

    getDirectoryListingAsync():Void

    Asynchronously retrieves an array of File objects corresponding to the contents of the +}

    Returns:

    Array An array of File objects.

    See also:

    getDirectoryListingAsync():Void

    Asynchronously retrieves an array of File objects corresponding to the contents of the directory represented by this File object.

    Events:

    ioError

    You do not have adequate permissions to read this directory, or the directory does not exist.

    directoryListing

    The directory contents have been enumerated successfully. The contents event includes a files property, which is the resulting array of File objects. @@ -545,7 +541,7 @@ for (i in 0...list.length) { trace(list[i].nativePath); } -}

    @:value({ useDotDot : false })getRelativePath(ref:FileReference, useDotDot:Bool = false):String

    Finds the relative path between two File paths.

    +}

    See also:

    @:value({ useDotDot : false })getRelativePath(ref:FileReference, useDotDot:Bool = false):String

    Finds the relative path between two File paths.

    The relative path is the list of components that can be appended to (resolved against) this reference in order to locate the second (parameter) reference. The relative path is returned using the "/" separator character.

    @@ -580,11 +576,12 @@ catch (error:Error) { trace("Error:" + error.message); -}

    @:value({ overwrite : false })moveToAsync(newLocation:FileReference, overwrite:Bool = false):Void

    Begins moving the file or directory at the location specified by this File object to +}

    See also:

    @:value({ overwrite : false })moveToAsync(newLocation:FileReference, overwrite:Bool = false):Void

    Begins moving the file or directory at the location specified by this File object to the location specified by the newLocation parameter.

    To rename a file, set the destination parameter to point to a path that is in the file's directory, but with a different filename.

    -

    The move process creates any required parent directories (if possible).

    Parameters:

    newLocation

    The target location for the move. This object specifies the path to the +

    The move process creates any required parent directories (if possible).

    +

    @see Working with files

    Parameters:

    newLocation

    The target location for the move. This object specifies the path to the resulting (moved) file or directory, not the path to the containing directory.

    overwrite

    If false, the move fails if the target file already exists. If true, the operation overwrites any existing file or directory of the same name.

    Throws:

    SecurityError

    The application does not have the necessary permissions to move the file. The following code shows how to use the moveToAsync() method to rename a file. The original filename @@ -605,7 +602,8 @@ { trace("Done.") } - ```

    Events:

    complete

    Dispatched when the file or directory has been successfully moved.

    ioError

    The source does not exist; or the destination exists and overwrite is false; or + ``` +

    Events:

    complete

    Dispatched when the file or directory has been successfully moved.

    ioError

    The source does not exist; or the destination exists and overwrite is false; or the source could not be moved to the target; or the source and destination refer to the same file or folder and overwrite is set to true. On Windows, you cannot move a file that is open or a directory that contains a file that is open.

    openWithDefaultApplication():Void

    Opens the file in the application registered by the operating system to open this file type.

    resolvePath(path:String):File

    Creates a new File object with a path relative to this File object's path, based on the path @@ -758,8 +756,8 @@

    This method supports downloading of any file type, with either HTTP or HTTPS.

    You cannot connect to commonly reserved ports. For a complete list of -blocked ports, see "Restricting Networking APIs" in the ActionScript -3.0 Developer's Guide.

    +blocked ports, see "Restricting Networking APIs" in the OpenFL +Developer's Guide.

    Note: If your server requires user authentication, only SWF files running in a browser ?that is, using the browser plug-in or ActiveX control ?can provide a dialog box to prompt the user for a user @@ -855,7 +853,7 @@ file security restrictions.

    SecurityError

    You cannot connect to commonly reserved ports. For a complete list of blocked ports, see "Restricting Networking APIs" -in the ActionScript 3.0 Developer's +in the OpenFL Developer's Guide.

    Events:

    cancel

    Dispatched when the user dismisses the dialog box.

    complete

    Dispatched when the file download operation successfully completes.

    ioError

    Dispatched for any of the following reasons: @@ -873,7 +871,7 @@ control and browser plug-in players.

    open

    Dispatched when a download operation starts.

    progress

    Dispatched periodically during the file download operation.

    securityError

    Dispatched when a download fails because of a security error.

    select

    Dispatched when the user selects a file for -download from the dialog box.

    load():Void

    Starts the load of a local file selected by a user. Although Flash +download from the dialog box.

    See also:

    load():Void

    Starts the load of a local file selected by a user. Although Flash Player has no restriction on the size of files you can upload, download, load or save, it officially supports sizes of up to 100 MB. For content running in Flash Player, you must call the @@ -931,7 +929,7 @@ successfully.

    ioError

    Invoked if the load fails because of an input/output error while the application is reading or writing the file.

    open

    Dispatched when an load operation starts.

    progress

    Dispatched periodically during the file load -operation.

    @:value({ defaultFileName : null })save(data:Dynamic, ?defaultFileName:String):Void

    Opens a dialog box that lets the user save a file to the local +operation.

    See also:

    @:value({ defaultFileName : null })save(data:Dynamic, ?defaultFileName:String):Void

    Opens a dialog box that lets the user save a file to the local filesystem. Although Flash Player has no restriction on the size of files you can upload, download, load or save, the player officially supports sizes of up to 100 MB. @@ -1010,7 +1008,7 @@ successfully completes.

    ioError

    Dispatched if an input/output error occurs while the file is being read or transmitted.

    open

    Dispatched when a download operation starts.

    progress

    Dispatched periodically during the file download operation.

    select

    Dispatched when the user selects a file for download -from the dialog box.

    @:value({ testUpload : false, uploadDataFieldName : "Filedata" })upload(request:URLRequest, uploadDataFieldName:String = "Filedata", testUpload:Bool = false):Void

    Starts the upload of the file to a remote server. Although Flash +from the dialog box.

    See also:

    @:value({ testUpload : false, uploadDataFieldName : "Filedata" })upload(request:URLRequest, uploadDataFieldName:String = "Filedata", testUpload:Bool = false):Void

    Starts the upload of the file to a remote server. Although Flash Player has no restriction on the size of files you can upload or download, the player officially supports uploads or downloads of up to 100 MB. You must call the FileReference.browse() or @@ -1039,8 +1037,8 @@ default and a filename attribute set to the name of the original file

  • The binary contents of the file

    • You cannot connect to commonly reserved ports. For a complete list of -blocked ports, see "Restricting Networking APIs" in the ActionScript -3.0 Developer's Guide.

    +blocked ports, see "Restricting Networking APIs" in the OpenFL +Developer's Guide.

    For a sample POST request, see the description of the uploadDataFieldName parameter. You can send POST or GET parameters to the server with the upload() method; see the @@ -1168,7 +1166,7 @@ and the URL that may not be accessed.

    SecurityError

    You cannot connect to commonly reserved ports. For a complete list of blocked ports, see "Restricting Networking APIs" -in the ActionScript 3.0 Developer's +in the OpenFL Developer's Guide.

    Events:

    complete

    Dispatched when the file upload operation completes successfully.

    httpResponseStatus

    The upload operation completes successfully and the server returns a response URL and @@ -1189,7 +1187,7 @@ HTTPS.

    open

    Dispatched when an upload operation starts.

    progress

    Dispatched periodically during the file upload operation.

    securityError

    Dispatched when an upload fails because of a security violation.

    uploadCompleteData

    Dispatched when data has been received from -the server after a successful file upload.

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that +the server after a successful file upload.

    See also:

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

    @@ -1262,7 +1260,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/filesystem/FileMode.html b/openfl/filesystem/FileMode.html index 783b745..dd7a4c0 100644 --- a/openfl/filesystem/FileMode.html +++ b/openfl/filesystem/FileMode.html @@ -1,7 +1,10 @@ -openfl.filesystem.FileMode - API Reference

    View source

    enum abstract FileMode(String)

    package openfl.filesystem

    from String to String

    @:enum

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    Variables

    @:value(cast "append")@:impl@:enuminlineread onlyAPPEND:String = cast "append"

    Used for a file to be opened in write mode, with all written data appended to the end of the file. -Upon opening, any nonexistent file is created. .

    @:value(cast "read")@:impl@:enuminlineread onlyREAD:String = cast "read"

    Used for a file to be opened in read-only mode. The file must exist (missing files are not created).

    @:value(cast "update")@:impl@:enuminlineread onlyUPDATE:String = cast "update"

    Used for a file to be opened in read/write mode. Upon opening, any nonexistent file is created.

    @:value(cast "write")@:impl@:enuminlineread onlyWRITE:String = cast "write"

    Used for a file to be opened in write-only mode. Upon opening, any nonexistent file is created, and -any existing file is truncated (its data is deleted).

    \ No newline at end of file +
    View source

    enum abstract FileMode(String)

    package openfl.filesystem

    from String to String

    @:enum

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The FileMode enum defines string constants used in the fileMode parameter +of the open() and openAsync() methods of the FileStream class. The +fileMode parameter of these methods determines the capabilities available +to the FileStream object once the file is opened.

    +

    The following capabilities are available, in various combinations, based on +the fileMode parameter value specified in the open method:

    • Reading — The FileStream object can read data from the file.
    • Writing — The FileStream object can write data to the file.
    • Creating — The FileStream object creates a nonexistent file upon opening.
    • Truncate upon opening — Data in the file is deleted upon opening (before any data is written).
    • Append written data — Data is always written to the end of the file (when any write method is called).

    See also:

    Variables

    @:value(cast "append")@:impl@:enuminlineread onlyAPPEND:String = cast "append"

    Used for a file to be opened in write mode, with all written data +appended to the end of the file. Upon opening, any nonexistent file is +created.

    @:value(cast "read")@:impl@:enuminlineread onlyREAD:String = cast "read"

    Used for a file to be opened in read-only mode. The file must exist +(missing files are not created).

    @:value(cast "update")@:impl@:enuminlineread onlyUPDATE:String = cast "update"

    Used for a file to be opened in read/write mode. Upon opening, any +nonexistent file is created.

    @:value(cast "write")@:impl@:enuminlineread onlyWRITE:String = cast "write"

    Used for a file to be opened in write-only mode. Upon opening, any +nonexistent file is created, and any existing file is truncated (its +data is deleted).

    \ No newline at end of file diff --git a/openfl/filesystem/FileStream.html b/openfl/filesystem/FileStream.html index f3f1746..61828ae 100644 --- a/openfl/filesystem/FileStream.html +++ b/openfl/filesystem/FileStream.html @@ -1,7 +1,7 @@ -openfl.filesystem.FileStream - API Referenceopenfl.filesystem.FileStream - OpenFL API Reference
    View source

    class FileStream

    package openfl.filesystem

    extends EventDispatcher

    implements IDataOutput, IDataInput

    @:access(openfl.utils.ByteArray)@:access(openfl.utils.ByteArrayData)@:access(openfl.filesystem.File)@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    A FileStream object is used to read and write files. Files can be opened synchronously +

    View source

    class FileStream

    package openfl.filesystem

    extends EventDispatcher

    implements IDataOutput, IDataInput

    @:access(openfl.utils.ByteArray)@:access(openfl.utils.ByteArrayData)@:access(openfl.filesystem.File)@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    A FileStream object is used to read and write files. Files can be opened synchronously by calling the open() method or asynchronously by calling the openAsync() method.

    The advantage of opening files asynchronously is that other code can execute while Adobe AIR runs read and write processes in the background. When opened asynchronously, progress @@ -72,9 +72,9 @@

    An application that is processing asynchronous input typically registers for progress events and consumes the data as it becomes available by calling read methods. Alternatively, an application can simply wait until all of the data is available by registering for the complete -event and processing the entire data set when the complete event is dispatched.

    Constructor

    new()

    Creates a FileStream object. Use the open() or openAsync() method to open a file.

    Variables

    read onlybytesAvailable:Int

    Returns the number of bytes of data available for reading in the input buffer. User code +event and processing the entire data set when the complete event is dispatched.

    See also:

    Constructor

    new()

    Creates a FileStream object. Use the open() or openAsync() method to open a file.

    Variables

    read onlybytesAvailable:Int

    Returns the number of bytes of data available for reading in the input buffer. User code must call bytesAvailable to ensure that sufficient data is available before trying to read -it with one of the read methods.

    endian:Endian

    The byte order for the data, either the BIG_ENDIAN or LITTLE_ENDIAN constant from the Endian +it with one of the read methods.

    See also:

    endian:Endian

    The byte order for the data, either the BIG_ENDIAN or LITTLE_ENDIAN constant from the Endian class.

    @:value(false)read onlyisWriting:Bool = false

    The isWriting property returns a bool used to identify the write state of asynchronous Update, Append, or Write streams. If isWrite is true, data is actively being written from the buffer.

    objectEncoding:ObjectEncoding

    Specifies whether the HXSF, JSON, AMF3 or AMF0 format is used when writing or reading binary data by using the readObject() or writeObject() method.

    @@ -89,7 +89,7 @@

    When reading a file asyncronously, if you set the position property, the application begins filling the read buffer with the data starting at the specified position, and the bytesAvailable property may be set to 0. Wait for a complete event before using a read method to read data; -or wait for a progress event and check the bytesAvailable property before using a read method.

    @:value(Math.POSITIVE_INFINITY)readAhead:Float = Math.POSITIVE_INFINITY

    The minimum amount of data to read from disk when reading files asynchronously.

    +or wait for a progress event and check the bytesAvailable property before using a read method.

    See also:

    @:value(Math.POSITIVE_INFINITY)readAhead:Float = Math.POSITIVE_INFINITY

    The minimum amount of data to read from disk when reading files asynchronously.

    This property specifies how much data an asynchronous stream attempts to read beyond the current position. Data is read in blocks based on the file system page size. Thus if you set readAhead to 9,000 on a computer system with an 8KB (8192 byte) page size, the runtime reads ahead 2 blocks, @@ -121,7 +121,7 @@

    For file reading operations, the end of the file has not been reached (and the complete event has not been dispatched). Output data is still available to written, and output-related events (such as the -outputProgress event or the ioError event) have registered event listeners.

    Events:

    close

    The file, which was opened asynchronously, is closed.

    open(file:File, fileMode:FileMode):Void

    Opens the FileStream object synchronously, pointing to the file specified by the +outputProgress event or the ioError event) have registered event listeners.

    Events:

    close

    The file, which was opened asynchronously, is closed.

    open(file:File, fileMode:FileMode):Void

    Opens the FileStream object synchronously, pointing to the file specified by the file parameter.

    	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
@@ -141,7 +141,10 @@
 	permissions.
 	@throws 	SecurityError The file location is in the application directory, and the
 	fileMode parameter is set to "append", "update", or "write" mode.
-

    openAsync(file:File, fileMode:FileMode):Void

    Opens the FileStream object asynchronously, pointing to the file specified by the file + + @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) +

    openAsync(file:File, fileMode:FileMode):Void

    Opens the FileStream object asynchronously, pointing to the file specified by the file parameter.

    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.

    @@ -157,7 +160,7 @@ 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.

    progress

    Dispatched as data is read to the input buffer. (The file must be opened with the fileMode parameter set to FileMode.READ or FileMode.UPDATE.)

    complete

    The file data has been read to the input buffer. (The file must be opened -with the fileMode parameter set to FileMode.READ or FileMode.UPDATE.)

    readBoolean():Bool

    Reads a Boolean value from the file stream, byte stream, or byte array. A single byte is read +with the fileMode parameter set to FileMode.READ or FileMode.UPDATE.)

    See also:

    readBoolean():Bool

    Reads a Boolean value from the file stream, byte stream, or byte array. A single byte is read and true is returned if the byte is nonzero, false otherwise.

    Returns:

    A Boolean value, true if the byte is nonzero, false otherwise.

    Throws:

    IOError

    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).

    EOFError

    The position specfied for reading data exceeds the number of bytes available @@ -358,7 +361,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/filesystem/index.html b/openfl/filesystem/index.html index 21c570a..50f914a 100644 --- a/openfl/filesystem/index.html +++ b/openfl/filesystem/index.html @@ -1,7 +1,7 @@ -openfl.filesystem - API Reference

    openfl.filesystem

    -
    ..
    File

    A File object represents a path to a file or directory. This can be an existing file +

    openfl.filesystem

    Here are some selections from the OpenFL Developer's Guide to help you get started with the openfl.filesystem package:

    ..
    File

    A File object represents a path to a file or directory. This can be an existing file or directory, or it can be one that does not yet exist; for instance, it can represent -the path to a file or directory that you plan to create.

    FileMode

    FileStream

    A FileStream object is used to read and write files. Files can be opened synchronously +the path to a file or directory that you plan to create.

    FileMode

    The FileMode enum defines string constants used in the fileMode parameter +of the open() and openAsync() methods of the FileStream class. The +fileMode parameter of these methods determines the capabilities available +to the FileStream object once the file is opened.

    FileStream

    A FileStream object is used to read and write files. Files can be opened synchronously by calling the open() method or asynchronously by calling the openAsync() method.

    \ No newline at end of file diff --git a/openfl/filters/BitmapFilter.html b/openfl/filters/BitmapFilter.html index 21e8803..48f78db 100644 --- a/openfl/filters/BitmapFilter.html +++ b/openfl/filters/BitmapFilter.html @@ -1,7 +1,7 @@ -openfl.filters.BitmapFilter - API Reference
    View source

    class BitmapFilter

    package openfl.filters

    extended by BlurFilter, ColorMatrixFilter, ConvolutionFilter, DisplacementMapFilter, DropShadowFilter, GlowFilter, ShaderFilter

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The BitmapFilter class is the base class for all image filter effects.

    +
    View source

    class BitmapFilter

    package openfl.filters

    extended by BlurFilter, ColorMatrixFilter, ConvolutionFilter, DisplacementMapFilter, DropShadowFilter, GlowFilter, ShaderFilter

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The BitmapFilter class is the base class for all image filter effects.

    The BevelFilter, BlurFilter, ColorMatrixFilter, ConvolutionFilter, DisplacementMapFilter, DropShadowFilter, GlowFilter, GradientBevelFilter, and GradientGlowFilter classes all extend the BitmapFilter class. You can diff --git a/openfl/filters/BitmapFilterQuality.html b/openfl/filters/BitmapFilterQuality.html index f0ef862..f85bd28 100644 --- a/openfl/filters/BitmapFilterQuality.html +++ b/openfl/filters/BitmapFilterQuality.html @@ -1,7 +1,7 @@ -openfl.filters.BitmapFilterQuality - API Referenceopenfl.filters.BitmapFilterQuality - OpenFL API Reference

    View source

    enum abstract BitmapFilterQuality(Int)

    package openfl.filters

    from Int, UInt to Int, UInt

    @:enum

    Available on all platforms

    The BitmapFilterQuality class contains values to set the rendering quality +

    View source

    enum abstract BitmapFilterQuality(Int)

    package openfl.filters

    from Int, UInt to Int, UInt

    @:enum

    Available on all platforms

    The BitmapFilterQuality class contains values to set the rendering quality of a BitmapFilter object.

    Variables

    @:value(cast 3)@:impl@:enuminlineread onlyHIGH:BitmapFilterQuality = 3

    Defines the high quality filter setting.

    @:value(cast 1)@:impl@:enuminlineread onlyLOW:BitmapFilterQuality = 1

    Defines the low quality filter setting.

    @:value(cast 2)@:impl@:enuminlineread onlyMEDIUM:BitmapFilterQuality = 2

    Defines the medium quality filter setting.

    \ No newline at end of file diff --git a/openfl/filters/BitmapFilterShader.html b/openfl/filters/BitmapFilterShader.html index 0fbf094..d9b01eb 100644 --- a/openfl/filters/BitmapFilterShader.html +++ b/openfl/filters/BitmapFilterShader.html @@ -1,7 +1,7 @@ -openfl.filters.BitmapFilterShader - API Reference
    View source

    class BitmapFilterShader

    package openfl.filters

    extends Shader

    @:build(openfl.utils._internal.ShaderMacro.build())@:autoBuild(openfl.utils._internal.ShaderMacro.build())@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Constructor

    @:value({ code : null })@:glVertexHeader("attribute vec4 openfl_Position;\n\t\tattribute vec2 openfl_TextureCoord;\n\n\t\tvarying vec2 openfl_TextureCoordv;\n\n\t\tuniform mat4 openfl_Matrix;\n\t\tuniform vec2 openfl_TextureSize;")@:glVertexBody("openfl_TextureCoordv = openfl_TextureCoord;\n\n\t\tgl_Position = openfl_Matrix * openfl_Position;")@:glVertexSource("#pragma header\n\n\t\tvoid main(void) {\n\n\t\t\t#pragma body\n\n\t\t}")@:glFragmentHeader("varying vec2 openfl_TextureCoordv;\n\n\t\tuniform sampler2D openfl_Texture;\n\t\tuniform vec2 openfl_TextureSize;")@:glFragmentBody("gl_FragColor = texture2D (openfl_Texture, openfl_TextureCoordv);")@:glFragmentSource("#pragma header\n\n\t\tvoid main(void) {\n\n\t\t\t#pragma body\n\n\t\t}")new(?code:ByteArray)

    Inherited Variables

    Defined by Shader

    write onlybyteCode:ByteArray

    The raw shader bytecode for this Shader instance.

    data:ShaderData

    Provides access to parameters, input images, and metadata for the +

    View source

    class BitmapFilterShader

    package openfl.filters

    extends Shader

    @:build(openfl.utils._internal.ShaderMacro.build())@:autoBuild(openfl.utils._internal.ShaderMacro.build())@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Constructor

    @:value({ code : null })@:glVertexHeader("attribute vec4 openfl_Position;\n\t\tattribute vec2 openfl_TextureCoord;\n\n\t\tvarying vec2 openfl_TextureCoordv;\n\n\t\tuniform mat4 openfl_Matrix;\n\t\tuniform vec2 openfl_TextureSize;")@:glVertexBody("openfl_TextureCoordv = openfl_TextureCoord;\n\n\t\tgl_Position = openfl_Matrix * openfl_Position;")@:glVertexSource("#pragma header\n\n\t\tvoid main(void) {\n\n\t\t\t#pragma body\n\n\t\t}")@:glFragmentHeader("varying vec2 openfl_TextureCoordv;\n\n\t\tuniform sampler2D openfl_Texture;\n\t\tuniform vec2 openfl_TextureSize;")@:glFragmentBody("gl_FragColor = texture2D (openfl_Texture, openfl_TextureCoordv);")@:glFragmentSource("#pragma header\n\n\t\tvoid main(void) {\n\n\t\t\t#pragma body\n\n\t\t}")new(?code:ByteArray)

    Inherited Variables

    Defined by Shader

    write onlybyteCode:ByteArray

    The raw shader bytecode for this Shader instance.

    data:ShaderData

    Provides access to parameters, input images, and metadata for the Shader instance. ShaderParameter objects representing parameters for the shader, ShaderInput objects representing the input images for the shader, and other values representing the shader's metadata are diff --git a/openfl/filters/BitmapFilterType.html b/openfl/filters/BitmapFilterType.html index 66bd013..8dda570 100644 --- a/openfl/filters/BitmapFilterType.html +++ b/openfl/filters/BitmapFilterType.html @@ -1,7 +1,7 @@ -openfl.filters.BitmapFilterType - API Referenceopenfl.filters.BitmapFilterType - OpenFL API Reference

    View source

    enum abstract BitmapFilterType(Null<Int>)

    package openfl.filters

    @:enum

    Available on all platforms

    The BitmapFilterType class contains values to set the type of a +

    View source

    enum abstract BitmapFilterType(Null<Int>)

    package openfl.filters

    @:enum

    Available on all platforms

    The BitmapFilterType class contains values to set the type of a BitmapFilter.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFULL:BitmapFilterType = 0

    Defines the setting that applies a filter to the entire area of an object.

    @:value(cast 1)@:impl@:enuminlineread onlyINNER:BitmapFilterType = 1

    Defines the setting that applies a filter to the inner area of an object.

    @:value(cast 2)@:impl@:enuminlineread onlyOUTER:BitmapFilterType = 2

    Defines the setting that applies a filter to the outer area of an object.

    \ No newline at end of file diff --git a/openfl/filters/BlurFilter.html b/openfl/filters/BlurFilter.html index 9d3c62e..36aafcd 100644 --- a/openfl/filters/BlurFilter.html +++ b/openfl/filters/BlurFilter.html @@ -1,14 +1,14 @@ -openfl.filters.BlurFilter - API Referenceopenfl.filters.BlurFilter - OpenFL API Reference
    View source

    final class BlurFilter

    package openfl.filters

    extends BitmapFilter

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.geom.Point)@:access(openfl.geom.Rectangle)@:final

    Available on all platforms

    The BlurFilter class lets you apply a blur visual effect to display +

    View source

    final class BlurFilter

    package openfl.filters

    extends BitmapFilter

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.geom.Point)@:access(openfl.geom.Rectangle)@:final

    Available on all platforms

    The BlurFilter class lets you apply a blur visual effect to display objects. A blur effect softens the details of an image. You can produce blurs that range from a softly unfocused look to a Gaussian blur, a hazy appearance like viewing an image through semi-opaque glass. When the quality property of this filter is set to low, the result is a softly unfocused look. When the quality property is set to high, it approximates a Gaussian blur filter. You can apply the filter to -any display object(that is, objects that inherit from the DisplayObject +any display object (that is, objects that inherit from the DisplayObject class), such as MovieClip, SimpleButton, TextField, and Video objects, as well as to BitmapData objects.

    To create a new filter, use the constructor new @@ -115,9 +115,9 @@ you can use additional numeric values up to 15 to achieve different effects, be aware that higher values are rendered more slowly.

    Variables

    blurX:Float

    The amount of horizontal blur. Valid values are from 0 to 255(floating -point). The default value is 4. Values that are a power of 2(such as 2, +point). The default value is 4. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.

    blurY:Float

    The amount of vertical blur. Valid values are from 0 to 255(floating -point). The default value is 4. Values that are a power of 2(such as 2, +point). The default value is 4. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.

    quality:Int

    The number of times to perform the blur. The default value is BitmapFilterQuality.LOW, which is equivalent to applying the filter once. The value BitmapFilterQuality.MEDIUM applies the diff --git a/openfl/filters/ColorMatrixFilter.html b/openfl/filters/ColorMatrixFilter.html index 03c8057..f547790 100644 --- a/openfl/filters/ColorMatrixFilter.html +++ b/openfl/filters/ColorMatrixFilter.html @@ -1,7 +1,7 @@ -openfl.filters.ColorMatrixFilter - API Referenceopenfl.filters.ColorMatrixFilter - OpenFL API Reference

    API Reference
    View source

    final class ColorMatrixFilter

    package openfl.filters

    extends BitmapFilter

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The ColorMatrixFilter class lets you apply a 4 x 5 matrix transformation +

    View source

    final class ColorMatrixFilter

    package openfl.filters

    extends BitmapFilter

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The ColorMatrixFilter class lets you apply a 4 x 5 matrix transformation on the RGBA color and alpha values of every pixel in the input image to produce a result with a new set of RGBA color and alpha values. It allows saturation changes, hue rotation, luminance to alpha, and various other diff --git a/openfl/filters/ConvolutionFilter.html b/openfl/filters/ConvolutionFilter.html index 011c9b9..b687147 100644 --- a/openfl/filters/ConvolutionFilter.html +++ b/openfl/filters/ConvolutionFilter.html @@ -1,7 +1,7 @@ -openfl.filters.ConvolutionFilter - API Referenceopenfl.filters.ConvolutionFilter - OpenFL API Reference

    API Reference
    View source

    class ConvolutionFilter

    package openfl.filters

    extends BitmapFilter

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The ConvolutionFilter class applies a matrix convolution filter effect. A +

    View source

    class ConvolutionFilter

    package openfl.filters

    extends BitmapFilter

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The ConvolutionFilter class applies a matrix convolution filter effect. A convolution combines pixels in the input image with neighboring pixels to produce an image. A wide variety of image effects can be achieved through convolutions, including blurring, edge detection, sharpening, embossing, diff --git a/openfl/filters/DisplacementMapFilter.html b/openfl/filters/DisplacementMapFilter.html index 815b87b..2d7474c 100644 --- a/openfl/filters/DisplacementMapFilter.html +++ b/openfl/filters/DisplacementMapFilter.html @@ -1,7 +1,7 @@ -openfl.filters.DisplacementMapFilter - API Referenceopenfl.filters.DisplacementMapFilter - OpenFL API Reference

    API Reference
    View source

    final class DisplacementMapFilter

    package openfl.filters

    extends BitmapFilter

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.geom.Point)@:access(openfl.geom.Rectangle)@:final

    Available on all platforms

    The DisplacementMapFilter class uses the pixel values from the specified +

    View source

    final class DisplacementMapFilter

    package openfl.filters

    extends BitmapFilter

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.geom.Point)@:access(openfl.geom.Rectangle)@:final

    Available on all platforms

    The DisplacementMapFilter class uses the pixel values from the specified BitmapData object (called the displacement map image) to perform a displacement of an object. You can use this filter to apply a warped or mottled effect to any object that inherits from the DisplayObject class, diff --git a/openfl/filters/DisplacementMapFilterMode.html b/openfl/filters/DisplacementMapFilterMode.html index 3f28238..20c762e 100644 --- a/openfl/filters/DisplacementMapFilterMode.html +++ b/openfl/filters/DisplacementMapFilterMode.html @@ -1,7 +1,7 @@ -openfl.filters.DisplacementMapFilterMode - API Referenceopenfl.filters.DisplacementMapFilterMode - OpenFL API Reference

    View source

    enum abstract DisplacementMapFilterMode(String)

    package openfl.filters

    from String to String

    @:enum

    Available on all platforms

    The DisplacementMapFilterMode class provides +

    View source

    enum abstract DisplacementMapFilterMode(String)

    package openfl.filters

    from String to String

    @:enum

    Available on all platforms

    The DisplacementMapFilterMode class provides values for the mode property of the DisplacementMapFilter class.

    Variables

    @:value(cast "clamp")@:impl@:enuminlineread onlyCLAMP:DisplacementMapFilterMode = "clamp"

    Clamps the displacement value to the edge of the source image.

    @:value(cast "color")@:impl@:enuminlineread onlyCOLOR:DisplacementMapFilterMode = "color"

    If the displacement value is outside the image, substitutes the values in the color and alpha properties.

    @:value(cast "ignore")@:impl@:enuminlineread onlyIGNORE:DisplacementMapFilterMode = "ignore"

    If the displacement value is out of range, ignores the displacement and uses the source pixel.

    @:value(cast "wrap")@:impl@:enuminlineread onlyWRAP:DisplacementMapFilterMode = "wrap"

    Wraps the displacement value to the other side of the source image.

    \ No newline at end of file diff --git a/openfl/filters/DropShadowFilter.html b/openfl/filters/DropShadowFilter.html index d9a7ab1..7edc93c 100644 --- a/openfl/filters/DropShadowFilter.html +++ b/openfl/filters/DropShadowFilter.html @@ -1,11 +1,11 @@ -openfl.filters.DropShadowFilter - API Referenceopenfl.filters.DropShadowFilter - OpenFL API Reference
    View source

    final class DropShadowFilter

    package openfl.filters

    extends BitmapFilter

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.filters.GlowFilter)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Point)@:access(openfl.geom.Rectangle)@:final

    Available on all platforms

    The DropShadowFilter class lets you add a drop shadow to display objects. +

    View source

    final class DropShadowFilter

    package openfl.filters

    extends BitmapFilter

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.filters.GlowFilter)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Point)@:access(openfl.geom.Rectangle)@:final

    Available on all platforms

    The DropShadowFilter class lets you add a drop shadow to display objects. The shadow algorithm is based on the same box filter that the blur filter uses. You have several options for the style of the drop shadow, including inner or outer shadow and knockout mode. You can apply the filter to any -display object(that is, objects that inherit from the DisplayObject +display object (that is, objects that inherit from the DisplayObject class), such as MovieClip, SimpleButton, TextField, and Video objects, as well as to BitmapData objects.

    The use of filters depends on the object to which you apply the @@ -91,7 +91,7 @@ limitation is 2,880 pixels in height and 2,880 pixels in width. If, for example, you zoom in on a large movie clip with a filter applied, the filter is turned off if the resulting image exceeds the maximum -dimensions.

    Constructor

    @:value({ hideObject : false, knockout : false, inner : false, quality : 1, strength : 1, blurY : 4, blurX : 4, alpha : 1, color : 0, angle : 45, distance : 4 })new(distance:Float = 4, angle:Float = 45, color:Int = 0, alpha:Float = 1, blurX:Float = 4, blurY:Float = 4, strength:Float = 1, quality:Int = 1, inner:Bool = false, knockout:Bool = false, hideObject:Bool = false)

    Creates a new DropShadowFilter instance with the specified parameters.

    Parameters:

    distance

    Offset distance for the shadow, in pixels.

    angle

    Angle of the shadow, 0 to 360 degrees(floating point).

    color

    Color of the shadow, in hexadecimal format +dimensions.

    Constructor

    @:value({ hideObject : false, knockout : false, inner : false, quality : 1, strength : 1, blurY : 4, blurX : 4, alpha : 1, color : 0, angle : 45, distance : 4 })new(distance:Float = 4, angle:Float = 45, color:Int = 0, alpha:Float = 1, blurX:Float = 4, blurY:Float = 4, strength:Float = 1, quality:Int = 1, inner:Bool = false, knockout:Bool = false, hideObject:Bool = false)

    Creates a new DropShadowFilter instance with the specified parameters.

    Parameters:

    distance

    Offset distance for the shadow, in pixels.

    angle

    Angle of the shadow, 0 to 360 degrees (floating point).

    color

    Color of the shadow, in hexadecimal format 0xRRGGBB. The default value is 0x000000.

    alpha

    Alpha transparency value for the shadow color. Valid values are 0.0 to 1.0. For example, .25 sets a transparency value of 25%.

    blurX

    Amount of horizontal blur. Valid values are 0 to 255.0 @@ -106,7 +106,7 @@ A value of true specifies an inner shadow. A value of false specifies an outer shadow

    			 (a shadow around the outer edges of the object).
-
    knockout

    Applies a knockout effect(true), which +

    knockout

    Applies a knockout effect (true), which effectively makes the object's fill transparent and reveals the background color of the document.

    hideObject

    Indicates whether or not the object is hidden. A value of true indicates that the object itself is @@ -121,8 +121,8 @@ indicates that the object itself is not drawn; only the shadow is visible. The default is false(the object is shown).

    inner:Bool

    Indicates whether or not the shadow is an inner shadow. The value true indicates an inner shadow. The default is -false, an outer shadow(a shadow around the outer edges of -the object).

    knockout:Bool

    Applies a knockout effect(true), which effectively makes the +false, an outer shadow (a shadow around the outer edges of +the object).

    knockout:Bool

    Applies a knockout effect (true), which effectively makes the object's fill transparent and reveals the background color of the document. The default is false(no knockout).

    quality:Int

    The number of times to apply the filter. The default value is BitmapFilterQuality.LOW, which is equivalent to applying the diff --git a/openfl/filters/GlowFilter.html b/openfl/filters/GlowFilter.html index ab9e0ea..c8b65c6 100644 --- a/openfl/filters/GlowFilter.html +++ b/openfl/filters/GlowFilter.html @@ -1,7 +1,7 @@ -openfl.filters.GlowFilter - API Referenceopenfl.filters.GlowFilter - OpenFL API Reference

    API Reference
    View source

    final class GlowFilter

    package openfl.filters

    extends BitmapFilter

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Point)@:access(openfl.geom.Rectangle)@:final

    Available on all platforms

    The GlowFilter class lets you apply a glow effect to display objects. You +

    View source

    final class GlowFilter

    package openfl.filters

    extends BitmapFilter

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Point)@:access(openfl.geom.Rectangle)@:final

    Available on all platforms

    The GlowFilter class lets you apply a glow effect to display objects. You have several options for the style of the glow, including inner or outer glow and knockout mode. The glow filter is similar to the drop shadow filter with the distance and angle properties of @@ -97,11 +97,11 @@ 0xRRGGBB. The default value is 0xFF0000.

    alpha

    The alpha transparency value for the color. Valid values are 0 to 1. For example, .25 sets a transparency value of 25%.

    blurX

    The amount of horizontal blur. Valid values are 0 to 255 -(floating point). Values that are a power of 2(such as 2,

    +(floating point). Values that are a power of 2 (such as 2,

    			4, 8, 16 and 32) are optimized to render more quickly than
 			other values.
    blurY

    The amount of vertical blur. Valid values are 0 to 255 -(floating point). Values that are a power of 2(such as 2,

    +(floating point). Values that are a power of 2 (such as 2,

    			4, 8, 16 and 32) are optimized to render more quickly than
 			other values.
    strength

    The strength of the imprint or spread. The higher the @@ -112,15 +112,15 @@

    For more information, see the description of the quality property.

    inner

    Specifies whether the glow is an inner glow. The value true specifies an inner glow. The value -false specifies an outer glow(a glow around +false specifies an outer glow (a glow around the outer edges of the object).

    knockout

    Specifies whether the object has a knockout effect. The value true makes the object's fill transparent and reveals the background color of the document.

    Variables

    alpha:Float

    The alpha transparency value for the color. Valid values are 0 to 1. For -example, .25 sets a transparency value of 25%. The default value is 1.

    blurX:Float

    The amount of horizontal blur. Valid values are 0 to 255(floating point). -The default value is 6. Values that are a power of 2(such as 2, 4, 8, 16, -and 32) are optimized to render more quickly than other values.

    blurY:Float

    The amount of vertical blur. Valid values are 0 to 255(floating point). -The default value is 6. Values that are a power of 2(such as 2, 4, 8, 16, +example, .25 sets a transparency value of 25%. The default value is 1.

    blurX:Float

    The amount of horizontal blur. Valid values are 0 to 255 (floating point). +The default value is 6. Values that are a power of 2 (such as 2, 4, 8, 16, +and 32) are optimized to render more quickly than other values.

    blurY:Float

    The amount of vertical blur. Valid values are 0 to 255 (floating point). +The default value is 6. Values that are a power of 2 (such as 2, 4, 8, 16, and 32) are optimized to render more quickly than other values.

    color:Int

    The color of the glow. Valid values are in the hexadecimal format 0xRRGGBB. The default value is 0xFF0000.

    inner:Bool

    Specifies whether the glow is an inner glow. The value true indicates an inner glow. The default is false, an outer glow diff --git a/openfl/filters/ShaderFilter.html b/openfl/filters/ShaderFilter.html index 7d748fb..4549625 100644 --- a/openfl/filters/ShaderFilter.html +++ b/openfl/filters/ShaderFilter.html @@ -1,7 +1,7 @@ -openfl.filters.ShaderFilter - API Referenceopenfl.filters.ShaderFilter - OpenFL API Reference

    API Reference
    View source

    class ShaderFilter

    package openfl.filters

    extends BitmapFilter

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The ShaderFilter class applies a filter by executing a shader on the +

    View source

    class ShaderFilter

    package openfl.filters

    extends BitmapFilter

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The ShaderFilter class applies a filter by executing a shader on the object being filtered. The filtered object is used as an input to the shader, and the shader output becomes the filter result. To create a new filter, use the constructor new ShaderFilter(). The use diff --git a/openfl/filters/index.html b/openfl/filters/index.html index f32b539..80d3333 100644 --- a/openfl/filters/index.html +++ b/openfl/filters/index.html @@ -1,7 +1,7 @@ -openfl.filters - API Reference

    openfl.filters

    -
    ..
    BitmapFilter

    The BitmapFilter class is the base class for all image filter effects.

    BitmapFilterQuality

    The BitmapFilterQuality class contains values to set the rendering quality +

    openfl.filters

    ..
    BitmapFilter

    The BitmapFilter class is the base class for all image filter effects.

    BitmapFilterQuality

    The BitmapFilterQuality class contains values to set the rendering quality of a BitmapFilter object.

    BitmapFilterShader

    BitmapFilterType

    The BitmapFilterType class contains values to set the type of a BitmapFilter.

    BlurFilter

    The BlurFilter class lets you apply a blur visual effect to display objects. A blur effect softens the details of an image. You can produce @@ -94,7 +61,7 @@

    package ::full::

    quality property of this filter is set to low, the result is a softly unfocused look. When the quality property is set to high, it approximates a Gaussian blur filter. You can apply the filter to -any display object(that is, objects that inherit from the DisplayObject +any display object (that is, objects that inherit from the DisplayObject class), such as MovieClip, SimpleButton, TextField, and Video objects, as well as to BitmapData objects.

    ColorMatrixFilter

    The ColorMatrixFilter class lets you apply a 4 x 5 matrix transformation on the RGBA color and alpha values of every pixel in the input image to @@ -125,7 +92,7 @@

    package ::full::

    The shadow algorithm is based on the same box filter that the blur filter uses. You have several options for the style of the drop shadow, including inner or outer shadow and knockout mode. You can apply the filter to any -display object(that is, objects that inherit from the DisplayObject +display object (that is, objects that inherit from the DisplayObject class), such as MovieClip, SimpleButton, TextField, and Video objects, as well as to BitmapData objects.

    GlowFilter

    The GlowFilter class lets you apply a glow effect to display objects. You have several options for the style of the glow, including inner or outer diff --git a/openfl/geom/ColorTransform.html b/openfl/geom/ColorTransform.html index 467ff6d..da4173a 100644 --- a/openfl/geom/ColorTransform.html +++ b/openfl/geom/ColorTransform.html @@ -1,7 +1,7 @@ -openfl.geom.ColorTransform - API Referenceopenfl.geom.ColorTransform - OpenFL API Reference

    View source

    class ColorTransform

    package openfl.geom

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The ColorTransform class lets you adjust the color values in a display +

    View source

    class ColorTransform

    package openfl.geom

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The ColorTransform class lets you adjust the color values in a display object. The color adjustment or color transformation can be applied to all four channels: red, green, blue, and alpha transparency.

    When a ColorTransform object is applied to a display object, a new value @@ -74,7 +74,7 @@ ColorTransform object.

    Color transformations do not apply to the background color of a movie clip(such as a loaded SWF object). They apply only to graphics and symbols -that are attached to the movie clip.

    Constructor

    @:value({ alphaOffset : 0, blueOffset : 0, greenOffset : 0, redOffset : 0, alphaMultiplier : 1, blueMultiplier : 1, greenMultiplier : 1, redMultiplier : 1 })new(redMultiplier:Float = 1, greenMultiplier:Float = 1, blueMultiplier:Float = 1, alphaMultiplier:Float = 1, redOffset:Float = 0, greenOffset:Float = 0, blueOffset:Float = 0, alphaOffset:Float = 0)

    Creates a ColorTransform object for a display object with the specified +that are attached to the movie clip.

    See also:

    Constructor

    @:value({ alphaOffset : 0, blueOffset : 0, greenOffset : 0, redOffset : 0, alphaMultiplier : 1, blueMultiplier : 1, greenMultiplier : 1, redMultiplier : 1 })new(redMultiplier:Float = 1, greenMultiplier:Float = 1, blueMultiplier:Float = 1, alphaMultiplier:Float = 1, redOffset:Float = 0, greenOffset:Float = 0, blueOffset:Float = 0, alphaOffset:Float = 0)

    Creates a ColorTransform object for a display object with the specified color channel values and alpha values.

    Parameters:

    redMultiplier

    The value for the red multiplier, in the range from 0 to 1.

    greenMultiplier

    The value for the green multiplier, in the range from 0 to 1.

    blueMultiplier

    The value for the blue multiplier, in the range @@ -101,7 +101,7 @@

    When you pass a value for this property, use the format 0xRRGGBB. RR, GG, and BB each consist of two hexadecimal digits that specify the offset of each color component. The 0x -tells the ActionScript compiler that the number is a hexadecimal +tells the Haxe compiler that the number is a hexadecimal value.

    greenMultiplier:Float

    A decimal value that is multiplied with the green channel value.

    greenOffset:Float

    A number from -255 to 255 that is added to the green channel value after it has been multiplied by the greenMultiplier value.

    redMultiplier:Float

    A decimal value that is multiplied with the red channel value.

    redOffset:Float

    A number from -255 to 255 that is added to the red channel value after it has been multiplied by the redMultiplier value.

    Methods

    concat(second:ColorTransform):Void

    Concatenates the ColorTranform object specified by the second diff --git a/openfl/geom/Matrix.html b/openfl/geom/Matrix.html index b269ff2..59bb482 100644 --- a/openfl/geom/Matrix.html +++ b/openfl/geom/Matrix.html @@ -1,7 +1,7 @@ -openfl.geom.Matrix - API Referenceopenfl.geom.Matrix - OpenFL API Reference

    API Reference
    View source

    class Matrix

    package openfl.geom

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Matrix class represents a transformation matrix that determines how to +

    View source

    class Matrix

    package openfl.geom

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Matrix class represents a transformation matrix that determines how to map points from one coordinate space to another. You can perform various graphical transformations on a display object by setting the properties of a Matrix object, applying that Matrix object to the matrix property of a @@ -100,7 +100,7 @@ display object target (by using the transform property of that display object).

    Use the new Matrix() constructor to create a Matrix object before you -can call the methods of the Matrix object.

    Constructor

    @:value({ ty : 0, tx : 0, d : 1, c : 0, b : 0, a : 1 })new(a:Float = 1, b:Float = 0, c:Float = 0, d:Float = 1, tx:Float = 0, ty:Float = 0)

    Creates a new Matrix object with the specified parameters. In matrix +can call the methods of the Matrix object.

    See also:

    Constructor

    @:value({ ty : 0, tx : 0, d : 1, c : 0, b : 0, a : 1 })new(a:Float = 1, b:Float = 0, c:Float = 0, d:Float = 1, tx:Float = 0, ty:Float = 0)

    Creates a new Matrix object with the specified parameters. In matrix notation, the properties are organized like this:

    Matrix class properties in matrix notation showing assumed values for u, v, and w

    If you do not provide any parameters to the new Matrix() @@ -165,7 +165,14 @@ method, the deltaTransformPoint() method's transformation does not consider the translation parameters tx and ty.

    Parameters:

    point

    The point for which you want to get the result of the matrix -transformation.

    Returns:

    The point resulting from applying the matrix transformation.

    identity():Void

    Sets each matrix property to a value that causes a null +transformation.

    Returns:

    The point resulting from applying the matrix transformation.

    deltaTransformPointToOutput(point:Point, output:Point):Point

    Given a point in the pretransform coordinate space, returns the +coordinates of that point after the transformation occurs. Unlike the +standard transformation applied using the transformPoint() +method, the deltaTransformPoint() method's transformation +does not consider the translation parameters tx and +ty.

    Parameters:

    point

    The point for which you want to get the result of the matrix +transformation.

    output

    An optional point to be set with the output value and +returned, to avoid the runtime creating a new point object.

    Returns:

    The point resulting from applying the matrix transformation.

    identity():Void

    Sets each matrix property to a value that causes a null transformation. An object transformed by applying an identity matrix will be identical to the original. After calling the identity() method, the resulting matrix has the @@ -186,6 +193,9 @@ object: a, b, c, d, tx, and ty.

    transformPoint(pos:Point):Point

    Returns the result of applying the geometric transformation represented by the Matrix object to the specified point.

    Parameters:

    point

    The point for which you want to get the result of the Matrix -transformation.

    Returns:

    The point resulting from applying the Matrix transformation.

    translate(dx:Float, dy:Float):Void

    Translates the matrix along the x and y axes, as specified +transformation.

    Returns:

    The point resulting from applying the Matrix transformation.

    transformPointToOutput(pos:Point, output:Point):Point

    Returns the result of applying the geometric transformation represented by +the Matrix object to the specified point.

    Parameters:

    point

    The point for which you want to get the result of the Matrix +transformation.

    output

    An optional point to be set with the output value and +returned, to avoid the runtime creating a new point object.

    Returns:

    The point resulting from applying the Matrix transformation.

    translate(dx:Float, dy:Float):Void

    Translates the matrix along the x and y axes, as specified by the dx and dy parameters.

    Parameters:

    dx

    The amount of movement along the x axis to the right, in pixels.

    dy

    The amount of movement down along the y axis, in pixels.

    \ No newline at end of file diff --git a/openfl/geom/Matrix3D.html b/openfl/geom/Matrix3D.html index 5daab69..c39093a 100644 --- a/openfl/geom/Matrix3D.html +++ b/openfl/geom/Matrix3D.html @@ -1,7 +1,7 @@ -openfl.geom.Matrix3D - API Referenceopenfl.geom.Matrix3D - OpenFL API Reference
    API Reference
    View source

    class Matrix3D

    package openfl.geom

    extended by PerspectiveMatrix3D

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Matrix3D class represents a transformation matrix that determines the position and +

    View source

    class Matrix3D

    package openfl.geom

    extended by PerspectiveMatrix3D

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Matrix3D class represents a transformation matrix that determines the position and orientation of a three-dimensional (3D) display object. The matrix can perform transformation functions including translation (repositioning along the x, y, and z axes), rotation, and scaling (resizing). The Matrix3D class can also perform @@ -112,6 +112,29 @@ thisMat Matrix3D object is interpolated toward the target Matrix3D object.

    Returns:

    A Matrix3D object with elements that place the values of the matrix between the original matrix and the target matrix. When the returned matrix is applied to the this display object, the object moves the specified percent closer +to the target object.

    staticinterpolateToOutput(thisMat:Matrix3D, toMat:Matrix3D, percent:Float, output:Matrix3D):Matrix3D

    Interpolates the translation, rotation, and scale transformation of one matrix +toward those of the target matrix.

    +

    The interpolate() method avoids some of the unwanted results that can occur +when using methods such as the display object's axis rotation properties. The +interpolate() method invalidates the cached value of the rotation property of +the display object and converts the orientation elements of the display object's +matrix to a quaternion before interpolation. This method guarantees the shortest, +most efficient path for the rotation. It also produces a smooth, gimbal-lock-free +rotation. A gimbal lock can occur when using Euler Angles, where each axis is +handled independently. During the rotation around two or more axes, the axes can +become aligned, leading to unexpected results. Quaternion rotation avoids the +gimbal lock.

    +

    Consecutive calls to the interpolate() method can produce the effect of a +display object starting quickly and then slowly approaching another display +object. For example, if you set the thisMat parameter to the returned Matrix3D +object, the toMat parameter to the target display object's associated Matrix3D +object, and the percent parameter to 0.1, the display object moves ten percent +toward the target object. On subsequent calls or in subsequent frames, the object +moves ten percent of the remaining 90 percent, then ten percent of the remaining +distance, and continues until it reaches the target.

    Parameters:

    thisMat

    The Matrix3D object that is to be interpolated.

    toMat

    The target Matrix3D object.

    percent

    A value between 0 and 1 that determines the percent the +thisMat Matrix3D object is interpolated toward the target Matrix3D object.

    output

    An optional Matrix3D object to be used and returned to avoid the runtime creating a new object.

    Returns:

    A Matrix3D object with elements that place the values of the matrix +between the original matrix and the target matrix. When the returned matrix is +applied to the this display object, the object moves the specified percent closer to the target object.

    Constructor

    @:value({ v : null })new(?v:Vector<Float>)

    Variables

    read onlydeterminant:Float

    A Number that determines whether a matrix is invertible.

    A Matrix3D object must be invertible. You can use the determinant property to make sure that a Matrix3D object is invertible. If determinant is zero, an inverse of @@ -231,6 +254,35 @@ are eulerAngles (constant EULER_ANGLES), axisAngle (constant AXIS_ANGLE), and quaternion (constant QUATERNION). For additional information on the different orientation style, see the geom.Orientation3D class.

    Returns:

    A Vector of three Vector3D objects, each holding the translation, +rotation, and scale settings, respectively.

    @:value({ orientationStyle : EULER_ANGLES })decomposeToOutput(orientationStyle:Orientation3D = EULER_ANGLES, ?output:Vector<Vector3D>):Vector<Vector3D>

    Returns the transformation matrix's translation, rotation, and scale settings as +a Vector of three Vector3D objects. The first Vector3D object holds the +translation elements. The second Vector3D object holds the rotation elements. +The third Vector3D object holds the scale elements.

    +

    Some Matrix3D methods, such as the interpolateTo() method, automatically +decompose and recompose the matrix to perform their transformation.

    +

    To modify the matrix's transformation with an absolute parent frame of reference, +retrieve the settings with the decompose() method and make the appropriate +changes. You can then set the Matrix3D object to the modified transformation +using the recompose() method.

    +

    The decompose() method's parameter specifies the orientation style that is +meant to be used for the transformation. The default orientation is eulerAngles, +which defines the orientation with three separate angles of rotation for each +axis. The rotations occur consecutively and do not change the axis of each other. +The display object's axis rotation properties perform Euler Angles orientation +style transformation. The other orientation style options are axisAngle and +quaternion. The Axis Angle orientation uses a combination of an axis and an +angle to determine the orientation. The axis around which the object is rotated +is a unit vector that represents a direction. The angle represents the magnitude +of the rotation about the vector. The direction also determines where a display +object is facing and the angle determines which way is up. The appendRotation() +and prependRotation() methods use the Axis Angle orientation. The quaternion +orientation uses complex numbers and the fourth element of a vector. The three +axes of rotation (x,y,z) and an angle of rotation (w) represent the orientation. +The interpolate() method uses quaternion.

    Parameters:

    orientationStyle

    An optional parameter that determines the orientation +style used for the matrix transformation. The three types of orientation style +are eulerAngles (constant EULER_ANGLES), axisAngle (constant AXIS_ANGLE), +and quaternion (constant QUATERNION). For additional information on the +different orientation style, see the geom.Orientation3D class.

    output

    An optional vector of three Vector3D objects to be used and returned to avoid the runtime creating new objects.

    Returns:

    A Vector of three Vector3D objects, each holding the translation, rotation, and scale settings, respectively.

    deltaTransformVector(v:Vector3D):Vector3D

    Uses the transformation matrix without its translation elements to transform a Vector3D object from one space coordinate to another. The returned Vector3D object holds the new coordinates after the rotation and scaling transformations @@ -248,7 +300,24 @@ You can then use the 2D points to draw the rotating 3D object.

    Note: This method automatically sets the w component of the passed Vector3D to 0.0.

    Parameters:

    v

    A Vector3D object holding the coordinates that are going to be -transformed.

    Returns:

    Vector3D A Vector3D object with the transformed coordinates.

    identity():Void

    Converts the current matrix to an identity or unit matrix. An identity matrix has +transformed.

    Returns:

    Vector3D A Vector3D object with the transformed coordinates.

    deltaTransformVectorToOutput(v:Vector3D, output:Vector3D):Vector3D

    Uses the transformation matrix without its translation elements to transform a +Vector3D object from one space coordinate to another. The returned Vector3D +object holds the new coordinates after the rotation and scaling transformations +have been applied. If the deltaTransformVector() method applies a matrix that +only contains a translation transformation, the returned Vector3D is the same as +the original Vector3D object.

    +

    You can use the deltaTransformVector() method to have a display object in one +coordinate space respond to the rotation transformation of a second display +object. The object does not copy the rotation; it only changes its position to +reflect the changes in the rotation. For example, to use the display.Graphics +API for drawing a rotating 3D display object, you must map the object's rotating +coordinates to a 2D point. First, retrieve the object's 3D coordinates after each +rotation, using the deltaTransformVector() method. Next, apply the display +object's local3DToGlobal() method to translate the 3D coordinates to 2D points. +You can then use the 2D points to draw the rotating 3D object.

    +

    Note: This method automatically sets the w component of the passed Vector3D +to 0.0.

    Parameters:

    v

    A Vector3D object holding the coordinates that are going to be +transformed.

    output

    An optional Vector3D object to be used and returned to avoid the runtime creating a new object.

    Returns:

    Vector3D A Vector3D object with the transformed coordinates.

    identity():Void

    Converts the current matrix to an identity or unit matrix. An identity matrix has a value of one for the elements on the main diagonal and a value of zero for all other elements. The result is a matrix where the rawData value is 1,0,0,0,0,1,0,0,0,0,1,0,0,0,0,1 and the rotation setting is set to @@ -441,7 +510,17 @@ rotation and scale elements remain the same.

    Note: This method automatically sets the w component of the passed Vector3D to 1.0.

    Parameters:

    v

    A Vector3D object holding the coordinates that are going to be -transformed.

    Returns:

    A Vector3D object with the transformed coordinates.

    transformVectors(vin:Vector<Float>, vout:Vector<Float>):Void

    Uses the transformation matrix to transform a Vector of Numbers from one +transformed.

    Returns:

    A Vector3D object with the transformed coordinates.

    transformVectorToOutput(v:Vector3D, output:Vector3D):Vector3D

    Uses the transformation matrix to transform a Vector3D object from one space +coordinate to another. The returned Vector3D object holds the new coordinates +after the transformation. All the matrix transformations including translation +are applied to the Vector3D object.

    +

    If the result of the transformVector() method was applied to the position of a +display object, only the display object's position changes. The display object's +rotation and scale elements remain the same.

    +

    Note: This method automatically sets the w component of the passed Vector3D +to 1.0.

    Parameters:

    v

    A Vector3D object holding the coordinates that are going to be +transformed.

    output

    An optional Vector3D object to be used and returned to +avoid the runtime creating a new object.

    Returns:

    A Vector3D object with the transformed coordinates.

    transformVectors(vin:Vector<Float>, vout:Vector<Float>):Void

    Uses the transformation matrix to transform a Vector of Numbers from one coordinate space to another. The tranformVectors() method reads every three Numbers in the vin Vector object as a 3D coordinate (x,y,z) and places a transformed 3D coordinate in the vout Vector object. All the matrix diff --git a/openfl/geom/Orientation3D.html b/openfl/geom/Orientation3D.html index 8338acc..b187182 100644 --- a/openfl/geom/Orientation3D.html +++ b/openfl/geom/Orientation3D.html @@ -1,7 +1,7 @@ -openfl.geom.Orientation3D - API Referenceopenfl.geom.Orientation3D - OpenFL API Reference

    API Reference
    View source

    enum abstract Orientation3D(Null<Int>)

    package openfl.geom

    @:enum

    Available on all platforms

    The Orientation3D class is an enumeration of constant +

    View source

    enum abstract Orientation3D(Null<Int>)

    package openfl.geom

    @:enum

    Available on all platforms

    The Orientation3D class is an enumeration of constant values for representing the orientation style of a Matrix3D object. The three types of orientation are Euler angles, axis angle, and quaternion. The decompose and recompose methods of the Matrix3D object take one of these diff --git a/openfl/geom/PerspectiveProjection.html b/openfl/geom/PerspectiveProjection.html index b2fc6f1..5b67dc0 100644 --- a/openfl/geom/PerspectiveProjection.html +++ b/openfl/geom/PerspectiveProjection.html @@ -1,7 +1,7 @@ -openfl.geom.PerspectiveProjection - API Referenceopenfl.geom.PerspectiveProjection - OpenFL API Reference

    API Reference
    View source

    class PerspectiveProjection

    package openfl.geom

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The PerspectiveProjection class provides an easy way to assign or modify the perspective +

    View source

    class PerspectiveProjection

    package openfl.geom

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The PerspectiveProjection class provides an easy way to assign or modify the perspective transformations of a display object and all of its children. For more complex or custom perspective transformations, use the Matrix3D class. While the PerspectiveProjection class provides basic three-dimensional presentation properties, the Matrix3D class provides more @@ -102,4 +102,9 @@ property defined for its transformations. In fact, use either a PerspectiveProjection or a Matrix3D object to specify the perspective transformation. If when using the PerspectiveProjection object, a Matrix3D object was needed, the toMatrix3D() method can retrieve the underlying Matrix3D object of the display object. -For example, the toMatrix3D() method can be used with the Utils3D.projectVectors() method.

    Returns:

    The underlying Matrix3D object.

    \ No newline at end of file +For example, the toMatrix3D() method can be used with the Utils3D.projectVectors() method.

    Returns:

    The underlying Matrix3D object.

    toMatrix3DToOutput(output:Matrix3D):Matrix3D

    Returns the underlying Matrix3D object of the display object.

    +

    A display object, like the root object, can have a PerspectiveProjection object without needing a Matrix3D +property defined for its transformations. In fact, use either a PerspectiveProjection or a Matrix3D object +to specify the perspective transformation. If when using the PerspectiveProjection object, a Matrix3D +object was needed, the toMatrix3D() method can retrieve the underlying Matrix3D object of the display object. +For example, the toMatrix3D() method can be used with the Utils3D.projectVectors() method.

    Parameters:

    output

    An optional Matrix3D to be set to the underlying Matrix3D, avoiding the creation of a new object.

    Returns:

    The underlying Matrix3D object.

    \ No newline at end of file diff --git a/openfl/geom/Point.html b/openfl/geom/Point.html index 2f834d9..a6b30ed 100644 --- a/openfl/geom/Point.html +++ b/openfl/geom/Point.html @@ -1,7 +1,7 @@ -openfl.geom.Point - API Referenceopenfl.geom.Point - OpenFL API Reference
    View source

    class Point

    package openfl.geom

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Point object represents a location in a two-dimensional coordinate +

    View source

    class Point

    package openfl.geom

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Point object represents a location in a two-dimensional coordinate system, where x represents the horizontal axis and y represents the vertical axis.

    The following code creates a point at(0,0):

    Methods and properties of the following classes use Point objects:

    • BitmapData
    • DisplayObject
    • DisplayObjectContainer
    • DisplacementMapFilter
    • NativeWindow
    • Matrix
    • Rectangle

    You can use the new Point() constructor to create a Point -object.

    Static methods

    staticdistance(pt1:Point, pt2:Point):Float

    Returns the distance between pt1 and pt2.

    Parameters:

    pt1

    The first point.

    pt2

    The second point.

    Returns:

    The distance between the first and second points.

    staticinterpolate(pt1:Point, pt2:Point, f:Float):Point

    Determines a point between two specified points. The parameter +object.

    See also:

    Static methods

    staticdistance(pt1:Point, pt2:Point):Float

    Returns the distance between pt1 and pt2.

    Parameters:

    pt1

    The first point.

    pt2

    The second point.

    Returns:

    The distance between the first and second points.

    staticinterpolate(pt1:Point, pt2:Point, f:Float):Point

    Determines a point between two specified points. The parameter f determines where the new interpolated point is located relative to the two end points specified by parameters pt1 and pt2. The closer the value of the parameter f @@ -71,9 +71,24 @@ where the new point will be, along the line between pt1 and pt2. If f=1, pt1 is returned; if f=0, -pt2 is returned.

    Returns:

    The new, interpolated point.

    staticpolar(len:Float, angle:Float):Point

    Converts a pair of polar coordinates to a Cartesian point coordinate.

    Parameters:

    len

    The length coordinate of the polar pair.

    angle

    The angle, in radians, of the polar pair.

    Returns:

    The Cartesian point.

    Constructor

    @:value({ y : 0, x : 0 })new(x:Float = 0, y:Float = 0)

    Creates a new point. If you pass no parameters to this method, a point is +pt2 is returned.

    Returns:

    The new, interpolated point.

    staticinterpolateToOutput(pt1:Point, pt2:Point, f:Float, output:Point):Point

    Determines a point between two specified points, and sets them on the +specified output point (or a new point, if null). The parameter +f determines where the new interpolated point is located +relative to the two end points specified by parameters pt1 +and pt2. The closer the value of the parameter f +is to 1.0, the closer the interpolated point is to the first +point(parameter pt1). The closer the value of the parameter +f is to 0, the closer the interpolated point is to the second +point(parameter pt2).

    Parameters:

    pt1

    The first point.

    pt2

    The second point.

    f

    The level of interpolation between the two points. Indicates +where the new point will be, along the line between +pt1 and pt2. If f=1, +pt1 is returned; if f=0, +pt2 is returned.

    output

    An optional point to be used for the result of the operation.

    Returns:

    The new, interpolated point (or the object passed in as the output parameter, if not null).

    staticpolar(len:Float, angle:Float):Point

    Converts a pair of polar coordinates to a Cartesian point coordinate.

    Parameters:

    len

    The length coordinate of the polar pair.

    angle

    The angle, in radians, of the polar pair.

    Returns:

    The Cartesian point.

    staticpolarToOutput(len:Float, angle:Float, output:Point):Point

    Converts a pair of polar coordinates to a Cartesian point coordinate, +and sets them on the specified output point (or a new point, if +null).

    Parameters:

    len

    The length coordinate of the polar pair.

    angle

    The angle, in radians, of the polar pair.

    output

    An optional point to be used for the result of the operation.

    Returns:

    The Cartesian point (or the object passed in as the output parameter, if not null).

    Constructor

    @:value({ y : 0, x : 0 })new(x:Float = 0, y:Float = 0)

    Creates a new point. If you pass no parameters to this method, a point is created at(0,0).

    Parameters:

    x

    The horizontal coordinate.

    y

    The vertical coordinate.

    Variables

    read onlylength:Float

    The length of the line segment from(0,0) to this point.

    x:Float

    The horizontal coordinate of the point. The default value is 0.

    y:Float

    The vertical coordinate of the point. The default value is 0.

    Methods

    add(v:Point):Point

    Adds the coordinates of another point to the coordinates of this point to -create a new point.

    Parameters:

    v

    The point to be added.

    Returns:

    The new point.

    clone():Point

    Creates a copy of this Point object.

    Returns:

    The new Point object.

    copyFrom(sourcePoint:Point):Void

    Copies all of the point data from the source Point object into the calling Point +create a new point.

    Parameters:

    v

    The point to be added.

    Returns:

    The new point.

    addToOutput(v:Point, output:Point):Point

    Adds the coordinates of another point to the coordinates of this point +and sets them on the specified output point (or a new point, if null).

    Parameters:

    v

    The point to be added.

    output

    An optional point to be used for the result of the operation.

    Returns:

    The new point (or the object passed in as the output parameter, if not null).

    clone():Point

    Creates a copy of this Point object.

    Returns:

    The new Point object.

    copyFrom(sourcePoint:Point):Void

    Copies all of the point data from the source Point object into the calling Point object.

    Parameters:

    sourcePoint

    The Point object from which to copy the data.

    equals(toCompare:Point):Bool

    Determines whether two points are equal. Two points are equal if they have the same x and y values.

    Parameters:

    toCompare

    The point to be compared.

    Returns:

    A value of true if the object is equal to this Point object; false if it is not equal.

    normalize(thickness:Float):Void

    Scales the line segment between(0,0) and the current point to a set @@ -84,7 +99,9 @@ new x value. The value of dy is added to the original value of y to create the new y value.

    Parameters:

    dx

    The amount by which to offset the horizontal coordinate, x.

    dy

    The amount by which to offset the vertical coordinate, y.

    setTo(xa:Float, ya:Float):Void

    Sets the members of Point to the specified values

    Parameters:

    xa

    the values to set the point to.

    null

    ya

    subtract(v:Point):Point

    Subtracts the coordinates of another point from the coordinates of this -point to create a new point.

    Parameters:

    v

    The point to be subtracted.

    Returns:

    The new point.

    toString():String

    Returns a string that contains the values of the x and y +point to create a new point.

    Parameters:

    v

    The point to be subtracted.

    Returns:

    The new point.

    subtractToOutput(v:Point, output:Point):Point

    Subtracts the coordinates of another point from the coordinates of this +point, and sets them on the specified output point (or a new point, if +null).

    Parameters:

    v

    The point to be subtracted.

    output

    An optional point to be used for the result of the operation.

    Returns:

    The new point (or the object passed in as the output parameter, if not null).

    toString():String

    Returns a string that contains the values of the x and y coordinates. The string has the form "(x=_x_, y=_y_)", so calling the toString() method for a point at 23,17 would return "(x=23, y=17)".

    Returns:

    The string representation of the coordinates.

    \ No newline at end of file diff --git a/openfl/geom/Rectangle.html b/openfl/geom/Rectangle.html index a1a2bfd..15167d1 100644 --- a/openfl/geom/Rectangle.html +++ b/openfl/geom/Rectangle.html @@ -1,7 +1,7 @@ -openfl.geom.Rectangle - API Referenceopenfl.geom.Rectangle - OpenFL API Reference
    View source

    class Rectangle

    package openfl.geom

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    A Rectangle object is an area defined by its position, as indicated by its +

    View source

    class Rectangle

    package openfl.geom

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    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.

    The x, y, width, and height properties of the Rectangle class are independent of @@ -80,7 +80,7 @@ Rectangle object.

    Note: The Rectangle class does not define a rectangular Shape display object. To draw a rectangular Shape object onscreen, use the -drawRect() method of the Graphics class.

    Constructor

    @:value({ height : 0, width : 0, y : 0, x : 0 })new(x:Float = 0, y:Float = 0, width:Float = 0, height:Float = 0)

    Creates a new Rectangle object with the top-left corner specified by the +drawRect() method of the Graphics class.

    See also:

    Constructor

    @:value({ height : 0, width : 0, y : 0, x : 0 })new(x:Float = 0, y:Float = 0, width:Float = 0, height:Float = 0)

    Creates a new Rectangle object with the top-left corner specified by the x and y parameters and with the specified width and height parameters. If you call this function without parameters, a rectangle with x, @@ -128,7 +128,7 @@ height properties as the original Rectangle object.

    Returns:

    A new Rectangle object with the same values for the x, y, width, and height properties as the original Rectangle object.

    contains(x:Float, y:Float):Bool

    Determines whether the specified point is contained within the rectangular -region defined by this Rectangle object.

    Parameters:

    x

    The x coordinate(horizontal position) of the point.

    y

    The y coordinate(vertical position) of the point.

    Returns:

    A value of true if the Rectangle object contains the +region defined by this Rectangle object.

    Parameters:

    x

    The x coordinate (horizontal position) of the point.

    y

    The y coordinate (vertical position) of the point.

    Returns:

    A value of true if the Rectangle object contains the specified point; otherwise false.

    containsPoint(point:Point):Bool

    Determines whether the specified point is contained within the rectangular region defined by this Rectangle object. This method is similar to the Rectangle.contains() method, except that it takes a Point @@ -178,6 +178,16 @@ it intersects with this Rectangle object.

    Returns:

    A Rectangle object that equals the area of intersection. If the rectangles do not intersect, this method returns an empty Rectangle object; that is, a rectangle with its x, y, +width, and height properties set to 0.

    intersectionToOutput(toIntersect:Rectangle, output:Rectangle):Rectangle

    If the Rectangle object specified in the toIntersect parameter +intersects with this Rectangle object, returns the area of +intersection as a Rectangle object. If the rectangles do not +intersect, this method returns an empty Rectangle object with its +properties set to 0.

    +

    The resulting intersection rectangle.

    Parameters:

    toIntersect

    The Rectangle object to compare against to see if +it intersects with this Rectangle object.

    output

    An optional Rectangle to be used as the output value, +avoiding the creation of a new object

    Returns:

    A Rectangle object that equals the area of intersection. If +the rectangles do not intersect, this method returns an empty +Rectangle object; that is, a rectangle with its x, y, width, and height properties set to 0.

    intersects(toIntersect:Rectangle):Bool

    Determines whether the object specified in the toIntersect parameter intersects with this Rectangle object. This method checks the x, y, width, and @@ -197,4 +207,11 @@

    The resulting union rectangle.

    Note: The union() method ignores rectangles with 0 as the height or width value, such as: var rect2:Rectangle = new Rectangle(300,300,50,0);

    Parameters:

    toUnion

    A Rectangle object to add to this Rectangle object.

    Returns:

    A new Rectangle object that is the union of the two -rectangles.

    \ No newline at end of file +rectangles.

    unionToOutput(toUnion:Rectangle, output:Rectangle):Rectangle

    Adds two rectangles together to create a new Rectangle object, by +filling in the horizontal and vertical space between the two +rectangles.

    +

    The resulting union rectangle.

    +

    Note: The union() method ignores rectangles with 0 as the +height or width value, such as: var rect2:Rectangle = new Rectangle(300,300,50,0);

    Parameters:

    toUnion

    A Rectangle object to add to this Rectangle object.

    output

    An optional Rectangle to be used as the output value, +avoiding the creation of a new object

    Returns:

    A new Rectangle object (or the object passed in as the output +parameter, if not null) that is the union of the two rectangles.

    \ No newline at end of file diff --git a/openfl/geom/Transform.html b/openfl/geom/Transform.html index 8de8153..285c15c 100644 --- a/openfl/geom/Transform.html +++ b/openfl/geom/Transform.html @@ -1,10 +1,10 @@ -openfl.geom.Transform - API Referenceopenfl.geom.Transform - OpenFL API Reference
    API Reference
    View source

    class Transform

    package openfl.geom

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.DisplayObject)@:access(openfl.geom.ColorTransform)

    Available on all platforms

    The Transform class provides access to color adjustment properties and two- +

    View source

    class Transform

    package openfl.geom

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.DisplayObject)@:access(openfl.geom.ColorTransform)

    Available on all platforms

    The Transform class provides access to color adjustment properties and two- or three-dimensional transformation objects that can be applied to a display object. During the transformation, the color or the orientation and -position of a display object is adjusted(offset) from the current values +position of a display object is adjusted (offset) from the current values or coordinates to new values or coordinates. The Transform class also collects data about color and two-dimensional matrix transformations that are applied to a display object and all of its parent objects. You can @@ -108,7 +108,7 @@ same time. Use the PerspectiveProjection object for focal length and projection center changes. For more control over the perspective transformation, create a perspective projection Matrix3D object.

    Constructor

    new(displayObject:DisplayObject)

    Variables

    colorTransform:ColorTransform

    A ColorTransform object containing values that universally adjust the -colors in the display object.

    Throws:

    TypeError

    The colorTransform is null when being set

    read onlyconcatenatedColorTransform:ColorTransform

    A ColorTransform object representing the combined color transformations +colors in the display object.

    Throws:

    TypeError

    The colorTransform is null when being set

    See also:

    read onlyconcatenatedColorTransform:ColorTransform

    A ColorTransform object representing the combined color transformations applied to the display object and all of its parent objects, back to the root level. If different color transformations have been applied at different levels, all of those transformations are concatenated into one @@ -126,7 +126,7 @@ null), the matrix3D property is null. And if the matrix3D property is set to a value(not null), the matrix property is -null.

    Throws:

    TypeError

    The matrix is null when being set

    matrix3D:Matrix3D

    Provides access to the Matrix3D object of a three-dimensional display +null.

    Throws:

    TypeError

    The matrix is null when being set

    See also:

    matrix3D:Matrix3D

    Provides access to the Matrix3D object of a three-dimensional display object. The Matrix3D object represents a transformation matrix that determines the display object's position and orientation. A Matrix3D object can also perform perspective projection.

    diff --git a/openfl/geom/Utils3D.html b/openfl/geom/Utils3D.html index 62abed1..8a5296d 100644 --- a/openfl/geom/Utils3D.html +++ b/openfl/geom/Utils3D.html @@ -1,7 +1,7 @@ -openfl.geom.Utils3D - API Referenceopenfl.geom.Utils3D - OpenFL API Reference
    View source

    class Utils3D

    package openfl.geom

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Utils3D class contains static methods that simplify the implementation of +

    View source

    class Utils3D

    package openfl.geom

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Utils3D class contains static methods that simplify the implementation of certain three-dimensional matrix operations.

    Static methods

    staticprojectVector(m:Matrix3D, v:Vector3D):Vector3D

    Using a projection Matrix3D object, projects a Vector3D object from one space coordinate to another. The projectVector() method is like the Matrix3D.transformVector() method except that the projectVector() method @@ -66,7 +66,20 @@ object that applies to the children of the display object. For more advance projections, use the matrix3D.rawData property to create a custom projection matrix. There is no built-in Matrix3D method for creating a projection Matrix3D -object.

    v

    The Vector3D object that is projected to a new space coordinate.

    Returns:

    A new Vector3D with a transformed space coordinate.

    staticprojectVectors(m:Matrix3D, verts:Vector<Float>, projectedVerts:Vector<Float>, uvts:Vector<Float>):Void

    Using a projection Matrix3D object, projects a Vector of three-dimensional space +object.

    v

    The Vector3D object that is projected to a new space coordinate.

    Returns:

    A new Vector3D with a transformed space coordinate.

    staticprojectVectorToOutput(m:Matrix3D, v:Vector3D, output:Vector3D):Vector3D

    Using a projection Matrix3D object, projects a Vector3D object from one space +coordinate to another. The projectVector() method is like the +Matrix3D.transformVector() method except that the projectVector() method +divides the x, y, and z elements of the original Vector3D object by the +projection depth value. The depth value is the distance from the eye to the +Vector3D object in view or eye space. The default value for this distance is the +value of the z element.

    Parameters:

    m

    A projection Matrix3D object that implements the projection +transformation. If a display object has a PerspectiveProjection object, you can +use the perspectiveProjection.toMatrix() method to produce a projection Matrix3D +object that applies to the children of the display object. For more advance +projections, use the matrix3D.rawData property to create a custom projection +matrix. There is no built-in Matrix3D method for creating a projection Matrix3D +object.

    v

    The Vector3D object that is projected to a new space coordinate.

    output

    An optional Vector3D object that will be used for the +output rather than creating a new Vector3D object

    Returns:

    A new Vector3D with a transformed space coordinate.

    staticprojectVectors(m:Matrix3D, verts:Vector<Float>, projectedVerts:Vector<Float>, uvts:Vector<Float>):Void

    Using a projection Matrix3D object, projects a Vector of three-dimensional space coordinates (verts) to a Vector of two-dimensional space coordinates (projectedVerts). The projected Vector object should be pre-allocated before it is used as a parameter.

    diff --git a/openfl/geom/Vector3D.html b/openfl/geom/Vector3D.html index c6c8c2c..84c8e87 100644 --- a/openfl/geom/Vector3D.html +++ b/openfl/geom/Vector3D.html @@ -1,7 +1,7 @@ -openfl.geom.Vector3D - API Referenceopenfl.geom.Vector3D - OpenFL API Reference
    API Reference
    View source

    class Vector3D

    package openfl.geom

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Vector3D class represents a point or a location in the three-dimensional space using +

    View source

    class Vector3D

    package openfl.geom

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Vector3D class represents a point or a location in the three-dimensional space using the Cartesian coordinates x, y, and z. As in a two-dimensional space, the x property represents the horizontal axis and the y property represents the vertical axis. In three-dimensional space, the z property represents depth. The value of the x property increases as the object moves to the right. The value of the y property @@ -123,6 +123,17 @@ distance between the origin point of the first vector and the end point of the second vector.

    Resultant Vector3D

    Parameters:

    a

    A Vector3D object to be added to the current Vector3D object.

    Returns:

    A Vector3D object that is the result of adding the current Vector3D +object to another Vector3D object.

    addToOutput(a:Vector3D, output:Vector3D):Vector3D

    Adds the value of the x, y, and z elements of the current Vector3D object to the +values of the x, y, and z elements of another Vector3D object. The add() method +does not change the current Vector3D object. Instead, it returns a new Vector3D +object with the new values.

    +

    The result of adding two vectors together is a resultant vector. One way to +visualize the result is by drawing a vector from the origin or tail of the first +vector to the end or head of the second vector. The resultant vector is the +distance between the origin point of the first vector and the end point of the +second vector.

    +

    Resultant Vector3D

    Parameters:

    a

    A Vector3D object to be added to the current Vector3D object.

    output

    An optional Vector3D object to be used as the output +value, avoiding the creation of a new object

    Returns:

    A Vector3D object that is the result of adding the current Vector3D object to another Vector3D object.

    clone():Vector3D

    Returns a new Vector3D object that is an exact copy of the current Vector3D object.

    Returns:

    A new Vector3D object that is a copy of the current Vector3D object.

    copyFrom(sourceVector3D:Vector3D):Void

    Copies all of vector data from the source Vector3D object into the calling Vector3D object.

    Parameters:

    sourceVector3D

    The Vector3D object from which to copy the data.

    crossProduct(a:Vector3D):Vector3D

    Returns a new Vector3D object that is perpendicular (at a right angle) to the current Vector3D and another Vector3D object. If the returned Vector3D object's @@ -132,6 +143,15 @@ the normalized vector of the camera or eye viewpoint to get a dot product. The value of the dot product can identify whether a surface of a three-dimensional object is hidden from the viewpoint.

    Parameters:

    a

    A second Vector3D object.

    Returns:

    A new Vector3D object that is perpendicular to the current Vector3D +object and the Vector3D object specified as the parameter.

    crossProductToOutput(a:Vector3D, output:Vector3D):Vector3D

    Returns a new Vector3D object that is perpendicular (at a right angle) to the +current Vector3D and another Vector3D object. If the returned Vector3D object's +coordinates are (0,0,0), then the two Vector3D objects are parallel to each other.

    +

    Cross Product

    +

    You can use the normalized cross product of two vertices of a polygon surface with +the normalized vector of the camera or eye viewpoint to get a dot product. The +value of the dot product can identify whether a surface of a three-dimensional +object is hidden from the viewpoint.

    Parameters:

    a

    A second Vector3D object.

    output

    An optional Vector3D object to be used as the output +value, avoiding the creation of a new object

    Returns:

    A new Vector3D object that is perpendicular to the current Vector3D object and the Vector3D object specified as the parameter.

    decrementBy(a:Vector3D):Void

    Decrements the value of the x, y, and z elements of the current Vector3D object by the values of the x, y, and z elements of specified Vector3D object. Unlike the Vector3D.subtract() method, the decrementBy() method changes the current @@ -188,5 +208,10 @@ from the values of the x, y, and z elements of another Vector3D object. The subtract() method does not change the current Vector3D object. Instead, this method returns a new Vector3D object with the new values.

    Parameters:

    a

    The Vector3D object to be subtracted from the current Vector3D object.

    Returns:

    A new Vector3D object that is the difference between the current +Vector3D and the specified Vector3D object.

    subtractToOutput(a:Vector3D, output:Vector3D):Vector3D

    Subtracts the value of the x, y, and z elements of the current Vector3D object +from the values of the x, y, and z elements of another Vector3D object. The +subtract() method does not change the current Vector3D object. Instead, this +method returns a new Vector3D object with the new values.

    Parameters:

    a

    The Vector3D object to be subtracted from the current Vector3D object.

    output

    An optional Vector3D object to be used as the output +value, avoiding the creation of a new object

    Returns:

    A new Vector3D object that is the difference between the current Vector3D and the specified Vector3D object.

    toString():String

    Returns a string representation of the current Vector3D object. The string contains the values of the x, y, and z properties.

    Returns:

    A string containing the values of the x, y, and z properties.

    \ No newline at end of file diff --git a/openfl/geom/index.html b/openfl/geom/index.html index 570fa27..4c83a10 100644 --- a/openfl/geom/index.html +++ b/openfl/geom/index.html @@ -1,7 +1,7 @@ -openfl.geom - API Reference

    openfl.geom

    -
    ..
    ColorTransform

    The ColorTransform class lets you adjust the color values in a display +

    openfl.geom

    Here are some selections from the OpenFL Developer's Guide to help you get started with the openfl.geom package:

    ..
    ColorTransform

    The ColorTransform class lets you adjust the color values in a display object. The color adjustment or color transformation can be applied to all four channels: red, green, blue, and alpha transparency.

    Matrix

    The Matrix class represents a transformation matrix that determines how to map points from one coordinate space to another. You can perform various @@ -116,7 +83,7 @@

    package ::full::

    top-left corner point(x, y) and by its width and its height.

    Transform

    The Transform class provides access to color adjustment properties and two- or three-dimensional transformation objects that can be applied to a display object. During the transformation, the color or the orientation and -position of a display object is adjusted(offset) from the current values +position of a display object is adjusted (offset) from the current values or coordinates to new values or coordinates. The Transform class also collects data about color and two-dimensional matrix transformations that are applied to a display object and all of its parent objects. You can diff --git a/openfl/globalization/DateTimeFormatter.html b/openfl/globalization/DateTimeFormatter.html index f5736bb..ff29a4f 100644 --- a/openfl/globalization/DateTimeFormatter.html +++ b/openfl/globalization/DateTimeFormatter.html @@ -1,7 +1,7 @@ -openfl.globalization.DateTimeFormatter - API Reference

    View source

    final class DateTimeFormatter

    package openfl.globalization

    @:final

    Available on all platforms

    Static methods

    staticgetAvailableLocaleIDNames():Vector<String>

    Constructor

    @:value({ timeStyle : LONG, dateStyle : LONG })new(requestedLocaleIDName:String, dateStyle:DateTimeStyle = LONG, timeStyle:DateTimeStyle = LONG)

    Variables

    read onlyactualLocaleIDName:String

    read onlylastOperationStatus:LastOperationStatus

    read onlyrequestedLocaleIDName:String

    Methods

    format(date:Date):String

    formatUTC(date:Date):String

    getDateStyle():DateTimeStyle

    getDateTimePattern():String

    getFirstWeekday():Int

    @:value({ context : STANDALONE, nameStyle : FULL })getMonthNames(nameStyle:DateTimeNameStyle = FULL, context:DateTimeNameContext = STANDALONE):Vector<String>

    getTimeStyle():DateTimeStyle

    @:value({ context : STANDALONE, nameStyle : FULL })getWeekdayNames(nameStyle:DateTimeNameStyle = FULL, context:DateTimeNameContext = STANDALONE):Vector<String>

    setDateTimePattern(pattern:String):Void

    @:value({ timeStyle : LONG, dateStyle : LONG })setDateTimeStyles(dateStyle:DateTimeStyle = LONG, timeStyle:DateTimeStyle = LONG):Void

    \ No newline at end of file +
    View source

    final class DateTimeFormatter

    package openfl.globalization

    @:final

    Available on all platforms

    Static methods

    staticgetAvailableLocaleIDNames():Vector<String>

    Constructor

    @:value({ timeStyle : LONG, dateStyle : LONG })new(requestedLocaleIDName:String, dateStyle:DateTimeStyle = LONG, timeStyle:DateTimeStyle = LONG)

    Variables

    read onlyactualLocaleIDName:String

    read onlylastOperationStatus:LastOperationStatus

    read onlyrequestedLocaleIDName:String

    Methods

    format(date:Date):String

    formatUTC(date:Date):String

    getDateStyle():DateTimeStyle

    getDateTimePattern():String

    getFirstWeekday():Int

    @:value({ context : STANDALONE, nameStyle : FULL })getMonthNames(nameStyle:DateTimeNameStyle = FULL, context:DateTimeNameContext = STANDALONE):Vector<String>

    getTimeStyle():DateTimeStyle

    @:value({ context : STANDALONE, nameStyle : FULL })getWeekdayNames(nameStyle:DateTimeNameStyle = FULL, context:DateTimeNameContext = STANDALONE):Vector<String>

    setDateTimePattern(pattern:String):Void

    @:value({ timeStyle : LONG, dateStyle : LONG })setDateTimeStyles(dateStyle:DateTimeStyle = LONG, timeStyle:DateTimeStyle = LONG):Void

    \ No newline at end of file diff --git a/openfl/globalization/DateTimeNameContext.html b/openfl/globalization/DateTimeNameContext.html index e8d2a45..168c592 100644 --- a/openfl/globalization/DateTimeNameContext.html +++ b/openfl/globalization/DateTimeNameContext.html @@ -1,7 +1,10 @@ -openfl.globalization.DateTimeNameContext - API Reference
    View source

    enum abstract DateTimeNameContext(Null<Int>)

    package openfl.globalization

    @:enum

    Available on all platforms

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFORMAT:DateTimeNameContext = 0

    @:value(cast 1)@:impl@:enuminlineread onlySTANDALONE:DateTimeNameContext = 1

    \ No newline at end of file +
    View source

    enum abstract DateTimeNameContext(Null<Int>)

    package openfl.globalization

    @:enum

    Available on all platforms

    The DateTimeNameContext class enumerates constant values representing the +formatting context in which a month name or weekday name is used. These +constants are used for the context parameters for the DateTimeFormatter's +getMonthNames() and getWeekDayNames() methods.

    +

    The context parameter only changes the results of those methods for certain +locales and operating systems. For most locales, the lists of month names +and weekday names do not differ by context.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFORMAT:DateTimeNameContext = 0

    Indicates that the date element name is used within a date format.

    @:value(cast 1)@:impl@:enuminlineread onlySTANDALONE:DateTimeNameContext = 1

    Indicates that the date element name is used in a "stand alone" context, +independent of other formats. For example, the name can be used to show +only the month name in a calendar or the weekday name in a date chooser.

    \ No newline at end of file diff --git a/openfl/globalization/DateTimeNameStyle.html b/openfl/globalization/DateTimeNameStyle.html index dbc32f2..4718e0f 100644 --- a/openfl/globalization/DateTimeNameStyle.html +++ b/openfl/globalization/DateTimeNameStyle.html @@ -1,7 +1,10 @@ -openfl.globalization.DateTimeNameStyle - API Reference
    View source

    enum abstract DateTimeNameStyle(Null<Int>)

    package openfl.globalization

    @:enum

    Available on all platforms

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFULL:DateTimeNameStyle = 0

    @:value(cast 1)@:impl@:enuminlineread onlyLONG_ABBREVIATION:DateTimeNameStyle = 1

    @:value(cast 2)@:impl@:enuminlineread onlySHORT_ABBREVIATION:DateTimeNameStyle = 2

    \ No newline at end of file +
    View source

    enum abstract DateTimeNameStyle(Null<Int>)

    package openfl.globalization

    @:enum

    Available on all platforms

    The DateTimeNameStyle class enumerates constants that control the length of +the month names and weekday names that are used when formatting dates. Use +these constants for the nameStyle parameter of the DateTimeFormatter +getMonthNames() and getWeekDayNames() methods.

    +

    The LONG_ABBREVIATION and SHORT_ABBREVIATION may be the same or +different depending on the operating system and browser settings.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFULL:DateTimeNameStyle = 0

    Specifies the full form or full name style for month names and weekday +names. Examples: Tuesday, November.

    @:value(cast 1)@:impl@:enuminlineread onlyLONG_ABBREVIATION:DateTimeNameStyle = 1

    Specifies the long abbreviation style for month names and weekday names. +Examples: Tues for Tuesday, Nov for November.

    @:value(cast 2)@:impl@:enuminlineread onlySHORT_ABBREVIATION:DateTimeNameStyle = 2

    Specifies the short abbreviation style for month names and weekday names. +Examples: T for Tuesday, N for November.

    \ No newline at end of file diff --git a/openfl/globalization/DateTimeStyle.html b/openfl/globalization/DateTimeStyle.html index 99f2673..94c0eee 100644 --- a/openfl/globalization/DateTimeStyle.html +++ b/openfl/globalization/DateTimeStyle.html @@ -1,7 +1,10 @@ -openfl.globalization.DateTimeStyle - API Reference
    View source

    enum abstract DateTimeStyle(Null<Int>)

    package openfl.globalization

    @:enum

    Available on all platforms

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyCUSTOM:DateTimeStyle = 0

    @:value(cast 1)@:impl@:enuminlineread onlyLONG:DateTimeStyle = 1

    @:value(cast 2)@:impl@:enuminlineread onlyMEDIUM:DateTimeStyle = 2

    @:value(cast 3)@:impl@:enuminlineread onlyNONE:DateTimeStyle = 3

    @:value(cast 4)@:impl@:enuminlineread onlySHORT:DateTimeStyle = 4

    \ No newline at end of file +
    View source

    enum abstract DateTimeStyle(Null<Int>)

    package openfl.globalization

    @:enum

    Available on all platforms

    Enumerates constants that determine a locale-specific date and time +formatting pattern. These constants are used when constructing a +DateTimeFormatter object or when calling the +DateTimeFormatter.setDateTimeStyles() method.

    +

    The CUSTOM constant cannot be used in the DateTimeFormatter constructor or +the DateFormatter.setDateTimeStyles() method. This constant is instead set +as the timeStyle and dateStyle property as a side effect of calling the +DateTimeFormatter.setDateTimePattern() method.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyCUSTOM:DateTimeStyle = 0

    Specifies that a custom pattern string is used to specify the date or +time style.

    @:value(cast 1)@:impl@:enuminlineread onlyLONG:DateTimeStyle = 1

    Specifies the long style of a date or time.

    @:value(cast 2)@:impl@:enuminlineread onlyMEDIUM:DateTimeStyle = 2

    Specifies the medium style of a date or time.

    @:value(cast 3)@:impl@:enuminlineread onlyNONE:DateTimeStyle = 3

    Specifies that the date or time should not be included in the formatted string.

    @:value(cast 4)@:impl@:enuminlineread onlySHORT:DateTimeStyle = 4

    Specifies the short style of a date or time.

    \ No newline at end of file diff --git a/openfl/globalization/LastOperationStatus.html b/openfl/globalization/LastOperationStatus.html index a050525..c39a117 100644 --- a/openfl/globalization/LastOperationStatus.html +++ b/openfl/globalization/LastOperationStatus.html @@ -1,7 +1,10 @@ -openfl.globalization.LastOperationStatus - API Reference
    View source

    enum abstract LastOperationStatus(Null<Int>)

    package openfl.globalization

    @:enum

    Available on all platforms

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBUFFER_OVERFLOW_ERROR:LastOperationStatus = 0

    @:value(cast 1)@:impl@:enuminlineread onlyERROR_CODE_UNKNOWN:LastOperationStatus = 1

    @:value(cast 2)@:impl@:enuminlineread onlyILLEGAL_ARGUMENT_ERROR:LastOperationStatus = 2

    @:value(cast 3)@:impl@:enuminlineread onlyINDEX_OUT_OF_BOUNDS_ERROR:LastOperationStatus = 3

    @:value(cast 4)@:impl@:enuminlineread onlyINVALID_ATTR_VALUE:LastOperationStatus = 4

    @:value(cast 5)@:impl@:enuminlineread onlyINVALID_CHAR_FOUND:LastOperationStatus = 5

    @:value(cast 6)@:impl@:enuminlineread onlyMEMORY_ALLOCATION_ERROR:LastOperationStatus = 6

    @:value(cast 7)@:impl@:enuminlineread onlyNO_ERROR:LastOperationStatus = 7

    @:value(cast 8)@:impl@:enuminlineread onlyNUMBER_OVERFLOW_ERROR:LastOperationStatus = 8

    @:value(cast 9)@:impl@:enuminlineread onlyPARSE_ERROR:LastOperationStatus = 9

    @:value(cast 10)@:impl@:enuminlineread onlyPATTERN_SYNTAX_ERROR:LastOperationStatus = 10

    @:value(cast 11)@:impl@:enuminlineread onlyPLATFORM_API_FAILED:LastOperationStatus = 11

    @:value(cast 12)@:impl@:enuminlineread onlyTRUNCATED_CHAR_FOUND:LastOperationStatus = 12

    @:value(cast 13)@:impl@:enuminlineread onlyUNEXPECTED_TOKEN:LastOperationStatus = 13

    @:value(cast 14)@:impl@:enuminlineread onlyUNSUPPORTED_ERROR:LastOperationStatus = 14

    @:value(cast 15)@:impl@:enuminlineread onlyUSING_DEFAULT_WARNING:LastOperationStatus = 15

    @:value(cast 16)@:impl@:enuminlineread onlyUSING_FALLBACK_WARNING:LastOperationStatus = 16

    \ No newline at end of file +
    View source

    enum abstract LastOperationStatus(Null<Int>)

    package openfl.globalization

    @:enum

    Available on all platforms

    The LastOperationStatus class enumerates constant values that represent the +status of the most recent globalization service operation. These values can +be retrieved through the read-only property lastOperationStatus available +in most globalization classes.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBUFFER_OVERFLOW_ERROR:LastOperationStatus = 0

    Indicates that given buffer is not enough to hold the result.

    @:value(cast 1)@:impl@:enuminlineread onlyERROR_CODE_UNKNOWN:LastOperationStatus = 1

    Indicates that the return error code is not known. Any non-static method +or read/write properties can return this error when the operation is not +successful and the return error code is not known.

    @:value(cast 2)@:impl@:enuminlineread onlyILLEGAL_ARGUMENT_ERROR:LastOperationStatus = 2

    Indicates that an argument passed to a method was illegal.

    @:value(cast 3)@:impl@:enuminlineread onlyINDEX_OUT_OF_BOUNDS_ERROR:LastOperationStatus = 3

    Indicates that an iterator went out of range or an invalid parameter was specified for month, day, or time.

    @:value(cast 4)@:impl@:enuminlineread onlyINVALID_ATTR_VALUE:LastOperationStatus = 4

    Indicates that a given attribute value is out of the expected range.

    @:value(cast 5)@:impl@:enuminlineread onlyINVALID_CHAR_FOUND:LastOperationStatus = 5

    Indicates that invalid Unicode value was found.

    @:value(cast 6)@:impl@:enuminlineread onlyMEMORY_ALLOCATION_ERROR:LastOperationStatus = 6

    Indicates that memory allocation has failed.

    @:value(cast 7)@:impl@:enuminlineread onlyNO_ERROR:LastOperationStatus = 7

    Indicates that the last operation succeeded without any errors. This +status can be returned by all constructors, non-static methods, static +methods and read/write properties.

    @:value(cast 8)@:impl@:enuminlineread onlyNUMBER_OVERFLOW_ERROR:LastOperationStatus = 8

    Indicates that an operation resulted a value that exceeds a specified +numeric type.

    @:value(cast 9)@:impl@:enuminlineread onlyPARSE_ERROR:LastOperationStatus = 9

    Indicates that the parsing of a number failed. This status can be +returned by parsing methods of the formatter classes, such as +CurrencyFormatter.parse() and NumberFormatter.parseNumber(). For +example, if the value "12abc34" is passed as the parameter to the +CurrencyFormatter.parse() method, the method returns "NaN" and sets +the lastOperationStatus value to LastOperationStatus.PARSE_ERROR.

    @:value(cast 10)@:impl@:enuminlineread onlyPATTERN_SYNTAX_ERROR:LastOperationStatus = 10

    Indicates that the pattern for formatting a number, date, or time is +invalid. This status is set when the user's operating system does not +support the given pattern.

    @:value(cast 11)@:impl@:enuminlineread onlyPLATFORM_API_FAILED:LastOperationStatus = 11

    Indicates that an underlying platform API failed for an operation.

    @:value(cast 12)@:impl@:enuminlineread onlyTRUNCATED_CHAR_FOUND:LastOperationStatus = 12

    Indicates that a truncated Unicode character value was found.

    @:value(cast 13)@:impl@:enuminlineread onlyUNEXPECTED_TOKEN:LastOperationStatus = 13

    Indicates that an unexpected token was detected in a Locale ID string.

    @:value(cast 14)@:impl@:enuminlineread onlyUNSUPPORTED_ERROR:LastOperationStatus = 14

    Indicates that the requested operation or option is not supported. This +status can be returned by methods like +DateTimeFormatter.setDateTimePattern() and when retrieving properties +like Collator.ignoreCase.

    @:value(cast 15)@:impl@:enuminlineread onlyUSING_DEFAULT_WARNING:LastOperationStatus = 15

    Indicates that an operating system default value was used during the +most recent operation. Class constructors can return this status.

    @:value(cast 16)@:impl@:enuminlineread onlyUSING_FALLBACK_WARNING:LastOperationStatus = 16

    Indicates that a fallback value was set during the most recent +operation. This status can be returned by constructors and methods like +DateTimeFormatter.setDateTimeStyles(), and when retrieving properties +like CurrencyFormatter.groupingPattern.

    \ No newline at end of file diff --git a/openfl/globalization/LocaleID.html b/openfl/globalization/LocaleID.html index 0204c97..5b12794 100644 --- a/openfl/globalization/LocaleID.html +++ b/openfl/globalization/LocaleID.html @@ -1,7 +1,9 @@ -openfl.globalization.LocaleID - API Reference
    View source

    final class LocaleID

    package openfl.globalization

    @:final

    Available on all platforms

    Static variables

    @:value("i-default")staticinlineread onlyDEFAULT:String = "i-default"

    Constructor

    new(name:String)

    Variables

    read onlylastOperationStatus:LastOperationStatus

    read onlyname:String

    Methods

    getLanguage():String

    getRegion():String

    getScript():String

    getVariant():String

    isRightToLeft():Bool

    \ No newline at end of file +
    View source

    final class LocaleID

    package openfl.globalization

    @:final

    Available on all platforms

    The LocaleID class provides methods for parsing and using locale ID names. +This class supports locale ID names that use the syntax defined by the +Unicode Technical Standard #35.

    See also:

    Static variables

    @:value("i-default")staticinlineread onlyDEFAULT:String = "i-default"

    Indicates that the user's default linguistic preferences should be used, +as specified in the user's operating system settings. For example, suc +preferences are typically set using the "Control Panel" for Windows, or +the "System Preferences" in macOS.

    +

    Using the LocaleID.DEFAULT setting can result in the use of a +different locale ID name for different kinds of operations. For example, +one locale could be used for sorting and a different one for formatting. +This flexibility respects the user preferences, and the class behaves +this way by design.

    +

    This locale identifier is not always the most appropriate one to use. +For applications running in the browser, the browser's preferred locale +could be a better choice. It is often a good idea to let the user alter +the preferred locale ID name setting and preserve that preference in a +user profile, cookie, or shared object.

    Constructor

    new(name:String)

    Constructs a new LocaleID object, given a locale name. The locale name +must conform to the syntax defined by the +Unicode Technical Standard #35.

    +

    When the constructor completes successfully the lastOperationStatus +property is set to:

    +

    When the requested locale ID name is not available then the +lastOperationStatus is set to one of the following:

    • LastOperationStatus.USING_FALLBACK_WARNING
    • LastOperationStatus.USING_DEFAULT_WARNING
    +

    Otherwise, the lastOperationStatus property is set to one of the +constants defined in the LastOperationStatus class.

    +

    For details on the warnings listed above and other possible values of +the lastOperationStatus property, see the descriptions in the +LastOperationStatus class.

    Variables

    read onlylastOperationStatus:LastOperationStatus

    The status of the most recent operation that this LocaleID object +performed. The lastOperationStatus property is set whenever the +constructor or a method of this class is called or another property is +set. For the possible values see the description for each method.

    read onlyname:String

    Returns a slightly more "canonical" locale identifier.

    +

    This method performs the following conversion to the locale ID name to +give it a more canonical form.

    • Proper casing is applied to all of the components.
    • Underscores are converted to dashes.
    +

    No additional processing is performed. For example, aliases are not +replaced, and no elements are added or removed.

    +

    When this method is called and it completes successfully, the +lastOperationStatus property is set to:

    +

    Otherwise, the lastOperationStatus property is set to one of the +constants defined in the LastOperationStatus class.

    Methods

    getLanguage():String

    Returns the language code specified by the locale ID name.

    +

    If the locale name cannot be properly parsed then the language code is +the same as the full locale name.

    +

    When this method is called and it completes successfully, the +lastOperationStatus property is set to:

    +

    Otherwise, the lastOperationStatus property is set to one of the +constants defined in the LastOperationStatus class.

    getRegion():String

    Returns the region code specified by the locale ID name.

    +

    This method returns an empty string if the region code cannot be parsed +or guessed/ This could occur if an unknown or incomplete locale ID name +like "xy" is used. The region code is not validated against a fixed +list. For example, the region code returned for a locale ID name of +"xx-YY" is "YY".

    +

    When this method is called and it completes successfully, the +lastOperationStatus property is set to:

    +

    If the region is not part of the specified locale name, the most likely +region code for the locale is "guessed" and lastOperationStatus +property is set to LastOperationStatus.USING_FALLBACK_WARNING.

    +

    Otherwise, the lastOperationStatus property is set to one of the +constants defined in the LastOperationStatus class.

    getScript():String

    Returns the script code specified by the locale ID name.

    +

    This method returns an empty string if the script code cannot be parsed +or guessed. This could occur if an unknown or incomplete locale ID name +like "xy" is used. The script code is not validated against a fixed +list. For example, the script code returned for a locale ID name of +"xx-Abcd-YY" is "Abcd".

    +

    The region, as well as the language, can also affect the return value. +For example, the script code for "mn-MN" (Mongolian-Mongolia) is "Cyrl" +(Cyrillic), while the script code for "mn-CN" (Mongolian-China) is +"Mong" (Mongolian).

    +

    When this method is called and it completes successfully, the +lastOperationStatus property is set to:

    +

    If the script code is not part of the specified locale name, the most +likely script code is "guessed" and lastOperationStatus property is +set to LastOperationStatus.USING_FALLBACK_WARNING.

    +

    Otherwise, the lastOperationStatus property is set to one of the +constants defined in the LastOperationStatus class.

    getVariant():String

    Returns the language variant code specified by the locale ID name.

    +

    This method returns an empty string if there is no language variant code +in the given locale ID name. (No guessing is necessary because few

    +
    locales have or need a language variant.)
+
    +

    When this method is called and it completes successfully, the +lastOperationStatus property is set to:

    +

    Otherwise, the lastOperationStatus property is set to one of the +constants defined in the LastOperationStatus class.

    isRightToLeft():Bool

    Specifies whether the text direction for the specified locale is right +to left.

    +

    The result can be used to determine the direction of the text in the +OpenFL text engine, and to decide whether to mirror the user interface +to support the current text direction.

    +

    When this method is called and it completes successfully, the +lastOperationStatus property is set to:

    +

    Otherwise, the lastOperationStatus property is set to one of the +constants defined in the LastOperationStatus class.

    \ No newline at end of file diff --git a/openfl/globalization/index.html b/openfl/globalization/index.html index 13ec736..864b84b 100644 --- a/openfl/globalization/index.html +++ b/openfl/globalization/index.html @@ -1,7 +1,7 @@ -openfl.globalization - API Reference

    openfl.globalization

    -
    ..
    DateTimeFormatter

    DateTimeNameContext

    DateTimeNameStyle

    DateTimeStyle

    LastOperationStatus

    LocaleID

    \ No newline at end of file +

    openfl.globalization

    ..
    DateTimeFormatter

    DateTimeNameContext

    The DateTimeNameContext class enumerates constant values representing the +formatting context in which a month name or weekday name is used. These +constants are used for the context parameters for the DateTimeFormatter's +getMonthNames() and getWeekDayNames() methods.

    DateTimeNameStyle

    The DateTimeNameStyle class enumerates constants that control the length of +the month names and weekday names that are used when formatting dates. Use +these constants for the nameStyle parameter of the DateTimeFormatter +getMonthNames() and getWeekDayNames() methods.

    DateTimeStyle

    Enumerates constants that determine a locale-specific date and time +formatting pattern. These constants are used when constructing a +DateTimeFormatter object or when calling the +DateTimeFormatter.setDateTimeStyles() method.

    LastOperationStatus

    The LastOperationStatus class enumerates constant values that represent the +status of the most recent globalization service operation. These values can +be retrieved through the read-only property lastOperationStatus available +in most globalization classes.

    LocaleID

    The LocaleID class provides methods for parsing and using locale ID names. +This class supports locale ID names that use the syntax defined by the +Unicode Technical Standard #35.

    \ No newline at end of file diff --git a/openfl/media/AudioPlaybackMode.html b/openfl/media/AudioPlaybackMode.html index eb32144..a4a49b5 100644 --- a/openfl/media/AudioPlaybackMode.html +++ b/openfl/media/AudioPlaybackMode.html @@ -1,7 +1,7 @@ -openfl.media.AudioPlaybackMode - API Referenceopenfl.media.AudioPlaybackMode - OpenFL API Reference
    View source

    enum abstract AudioPlaybackMode(Null<Int>)

    package openfl.media

    @:enum

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The AudioPlaybackMode class defines constants for the audioPlaybackMode +

    View source

    enum abstract AudioPlaybackMode(Null<Int>)

    package openfl.media

    @:enum

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The AudioPlaybackMode class defines constants for the audioPlaybackMode property of the SoundMixer class.

    Known Issue: No audio is played in the Media Playback mode for StageVideo, when the mute switch is ON.

    diff --git a/openfl/media/CameraPosition.html b/openfl/media/CameraPosition.html index bb4a15d..62b18af 100644 --- a/openfl/media/CameraPosition.html +++ b/openfl/media/CameraPosition.html @@ -1,7 +1,7 @@ -openfl.media.CameraPosition - API Referenceopenfl.media.CameraPosition - OpenFL API Reference
    View source

    enum abstract CameraPosition(Null<Int>)

    package openfl.media

    @:enum

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The CameraPosition class defines constants for the position property of +

    View source

    enum abstract CameraPosition(Null<Int>)

    package openfl.media

    @:enum

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The CameraPosition class defines constants for the position property of the Camera class.

    See also:

    • openfl.media.Camera

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBACK:CameraPosition = 0

    The Camera.position property returns this value for a back camera.

    @:value(cast 1)@:impl@:enuminlineread onlyFRONT:CameraPosition = 1

    The Camera.position property returns this value for a front camera.

    @:value(cast 2)@:impl@:enuminlineread onlyUNKNOWN:CameraPosition = 2

    The Camera.position property returns this value when the position of the Camera cannot be determined. This is the default value.

    \ No newline at end of file diff --git a/openfl/media/ID3Info.html b/openfl/media/ID3Info.html index 52db062..58167f7 100644 --- a/openfl/media/ID3Info.html +++ b/openfl/media/ID3Info.html @@ -1,7 +1,7 @@ -openfl.media.ID3Info - API Referenceopenfl.media.ID3Info - OpenFL API Reference
    View source

    final class ID3Info

    package openfl.media

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The ID3Info class contains properties that reflect ID3 metadata. You can get +

    View source

    final class ID3Info

    package openfl.media

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The ID3Info class contains properties that reflect ID3 metadata. You can get additional metadata for MP3 files by accessing the id3 property of the Sound class; for example, mySound.id3.TIME. For more information, see the entry for Sound.id3 and the ID3 tag definitions at http://www.id3.org.

    Constructor

    new()

    Variables

    album:String

    The name of the album; corresponds to the ID3 2.0 tag TALB.

    artist:String

    The name of the artist; corresponds to the ID3 2.0 tag TPE1.

    comment:String

    A comment about the recording; corresponds to the ID3 2.0 tag COMM.

    genre:String

    The genre of the song; corresponds to the ID3 2.0 tag TCON.

    songName:String

    The name of the song; corresponds to the ID3 2.0 tag TIT2.

    track:String

    The track number; corresponds to the ID3 2.0 tag TRCK.

    year:String

    The year of the recording; corresponds to the ID3 2.0 tag TYER.

    \ No newline at end of file diff --git a/openfl/media/Sound.html b/openfl/media/Sound.html index 41263bd..53ff432 100644 --- a/openfl/media/Sound.html +++ b/openfl/media/Sound.html @@ -1,7 +1,7 @@ -openfl.media.Sound - API Referenceopenfl.media.Sound - OpenFL API Reference
    API Reference
    View source

    class Sound

    package openfl.media

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(lime.media.AudioBuffer)@:access(lime.utils.AssetLibrary)@:access(openfl.media.SoundMixer)@:access(openfl.media.SoundChannel)@:autoBuild(openfl.utils._internal.AssetsMacro.embedSound())

    Available on all platforms

    The Sound class lets you work with sound in an application. The Sound class +

    View source

    class Sound

    package openfl.media

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(lime.media.AudioBuffer)@:access(lime.utils.AssetLibrary)@:access(openfl.media.SoundMixer)@:access(openfl.media.SoundChannel)@:autoBuild(openfl.utils._internal.AssetsMacro.embedSound())

    Available on all platforms

    The Sound class lets you work with sound in an application. The Sound class lets you create a Sound object, load and play an external MP3 file into that object, close the sound stream, and access data about the sound, such as information about the number of bytes in the stream and ID3 metadata. @@ -77,8 +77,8 @@ stream for playback.

    To control sounds that are embedded in a SWF file, use the properties in the SoundMixer class.

    -

    Note: The ActionScript 3.0 Sound API differs from ActionScript -2.0. In ActionScript 3.0, you cannot take sound objects and arrange them in +

    Note: The OpenFL Sound API differs from ActionScript +2.0. In OpenFL, you cannot take sound objects and arrange them in a hierarchy to control their properties.

    When you use this class, consider the following security model:

    • Loading and playing a sound is not allowed if the calling file is in a network sandbox and the sound file to be loaded is local.
    • By default, loading and playing a sound is not allowed if the calling @@ -97,7 +97,7 @@ Center Topic: Security.

      Events:

      complete

      Dispatched when data has loaded successfully.

      id3

      Dispatched by a Sound object when ID3 data is available for an MP3 sound.

      ioError

      Dispatched when an input/output error occurs that causes a load operation to fail.

      open

      Dispatched when a load operation starts.

      progress

      Dispatched when data is received as a load operation -progresses.

      sampleData

      Dispatched when the runtime requests new audio data.

    Static methods

    staticfromAudioBuffer(buffer:AudioBuffer):Sound

    Creates a new Sound from an AudioBuffer immediately.

    Parameters:

    buffer

    An AudioBuffer instance

    Returns:

    A new Sound

    staticfromFile(path:String):Sound

    Creates a new Sound from a file path synchronously. This means that the +progresses.

    sampleData

    Dispatched when the runtime requests new audio data.

    See also:

    Static methods

    staticfromAudioBuffer(buffer:AudioBuffer):Sound

    Creates a new Sound from an AudioBuffer immediately.

    Parameters:

    buffer

    An AudioBuffer instance

    Returns:

    A new Sound

    staticfromFile(path:String):Sound

    Creates a new Sound from a file path synchronously. This means that the Sound will be returned immediately (if supported).

    HTML5 and Flash do not support creating Sound synchronously, so these targets always return null.

    @@ -121,7 +121,7 @@ In Flash Player 10 and later and AIR 1.5 and later, instead of using load(), you can use the sampleData event handler to load sound dynamically into the Sound object.

    Parameters:

    stream

    The URL that points to an external MP3 file.

    context

    An optional SoundLoader context object, which can define -the buffer time(the minimum number of milliseconds of MP3 +the buffer time (the minimum number of milliseconds of MP3 data to hold in the Sound object's buffer) and can specify whether the application should check for a cross-domain policy file prior to loading the sound.

    Variables

    read onlybytesLoaded:Int

    Returns the currently available number of bytes in this sound object. This @@ -136,8 +136,8 @@ provides access to these tags through the format my_sound.id3.COMM, my_sound.id3.TIME, and so on. The first table describes tags that can be accessed either through the ID3 2.0 property name or the -ActionScript property name. The second table describes ID3 tags that -are supported but do not have predefined properties in ActionScript.

    ID3 2.0 tagCorresponding Sound class property
    COMMSound.id3.comment
    TALBSound.id3.album
    TCONSound.id3.genre
    TIT2Sound.id3.songName
    TPE1Sound.id3.artist
    TRCKSound.id3.track
    TYERSound.id3.year
    +Haxe property name. The second table describes ID3 tags that +are supported but do not have predefined properties in Haxe.

    ID3 2.0 tagCorresponding Sound class property
    COMMSound.id3.comment
    TALBSound.id3.album
    TCONSound.id3.genre
    TIT2Sound.id3.songName
    TPE1Sound.id3.artist
    TRCKSound.id3.track
    TYERSound.id3.year

    The following table describes ID3 tags that are supported but do not have predefined properties in the Sound class. You access them by calling mySound.id3.TFLT, mySound.id3.TIME, and so on. NOTE: @@ -195,13 +195,13 @@ is in the local-with-file-system sandbox and the sound is in a network sandbox.

  • Access from the local-trusted or local-with-networking sandbox requires permission from a website through a URL policy file.
  • You cannot connect to commonly reserved ports. For a complete list -of blocked ports, see "Restricting Networking APIs" in the ActionScript -3.0 Developer's Guide.
  • You can prevent a SWF file from using this method by setting the +of blocked ports, see "Restricting Networking APIs" in the OpenFL +Developer's Guide.
  • You can prevent a SWF file from using this method by setting the allowNetworking parameter of the object and embed tags in the HTML page that contains the SWF content.

    • In Flash Player 10 and later, if you use a multipart Content-Type(for -example "multipart/form-data") that contains an upload(indicated by a +example "multipart/form-data") that contains an upload (indicated by a "filename" parameter in a "content-disposition" header within the POST body), the POST operation is subject to the security rules applied to uploads:

    • The POST operation must be performed in response to a user-initiated @@ -218,7 +218,7 @@ security limitations.

      For more information related to security, see the Flash Player Developer Center Topic: Security.

      Parameters:

      stream

      A URL that points to an external MP3 file.

      context

      An optional SoundLoader context object, which can define -the buffer time(the minimum number of milliseconds of MP3 +the buffer time (the minimum number of milliseconds of MP3 data to hold in the Sound object's buffer) and can specify whether the application should check for a cross-domain policy file prior to loading the sound.

      Throws:

      IOError

      A network error caused the load to fail.

      IOError

      The digest property of the @@ -226,12 +226,12 @@ You should only set the digest property of a URLRequest object when calling the URLLoader.load() method when loading a -SWZ file(an Adobe platform component).

      SecurityError

      Local untrusted files may not communicate with the +SWZ file (an Adobe platform component).

      SecurityError

      Local untrusted files may not communicate with the Internet. You can work around this by reclassifying this file as local-with-networking or trusted.

      SecurityError

      You cannot connect to commonly reserved ports. For a complete list of blocked ports, see "Restricting -Networking APIs" in the ActionScript 3.0 -Developer's Guide.

    loadCompressedDataFromByteArray(bytes:ByteArray, bytesLength:Int):Void

    Load MP3 sound data from a ByteArray object into a Sound object. The data will be read from the current +Networking APIs" in the OpenFL +Developer's Guide.

    See also:

    loadCompressedDataFromByteArray(bytes:ByteArray, bytesLength:Int):Void

    Load MP3 sound data from a ByteArray object into a Sound object. The data will be read from the current ByteArray position and will leave the ByteArray position at the end of the specified bytes length once finished. If the MP3 sound data contains ID3 data ID3 events will be dispatched during this function call. This function will throw an exception if the ByteArray object does not contain enough data.

    Parameters:

    bytes
    null

    bytesLength

    @:value({ sampleRate : 44100, stereo : true, format : "float" })loadPCMFromByteArray(bytes:ByteArray, samples:Int, format:String = "float", stereo:Bool = true, sampleRate:Float = 44100):Void

    Load PCM 32-bit floating point sound data from a ByteArray object into a Sound object. The data will be read @@ -252,7 +252,7 @@ sound channel.

    Returns:

    A SoundChannel object, which you use to control the sound. This method returns null if you have no sound card or if you run out of available sound channels. The maximum number of -sound channels available at once is 32.

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that +sound channels available at once is 32.

    See also:

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

    @@ -325,7 +325,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/media/SoundChannel.html b/openfl/media/SoundChannel.html index 6ad6206..8b3015d 100644 --- a/openfl/media/SoundChannel.html +++ b/openfl/media/SoundChannel.html @@ -1,7 +1,7 @@ -openfl.media.SoundChannel - API Referenceopenfl.media.SoundChannel - OpenFL API Reference

    API Reference
    View source

    final class SoundChannel

    package openfl.media

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.events.SampleDataEvent)@:access(openfl.media.Sound)@:access(openfl.media.SoundMixer)@:final@:keep

    Available on all platforms

    The SoundChannel class controls a sound in an application. Every sound is +

    View source

    final class SoundChannel

    package openfl.media

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.events.SampleDataEvent)@:access(openfl.media.Sound)@:access(openfl.media.SoundMixer)@:final@:keep

    Available on all platforms

    The SoundChannel class controls a sound in an application. Every sound is assigned to a sound channel, and the application can have multiple sound channels that are mixed together. The SoundChannel class contains a stop() method, properties for monitoring the amplitude (volume) of the channel, and a property for assigning a SoundTransform -object to the channel.

    Events:

    soundComplete

    Dispatched when a sound has finished playing.

    Variables

    read onlyleftPeak:Float

    The current amplitude(volume) of the left channel, from 0(silent) to 1 +object to the channel.

    Events:

    soundComplete

    Dispatched when a sound has finished playing.

    See also:

    Variables

    read onlyleftPeak:Float

    The current amplitude (volume) of the left channel, from 0 (silent) to 1 (full amplitude).

    position:Float

    When the sound is playing, the position property indicates in milliseconds the current point that is being played in the sound file. When the sound is stopped or paused, the position property @@ -71,10 +71,10 @@ property when the sound is stopped. You can resume the sound later by restarting it from that saved position.

    If the sound is looped, position is reset to 0 at the -beginning of each loop.

    read onlyrightPeak:Float

    The current amplitude(volume) of the right channel, from 0(silent) to 1 +beginning of each loop.

    read onlyrightPeak:Float

    The current amplitude (volume) of the right channel, from 0 (silent) to 1 (full amplitude).

    soundTransform:SoundTransform

    The SoundTransform object assigned to the sound channel. A SoundTransform object includes properties for setting volume, panning, left speaker -assignment, and right speaker assignment.

    Methods

    stop():Void

    Stops the sound playing in the channel.

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that +assignment, and right speaker assignment.

    Methods

    stop():Void

    Stops the sound playing in the channel.

    See also:

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

    @@ -147,7 +147,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/media/SoundLoaderContext.html b/openfl/media/SoundLoaderContext.html index 9215775..78b4d30 100644 --- a/openfl/media/SoundLoaderContext.html +++ b/openfl/media/SoundLoaderContext.html @@ -1,7 +1,7 @@ -openfl.media.SoundLoaderContext - API Referenceopenfl.media.SoundLoaderContext - OpenFL API Reference

    View source

    class SoundLoaderContext

    package openfl.media

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The SoundLoaderContext class provides security checks for files that load +

    View source

    class SoundLoaderContext

    package openfl.media

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The SoundLoaderContext class provides security checks for files that load sound. SoundLoaderContext objects are passed as an argument to the constructor and the load() method of the Sound class.

    When you use this class, consider the following security model:

    • Loading and playing a sound is not allowed if the calling file is in @@ -82,8 +82,8 @@ SoundMixer.bufferTime property. The SoundMixer.bufferTime property affects the buffer time for embedded streaming sounds in a SWF file and is independent of dynamically -created Sound objects(that is, Sound objects created in -ActionScript).

    checkPolicyFile:Bool

    Specifies whether the application should try to download a URL policy +created Sound objects (that is, Sound objects created in +Haxe code).

    checkPolicyFile:Bool

    Specifies whether the application should try to download a URL policy file from the loaded sound's server before beginning to load the sound. This property applies to sound that is loaded from outside the calling file's own domain using the Sound.load() method. diff --git a/openfl/media/SoundMixer.html b/openfl/media/SoundMixer.html index cc8534c..42fd1e3 100644 --- a/openfl/media/SoundMixer.html +++ b/openfl/media/SoundMixer.html @@ -1,7 +1,7 @@ -openfl.media.SoundMixer - API Referenceopenfl.media.SoundMixer - OpenFL API Reference

    API Reference
    View source

    final class SoundMixer

    package openfl.media

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.media.SoundChannel)@:final

    Available on all platforms

    The SoundMixer class contains static properties and methods for global +

    View source

    final class SoundMixer

    package openfl.media

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.media.SoundChannel)@:final

    Available on all platforms

    The SoundMixer class contains static properties and methods for global sound control in the application. The SoundMixer class controls embedded and streaming sounds in the application. it does not control dynamically created sounds (that is, sounds generated in response to a Sound object @@ -74,7 +74,7 @@ The SoundMixer.bufferTime property only affects the buffer time for embedded streaming sounds in a SWF and is independent of dynamically created Sound objects (that is, Sound objects created in -ActionScript). The value of SoundMixer.bufferTime cannot override or +Haxe code). The value of SoundMixer.bufferTime cannot override or set the default of the buffer time specified in the SoundLoaderContext object that is passed to the Sound.load() method.

    staticsoundTransform:SoundTransform

    The SoundTransform object that controls global sound properties. A SoundTransform object includes properties for setting volume, panning, diff --git a/openfl/media/SoundTransform.html b/openfl/media/SoundTransform.html index 7858212..a26c90f 100644 --- a/openfl/media/SoundTransform.html +++ b/openfl/media/SoundTransform.html @@ -1,7 +1,7 @@ -openfl.media.SoundTransform - API Reference

    View source

    final class SoundTransform

    package openfl.media

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The SoundTransform class contains properties for volume and panning.

    Constructor

    @:value({ panning : 0, vol : 1 })new(vol:Float = 1, panning:Float = 0)

    Creates a SoundTransform object.

    Parameters:

    vol

    The volume, ranging from 0(silent) to 1(full volume).

    panning

    The left-to-right panning of the sound, ranging from -1 -(full pan left) to 1(full pan right). A value of 0 -represents no panning(center).

    Variables

    leftToLeft:Float

    A value, from 0(none) to 1(all), specifying how much of the left input -is played in the left speaker.

    leftToRight:Float

    A value, from 0(none) to 1(all), specifying how much of the left input -is played in the right speaker.

    pan:Float

    The left-to-right panning of the sound, ranging from -1(full pan left) to -1(full pan right). A value of 0 represents no panning(balanced center -between right and left).

    rightToLeft:Float

    A value, from 0(none) to 1(all), specifying how much of the right input -is played in the left speaker.

    rightToRight:Float

    A value, from 0(none) to 1(all), specifying how much of the right input -is played in the right speaker.

    volume:Float

    The volume, ranging from 0(silent) to 1(full volume).

    \ No newline at end of file +
    View source

    final class SoundTransform

    package openfl.media

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The SoundTransform class contains properties for volume and panning.

    See also:

    Constructor

    @:value({ panning : 0, vol : 1 })new(vol:Float = 1, panning:Float = 0)

    Creates a SoundTransform object.

    Parameters:

    vol

    The volume, ranging from 0 (silent) to 1 (full volume).

    panning

    The left-to-right panning of the sound, ranging from -1 +(full pan left) to 1 (full pan right). A value of 0 +represents no panning (center).

    Variables

    leftToLeft:Float

    A value, from 0 (none) to 1 (all), specifying how much of the left input +is played in the left speaker.

    leftToRight:Float

    A value, from 0 (none) to 1 (all), specifying how much of the left input +is played in the right speaker.

    pan:Float

    The left-to-right panning of the sound, ranging from -1 (full pan left) +to 1 (full pan right). A value of 0 represents no panning (balanced +center between right and left).

    +

    The following example sets the pan to 0.5 (half pan right) when +starting to play a Sound.

    +
    var transform = new SoundTransform(1.0, 0.5);
+var soundChannel = sound.play(0, 0, transform);
    +

    The following example sets the pan to -1 (full pan left) for a +SoundChannel that is currently playing.

    +
    var transform = soundChannel.soundTransform;
+transform.pan = -1.0;
+soundChannel.soundTransform = transform;

    See also:

    rightToLeft:Float

    A value, from 0 (none) to 1 (all), specifying how much of the right +input is played in the left speaker.

    rightToRight:Float

    A value, from 0 (none) to 1 (all), specifying how much of the right +input is played in the right speaker.

    volume:Float

    The volume, ranging from 0 (silent) to 1 (full volume).

    +

    The following example sets the volume to 0.5 (half volume) when +starting to play a Sound.

    +
    var transform = new SoundTransform(0.5);
+var soundChannel = sound.play(0, 0, transform);
    +

    The following example sets the volume to 0.0 (silent) for a +SoundChannel that is currently playing.

    +
    var transform = soundChannel.soundTransform;
+transform.volume = 0.0;
+soundChannel.soundTransform = transform;

    See also:

    \ No newline at end of file diff --git a/openfl/media/Video.html b/openfl/media/Video.html index 383f709..8d230e7 100644 --- a/openfl/media/Video.html +++ b/openfl/media/Video.html @@ -1,7 +1,7 @@ -openfl.media.Video - API Referenceopenfl.media.Video - OpenFL API Reference
    API Reference
    View source

    class Video

    package openfl.media

    extends DisplayObject › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.textures.TextureBase)@:access(openfl.display3D.Context3D)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Matrix)@:access(openfl.geom.Point)@:access(openfl.geom.Rectangle)@:access(openfl.net.NetStream)

    Available on all platforms

    The Video class displays live or recorded video in an application without +

    View source

    class Video

    package openfl.media

    extends DisplayObject › EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display3D.textures.TextureBase)@:access(openfl.display3D.Context3D)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Matrix)@:access(openfl.geom.Point)@:access(openfl.geom.Rectangle)@:access(openfl.net.NetStream)

    Available on all platforms

    The Video class displays live or recorded video in an application without embedding the video in your SWF file. This class creates a Video object that plays either of the following kinds of video: recorded video files stored on a server or locally, or live video captured by the user. A Video @@ -167,7 +167,7 @@ For example, you can clear the last image or display standby information without hiding the Video object.

    Inherited Variables

    Defined by DisplayObject

    @:keepalpha:Float

    Indicates the alpha transparency value of the object specified. Valid values are 0 (fully transparent) to 1 (fully opaque). The default value is 1. -Display objects with alpha set to 0 are active, even though they are invisible.

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A +Display objects with alpha set to 0 are active, even though they are invisible.

    See also:

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A bitmap can be drawn internally in two ways. If you have a blend mode enabled or an external clipping mask, the bitmap is drawn by adding a bitmap-filled square shape to the vector render. If you attempt to set @@ -187,7 +187,7 @@ BlendMode class defines string values you can use. The illustrations in the table show blendMode values applied to a circular display object(2) superimposed on another display object(1).

    -

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn +

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    See also:

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn to the bitmap instead of the main display. If cacheAsBitmapMatrix is null or unsupported, the bitmap is then copied to the main display as unstretched, unrotated pixels snapped @@ -218,12 +218,12 @@ number of pixels cannot exceed 16,777,215 pixels.(So, if a bitmap image is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is is 2880 pixels in height and 2,880 pixels -in width.

  • The bitmap fails to allocate(out of memory error).
    • +in width.
  • The bitmap fails to allocate (out of memory error).

    • The cacheAsBitmap property is best used with movie clips that have mostly static content and that do not scale and rotate frequently. With such movie clips, cacheAsBitmap can lead to -performance increases when the movie clip is translated(when its x -and y position is changed).

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to +performance increases when the movie clip is translated (when its x +and y position is changed).

    See also:

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. The application uses this matrix as a transformation matrix that is applied when rendering the bitmap version of the display object.

    Adobe AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop @@ -257,16 +257,16 @@

    Note: The cacheAsBitmapMatrix property is suitable for 2D transformations. If you need to apply transformations in 3D, you may do so by setting a 3D property of the object and manipulating its transform.matrix3D property. If the application is packaged using GPU mode, this allows the 3D transforms -to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated +to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    See also:

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated with the display object. The openfl.filters package contains several classes that define specific filters you can use.

    Filters can be applied in Flash Professional at design time, or at run -time by using ActionScript code. To apply a filter by using ActionScript, +time by using Haxe code. To apply a filter by using Haxe, you must make a temporary copy of the entire filters array, modify the temporary array, then assign the value of the temporary array back to the filters array. You cannot directly add a new filter object to the filters array.

    -

    To add a filter by using ActionScript, perform the following steps +

    To add a filter by using Haxe, perform the following steps (assume that the target display object is named myDisplayObject):

    1. Create a new filter object by using the constructor method of your chosen filter class.
    2. Assign the value of the myDisplayObject.filters array @@ -297,7 +297,7 @@

      The openfl.filters package includes classes for filters. For example, to create a DropShadow filter, you would write:

      Throws:

      ArgumentError

      When filters includes a ShaderFilter and the shader output type is not compatible with -this operation(the shader must specify a +this operation (the shader must specify a pixel4 output).

      ArgumentError

      When filters includes a ShaderFilter and the shader doesn't specify any image input or the first input is not an image4 input.

      ArgumentError

      When filters includes a ShaderFilter @@ -315,10 +315,10 @@ is adjusted accordingly, as shown in the following code:

      Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a height of 0, even if you try to -set height to a different value.

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file +set height to a different value.

      See also:

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file to which this display object belongs. The loaderInfo property is defined only for the root display object of a SWF file or for a loaded -Bitmap(not for a Bitmap that is drawn with ActionScript). To find the +Bitmap (not for a Bitmap that is drawn with Haxe). To find the loaderInfo object associated with the SWF file that contains a display object named myDisplayObject, use myDisplayObject.root.loaderInfo.

      @@ -330,7 +330,7 @@ list. The mask object itself is not drawn. Set mask to null to remove the mask.

      To be able to scale a mask object, it must be on the display list. To -be able to drag a mask Sprite object(by calling its +be able to drag a mask Sprite object (by calling its startDrag() method), it must be on the display list. To call the startDrag() method for a mask sprite based on a mouseDown event being dispatched by the sprite, set the @@ -349,23 +349,23 @@ more than one calling display object. When the mask is assigned to a second display object, it is removed as the mask of the first object, and that object's mask property becomes -null.

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in +null.

      See also:

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned x -coordinate will reflect the non-rotated object.

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in +coordinate will reflect the non-rotated object.

      See also:

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned y -coordinate will reflect the non-rotated object.

      name:String

      Indicates the instance name of the DisplayObject. The object can be +coordinate will reflect the non-rotated object.

      See also:

      name:String

      Indicates the instance name of the DisplayObject. The object can be identified in the child list of its parent display object container by calling the getChildByName() method of the display object container.

      Throws:

      IllegalOperationError

      If you are attempting to set this property on an object that was placed on the timeline in the Flash authoring tool.

      opaqueBackground:Null<Int>

      Specifies whether the display object is opaque with a certain background color. A transparent bitmap contains alpha channel data and is drawn -transparently. An opaque bitmap has no alpha channel(and renders faster +transparently. An opaque bitmap has no alpha channel (and renders faster than a transparent bitmap). If the bitmap is opaque, you specify its own background color to use.

      -

      If set to a number value, the surface is opaque(not transparent) with +

      If set to a number value, the surface is opaque (not transparent) with the RGB background color that the number specifies. If set to null(the default value), the display object has a transparent background.

      @@ -377,7 +377,7 @@

      The opaque background region is not matched when calling the hitTestPoint() method with the shapeFlag parameter set to true.

      -

      The opaque background region does not respond to mouse events.

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display +

      The opaque background region does not respond to mouse events.

      See also:

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display object. Use the parent property to specify a relative path to display objects that are above the current display object in the display list hierarchy.

      @@ -386,7 +386,7 @@ 
      this.parent.parent.alpha = 20;

      Throws:

      SecurityError

      The parent display object belongs to a security sandbox to which you do not have access. You can avoid this situation by having the parent movie call -the Security.allowDomain() method.

      read onlyroot:DisplayObject

      For a display object in a loaded SWF file, the root property +the Security.allowDomain() method.

      See also:

    read onlyroot:DisplayObject

    For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. For a Bitmap object representing a loaded image file, the root property is the Bitmap object @@ -399,7 +399,7 @@ is a child of the top-most display object in a loaded SWF file.

    For example, if you create a new Sprite object by calling the Sprite() constructor method, its root property -is null until you add it to the display list(or to a display +is null until you add it to the display list (or to a display object container that is off the display list but that is a child of the top-most display object in a SWF file).

    For a loaded SWF file, even though the Loader object used to load the @@ -407,12 +407,12 @@ SWF file has its root property set to itself. The Loader object does not have its root property set until it is added as a child of a display object for which the root property is -set.

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its +set.

    See also:

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement my_video.rotation = 450 -is the same as my_video.rotation = 90.

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, +is the same as my_video.rotation = 90.

    See also:

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, the entire display object is scaled normally when any scale transformation is applied.

    When you define the scale9Grid property, the display @@ -440,11 +440,11 @@ the registration point. The default registration point is (0,0). 1.0 equals 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the +y property values, which are defined in whole pixels.

    See also:

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. The default registration point is (0,0). 1.0 is 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is +y property values, which are defined in whole pixels.

    See also:

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is cropped to the size defined by the rectangle, and it scrolls within the rectangle when you change the x and y properties of the scrollRect object.

    @@ -461,17 +461,17 @@ an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated 90° and you scroll it left and right, the display object actually scrolls -up and down.

    @:betashader:Shader

    BETA**

    +up and down.

    See also:

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to apply a post-process effect to multiple display objects at once, enable cacheAsBitmap or use the filters property with a ShaderFilter

    read onlystage:Stage

    The Stage of the display object. A Flash runtime application has only one Stage object. For example, you can create and load multiple display objects into the display list, and the stage property of each -display object refers to the same Stage object(even if the display object +display object refers to the same Stage object (even if the display object belongs to a loaded SWF file).

    If a display object is not added to the display list, its -stage property is set to null.

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color +stage property is set to null.

    See also:

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. The specific properties - matrix, colorTransform, and three read-only properties (concatenatedMatrix, concatenatedColorTransform, @@ -508,21 +508,21 @@ is adjusted accordingly, as shown in the following code:

    Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a width of 0, even if you try to set -width to a different value.

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative +width to a different value.

    See also:

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative +registration point position.

    See also:

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative +registration point position.

    See also:

    Inherited Methods

    Defined by DisplayObject

    getBounds(targetCoordinateSpace:DisplayObject):Rectangle

    Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. Consider the following code, which shows how the rectangle returned can vary depending on the targetCoordinateSpace parameter that @@ -549,8 +549,8 @@ coordinates, respectively.

    Parameters:

    targetCoordinateSpace

    The display object that defines the coordinate system to use.

    Returns:

    The rectangle that defines the area of the display object relative to the targetCoordinateSpace object's coordinate -system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage(global) coordinates -to the display object's(local) coordinates.

    +system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage (global) coordinates +to the display object's (local) coordinates.

    To use this method, first create an instance of the Point class. The x and y values that you assign represent global coordinates because they relate to the origin(0,0) of the main display area. Then @@ -565,17 +565,17 @@ point specified by the x and y parameters. The x and y parameters specify a point in the coordinate space of the Stage, not the display object container that -contains the display object(unless that display object container is the +contains the display object (unless that display object container is the Stage).

    Parameters:

    x

    The x coordinate to test against this object.

    y

    The y coordinate to test against this object.

    shapeFlag

    Whether to check against the actual pixels of the object (true) or the bounding box (false).

    Returns:

    true if the display object overlaps or intersects with the specified point; false otherwise.

    invalidate():Void

    Calling the invalidate() method signals to have the current object -redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's(local) -coordinates to the Stage(global) coordinates.

    +redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's (local) +coordinates to the Stage (global) coordinates.

    This method allows you to convert any given x and y coordinates from values that are relative to the origin(0,0) of a -specific display object(local coordinates) to values that are relative to -the origin of the Stage(global coordinates).

    +specific display object (local coordinates) to values that are relative to +the origin of the Stage (global coordinates).

    To use this method, first create an instance of the Point class. The x and y values that you assign represent local coordinates because they relate to the origin of the display object.

    diff --git a/openfl/media/index.html b/openfl/media/index.html index e80d82b..83e70d8 100644 --- a/openfl/media/index.html +++ b/openfl/media/index.html @@ -1,7 +1,7 @@ -openfl.media - API Reference

    openfl.media

    -
    ..
    AudioPlaybackMode

    The AudioPlaybackMode class defines constants for the audioPlaybackMode +

    openfl.media

    Here are some selections from the OpenFL Developer's Guide to help you get started with the openfl.media package:

    ..
    AudioPlaybackMode

    The AudioPlaybackMode class defines constants for the audioPlaybackMode property of the SoundMixer class.

    CameraPosition

    The CameraPosition class defines constants for the position property of the Camera class.

    ID3Info

    The ID3Info class contains properties that reflect ID3 metadata. You can get additional metadata for MP3 files by accessing the id3 property of the Sound diff --git a/openfl/net/DatagramSocket.html b/openfl/net/DatagramSocket.html index bb231b2..d8d7787 100644 --- a/openfl/net/DatagramSocket.html +++ b/openfl/net/DatagramSocket.html @@ -1,7 +1,7 @@ -openfl.net.DatagramSocket - API Reference

    View source

    class DatagramSocket

    package openfl.net

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The DatagramSocket class enables code to send and receive Universal Datagram Protocol (UDP) packets.

    +
    View source

    class DatagramSocket

    package openfl.net

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on AIR, Android, Flash, HashLink, Linux, Neko, Windows, iOS, macOS

    The DatagramSocket class enables code to send and receive Universal Datagram Protocol (UDP) packets.

    You can test for support at run time using the DatagramSocket.isSupported property.

    OpenFL target support: This feature is supported on all desktop operating diff --git a/openfl/net/FileFilter.html b/openfl/net/FileFilter.html index b27d06a..2d1978b 100644 --- a/openfl/net/FileFilter.html +++ b/openfl/net/FileFilter.html @@ -1,7 +1,7 @@ -openfl.net.FileFilter - API Referenceopenfl.net.FileFilter - OpenFL API Reference

    API Reference
    View source

    final class FileFilter

    package openfl.net

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The FileFilter class is used to indicate what files on the user's system +

    View source

    final class FileFilter

    package openfl.net

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The FileFilter class is used to indicate what files on the user's system are shown in the file-browsing dialog box that is displayed when the FileReference.browse() method, the FileReferenceList.browse() method is called or a browse method of a File, FileReference, or diff --git a/openfl/net/FileReference.html b/openfl/net/FileReference.html index 6505402..c44081b 100644 --- a/openfl/net/FileReference.html +++ b/openfl/net/FileReference.html @@ -1,7 +1,7 @@ -openfl.net.FileReference - API Referenceopenfl.net.FileReference - OpenFL API Reference

    API Reference
    View source

    class FileReference

    package openfl.net

    extends EventDispatcher

    extended by File

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The FileReference class provides a means to upload and download files +

    View source

    class FileReference

    package openfl.net

    extends EventDispatcher

    extended by File

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The FileReference class provides a means to upload and download files between a user's computer and a server. An operating-system dialog box prompts the user to select a file to upload or a location for download. Each FileReference object refers to a single file on the user's disk and @@ -301,7 +301,7 @@ other properties of the FileReference object.

    uploadCompleteData

    Dispatched after data is received from the server after a successful upload. This event is not dispatched if data is not returned from the -server.

    Constructor

    new()

    Creates a new FileReference object. When populated, a FileReference +server.

    See also:

    Constructor

    new()

    Creates a new FileReference object. When populated, a FileReference object represents a file on the user's local disk.

    Variables

    read onlycreationDate:Date

    The creation date of the file on the local disk. If the object is was not populated, a call to get the value of this property returns null.

    Throws:

    IOError

    If the file information cannot be @@ -487,8 +487,8 @@

    This method supports downloading of any file type, with either HTTP or HTTPS.

    You cannot connect to commonly reserved ports. For a complete list of -blocked ports, see "Restricting Networking APIs" in the ActionScript -3.0 Developer's Guide.

    +blocked ports, see "Restricting Networking APIs" in the OpenFL +Developer's Guide.

    Note: If your server requires user authentication, only SWF files running in a browser ?that is, using the browser plug-in or ActiveX control ?can provide a dialog box to prompt the user for a user @@ -584,7 +584,7 @@ file security restrictions.

    SecurityError

    You cannot connect to commonly reserved ports. For a complete list of blocked ports, see "Restricting Networking APIs" -in the ActionScript 3.0 Developer's +in the OpenFL Developer's Guide.

    Events:

    cancel

    Dispatched when the user dismisses the dialog box.

    complete

    Dispatched when the file download operation successfully completes.

    ioError

    Dispatched for any of the following reasons: @@ -602,7 +602,7 @@ control and browser plug-in players.

    open

    Dispatched when a download operation starts.

    progress

    Dispatched periodically during the file download operation.

    securityError

    Dispatched when a download fails because of a security error.

    select

    Dispatched when the user selects a file for -download from the dialog box.

    load():Void

    Starts the load of a local file selected by a user. Although Flash +download from the dialog box.

    See also:

    load():Void

    Starts the load of a local file selected by a user. Although Flash Player has no restriction on the size of files you can upload, download, load or save, it officially supports sizes of up to 100 MB. For content running in Flash Player, you must call the @@ -660,7 +660,7 @@ successfully.

    ioError

    Invoked if the load fails because of an input/output error while the application is reading or writing the file.

    open

    Dispatched when an load operation starts.

    progress

    Dispatched periodically during the file load -operation.

    @:value({ defaultFileName : null })save(data:Dynamic, ?defaultFileName:String):Void

    Opens a dialog box that lets the user save a file to the local +operation.

    See also:

    @:value({ defaultFileName : null })save(data:Dynamic, ?defaultFileName:String):Void

    Opens a dialog box that lets the user save a file to the local filesystem. Although Flash Player has no restriction on the size of files you can upload, download, load or save, the player officially supports sizes of up to 100 MB. @@ -739,7 +739,7 @@ successfully completes.

    ioError

    Dispatched if an input/output error occurs while the file is being read or transmitted.

    open

    Dispatched when a download operation starts.

    progress

    Dispatched periodically during the file download operation.

    select

    Dispatched when the user selects a file for download -from the dialog box.

    @:value({ testUpload : false, uploadDataFieldName : "Filedata" })upload(request:URLRequest, uploadDataFieldName:String = "Filedata", testUpload:Bool = false):Void

    Starts the upload of the file to a remote server. Although Flash +from the dialog box.

    See also:

    @:value({ testUpload : false, uploadDataFieldName : "Filedata" })upload(request:URLRequest, uploadDataFieldName:String = "Filedata", testUpload:Bool = false):Void

    Starts the upload of the file to a remote server. Although Flash Player has no restriction on the size of files you can upload or download, the player officially supports uploads or downloads of up to 100 MB. You must call the FileReference.browse() or @@ -768,8 +768,8 @@ default and a filename attribute set to the name of the original file

  • The binary contents of the file

    • You cannot connect to commonly reserved ports. For a complete list of -blocked ports, see "Restricting Networking APIs" in the ActionScript -3.0 Developer's Guide.

    +blocked ports, see "Restricting Networking APIs" in the OpenFL +Developer's Guide.

    For a sample POST request, see the description of the uploadDataFieldName parameter. You can send POST or GET parameters to the server with the upload() method; see the @@ -897,7 +897,7 @@ and the URL that may not be accessed.

    SecurityError

    You cannot connect to commonly reserved ports. For a complete list of blocked ports, see "Restricting Networking APIs" -in the ActionScript 3.0 Developer's +in the OpenFL Developer's Guide.

    Events:

    complete

    Dispatched when the file upload operation completes successfully.

    httpResponseStatus

    The upload operation completes successfully and the server returns a response URL and @@ -918,7 +918,7 @@ HTTPS.

    open

    Dispatched when an upload operation starts.

    progress

    Dispatched periodically during the file upload operation.

    securityError

    Dispatched when an upload fails because of a security violation.

    uploadCompleteData

    Dispatched when data has been received from -the server after a successful file upload.

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that +the server after a successful file upload.

    See also:

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

    @@ -991,7 +991,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/net/FileReferenceList.html b/openfl/net/FileReferenceList.html index 814b0d7..1320b3e 100644 --- a/openfl/net/FileReferenceList.html +++ b/openfl/net/FileReferenceList.html @@ -1,7 +1,7 @@ -openfl.net.FileReferenceList - API Reference

    View source

    class FileReferenceList

    package openfl.net

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.net.FileReference)

    Available on HTML5

    Constructor

    new()

    Variables

    read onlyfileList:Array<FileReference>

    Methods

    @:value({ typeFilter : null })browse(?typeFilter:Array<FileFilter>):Bool

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that +

    View source

    class FileReferenceList

    package openfl.net

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.net.FileReference)

    Available on HTML5

    Constructor

    new()

    Variables

    read onlyfileList:Array<FileReference>

    Methods

    @:value({ typeFilter : null })browse(?typeFilter:Array<FileFilter>):Bool

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

    @@ -125,7 +125,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/net/IDynamicPropertyOutput.html b/openfl/net/IDynamicPropertyOutput.html index 4fe400a..a486e44 100644 --- a/openfl/net/IDynamicPropertyOutput.html +++ b/openfl/net/IDynamicPropertyOutput.html @@ -1,7 +1,7 @@ -openfl.net.IDynamicPropertyOutput - API Referenceopenfl.net.IDynamicPropertyOutput - OpenFL API Reference

    View source

    interface IDynamicPropertyOutput

    package openfl.net

    Available on all platforms

    This interface controls the serialization of dynamic properties of dynamic +

    View source

    interface IDynamicPropertyOutput

    package openfl.net

    Available on all platforms

    This interface controls the serialization of dynamic properties of dynamic objects. You use this interface with the IDynamicPropertyWriter interface and the ObjectEncoding.dynamicPropertyWriter property.

    Methods

    writeDynamicProperty(name:String, value:Dynamic):Void

    Adds a dynamic property to the binary output of a serialized object. When the object is subsequently read (using a method such as diff --git a/openfl/net/IDynamicPropertyWriter.html b/openfl/net/IDynamicPropertyWriter.html index 4686fa5..c6c58a9 100644 --- a/openfl/net/IDynamicPropertyWriter.html +++ b/openfl/net/IDynamicPropertyWriter.html @@ -1,7 +1,7 @@ -openfl.net.IDynamicPropertyWriter - API Referenceopenfl.net.IDynamicPropertyWriter - OpenFL API Reference

    API Reference
    View source

    interface IDynamicPropertyWriter

    package openfl.net

    Available on all platforms

    This interface is used with the IDynamicPropertyOutput interface to +

    View source

    interface IDynamicPropertyWriter

    package openfl.net

    Available on all platforms

    This interface is used with the IDynamicPropertyOutput interface to control the serialization of dynamic properties of dynamic objects. To use this interface, assign an object that implements the IDynamicPropertyWriter interface to the diff --git a/openfl/net/IPVersion.html b/openfl/net/IPVersion.html index ce4ea8d..af73709 100644 --- a/openfl/net/IPVersion.html +++ b/openfl/net/IPVersion.html @@ -1,7 +1,7 @@ -openfl.net.IPVersion - API Referenceopenfl.net.IPVersion - OpenFL API Reference

    View source

    enum abstract IPVersion(Null<Int>)

    package openfl.net

    @:enum

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The IPVersion class defines constants representing the different families of +

    View source

    enum abstract IPVersion(Null<Int>)

    package openfl.net

    @:enum

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The IPVersion class defines constants representing the different families of IP addresses.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyIPV4:IPVersion = 0

    An Internet Protocol version 4 (IPv4) address.

    IPv4 addresses are expressed in Haxe as a string in dot-decimal notation, such as: "192.0.2.0".

    @:value(cast 1)@:impl@:enuminlineread onlyIPV6:IPVersion = 1

    IPv6 addresses are expressed in Haxe as a string in hexadecimal-colon diff --git a/openfl/net/NetConnection.html b/openfl/net/NetConnection.html index 35180da..e9a9aa5 100644 --- a/openfl/net/NetConnection.html +++ b/openfl/net/NetConnection.html @@ -1,7 +1,7 @@ -openfl.net.NetConnection - API Referenceopenfl.net.NetConnection - OpenFL API Reference

    API Reference
    View source

    class NetConnection

    package openfl.net

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The NetConnection class creates a two-way connection between a client and +

    View source

    class NetConnection

    package openfl.net

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The NetConnection class creates a two-way connection between a client and a server. The client can be a Flash Player or AIR application. The server can be a web server, Flash Media Server, an application server running Flash Remoting, or the <a @@ -117,7 +117,7 @@ scope="external">Flash Media Server documentation.

  • You cannot call NetConnection.connect() if the calling file is in the local-with-file-system sandbox.
  • You cannot connect to commonly reserved ports. For a complete list of blocked ports, see "Restricting Networking APIs" in the -ActionScript 3.0 Developer's Guide.
  • To prevent a SWF file from calling this method, set the +OpenFL Developer's Guide.
  • To prevent a SWF file from calling this method, set the allowNetworking parameter of the the object and embed tags in the HTML page that contains the SWF content.

    • However, in Adobe AIR, content in the application security sandbox @@ -174,7 +174,7 @@ local-with-networking or trusted.

    SecurityError

    You cannot connect to commonly reserved ports. For a complete list of blocked ports, see "Restricting Networking APIs" in the -ActionScript 3.0 Developer's Guide.

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that +OpenFL Developer's Guide.

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

    @@ -247,7 +247,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/net/NetStream.html b/openfl/net/NetStream.html index 50e79cf..04d122b 100644 --- a/openfl/net/NetStream.html +++ b/openfl/net/NetStream.html @@ -1,7 +1,7 @@ -openfl.net.NetStream - API Referenceopenfl.net.NetStream - OpenFL API Reference

    View source

    class NetStream

    package openfl.net

    extends EventDispatcher

    @:access(openfl.media.SoundMixer)@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The NetStream class opens a one-way streaming channel over a +

    View source

    class NetStream

    package openfl.net

    extends EventDispatcher

    @:access(openfl.media.SoundMixer)@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The NetStream class opens a one-way streaming channel over a NetConnection. Use the NetStream class to do the following:

    • Call NetStream.play() to play a media file from a local disk, a web server, or Flash Media Server.
    • Call NetStream.publish() to publish a video, audio, and data stream to @@ -579,7 +579,7 @@ policy files might not be applicable to the file's final URL, which is the URL that matters in security decisions.

      For more information on policy files, see "Website controls (policy -files)" in the ActionScript 3.0 Developer's Guide and the Flash +files)" in the OpenFL Developer's Guide and the Flash Player Developer Center Topic: <a href="http://www.adobe.com/go/devnet_security_en" scope="external">Security.

    client:Dynamic

    Specifies the object on which callback methods are invoked to handle @@ -895,7 +895,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/net/ObjectEncoding.html b/openfl/net/ObjectEncoding.html index 70cbf6d..d961bb5 100644 --- a/openfl/net/ObjectEncoding.html +++ b/openfl/net/ObjectEncoding.html @@ -1,7 +1,7 @@ -openfl.net.ObjectEncoding - API Referenceopenfl.net.ObjectEncoding - OpenFL API Reference

    View source

    enum abstract ObjectEncoding(Int)

    package openfl.net

    from Int, UInt to Int, UInt

    @:enum

    Available on all platforms

    The ObjectEncoding class is used in defining serialization settings in +

    View source

    enum abstract ObjectEncoding(Int)

    package openfl.net

    from Int, UInt to Int, UInt

    @:enum

    Available on all platforms

    The ObjectEncoding class is used in defining serialization settings in classes that serialize objects (such as FileStream, NetStream, NetConnection, SharedObject, and ByteArray).

    Object encoding controls how objects are represented in serialized diff --git a/openfl/net/Responder.html b/openfl/net/Responder.html index 4c3ce1f..338d881 100644 --- a/openfl/net/Responder.html +++ b/openfl/net/Responder.html @@ -1,7 +1,7 @@ -openfl.net.Responder - API Referenceopenfl.net.Responder - OpenFL API Reference

    API Reference
    View source

    class Responder

    package openfl.net

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Responder class provides an object that is used in +

    View source

    class Responder

    package openfl.net

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Responder class provides an object that is used in NetConnection.call() to handle return values from the server related to the success or failure of specific operations. When working with NetConnection.call(), you may encounter a network operation fault specific diff --git a/openfl/net/SecureSocket.html b/openfl/net/SecureSocket.html index df4ca99..9820712 100644 --- a/openfl/net/SecureSocket.html +++ b/openfl/net/SecureSocket.html @@ -1,7 +1,7 @@ -openfl.net.SecureSocket - API Referenceopenfl.net.SecureSocket - OpenFL API Reference

    View source

    class SecureSocket

    package openfl.net

    extends Socket › EventDispatcher

    @:access(openfl.security.X509Certificate)@:access(openfl.security.X500DistinguishedName)

    Available on all platforms

    The SecureSocket class enables code to make socket connections using the +

    View source

    class SecureSocket

    package openfl.net

    extends Socket › EventDispatcher

    @:access(openfl.security.X509Certificate)@:access(openfl.security.X500DistinguishedName)

    Available on all platforms

    The SecureSocket class enables code to make socket connections using the Secure Sockets Layer (SSL) and Transport Layer Security (TLS) protocols.

    You can test for support at run time using the SecureSocket.isSupported property.

    @@ -163,9 +163,9 @@ this property returns a value of true if the socket is currently connected, or false otherwise.

    endian:Endian

    Indicates the byte order for the data. Possible values are constants from the openfl.utils.Endian class, Endian.BIG_ENDIAN or -Endian.LITTLE_ENDIAN.

    read onlylocalAddress:String

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The IP address this socket is bound to on the local machine.

    read onlylocalPort:Int

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The port this socket is bound to on the local machine.

    objectEncoding:ObjectEncoding

    Controls the version of AMF used when writing or reading an object.

    read onlyremoteAddress:String

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The IP address of the remote machine to which this socket is connected.

    +Endian.LITTLE_ENDIAN.

    read onlylocalAddress:String

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The IP address this socket is bound to on the local machine.

    read onlylocalPort:Int

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The port this socket is bound to on the local machine.

    objectEncoding:ObjectEncoding

    Controls the version of AMF used when writing or reading an object.

    read onlyremoteAddress:String

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The IP address of the remote machine to which this socket is connected.

    You can use this property to determine the IP address of a client socket -dispatched in a ServerSocketConnectEvent by a ServerSocket object.

    read onlyremotePort:Int

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The port on the remote machine to which this socket is connected.

    +dispatched in a ServerSocketConnectEvent by a ServerSocket object.

    read onlyremotePort:Int

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The port on the remote machine to which this socket is connected.

    You can use this property to determine the port number of a client socket dispatched in a ServerSocketConnectEvent by a ServerSocket object.

    timeout:Int

    Indicates the number of milliseconds to wait for a connection. If the connection doesn't succeed within the specified time, the @@ -335,7 +335,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/net/ServerSocket.html b/openfl/net/ServerSocket.html index 54cea7d..572b425 100644 --- a/openfl/net/ServerSocket.html +++ b/openfl/net/ServerSocket.html @@ -1,7 +1,7 @@ -openfl.net.ServerSocket - API Referenceopenfl.net.ServerSocket - OpenFL API Reference

    View source

    class ServerSocket

    package openfl.net

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.net.Socket)

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The ServerSocket class allows code to act as a server for Transport Control +

    View source

    class ServerSocket

    package openfl.net

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.net.Socket)

    Available on AIR, Android, Flash, HashLink, Linux, Neko, Windows, iOS, macOS

    The ServerSocket class allows code to act as a server for Transport Control Protocol (TCP) Connections.

    You can test for support at run time using the ServerSocket.isSupported property.

    diff --git a/openfl/net/SharedObject.html b/openfl/net/SharedObject.html index d9e6c42..32e4196 100644 --- a/openfl/net/SharedObject.html +++ b/openfl/net/SharedObject.html @@ -1,7 +1,7 @@ -openfl.net.SharedObject - API Referenceopenfl.net.SharedObject - OpenFL API Reference
    API Reference
    View source

    class SharedObject

    package openfl.net

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The SharedObject class is used to read and store limited amounts of data on +

    View source

    class SharedObject

    package openfl.net

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The SharedObject class is used to read and store limited amounts of data on a user's computer or on a server. Shared objects offer real-time data sharing between multiple client SWF files and objects that are persistent on the local computer or remote server. Local shared objects are similar to @@ -245,9 +245,9 @@ used to store shared objects. The domain that is used depends on the security permissions granted to the local file that created the shared object. Local files can have three different levels of permissions:

    1. Access to the local filesystem only.
    2. Access to the network only.
    3. Access to both the network and the local filesystem.
    -

    Local files with access to the local filesystem(level 1 or 3) store +

    Local files with access to the local filesystem (level 1 or 3) store their shared objects in one location. Local files without access to the -local filesystem(level 2) store their shared objects in another +local filesystem (level 2) store their shared objects in another location.

    You can prevent a SWF file from using this method by setting the allowNetworking parameter of the the object and @@ -289,7 +289,7 @@

    The following diagram shows the use of the secure parameter:

    Returns:

    A reference to a shared object that is persistent locally and is available only to the current client. If Flash Player can't create -or find the shared object(for example, if localPath +or find the shared object (for example, if localPath was specified but no such directory exists), this method throws an exception.

    Throws:

    Error

    Flash Player cannot create the shared object for whatever reason. This error might occur is if persistent shared @@ -452,7 +452,7 @@ minDiskSpace. If Flash asks the user to allot disk space for the shared object, it asks for 500 bytes. After the user allots the requested amount of space, Flash won't have to ask for more space on -future attempts to flush the object(as long as its size doesn't exceed +future attempts to flush the object (as long as its size doesn't exceed 500 bytes).

    After the user responds to the dialog box, this method is called again. A netStatus event is dispatched with a code @@ -473,7 +473,7 @@ error might occur if the user has permanently disallowed local information storage for objects from this domain.

    Note: Local content can always write shared -objects from third-party domains(domains other than the +objects from third-party domains (domains other than the domain in the current browser address bar) to disk, even if writing of third-party shared objects to disk is disallowed.

    send(args:Array<Dynamic>):Void

    Broadcasts a message to all clients connected to a remote shared @@ -579,7 +579,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/net/SharedObjectFlushStatus.html b/openfl/net/SharedObjectFlushStatus.html index 1c936f8..0739515 100644 --- a/openfl/net/SharedObjectFlushStatus.html +++ b/openfl/net/SharedObjectFlushStatus.html @@ -1,7 +1,7 @@ -openfl.net.SharedObjectFlushStatus - API Referenceopenfl.net.SharedObjectFlushStatus - OpenFL API Reference

    View source

    enum abstract SharedObjectFlushStatus(Null<Int>)

    package openfl.net

    @:enum

    Available on all platforms

    The SharedObjectFlushStatus class provides values for the code returned +

    View source

    enum abstract SharedObjectFlushStatus(Null<Int>)

    package openfl.net

    @:enum

    Available on all platforms

    The SharedObjectFlushStatus class provides values for the code returned from a call to the SharedObject.flush() method.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyFLUSHED:SharedObjectFlushStatus = 0

    Indicates that the flush completed successfully.

    @:value(cast 1)@:impl@:enuminlineread onlyPENDING:SharedObjectFlushStatus = 1

    Indicates that the user is being prompted to increase disk space for the shared object before the flush can occur.

    \ No newline at end of file diff --git a/openfl/net/Socket.html b/openfl/net/Socket.html index a73dbae..c2f2962 100644 --- a/openfl/net/Socket.html +++ b/openfl/net/Socket.html @@ -1,7 +1,7 @@ -openfl.net.Socket - API Referenceopenfl.net.Socket - OpenFL API Reference
    View source

    class Socket

    package openfl.net

    extends EventDispatcher

    implements IDataOutput, IDataInput

    extended by SecureSocket

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Socket class enables code to establish Transport Control Protocol +

    View source

    class Socket

    package openfl.net

    extends EventDispatcher

    implements IDataOutput, IDataInput

    extended by SecureSocket

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Socket class enables code to establish Transport Control Protocol (TCP) socket connections for sending and receiving binary data. The Socket class is useful for working with servers that use binary protocols.

    @@ -162,7 +162,7 @@ server whose policy file doesn't grant the calling host access to the specified port. For more information on policy files, see "Website -controls (policy files)" in the ActionScript 3.0 +controls (policy files)" in the OpenFL Developer's Guide and the Flash Player Developer Center Topic: <a href="http://www.adobe.com/go/devnet_security_en" @@ -179,9 +179,9 @@ this property returns a value of true if the socket is currently connected, or false otherwise.

    endian:Endian

    Indicates the byte order for the data. Possible values are constants from the openfl.utils.Endian class, Endian.BIG_ENDIAN or -Endian.LITTLE_ENDIAN.

    read onlylocalAddress:String

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The IP address this socket is bound to on the local machine.

    read onlylocalPort:Int

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The port this socket is bound to on the local machine.

    objectEncoding:ObjectEncoding

    Controls the version of AMF used when writing or reading an object.

    read onlyremoteAddress:String

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The IP address of the remote machine to which this socket is connected.

    +Endian.LITTLE_ENDIAN.

    read onlylocalAddress:String

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The IP address this socket is bound to on the local machine.

    read onlylocalPort:Int

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The port this socket is bound to on the local machine.

    objectEncoding:ObjectEncoding

    Controls the version of AMF used when writing or reading an object.

    read onlyremoteAddress:String

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The IP address of the remote machine to which this socket is connected.

    You can use this property to determine the IP address of a client socket -dispatched in a ServerSocketConnectEvent by a ServerSocket object.

    read onlyremotePort:Int

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The port on the remote machine to which this socket is connected.

    +dispatched in a ServerSocketConnectEvent by a ServerSocket object.

    read onlyremotePort:Int

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The port on the remote machine to which this socket is connected.

    You can use this property to determine the port number of a client socket dispatched in a ServerSocketConnectEvent by a ServerSocket object.

    timeout:Int

    Indicates the number of milliseconds to wait for a connection. If the connection doesn't succeed within the specified time, the @@ -220,7 +220,7 @@ server whose policy file doesn't grant the calling host access to the specified port. For more information on policy files, see "Website -controls (policy files)" in the ActionScript 3.0 +controls (policy files)" in the OpenFL Developer's Guide and the Flash Player Developer Center Topic: <a href="http://www.adobe.com/go/devnet_security_en" @@ -384,7 +384,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/net/URLLoader.html b/openfl/net/URLLoader.html index 75c754e..7c3a429 100644 --- a/openfl/net/URLLoader.html +++ b/openfl/net/URLLoader.html @@ -1,7 +1,7 @@ -openfl.net.URLLoader - API Referenceopenfl.net.URLLoader - OpenFL API Reference

    View source

    class URLLoader

    package openfl.net

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The URLLoader class downloads data from a URL as text, binary data, or +

    View source

    class URLLoader

    package openfl.net

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The URLLoader class downloads data from a URL as text, binary data, or URL-encoded variables. It is useful for downloading text files, XML, or other information to be used in a dynamic, data-driven application.

    A URLLoader object downloads all of the data from a URL before making it @@ -104,9 +104,9 @@ sandbox. Also dispatched if a call to URLLoader.load() attempts to load a SWZ file and the certificate is invalid or the -digest string does not match the component.

    Constructor

    @:value({ request : null })new(?request:URLRequest)

    Creates a URLLoader object.

    Parameters:

    request

    A URLRequest object specifying the URL to download. If this +digest string does not match the component.

    See also:

    Constructor

    @:value({ request : null })new(?request:URLRequest)

    Creates a URLLoader object.

    Parameters:

    request

    A URLRequest object specifying the URL to download. If this parameter is omitted, no load operation begins. If -specified, the load operation begins immediately(see the +specified, the load operation begins immediately (see the load entry for more information).

    Variables

    bytesLoaded:Int

    Indicates the number of bytes that have been loaded thus far during the load operation.

    bytesTotal:Int

    Indicates the total number of bytes in the downloaded data. This property contains 0 while the load operation is in progress and is populated when @@ -154,10 +154,10 @@ different domain, place a URL policy file on the server hosting the data.

    You cannot connect to commonly reserved ports. For a complete list of -blocked ports, see "Restricting Networking APIs" in the ActionScript -3.0 Developer's Guide.

    +blocked ports, see "Restricting Networking APIs" in the OpenFL +Developer's Guide.

    In Flash Player 10 and later, if you use a multipart Content-Type(for -example "multipart/form-data") that contains an upload(indicated by a +example "multipart/form-data") that contains an upload (indicated by a "filename" parameter in a "content-disposition" header within the POST body), the POST operation is subject to the security rules applied to uploads:

    • The POST operation must be performed in response to a user-initiated @@ -188,8 +188,8 @@ Internet. This may be worked around by reclassifying this file as local-with-networking or trusted.

      SecurityError

      You are trying to connect to a commonly reserved port. For a complete list of blocked ports, see -"Restricting Networking APIs" in the ActionScript -3.0 Developer's Guide.

      TypeError

      The value of the request parameter or the +"Restricting Networking APIs" in the OpenFL +Developer's Guide.

      TypeError

      The value of the request parameter or the URLRequest.url property of the URLRequest object passed are null.

      Events:

      complete

      Dispatched after data has loaded successfully.

      httpResponseStatus

      Dispatched if a call to the load() method attempts to access data over HTTP and @@ -205,7 +205,7 @@ the server.

      securityError

      A load operation attempted to load a SWZ file(a Adobe platform component), but the certificate is invalid or the digest does not match the -component.

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that +component.

    See also:

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

    @@ -278,7 +278,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/net/URLLoaderDataFormat.html b/openfl/net/URLLoaderDataFormat.html index 8149c8a..bffb3c7 100644 --- a/openfl/net/URLLoaderDataFormat.html +++ b/openfl/net/URLLoaderDataFormat.html @@ -1,7 +1,7 @@ -openfl.net.URLLoaderDataFormat - API Referenceopenfl.net.URLLoaderDataFormat - OpenFL API Reference

    View source

    enum abstract URLLoaderDataFormat(Null<Int>)

    package openfl.net

    @:enum

    Available on all platforms

    The URLLoaderDataFormat class provides values that specify how downloaded +

    View source

    enum abstract URLLoaderDataFormat(Null<Int>)

    package openfl.net

    @:enum

    Available on all platforms

    The URLLoaderDataFormat class provides values that specify how downloaded data is received.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBINARY:URLLoaderDataFormat = 0

    Specifies that downloaded data is received as raw binary data.

    @:value(cast 1)@:impl@:enuminlineread onlyTEXT:URLLoaderDataFormat = 1

    Specifies that downloaded data is received as text.

    @:value(cast 2)@:impl@:enuminlineread onlyVARIABLES:URLLoaderDataFormat = 2

    Specifies that downloaded data is received as URL-encoded variables.

    \ No newline at end of file diff --git a/openfl/net/URLRequest.html b/openfl/net/URLRequest.html index 90a1a72..30cf412 100644 --- a/openfl/net/URLRequest.html +++ b/openfl/net/URLRequest.html @@ -1,7 +1,7 @@ -openfl.net.URLRequest - API Referenceopenfl.net.URLRequest - OpenFL API Reference
    API Reference
    View source

    final class URLRequest

    package openfl.net

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The URLRequest class captures all of the information in a single HTTP +

    View source

    final class URLRequest

    package openfl.net

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The URLRequest class captures all of the information in a single HTTP request. URLRequest objects are passed to the load() methods of the Loader, URLStream, and URLLoader classes, and to other loading operations, to initiate URL downloads. They are also passed to the @@ -79,7 +79,7 @@ (in Flash Player), and loading is governed by the content's domain and any permissions granted in URL policy files.

    For more information related to security, see the Flash Player Developer -Center Topic: Security.

    Constructor

    @:value({ url : null })new(?url:String)

    Creates a URLRequest object. If System.useCodePage is +Center Topic: Security.

    See also:

    Constructor

    @:value({ url : null })new(?url:String)

    Creates a URLRequest object. If System.useCodePage is true, the request is encoded using the system code page, rather than Unicode. If System.useCodePage is false, the request is encoded using Unicode, rather than the @@ -99,12 +99,12 @@ object, the value of contentType must be application/x-www-form-urlencoded.

  • If the value of the data property is any other type, the value of contentType should indicate the type of the POST -data that will be sent(which is the binary or string data contained in +data that will be sent (which is the binary or string data contained in the value of the data property).
  • For FileReference.upload(), the Content-Type of the request is set automatically to multipart/form-data, and the value of the contentType property is ignored.

    • In Flash Player 10 and later, if you use a multipart Content-Type(for -example "multipart/form-data") that contains an upload(indicated by a +example "multipart/form-data") that contains an upload (indicated by a "filename" parameter in a "content-disposition" header within the POST body), the POST operation is subject to the security rules applied to uploads:

    • The POST operation must be performed in response to a user-initiated @@ -154,19 +154,26 @@

      Note: The HTMLLoader.load() method does not support the URLRequest.idleTimeout property. The HTMLLoader class defines its own idleTimeout property.

      -

      The default value is initialized from the URLRequestDefaults.idleTimeout property.

    manageCookies:Bool

    Specifies whether the HTTP protocol stack should manage cookies for this request. -When true, cookies are added to the request and response cookies are remembered. -If false, cookies are not added to the request and response cookies are not -remembered, but users can manage cookies themselves by direct header manipulation. -Note: On Windows, you cannot add cookies to a URL request manually when -manageCookies is set to true. On other operating systems, adding cookies to a -request is permitted irrespective of whether manageCookies is set to true or -false. When permitted, you can add cookies to a request manually by adding a -URLRequestHeader object containing the cookie data to the requestHeaders array.

    +

    The default value is initialized from the URLRequestDefaults.idleTimeout property.

    manageCookies:Bool

    Specifies whether the HTTP protocol stack should manage cookies for this +request. When true, cookies are added to the request and response +cookies are remembered. If false, cookies are not added to the request +and response cookies are not remembered, but users can manage cookies +themselves by direct header manipulation.

    +

    Note: In OpenFL's HTML5 target, the 'Cookie' request header +cannot be added programatically, due to web browser security +restrictions. See +MDN: Forbidden Request Headers +for details.

    +

    Note: On Windows, you cannot add cookies to a URL request manually +when manageCookies is set to true. On other operating systems, +adding cookies to a request is permitted irrespective of whether +manageCookies is set to true or false. When permitted, you can add +cookies to a request manually by adding a URLRequestHeader object +containing the cookie data to the requestHeaders array.

    On Mac OS, cookies are shared with Safari. To clear cookies on Mac OS:

    1. Open Safari.
    2. Select Safari > Preferences, and click the Security panel.
    3. Click the Show Cookies button.
    4. Click the Reomove All button.

    To clear cookies on Windows:

    1. Open the Internet Properties control panel, and click the General tab.
    2. Click the Delete Cookies button.

    The default value is true.

    method:String

    Controls the HTTP form submission method.

    -

    For SWF content running in Flash Player(in the browser), this property +

    For SWF content running in Flash Player (in the browser), this property is limited to GET or POST operations, and valid values are URLRequestMethod.GET or URLRequestMethod.POST.

    @@ -176,7 +183,7 @@ operations.

    For content running in Adobe AIR, when using the navigateToURL() function, the runtime treats a URLRequest -that uses the POST method(one that has its method property +that uses the POST method (one that has its method property set to URLRequestMethod.POST) as using the GET method.

    Note: If running in Flash Player and the referenced form has no body, Flash Player automatically uses a GET operation, even if the method @@ -203,7 +210,7 @@

    Be sure to encode any characters that are either described as unsafe in the Uniform Resource Locator specification(see http://www.faqs.org/rfcs/rfc1738.html) or that are reserved in the URL -scheme of the URLRequest object(when not used for their reserved +scheme of the URLRequest object (when not used for their reserved purpose). For example, use "%25" for the percent(%) symbol and "%23" for the number sign(#), as in "http://www.example.com/orderForm.cfm?item=%23B-3&discount=50%25".

    @@ -217,7 +224,7 @@ using any of the following URL schemes:

    • http and https
    • file
    • app-storage
    • app

    Note: IPv6(Internet Protocol version 6) is supported in AIR and in Flash Player 9.0.115.0 and later. IPv6 is a version of Internet -Protocol that supports 128-bit addresses(an improvement on the earlier +Protocol that supports 128-bit addresses (an improvement on the earlier IPv4 protocol that supports 32-bit addresses). You might need to activate IPv6 on your networking interfaces. For more information, see the Help for the operating system hosting the data. If IPv6 is supported on the hosting @@ -229,4 +236,7 @@

    Note: This property does not affect the user agent string when the URLRequest object is used with the load() method of an HTMLLoader object. To set the user agent string for an HTMLLoader object, set the userAgent property of the -HTMLLoader object or set the static URLRequestDefaults.userAgent property.

    \ No newline at end of file +HTMLLoader object or set the static URLRequestDefaults.userAgent property.

    @:value(false)withCredentials:Bool = false

    Specifies whether cross-site Access-Control requests should be made +using credentials such as cookies, authentication headers or TLS client +certificates. Setting withCredentials has no effect on same-origin +requests, and it has no effect on targets not running in web browsers.

    \ No newline at end of file diff --git a/openfl/net/URLRequestDefaults.html b/openfl/net/URLRequestDefaults.html index 54ff58a..0ea1220 100644 --- a/openfl/net/URLRequestDefaults.html +++ b/openfl/net/URLRequestDefaults.html @@ -1,7 +1,7 @@ -openfl.net.URLRequestDefaults - API Referenceopenfl.net.URLRequestDefaults - OpenFL API Reference
    API Reference
    View source

    class URLRequestDefaults

    package openfl.net

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The URLRequestDefaults class includes static properties that you can set to define +

    View source

    class URLRequestDefaults

    package openfl.net

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The URLRequestDefaults class includes static properties that you can set to define default values for the properties of the URLRequest class. It also includes a static method, URLRequestDefaults.setLoginCredentialsForHost(), which lets you define default authentication credentials for requests. The URLRequest class defines the @@ -69,7 +69,7 @@ the currently running application.

    Only Adobe® AIR® content running in the application security sandbox can use the URLRequestDefaults class. Other content will result in a SecurityError being thrown -when accessing the members or properties of this class.

    Static variables

    @:value(true)staticfollowRedirects:Bool = true

    The default setting for the followRedirects property of URLRequest objects. +when accessing the members or properties of this class.

    See also:

    Static variables

    @:value(true)staticfollowRedirects:Bool = true

    The default setting for the followRedirects property of URLRequest objects. Setting the followRedirects property in a URLRequest object overrides this default setting. This setting does not apply to URLRequest objects used in file upload or RTMP requests.

    diff --git a/openfl/net/URLRequestHeader.html b/openfl/net/URLRequestHeader.html index 4a57b3b..60f2014 100644 --- a/openfl/net/URLRequestHeader.html +++ b/openfl/net/URLRequestHeader.html @@ -1,7 +1,7 @@ -openfl.net.URLRequestHeader - API Referenceopenfl.net.URLRequestHeader - OpenFL API Reference
    View source

    final class URLRequestHeader

    package openfl.net

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    A URLRequestHeader object encapsulates a single HTTP request header and +

    View source

    final class URLRequestHeader

    package openfl.net

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    A URLRequestHeader object encapsulates a single HTTP request header and consists of a name/value pair. URLRequestHeader objects are used in the requestHeaders property of the URLRequest class.

    +

    In OpenFL's HTML5 target, a number of request headers cannot be used, due +to web browser security restrictions. See +MDN: Forbidden Request Headers +for details.

    In Adobe® AIR®, content in the application security sandbox (such as content installed with the AIR application) can use any request headers, without error. However, for content running in @@ -69,7 +73,7 @@ security sandbox, the following request headers cannot be used, and the restricted terms are not case-sensitive(for example, Get, get, and GET are all not allowed). Also, -hyphenated terms apply if an underscore character is used(for example, +hyphenated terms apply if an underscore character is used (for example, both Content-Length and Content_Length are not allowed):

    Accept-Charset, Accept-Encoding, @@ -92,7 +96,7 @@ Via, Warning, WWW-Authenticate, x-flash-version.

    URLRequestHeader objects are restricted in length. If the cumulative -length of a URLRequestHeader object(the length of the name +length of a URLRequestHeader object (the length of the name property plus the value property) or an array of URLRequestHeader objects used in the URLRequest.requestHeaders property exceeds the acceptable length, an exception is thrown.

    @@ -108,10 +112,10 @@ URLRequest.requestHeaders property.

    Due to browser limitations, custom HTTP request headers are only supported for POST requests, not for GET -requests.

    Constructor

    @:value({ value : "", name : "" })new(name:String = "", value:String = "")

    Creates a new URLRequestHeader object that encapsulates a single HTTP +requests.

    See also:

    Constructor

    @:value({ value : "", name : "" })new(name:String = "", value:String = "")

    Creates a new URLRequestHeader object that encapsulates a single HTTP request header. URLRequestHeader objects are used in the -requestHeaders property of the URLRequest class.

    Parameters:

    name

    An HTTP request header name(such as +requestHeaders property of the URLRequest class.

    Parameters:

    name

    An HTTP request header name (such as Content-Type or SOAPAction).

    value

    The value associated with the name property -(such as text/plain).

    Variables

    name:String

    An HTTP request header name(such as Content-Type or +(such as text/plain).

    Variables

    name:String

    An HTTP request header name (such as Content-Type or SOAPAction).

    value:String

    The value associated with the name property(such as text/plain).

    \ No newline at end of file diff --git a/openfl/net/URLRequestMethod.html b/openfl/net/URLRequestMethod.html index 1dc3e27..66131c7 100644 --- a/openfl/net/URLRequestMethod.html +++ b/openfl/net/URLRequestMethod.html @@ -1,7 +1,7 @@ -openfl.net.URLRequestMethod - API Referenceopenfl.net.URLRequestMethod - OpenFL API Reference
    View source

    enum abstract URLRequestMethod(String)

    package openfl.net

    from String to String

    @:enum

    Available on all platforms

    The URLRequestMethod class provides values that specify whether the +

    View source

    enum abstract URLRequestMethod(String)

    package openfl.net

    from String to String

    @:enum

    Available on all platforms

    The URLRequestMethod class provides values that specify whether the URLRequest object should use the POST method or the -GET method when sending data to a server.

    Variables

    @:value(cast "DELETE")@:impl@:enuminlineread onlyDELETE:URLRequestMethod = "DELETE"

    Specifies that the URLRequest object is a DELETE.

    @:value(cast "GET")@:impl@:enuminlineread onlyGET:URLRequestMethod = "GET"

    Specifies that the URLRequest object is a GET.

    @:value(cast "HEAD")@:impl@:enuminlineread onlyHEAD:URLRequestMethod = "HEAD"

    Specifies that the URLRequest object is a HEAD.

    @:value(cast "OPTIONS")@:impl@:enuminlineread onlyOPTIONS:URLRequestMethod = "OPTIONS"

    Specifies that the URLRequest object is OPTIONS.

    @:value(cast "POST")@:impl@:enuminlineread onlyPOST:URLRequestMethod = "POST"

    Specifies that the URLRequest object is a POST.

    +GET method when sending data to a server.

    See also:

    Variables

    @:value(cast "DELETE")@:impl@:enuminlineread onlyDELETE:URLRequestMethod = "DELETE"

    Specifies that the URLRequest object is a DELETE.

    @:value(cast "GET")@:impl@:enuminlineread onlyGET:URLRequestMethod = "GET"

    Specifies that the URLRequest object is a GET.

    @:value(cast "HEAD")@:impl@:enuminlineread onlyHEAD:URLRequestMethod = "HEAD"

    Specifies that the URLRequest object is a HEAD.

    @:value(cast "OPTIONS")@:impl@:enuminlineread onlyOPTIONS:URLRequestMethod = "OPTIONS"

    Specifies that the URLRequest object is OPTIONS.

    @:value(cast "POST")@:impl@:enuminlineread onlyPOST:URLRequestMethod = "POST"

    Specifies that the URLRequest object is a POST.

    Note: For content running in Adobe AIR, when using the navigateToURL() function, the runtime treats a URLRequest -that uses the POST method(one that has its method property +that uses the POST method (one that has its method property set to URLRequestMethod.POST) as using the GET method.

    @:value(cast "PUT")@:impl@:enuminlineread onlyPUT:URLRequestMethod = "PUT"

    Specifies that the URLRequest object is a PUT.

    \ No newline at end of file diff --git a/openfl/net/URLStream.html b/openfl/net/URLStream.html index 260817e..e49de49 100644 --- a/openfl/net/URLStream.html +++ b/openfl/net/URLStream.html @@ -1,7 +1,7 @@ -openfl.net.URLStream - API Referenceopenfl.net.URLStream - OpenFL API Reference
    API Reference
    View source

    class URLStream

    package openfl.net

    extends EventDispatcher

    implements IDataInput

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The URLStream class provides low-level access to downloading URLs. Data is +

    View source

    class URLStream

    package openfl.net

    extends EventDispatcher

    implements IDataInput

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The URLStream class provides low-level access to downloading URLs. Data is made available to application code immediately as it is downloaded, instead of waiting until the entire file is complete as with URLLoader. The URLStream class also lets you close a stream before it finishes @@ -98,7 +98,7 @@ received can be read immediately using the methods of the URLStream class.

    securityError

    Dispatched if a call to URLStream.load() attempts to load data from a server outside the -security sandbox.

    Constructor

    new()

    Variables

    read onlybytesAvailable:UInt

    Returns the number of bytes of data available for reading in the input +security sandbox.

    See also:

    Constructor

    new()

    Variables

    read onlybytesAvailable:UInt

    Returns the number of bytes of data available for reading in the input buffer. Your code must call the bytesAvailable property to ensure that sufficient data is available before you try to read it with one of the read methods.

    read onlyconnected:Bool

    Indicates whether this URLStream object is currently connected. A call @@ -124,7 +124,7 @@ hosting the data.

    In Flash Player, you cannot connect to commonly reserved ports. For a complete list of blocked ports, see "Restricting Networking APIs" in -the ActionScript 3.0 Developer's Guide.

    +the OpenFL Developer's Guide.

    In Flash Player, you can prevent a SWF file from using this method by setting the allowNetworking parameter of the the object and embed tags in the HTML page that contains the SWF content.

    @@ -188,7 +188,7 @@ local-with-networking or trusted.

    SecurityError

    You are trying to connect to a commonly reserved port. For a complete list of blocked ports, see "Restricting Networking APIs" in the -ActionScript 3.0 Developer's Guide.

    Events:

    complete

    Dispatched after data has loaded +OpenFL Developer's Guide.

    Events:

    complete

    Dispatched after data has loaded successfully. If there is a httpResponseStatus event listener, the URLRequest object also dispatches a @@ -203,11 +203,11 @@ any complete or error event.

    ioError

    The load operation could not be completed.

    open

    Dispatched when a load operation starts.

    securityError

    A load operation attempted to retrieve data from a server outside the caller's security sandbox. This may be worked around using a -policy file on the server.

    readBoolean():Bool

    Reads a Boolean value from the stream. A single byte is read, and +policy file on the server.

    See also:

    readBoolean():Bool

    Reads a Boolean value from the stream. A single byte is read, and true is returned if the byte is nonzero, false otherwise.

    Returns:

    True is returned if the byte is nonzero, false otherwise.

    Throws:

    EOFError

    There is insufficient data available to read. If a local SWF file triggers a security warning, Flash Player prevents the URLStream data from being -available to ActionScript. When this happens, the +available to Haxe code. When this happens, the bytesAvailable property returns 0 even if data has been received, and any of the read methods throws an EOFError exception.

    IOError

    An I/O error occurred on the stream, or the stream is @@ -215,7 +215,7 @@ The returned value is in the range -128...127.

    Returns:

    Value in the range -128...127.

    Throws:

    EOFError

    There is insufficient data available to read. If a local SWF file triggers a security warning, Flash Player prevents the URLStream data from being -available to ActionScript. When this happens, the +available to Haxe code. When this happens, the bytesAvailable property returns 0 even if data has been received, and any of the read methods throws an EOFError exception.

    IOError

    An I/O error occurred on the stream, or the stream is @@ -226,7 +226,7 @@ cause all available data to be read.

    Throws:

    EOFError

    There is insufficient data available to read. If a local SWF file triggers a security warning, Flash Player prevents the URLStream data from being -available to ActionScript. When this happens, the +available to Haxe code. When this happens, the bytesAvailable property returns 0 even if data has been received, and any of the read methods throws an EOFError exception.

    IOError

    An I/O error occurred on the stream, or the stream is @@ -235,7 +235,7 @@ stream.

    Throws:

    EOFError

    There is insufficient data available to read. If a local SWF file triggers a security warning, Flash Player prevents the URLStream data from being -available to ActionScript. When this happens, the +available to Haxe code. When this happens, the bytesAvailable property returns 0 even if data has been received, and any of the read methods throws an EOFError exception.

    IOError

    An I/O error occurred on the stream, or the stream is @@ -244,7 +244,7 @@ stream.

    Throws:

    EOFError

    There is insufficient data available to read. If a local SWF file triggers a security warning, Flash Player prevents the URLStream data from being -available to ActionScript. When this happens, the +available to Haxe code. When this happens, the bytesAvailable property returns 0 even if data has been received, and any of the read methods throws an EOFError exception.

    IOError

    An I/O error occurred on the stream, or the stream is @@ -252,7 +252,7 @@ The returned value is in the range -2147483648...2147483647.

    Returns:

    Value in the range -2147483648...2147483647.

    Throws:

    EOFError

    There is insufficient data available to read. If a local SWF file triggers a security warning, Flash Player prevents the URLStream data from being -available to ActionScript. When this happens, the +available to Haxe code. When this happens, the bytesAvailable property returns 0 even if data has been received, and any of the read methods throws an EOFError exception.

    IOError

    An I/O error occurred on the stream, or the stream is @@ -274,14 +274,14 @@ code page.

    Returns:

    UTF-8 encoded string.

    Throws:

    EOFError

    There is insufficient data available to read. If a local SWF file triggers a security warning, Flash Player prevents the URLStream data from being -available to ActionScript. When this happens, the +available to Haxe code. When this happens, the bytesAvailable property returns 0 even if data has been received, and any of the read methods throws an EOFError exception.

    readObject():Dynamic

    Reads an object from the socket, encoded in Action Message Format (AMF).

    Returns:

    The deserialized object.

    Throws:

    EOFError

    There is insufficient data available to read. If a local SWF file triggers a security warning, Flash Player prevents the URLStream data from being -available to ActionScript. When this happens, the +available to Haxe code. When this happens, the bytesAvailable property returns 0 even if data has been received, and any of the read methods throws an EOFError exception.

    IOError

    An I/O error occurred on the stream, or the stream is @@ -289,7 +289,7 @@ The returned value is in the range -32768...32767.

    Returns:

    Value in the range -32768...32767.

    Throws:

    EOFError

    There is insufficient data available to read. If a local SWF file triggers a security warning, Flash Player prevents the URLStream data from being -available to ActionScript. When this happens, the +available to Haxe code. When this happens, the bytesAvailable property returns 0 even if data has been received, and any of the read methods throws an EOFError exception.

    IOError

    An I/O error occurred on the stream, or the stream is @@ -297,7 +297,7 @@ prefixed with an unsigned short indicating the length in bytes.

    Returns:

    A UTF-8 string.

    Throws:

    EOFError

    There is insufficient data available to read. If a local SWF file triggers a security warning, Flash Player prevents the URLStream data from being -available to ActionScript. When this happens, the +available to Haxe code. When this happens, the bytesAvailable property returns 0 even if data has been received, and any of the read methods throws an EOFError exception.

    IOError

    An I/O error occurred on the stream, or the stream is @@ -314,7 +314,7 @@ The returned value is in the range 0...255.

    Returns:

    Value in the range 0...255.

    Throws:

    EOFError

    There is insufficient data available to read. If a local SWF file triggers a security warning, Flash Player prevents the URLStream data from being -available to ActionScript. When this happens, the +available to Haxe code. When this happens, the bytesAvailable property returns 0 even if data has been received, and any of the read methods throws an EOFError exception.

    IOError

    An I/O error occurred on the stream, or the stream is @@ -322,7 +322,7 @@ The returned value is in the range 0...4294967295.

    Returns:

    Value in the range 0...4294967295.

    Throws:

    EOFError

    There is insufficient data available to read. If a local SWF file triggers a security warning, Flash Player prevents the URLStream data from being -available to ActionScript. When this happens, the +available to Haxe code. When this happens, the bytesAvailable property returns 0 even if data has been received, and any of the read methods throws an EOFError exception.

    IOError

    An I/O error occurred on the stream, or the stream is @@ -330,7 +330,7 @@ The returned value is in the range 0...65535.

    Returns:

    Value in the range 0...65535.

    Throws:

    EOFError

    There is insufficient data available to read. If a local SWF file triggers a security warning, Flash Player prevents the URLStream data from being -available to ActionScript. When this happens, the +available to Haxe code. When this happens, the bytesAvailable property returns 0 even if data has been received, and any of the read methods throws an EOFError exception.

    IOError

    An I/O error occurred on the stream, or the stream is @@ -407,7 +407,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/net/URLVariables.html b/openfl/net/URLVariables.html index 95538cd..15a6ef4 100644 --- a/openfl/net/URLVariables.html +++ b/openfl/net/URLVariables.html @@ -1,7 +1,7 @@ -openfl.net.URLVariables - API Referenceopenfl.net.URLVariables - OpenFL API Reference

    View source

    abstract URLVariables(Dynamic)

    package openfl.net

    from Dynamic to Dynamic

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:forward

    Available on all platforms

    The URLVariables class allows you to transfer variables between an +

    View source

    abstract URLVariables(Dynamic)

    package openfl.net

    from Dynamic to Dynamic

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:forward

    Available on all platforms

    The URLVariables class allows you to transfer variables between an application and a server. Use URLVariables objects with methods of the URLLoader class, with the data property of the URLRequest -class, and with openfl.net package functions.

    Static methods

    staticdecode(this:Dynamic, source:String):Void

    Converts the variable string to properties of the specified URLVariables +class, and with openfl.net package functions.

    See also:

    Static methods

    staticdecode(this:Dynamic, source:String):Void

    Converts the variable string to properties of the specified URLVariables object.

    This method is used internally by the URLVariables events. Most users do not need to call this method directly.

    Parameters:

    source

    A URL-encoded query string containing name/value pairs.

    Throws:

    Error

    The source parameter must be a URL-encoded query string diff --git a/openfl/net/XMLSocket.html b/openfl/net/XMLSocket.html index 2f01356..3c226d7 100644 --- a/openfl/net/XMLSocket.html +++ b/openfl/net/XMLSocket.html @@ -1,7 +1,7 @@ -openfl.net.XMLSocket - API Referenceopenfl.net.XMLSocket - OpenFL API Reference

    API Reference
    View source

    class XMLSocket

    package openfl.net

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The XMLSocket class implements client sockets that let the OpenFL +

    View source

    class XMLSocket

    package openfl.net

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The XMLSocket class implements client sockets that let the OpenFL application communicate with a server computer identified by an IP address or domain name. The XMLSocket class is useful for client-server applications that require low latency, such as real-time chat systems. A traditional @@ -255,7 +255,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/net/dns/AAAARecord.html b/openfl/net/dns/AAAARecord.html index ff03c49..de729f9 100644 --- a/openfl/net/dns/AAAARecord.html +++ b/openfl/net/dns/AAAARecord.html @@ -1,7 +1,7 @@ -openfl.net.dns.AAAARecord - API Referenceopenfl.net.dns.AAAARecord - OpenFL API Reference

    View source

    class AAAARecord

    package openfl.net.dns

    extends ResourceRecord

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The AAAARecord class represents a Domain Name System (DNS) AAAA resource +

    View source

    class AAAARecord

    package openfl.net.dns

    extends ResourceRecord

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The AAAARecord class represents a Domain Name System (DNS) AAAA resource record containing an IPv6 address.

    AAAA resource records are returned by a DNSResolver object as a result of a DNS lookup of a domain name.

    Constructor

    new()

    Creates an AAAA resource record.

    diff --git a/openfl/net/dns/ARecord.html b/openfl/net/dns/ARecord.html index a0418a3..2cf6488 100644 --- a/openfl/net/dns/ARecord.html +++ b/openfl/net/dns/ARecord.html @@ -1,7 +1,7 @@ -openfl.net.dns.ARecord - API Referenceopenfl.net.dns.ARecord - OpenFL API Reference
    View source

    class ARecord

    package openfl.net.dns

    extends ResourceRecord

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The ARecord class represents a Domain Name System (DNS) A resource record +

    View source

    class ARecord

    package openfl.net.dns

    extends ResourceRecord

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The ARecord class represents a Domain Name System (DNS) A resource record containing an IPv4 address.

    A resource records are returned by a DNSResolver object as a result of a DNS lookup of a domain name.

    Constructor

    new()

    Creates an A resource record.

    diff --git a/openfl/net/dns/DNSResolver.html b/openfl/net/dns/DNSResolver.html index b7c29b9..60cfea9 100644 --- a/openfl/net/dns/DNSResolver.html +++ b/openfl/net/dns/DNSResolver.html @@ -1,7 +1,7 @@ -openfl.net.dns.DNSResolver - API Reference
    View source

    class DNSResolver

    package openfl.net.dns

    extends EventDispatcher

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The DNSResolver class lets you lookup Domain Name System (DNS) resource records.

    +
    View source

    class DNSResolver

    package openfl.net.dns

    extends EventDispatcher

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The DNSResolver class lets you lookup Domain Name System (DNS) resource records.

    You can test for support at run time using the DNSResolver.isSupported property.

    OpenFL target support: Not currently supported, except when targeting AIR.

    @@ -145,7 +145,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/net/dns/MXRecord.html b/openfl/net/dns/MXRecord.html index fdeecae..a851a47 100644 --- a/openfl/net/dns/MXRecord.html +++ b/openfl/net/dns/MXRecord.html @@ -1,7 +1,7 @@ -openfl.net.dns.MXRecord - API Referenceopenfl.net.dns.MXRecord - OpenFL API Reference

    View source

    class MXRecord

    package openfl.net.dns

    extends ResourceRecord

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The MXRecord class represents a Domain Name System (DNS) MX resource record +

    View source

    class MXRecord

    package openfl.net.dns

    extends ResourceRecord

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The MXRecord class represents a Domain Name System (DNS) MX resource record containing a mail exchange server address.

    MX resource records are returned by a DNSResolver object as a result of a DNS lookup on a domain name. More than one record can be returned by a diff --git a/openfl/net/dns/PTRRecord.html b/openfl/net/dns/PTRRecord.html index 9e22306..59e1f6e 100644 --- a/openfl/net/dns/PTRRecord.html +++ b/openfl/net/dns/PTRRecord.html @@ -1,7 +1,7 @@ -openfl.net.dns.PTRRecord - API Referenceopenfl.net.dns.PTRRecord - OpenFL API Reference

    View source

    class PTRRecord

    package openfl.net.dns

    extends ResourceRecord

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The PTRRecord class represents a Domain Name System (DNS) PTR resource +

    View source

    class PTRRecord

    package openfl.net.dns

    extends ResourceRecord

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The PTRRecord class represents a Domain Name System (DNS) PTR resource record containing a canonical domain name.

    PTR resource records are returned by a DNSResolver object as a result of a DNS lookup of an IP address.

    Constructor

    new()

    Creates a PTR resource record.

    diff --git a/openfl/net/dns/ResourceRecord.html b/openfl/net/dns/ResourceRecord.html index 436e03e..77993aa 100644 --- a/openfl/net/dns/ResourceRecord.html +++ b/openfl/net/dns/ResourceRecord.html @@ -1,7 +1,7 @@ -openfl.net.dns.ResourceRecord - API Referenceopenfl.net.dns.ResourceRecord - OpenFL API Reference
    View source

    class ResourceRecord

    package openfl.net.dns

    extended by AAAARecord, ARecord, MXRecord, PTRRecord, SRVRecord

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The ResourceRecord class is the base class for Domain Name System (DNS) +

    View source

    class ResourceRecord

    package openfl.net.dns

    extended by AAAARecord, ARecord, MXRecord, PTRRecord, SRVRecord

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The ResourceRecord class is the base class for Domain Name System (DNS) resource record classes.

    DNS resource records are returned by a DNSResolver object as a result of a DNS lookup.

    Variables

    name:String

    The query string used to look up this resource record.

    ttl:Int

    The resource time-to-live (ttl) value.

    diff --git a/openfl/net/dns/SRVRecord.html b/openfl/net/dns/SRVRecord.html index 66a5e1b..a8425cb 100644 --- a/openfl/net/dns/SRVRecord.html +++ b/openfl/net/dns/SRVRecord.html @@ -1,7 +1,7 @@ -openfl.net.dns.SRVRecord - API Referenceopenfl.net.dns.SRVRecord - OpenFL API Reference
    View source

    class SRVRecord

    package openfl.net.dns

    extends ResourceRecord

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The SRVRecord class represents a Domain Name System (DNS) SRV resource +

    View source

    class SRVRecord

    package openfl.net.dns

    extends ResourceRecord

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The SRVRecord class represents a Domain Name System (DNS) SRV resource record containing a service host.

    SRV resource records are returned by a DNSResolver object as a result of a DNS lookup on a service locator. More than one record can be returned by a diff --git a/openfl/net/dns/index.html b/openfl/net/dns/index.html index a6e30fd..bcd1152 100644 --- a/openfl/net/dns/index.html +++ b/openfl/net/dns/index.html @@ -1,7 +1,7 @@ -openfl.net.dns - API Reference

    openfl.net.dns

    -
    ..
    AAAARecord

    The AAAARecord class represents a Domain Name System (DNS) AAAA resource +

    openfl.net.dns

    ..
    AAAARecord

    The AAAARecord class represents a Domain Name System (DNS) AAAA resource record containing an IPv6 address.

    ARecord

    The ARecord class represents a Domain Name System (DNS) A resource record containing an IPv4 address.

    DNSResolver

    The DNSResolver class lets you lookup Domain Name System (DNS) resource records.

    MXRecord

    The MXRecord class represents a Domain Name System (DNS) MX resource record containing a mail exchange server address.

    PTRRecord

    The PTRRecord class represents a Domain Name System (DNS) PTR resource diff --git a/openfl/net/index.html b/openfl/net/index.html index 5a4a385..776dfe5 100644 --- a/openfl/net/index.html +++ b/openfl/net/index.html @@ -1,7 +1,7 @@ -openfl.net - API Reference

    openfl.net

    -
    ..
    dns
    DatagramSocket

    The DatagramSocket class enables code to send and receive Universal Datagram Protocol (UDP) packets.

    FileFilter

    The FileFilter class is used to indicate what files on the user's system +

    openfl.net

    Here are some selections from the OpenFL Developer's Guide to help you get started with the openfl.net package:

    ..
    dns
    DatagramSocket

    The DatagramSocket class enables code to send and receive Universal Datagram Protocol (UDP) packets.

    FileFilter

    The FileFilter class is used to indicate what files on the user's system are shown in the file-browsing dialog box that is displayed when the FileReference.browse() method, the FileReferenceList.browse() method is called or a browse method of a File, FileReference, or diff --git a/openfl/permissions/PermissionStatus.html b/openfl/permissions/PermissionStatus.html index 9a2ff2b..e9bd50c 100644 --- a/openfl/permissions/PermissionStatus.html +++ b/openfl/permissions/PermissionStatus.html @@ -1,7 +1,7 @@ -openfl.permissions.PermissionStatus - API Referenceopenfl.permissions.PermissionStatus - OpenFL API Reference

    View source

    enum abstract PermissionStatus(Null<Int>)

    package openfl.permissions

    @:enum

    Available on all platforms

    The PermissionStatus class is an enumeration of constant values that specify +

    View source

    enum abstract PermissionStatus(Null<Int>)

    package openfl.permissions

    @:enum

    Available on all platforms

    The PermissionStatus class is an enumeration of constant values that specify the authorization status of a permission.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyDENIED:PermissionStatus = 0

    Specifies that the permission has been denied.

    @:value(cast 1)@:impl@:enuminlineread onlyGRANTED:PermissionStatus = 1

    Specifies that the permission has been granted.

    @:value(cast 2)@:impl@:enuminlineread onlyONLY_WHEN_IN_USE:PermissionStatus = 2

    Specifies that the permission has been granted only when the app is in use.

    @:value(cast 3)@:impl@:enuminlineread onlyUNKNOWN:PermissionStatus = 3

    Specifies that the permission hasn't been requested yet.

    NOTE: On Android, permissionStatus will return UNKNOWN if permission was denied with "Never ask again" option checked.

    \ No newline at end of file diff --git a/openfl/permissions/index.html b/openfl/permissions/index.html index 5db0e20..25ad64d 100644 --- a/openfl/permissions/index.html +++ b/openfl/permissions/index.html @@ -1,7 +1,7 @@ -openfl.permissions - API Reference

    openfl.permissions

    -
    ..
    PermissionStatus

    The PermissionStatus class is an enumeration of constant values that specify +

    openfl.permissions

    ..
    PermissionStatus

    The PermissionStatus class is an enumeration of constant values that specify the authorization status of a permission.

    \ No newline at end of file diff --git a/openfl/printing/PrintJob.html b/openfl/printing/PrintJob.html index 408bb7a..86dcc47 100644 --- a/openfl/printing/PrintJob.html +++ b/openfl/printing/PrintJob.html @@ -1,7 +1,7 @@ -openfl.printing.PrintJob - API Referenceopenfl.printing.PrintJob - OpenFL API Reference
    API Reference
    View source

    class PrintJob

    package openfl.printing

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(lime.graphics.ImageBuffer)

    Available on all platforms

    The PrintJob class lets you create content and print it to one or more +

    View source

    class PrintJob

    package openfl.printing

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(lime.graphics.ImageBuffer)

    Available on all platforms

    The PrintJob class lets you create content and print it to one or more pages. This class lets you render content that is visible, dynamic or offscreen to the user, prompt users with a single Print dialog box, and print an unscaled document with proportions that map to the proportions of @@ -76,8 +76,8 @@ user's printer settings, such as page height, width, and image orientation, and you can configure your document to dynamically format Flash content that is appropriate for the printer settings.

    -

    Note: ActionScript 3.0 does not restrict a PrintJob object to a single -frame (as did previous versions of ActionScript). However, since the +

    Note: OpenFL does not restrict a PrintJob object to a single +frame (as did previous versions of ActionScript 2.0). However, since the operating system displays print status information to the user after the user has clicked the OK button in the Print dialog box, you should call PrintJob.addPage() and PrintJob.send() as soon as possible to send @@ -233,7 +233,7 @@ a value for options but want to specify a value for frameNumber, pass null for options.

    frameNum

    An optional number that lets you specify which frame of a MovieClip object to print. Passing a frameNum -does not invoke ActionScript on that frame. If you +does not invoke Haxe code on that frame. If you omit this parameter and the sprite parameter is a MovieClip object, the current frame in sprite is printed.

    Throws:

    Error

    Throws an exception if you haven't called start() or diff --git a/openfl/printing/PrintJobOptions.html b/openfl/printing/PrintJobOptions.html index 415195c..b729c49 100644 --- a/openfl/printing/PrintJobOptions.html +++ b/openfl/printing/PrintJobOptions.html @@ -1,7 +1,7 @@ -openfl.printing.PrintJobOptions - API Referenceopenfl.printing.PrintJobOptions - OpenFL API Reference

    View source

    class PrintJobOptions

    package openfl.printing

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The PrintJobOptions class contains properties to use with the options +

    View source

    class PrintJobOptions

    package openfl.printing

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The PrintJobOptions class contains properties to use with the options parameter of the PrintJob.addPage() method. For more information about addPage(), see the PrintJob class.

    Constructor

    @:value({ printAsBitmap : false })new(printAsBitmap:Bool = false)

    Creates a new PrintJobOptions object. Pass this object to the options parameter of the PrintJob.addPage() method.

    Parameters:

    printAsBitmap

    If true, this object is printed as a bitmap. If diff --git a/openfl/printing/PrintJobOrientation.html b/openfl/printing/PrintJobOrientation.html index fb10080..21c86ec 100644 --- a/openfl/printing/PrintJobOrientation.html +++ b/openfl/printing/PrintJobOrientation.html @@ -1,7 +1,7 @@ -openfl.printing.PrintJobOrientation - API Referenceopenfl.printing.PrintJobOrientation - OpenFL API Reference

    View source

    enum abstract PrintJobOrientation(Null<Int>)

    package openfl.printing

    @:enum

    Available on all platforms

    This class provides values that are used by the PrintJob.orientation +

    View source

    enum abstract PrintJobOrientation(Null<Int>)

    package openfl.printing

    @:enum

    Available on all platforms

    This class provides values that are used by the PrintJob.orientation property for the image position of a printed page.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyLANDSCAPE:PrintJobOrientation = 0

    The landscape (horizontal) image orientation for printing. This constant is used with the PrintJob.orientation property. Use the syntax PrintJobOrientation.LANDSCAPE.

    @:value(cast 1)@:impl@:enuminlineread onlyPORTRAIT:PrintJobOrientation = 1

    The portrait (vertical) image orientation for printing. This constant diff --git a/openfl/printing/index.html b/openfl/printing/index.html index bdc8471..94286be 100644 --- a/openfl/printing/index.html +++ b/openfl/printing/index.html @@ -1,7 +1,7 @@ -openfl.printing - API Reference

    openfl.printing

    -
    ..
    PrintJob

    The PrintJob class lets you create content and print it to one or more +

    openfl.printing

    ..
    PrintJob

    The PrintJob class lets you create content and print it to one or more pages. This class lets you render content that is visible, dynamic or offscreen to the user, prompt users with a single Print dialog box, and print an unscaled document with proportions that map to the proportions of diff --git a/openfl/profiler/Telemetry.html b/openfl/profiler/Telemetry.html index 069a29e..5c64154 100644 --- a/openfl/profiler/Telemetry.html +++ b/openfl/profiler/Telemetry.html @@ -1,7 +1,7 @@ -openfl.profiler.Telemetry - API Referenceopenfl.profiler.Telemetry - OpenFL API Reference

    View source

    final class Telemetry

    package openfl.profiler

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:allow(openfl.display.Stage)@:final

    Available on all platforms

    The Telemetry class lets an application profile ActionScript code and register handlers +

    View source

    final class Telemetry

    package openfl.profiler

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:allow(openfl.display.Stage)@:final

    Available on all platforms

    The Telemetry class lets an application profile Haxe code and register handlers for commands

    Static variables

    staticread onlyconnected:Bool

    Indicates whether Telemetry is connected to a server

    @:value(0.0)staticread onlyspanMarker:Float = 0.0

    Returns a marker for use with Telemetry.sendSpanMetric

    Static methods

    staticregisterCommandHandler(commandName:String, handler:Dynamic):Bool

    Register a function that can be called by issuing a command over a socket

    Returns true if the registration is successful. If registration fails, there is already a handler registered for the command used (or the command name starts with diff --git a/openfl/profiler/index.html b/openfl/profiler/index.html index d4c1e43..d5200df 100644 --- a/openfl/profiler/index.html +++ b/openfl/profiler/index.html @@ -1,7 +1,7 @@ -openfl.profiler - API Reference

    openfl.profiler

    -
    ..
    Telemetry

    The Telemetry class lets an application profile ActionScript code and register handlers +

    openfl.profiler

    ..
    Telemetry

    The Telemetry class lets an application profile Haxe code and register handlers for commands

    \ No newline at end of file diff --git a/openfl/security/CertificateStatus.html b/openfl/security/CertificateStatus.html index 44dab4f..4720ef4 100644 --- a/openfl/security/CertificateStatus.html +++ b/openfl/security/CertificateStatus.html @@ -1,7 +1,7 @@ -openfl.security.CertificateStatus - API Referenceopenfl.security.CertificateStatus - OpenFL API Reference
    View source

    enum abstract CertificateStatus(String)

    package openfl.security

    from String to String

    @:enum

    Available on all platforms

    The CertificateStatus class defines constants used to report the results of +

    View source

    enum abstract CertificateStatus(String)

    package openfl.security

    from String to String

    @:enum

    Available on all platforms

    The CertificateStatus class defines constants used to report the results of certificate validation processing by a SecureSocket object.

    See also:

    Variables

    @:value(cast "expired")@:impl@:enuminlineread onlyEXPIRED:CertificateStatus = "expired"

    The certificate is outside its valid period.

    Indicates that certificate validation processing was attempted, but failed because the validity period of the certificate is either before diff --git a/openfl/security/X500DistinguishedName.html b/openfl/security/X500DistinguishedName.html index fe7e9a9..41889b5 100644 --- a/openfl/security/X500DistinguishedName.html +++ b/openfl/security/X500DistinguishedName.html @@ -1,7 +1,7 @@ -openfl.security.X500DistinguishedName - API Referenceopenfl.security.X500DistinguishedName - OpenFL API Reference

    View source

    class X500DistinguishedName

    package openfl.security

    @:directlyUsed

    Available on all platforms

    The X500DistinguishedName class defines Distinguished Name (DN) properties +

    View source

    class X500DistinguishedName

    package openfl.security

    @:directlyUsed

    Available on all platforms

    The X500DistinguishedName class defines Distinguished Name (DN) properties for use in the X509Certificate class. The Distinguished Name protocol is specified in RFC1779.

    This class is useful for any code that needs to examine a server diff --git a/openfl/security/X509Certificate.html b/openfl/security/X509Certificate.html index aec1f22..3d1f01e 100644 --- a/openfl/security/X509Certificate.html +++ b/openfl/security/X509Certificate.html @@ -1,7 +1,7 @@ -openfl.security.X509Certificate - API Referenceopenfl.security.X509Certificate - OpenFL API Reference

    API Reference
    View source

    class X509Certificate

    package openfl.security

    @:directlyUsed

    Available on all platforms

    The X509Certificate class represents an X.509 certificate. This class +

    View source

    class X509Certificate

    package openfl.security

    @:directlyUsed

    Available on all platforms

    The X509Certificate class represents an X.509 certificate. This class defines X.509 properties specified in RFC2459. After you make a successful call to SecureSocket.connect(), the server's certificate data is stored as diff --git a/openfl/security/index.html b/openfl/security/index.html index b6de35c..e3a14af 100644 --- a/openfl/security/index.html +++ b/openfl/security/index.html @@ -1,7 +1,7 @@ -openfl.security - API Reference

    openfl.security

    -
    ..
    CertificateStatus

    The CertificateStatus class defines constants used to report the results of +

    openfl.security

    ..
    CertificateStatus

    The CertificateStatus class defines constants used to report the results of certificate validation processing by a SecureSocket object.

    X500DistinguishedName

    The X500DistinguishedName class defines Distinguished Name (DN) properties for use in the X509Certificate class. The Distinguished Name protocol is specified in RFC1779.

    X509Certificate

    The X509Certificate class represents an X.509 certificate. This class diff --git a/openfl/sensors/Accelerometer.html b/openfl/sensors/Accelerometer.html index 43b8f77..88924a1 100644 --- a/openfl/sensors/Accelerometer.html +++ b/openfl/sensors/Accelerometer.html @@ -1,7 +1,7 @@ -openfl.sensors.Accelerometer - API Referenceopenfl.sensors.Accelerometer - OpenFL API Reference

    API Reference
    View source

    class Accelerometer

    package openfl.sensors

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Accelerometer class dispatches events based on activity detected by the +

    View source

    class Accelerometer

    package openfl.sensors

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Accelerometer class dispatches events based on activity detected by the device's motion sensor. This data represents the device's location or movement along a 3-dimensional axis. When the device moves, the sensor detects this movement and returns acceleration data. The Accelerometer @@ -96,7 +96,7 @@ being idle).

    Static variables

    staticread onlyisSupported:Bool

    The isSupported property is set to true if the accelerometer sensor is available on the device, otherwise it is set to false.

    Constructor

    new()

    Creates a new Accelerometer instance.

    Variables

    muted:Bool

    Specifies whether the user has denied access to the accelerometer -(true) or allowed access(false). When this +(true) or allowed access (false). When this value changes, a status event is dispatched.

    Methods

    setRequestedUpdateInterval(interval:Int):Void

    The setRequestedUpdateInterval method is used to set the desired time interval for updates. The time interval is measured in milliseconds. The update interval is only used as a hint to conserve the diff --git a/openfl/sensors/DeviceRotation.html b/openfl/sensors/DeviceRotation.html index 4676b52..dcef79f 100644 --- a/openfl/sensors/DeviceRotation.html +++ b/openfl/sensors/DeviceRotation.html @@ -1,7 +1,7 @@ -openfl.sensors.DeviceRotation - API Referenceopenfl.sensors.DeviceRotation - OpenFL API Reference

    API Reference
    View source

    class DeviceRotation

    package openfl.sensors

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The DeviceRotation class dispatches events based on activity detected by the +

    View source

    class DeviceRotation

    package openfl.sensors

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The DeviceRotation class dispatches events based on activity detected by the device's accelerometer, gyroscope sensors. This data represents the device's roll, pitch, yaw and quaternions. When the device rotates, the sensors detect this rotation and return this data. The DeviceRotation class provides diff --git a/openfl/sensors/Geolocation.html b/openfl/sensors/Geolocation.html index 3ead6fb..e35156b 100644 --- a/openfl/sensors/Geolocation.html +++ b/openfl/sensors/Geolocation.html @@ -1,7 +1,7 @@ -openfl.sensors.Geolocation - API Referenceopenfl.sensors.Geolocation - OpenFL API Reference

    View source

    class Geolocation

    package openfl.sensors

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The Geolocation class dispatches events in response to the device's location +

    View source

    class Geolocation

    package openfl.sensors

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The Geolocation class dispatches events in response to the device's location sensor.

    If a device supports geolocation, you can use this class to obtain the current geographical location of the device. The geographical location is diff --git a/openfl/sensors/index.html b/openfl/sensors/index.html index fe99085..b3791a8 100644 --- a/openfl/sensors/index.html +++ b/openfl/sensors/index.html @@ -1,7 +1,7 @@ -openfl.sensors - API Reference

    openfl.sensors

    -
    ..
    Accelerometer

    The Accelerometer class dispatches events based on activity detected by the +

    openfl.sensors

    ..
    Accelerometer

    The Accelerometer class dispatches events based on activity detected by the device's motion sensor. This data represents the device's location or movement along a 3-dimensional axis. When the device moves, the sensor detects this movement and returns acceleration data. The Accelerometer diff --git a/openfl/system/ApplicationDomain.html b/openfl/system/ApplicationDomain.html index 1e9e3bf..9265482 100644 --- a/openfl/system/ApplicationDomain.html +++ b/openfl/system/ApplicationDomain.html @@ -1,7 +1,7 @@ -openfl.system.ApplicationDomain - API Referenceopenfl.system.ApplicationDomain - OpenFL API Reference

    API Reference
    View source

    final class ApplicationDomain

    package openfl.system

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The ApplicationDomain class is a container for discrete groups of class +

    View source

    final class ApplicationDomain

    package openfl.system

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The ApplicationDomain class is a container for discrete groups of class definitions. Application domains are used to partition classes that are in the same security domain. They allow multiple definitions of the same class to exist and allow children to reuse parent definitions. @@ -82,7 +82,7 @@ domain is the system domain. Loaded classes are defined only when their parent doesn't already define them. You cannot override a loaded class definition with a newer definition.

    -

    For usage examples of application domains, see the ActionScript 3.0 +

    For usage examples of application domains, see the OpenFL Developer's Guide.

    The ApplicationDomain() constructor function allows you to create an ApplicationDomain object.

    Static variables

    @:value(new ApplicationDomain(null))staticread onlycurrentDomain:ApplicationDomain = new ApplicationDomain(null)

    Gets the current application domain in which your code is executing.

    Constructor

    @:value({ parentDomain : null })new(?parentDomain:ApplicationDomain)

    Creates a new application domain.

    Parameters:

    parentDomain

    If no parent domain is passed in, this application diff --git a/openfl/system/Capabilities.html b/openfl/system/Capabilities.html index 3651fdf..320682e 100644 --- a/openfl/system/Capabilities.html +++ b/openfl/system/Capabilities.html @@ -1,7 +1,7 @@ -openfl.system.Capabilities - API Referenceopenfl.system.Capabilities - OpenFL API Reference

    API Reference
    View source

    final class Capabilities

    package openfl.system

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The Capabilities class provides properties that describe the system and +

    View source

    final class Capabilities

    package openfl.system

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The Capabilities class provides properties that describe the system and runtime that are hosting the application. For example, a mobile phone's screen might be 100 square pixels, black and white, whereas a PC screen might be 1000 square pixels, color. By using the Capabilities class to @@ -125,7 +125,7 @@ incompatibility with the web browser or to a user setting in the mms.cfg file. There is no corresponding Capabilities property.

    All properties of the Capabilities class are read-only.

    Static variables

    @:value(true)staticread onlyavHardwareDisable:Bool = true

    Specifies whether access to the user's camera and microphone has been -administratively prohibited(true) or allowed +administratively prohibited (true) or allowed (false). The server string is AVD.

    For content in Adobe AIR™, this property applies only to content in security sandboxes other than the application security sandbox. Content in @@ -133,39 +133,39 @@ microphone.

    staticread onlycpuArchitecture:String

    Specifies the current CPU architecture. The cpuArchitecture property can return the following strings: "PowerPC", "x86", "SPARC", and "ARM". The -server string is ARCH.

    @:value(false)staticread onlyhasAccessibility:Bool = false

    Specifies whether the system supports(true) or does not -support(false) communication with accessibility aids. The +server string is ARCH.

    @:value(false)staticread onlyhasAccessibility:Bool = false

    Specifies whether the system supports (true) or does not +support (false) communication with accessibility aids. The server string is ACC.

    @:value(true)staticread onlyhasAudio:Bool = true

    Specifies whether the system has audio capabilities. This property is -always true. The server string is A.

    @:value(false)staticread onlyhasAudioEncoder:Bool = false

    Specifies whether the system can(true) or cannot +always true. The server string is A.

    @:value(false)staticread onlyhasAudioEncoder:Bool = false

    Specifies whether the system can (true) or cannot (false) encode an audio stream, such as that coming from a -microphone. The server string is AE.

    @:value(false)staticread onlyhasEmbeddedVideo:Bool = false

    Specifies whether the system supports(true) or does not -support(false) embedded video. The server string is -EV.

    @:value(false)staticread onlyhasIME:Bool = false

    Specifies whether the system does(true) or does not -(false) have an input method editor(IME) installed. The -server string is IME.

    @:value(false)staticread onlyhasMP3:Bool = false

    Specifies whether the system does(true) or does not +microphone. The server string is AE.

    @:value(false)staticread onlyhasEmbeddedVideo:Bool = false

    Specifies whether the system supports (true) or does not +support (false) embedded video. The server string is +EV.

    @:value(false)staticread onlyhasIME:Bool = false

    Specifies whether the system does (true) or does not +(false) have an input method editor (IME) installed. The +server string is IME.

    @:value(false)staticread onlyhasMP3:Bool = false

    Specifies whether the system does (true) or does not (false) have an MP3 decoder. The server string is -MP3.

    @:value(false)staticread onlyhasPrinting:Bool = false

    Specifies whether the system does(true) or does not +MP3.

    @:value(false)staticread onlyhasPrinting:Bool = false

    Specifies whether the system does (true) or does not (false) support printing. The server string is -PR.

    @:value(false)staticread onlyhasScreenBroadcast:Bool = false

    Specifies whether the system does(true) or does not +PR.

    @:value(false)staticread onlyhasScreenBroadcast:Bool = false

    Specifies whether the system does (true) or does not (false) support the development of screen broadcast applications to be run through Flash Media Server. The server string is -SB.

    @:value(false)staticread onlyhasScreenPlayback:Bool = false

    Specifies whether the system does(true) or does not +SB.

    @:value(false)staticread onlyhasScreenPlayback:Bool = false

    Specifies whether the system does (true) or does not (false) support the playback of screen broadcast applications that are being run through Flash Media Server. The server string is -SP.

    @:value(false)staticread onlyhasStreamingAudio:Bool = false

    Specifies whether the system can(true) or cannot +SP.

    @:value(false)staticread onlyhasStreamingAudio:Bool = false

    Specifies whether the system can (true) or cannot (false) play streaming audio. The server string is -SA.

    @:value(false)staticread onlyhasStreamingVideo:Bool = false

    Specifies whether the system can(true) or cannot +SA.

    @:value(false)staticread onlyhasStreamingVideo:Bool = false

    Specifies whether the system can (true) or cannot (false) play streaming video. The server string is SV.

    @:value(true)staticread onlyhasTLS:Bool = true

    Specifies whether the system supports native SSL sockets through -NetConnection(true) or does not(false). The -server string is TLS.

    @:value(false)staticread onlyhasVideoEncoder:Bool = false

    Specifies whether the system can(true) or cannot +NetConnection (true) or does not (false). The +server string is TLS.

    @:value(false)staticread onlyhasVideoEncoder:Bool = false

    Specifies whether the system can (true) or cannot (false) encode a video stream, such as that coming from a web camera. The server string is VE.

    @:value(false)staticread onlyisDebugger:Bool = false

    Specifies whether the system is a special debugging version (true) or an officially released version (false). The server string is DEB. This property is set to true when running in the debug version of Flash Player or the AIR Debug Launcher(ADL).

    @:value(false)staticread onlyisEmbeddedInAcrobat:Bool = false

    Specifies whether the Flash runtime is embedded in a PDF file that is open -in Acrobat 9.0 or higher(true) or not(false).

    staticread onlylanguage:String

    Specifies the language code of the system on which the content is +in Acrobat 9.0 or higher (true) or not (false).

    staticread onlylanguage:String

    Specifies the language code of the system on which the content is running. The language is specified as a lowercase two-letter language code from ISO 639-1. For Chinese, an additional uppercase two-letter country code from ISO 3166 distinguishes between Simplified and @@ -182,12 +182,12 @@ Capabilities.languages array to determine the primary user interface language for the system.

    The server string is L.

    @:value(false)staticread onlylocalFileReadDisable:Bool = false

    Specifies whether read access to the user's hard disk has been -administratively prohibited(true) or allowed +administratively prohibited (true) or allowed (false). For content in Adobe AIR, this property applies only to content in security sandboxes other than the application security sandbox.(Content in the application security sandbox can always read from the file system.) If this property is true, Flash Player -cannot read files(including the first file that Flash Player launches +cannot read files (including the first file that Flash Player launches with) from the user's hard disk. If this property is true, AIR content outside of the application security sandbox cannot read files from the user's hard disk. For example, attempts to read a file on the @@ -223,7 +223,7 @@ operating systems. Instead, use the property corresponding to the capability for which you are testing. For more information, see the Capabilities class description.

    staticread onlypixelAspectRatio:Float

    Specifies the pixel aspect ratio of the screen. The server string is -AR.

    @:value("StandAlone")staticread onlyplayerType:String = "StandAlone"

    Specifies the type of runtime environment. This property can have one of +AR.

    @:value("Desktop")staticread onlyplayerType:String = "Desktop"

    Specifies the type of runtime environment. This property can have one of the following values:

    • "ActiveX" for the Flash Player ActiveX control used by Microsoft Internet Explorer
    • "Desktop" for the Adobe AIR runtime (except for SWF content loaded by an HTML page, which has diff --git a/openfl/system/ImageDecodingPolicy.html b/openfl/system/ImageDecodingPolicy.html index 5a8aa4e..ec78497 100644 --- a/openfl/system/ImageDecodingPolicy.html +++ b/openfl/system/ImageDecodingPolicy.html @@ -1,7 +1,7 @@ -openfl.system.ImageDecodingPolicy - API Referenceopenfl.system.ImageDecodingPolicy - OpenFL API Reference
      View source

      enum abstract ImageDecodingPolicy(Null<Int>)

      package openfl.system

      @:enum

      Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

      The ImageDecodingPolicy class provides values for imageDecodingPolicy in +

      View source

      enum abstract ImageDecodingPolicy(Null<Int>)

      package openfl.system

      @:enum

      Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

      The ImageDecodingPolicy class provides values for imageDecodingPolicy in the LoaderContext class.

      Variables

      @:value(cast 0)@:impl@:enuminlineread onlyON_DEMAND:ImageDecodingPolicy = 0

      Specifies that the image being loaded will be decoded when needed and that the decoded data may be flushed at will by the system. If flushed, it will be re-decoded as needed.

      @:value(cast 1)@:impl@:enuminlineread onlyON_LOAD:ImageDecodingPolicy = 1

      Specifies that the image being loaded will be decoded on load, prior to diff --git a/openfl/system/LoaderContext.html b/openfl/system/LoaderContext.html index 2fd1576..1d326b6 100644 --- a/openfl/system/LoaderContext.html +++ b/openfl/system/LoaderContext.html @@ -1,7 +1,7 @@ -openfl.system.LoaderContext - API Referenceopenfl.system.LoaderContext - OpenFL API Reference

      API Reference
      View source

      class LoaderContext

      package openfl.system

      @:fileXml("tags=\"haxe,release\"")@:noDebug

      Available on all platforms

      The LoaderContext class provides options for loading SWF files and other +

      View source

      class LoaderContext

      package openfl.system

      @:fileXml("tags=\"haxe,release\"")@:noDebug

      Available on all platforms

      The LoaderContext class provides options for loading SWF files and other media by using the Loader class. The LoaderContext class is used as the context parameter in the load() and loadBytes() methods of the Loader class. @@ -80,7 +80,7 @@ decision to make: do you need programmatic access to the pixels of the loaded image? If so, see the checkPolicyFile property. If you want to apply deblocking when loading an image, use the JPEGLoaderContext class -instead of the LoaderContext class.

      Constructor

      @:value({ securityDomain : null, applicationDomain : null, checkPolicyFile : false })new(checkPolicyFile:Bool = false, ?applicationDomain:ApplicationDomain, ?securityDomain:SecurityDomain)

      Creates a new LoaderContext object, with the specified settings. For +instead of the LoaderContext class.

      See also:

      Constructor

      @:value({ securityDomain : null, applicationDomain : null, checkPolicyFile : false })new(checkPolicyFile:Bool = false, ?applicationDomain:ApplicationDomain, ?securityDomain:SecurityDomain)

      Creates a new LoaderContext object, with the specified settings. For complete details on these settings, see the descriptions of the properties of this class.

      Parameters:

      checkPolicyFile

      Specifies whether a check should be made for the existence of a URL policy file before @@ -188,7 +188,7 @@ default way, it can find the loading SWF file's application domain by using ApplicationDomain.currentDomain.parentDomain.

      For more information, see the "ApplicationDomain class" section of the -"Client System Environment" chapter of the ActionScript 3.0 +"Client System Environment" chapter of the OpenFL Developer's Guide.

      checkPolicyFile:Bool

      Specifies whether the application should attempt to download a URL policy file from the loaded object's server before beginning to load the object itself. This flag is applicable to the Loader.load() @@ -285,5 +285,5 @@ domain results in a SecurityError exception.

      Content in the AIR application security sandbox cannot load content from other sandboxes into its SecurityDomain.

      -

      For more information, see the "Security" chapter in the ActionScript -3.0 Developer's Guide.

      \ No newline at end of file +

      For more information, see the "Security" chapter in the Haxe +Developer's Guide.

      \ No newline at end of file diff --git a/openfl/system/Security.html b/openfl/system/Security.html index 603de1e..74c9c61 100644 --- a/openfl/system/Security.html +++ b/openfl/system/Security.html @@ -1,7 +1,7 @@ -openfl.system.Security - API Referenceopenfl.system.Security - OpenFL API Reference
      View source

      class Security

      package openfl.system

      @:fileXml("tags=\"haxe,release\"")@:noDebug

      Available on all platforms

      The Security class lets you specify how content in different domains can +

      View source

      class Security

      package openfl.system

      @:fileXml("tags=\"haxe,release\"")@:noDebug

      Available on all platforms

      The Security class lets you specify how content in different domains can communicate with each other.

      Static variables

      @:value("localTrusted")staticinlineread onlyLOCAL_TRUSTED:String = "localTrusted"

      The file is a local file and has been trusted by the user, using either the Flash Player Settings Manager or a FlashPlayerTrust configuration file. The file can read from local data sources and @@ -436,8 +436,8 @@ master policy file is loaded, use loadPolicyFile() to call it explicitly.

      You cannot connect to commonly reserved ports. For a complete list of -blocked ports, see "Restricting Networking APIs" in the ActionScript -3.0 Developer's Guide.

      +blocked ports, see "Restricting Networking APIs" in the OpenFL +Developer's Guide.

      Using the xmlsocket protocol along with a specific port number lets you retrieve policy files directly from an XMLSocket server, as shown in the following example. Socket connections are not subject to the diff --git a/openfl/system/SecurityDomain.html b/openfl/system/SecurityDomain.html index 5a2dad4..00ac0df 100644 --- a/openfl/system/SecurityDomain.html +++ b/openfl/system/SecurityDomain.html @@ -1,7 +1,7 @@ -openfl.system.SecurityDomain - API Referenceopenfl.system.SecurityDomain - OpenFL API Reference

      View source

      class SecurityDomain

      package openfl.system

      @:fileXml("tags=\"haxe,release\"")@:noDebug@SuppressWarnings("checkstyle:UnnecessaryConstructor")

      Available on all platforms

      The SecurityDomain class represents the current security "sandbox," also +

      View source

      class SecurityDomain

      package openfl.system

      @:fileXml("tags=\"haxe,release\"")@:noDebug@SuppressWarnings("checkstyle:UnnecessaryConstructor")

      Available on all platforms

      The SecurityDomain class represents the current security "sandbox," also known as a security domain. By passing an instance of this class to Loader.load(), you can request that loaded media be placed in a particular sandbox.

      Static variables

      @:value(new SecurityDomain())staticread onlycurrentDomain:SecurityDomain = new SecurityDomain()

      Gets the current security domain.

      \ No newline at end of file diff --git a/openfl/system/System.html b/openfl/system/System.html index bb5f4b6..42dab3e 100644 --- a/openfl/system/System.html +++ b/openfl/system/System.html @@ -1,7 +1,7 @@ -openfl.system.System - API Referenceopenfl.system.System - OpenFL API Reference
      View source

      final class System

      package openfl.system

      @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

      Available on all platforms

      The System class contains properties related to local settings and +

      View source

      final class System

      package openfl.system

      @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

      Available on all platforms

      The System class contains properties related to local settings and operations. Among these are settings for camers and microphones, operations with shared objects and the use of the Clipboard.

      Additional properties and methods are in other classes within the openfl.system package: the Capabilities class, the IME class, and the Security class.

      This class contains only static methods and properties. You cannot -create new instances of the System class.

      Static variables

      staticread onlytotalMemory:Int

      The amount of memory(in bytes) currently in use that has been directly +create new instances of the System class.

      Static variables

      staticread onlytotalMemory:Int

      The amount of memory (in bytes) currently in use that has been directly allocated by Flash Player or AIR.

      This property does not return all memory used by an OpenFL application or by the application (such as a browser) containing Flash @@ -85,7 +85,7 @@ application that supports Unicode, such as Notepad on Windows.

      If you load external text files that are not Unicode-encoded, set useCodePage to true. Add the following as the -first line of code of the file that is loading the data(for Flash +first line of code of the file that is loading the data (for Flash Professional, add it to the first frame): System.useCodePage = true;

      When this code is present, the application interprets external text @@ -106,7 +106,7 @@

      To ensure that users on all platforms can view external text files used in your application, you should encode all external text files as Unicode and leave useCodePage set to false. This way, -the application(Flash Player 6 and later, or AIR) interprets the text as +the application (Flash Player 6 and later, or AIR) interprets the text as Unicode.

      Static methods

      staticexit(code:Int):Void

      Closes Flash Player.

      For the standalone Flash Player debugger version only.

      OpenFL applications on desktop operating systems should call the @@ -120,7 +120,7 @@ the debugger version of the runtime.

      In an AIR application, the System.gc() method is only enabled in content running in the AIR Debug Launcher (ADL) or, in an installed -application, in content in the application security sandbox.

      staticpause():Void

      Pauses Flash Player or the AIR Debug Launcher(ADL). After calling this +application, in content in the application security sandbox.

      staticpause():Void

      Pauses Flash Player or the AIR Debug Launcher (ADL). After calling this method, nothing in the application continues except the delivery of Socket events.

      For the Flash Player debugger version or the AIR Debug Launcher @@ -134,4 +134,4 @@

      Flash Player 10 content, content in the application security sandbox in an AIR application, and Haxe "sys" targets can call the Clipboard.setData() method.

      Parameters:

      string

      A plain-text string of characters to put on the system -Clipboard, replacing its current contents(if any).

      \ No newline at end of file +Clipboard, replacing its current contents (if any).

      \ No newline at end of file diff --git a/openfl/system/TouchscreenType.html b/openfl/system/TouchscreenType.html index 567da59..c599c6c 100644 --- a/openfl/system/TouchscreenType.html +++ b/openfl/system/TouchscreenType.html @@ -1,7 +1,7 @@ -openfl.system.TouchscreenType - API Referenceopenfl.system.TouchscreenType - OpenFL API Reference
      View source

      enum abstract TouchscreenType(Null<Int>)

      package openfl.system

      @:enum

      Available on all platforms

      The TouchscreenType class is an enumeration class that provides values for +

      View source

      enum abstract TouchscreenType(Null<Int>)

      package openfl.system

      @:enum

      Available on all platforms

      The TouchscreenType class is an enumeration class that provides values for the different types of touch screens. Use the values defined by the TouchscreenType class with the Capabilities.touchscreenType property.

      Variables

      @:value(cast 0)@:impl@:enuminlineread onlyFINGER:TouchscreenType = 0

      A touchscreen designed to respond to finger touches.

      @:value(cast 1)@:impl@:enuminlineread onlyNONE:TouchscreenType = 1

      The computer or device does not have a supported touchscreen.

      @:value(cast 2)@:impl@:enuminlineread onlySTYLUS:TouchscreenType = 2

      A touchscreen designed for use with a stylus.

      \ No newline at end of file diff --git a/openfl/system/index.html b/openfl/system/index.html index cfeeeaa..6661223 100644 --- a/openfl/system/index.html +++ b/openfl/system/index.html @@ -1,7 +1,7 @@ -openfl.system - API Reference

      openfl.system

      -
      ..
      ApplicationDomain

      The ApplicationDomain class is a container for discrete groups of class +

      openfl.system

      ..
      ApplicationDomain

      The ApplicationDomain class is a container for discrete groups of class definitions. Application domains are used to partition classes that are in the same security domain. They allow multiple definitions of the same class to exist and allow children to reuse parent definitions. diff --git a/openfl/text/AntiAliasType.html b/openfl/text/AntiAliasType.html index 655f783..a8f8fab 100644 --- a/openfl/text/AntiAliasType.html +++ b/openfl/text/AntiAliasType.html @@ -1,7 +1,7 @@ -openfl.text.AntiAliasType - API Referenceopenfl.text.AntiAliasType - OpenFL API Reference

      View source

      enum abstract AntiAliasType(Null<Int>)

      package openfl.text

      @:enum

      Available on all platforms

      The AntiAliasType class provides values for anti-aliasing in the +

      View source

      enum abstract AntiAliasType(Null<Int>)

      package openfl.text

      @:enum

      Available on all platforms

      The AntiAliasType class provides values for anti-aliasing in the openfl.text.TextField class.

      Variables

      @:value(cast 0)@:impl@:enuminlineread onlyADVANCED:AntiAliasType = 0

      Sets anti-aliasing to advanced anti-aliasing. Advanced anti-aliasing allows font faces to be rendered at very high quality at small sizes. It is best used with applications that have a lot of small text. Advanced -anti-aliasing is not recommended for very large fonts(larger than 48 +anti-aliasing is not recommended for very large fonts (larger than 48 points). This constant is used for the antiAliasType property in the TextField class. Use the syntax AntiAliasType.ADVANCED.

      @:value(cast 1)@:impl@:enuminlineread onlyNORMAL:AntiAliasType = 1

      Sets anti-aliasing to the anti-aliasing that is used in Flash Player 7 and diff --git a/openfl/text/AutoCapitalize.html b/openfl/text/AutoCapitalize.html index 651b889..5b28da3 100644 --- a/openfl/text/AutoCapitalize.html +++ b/openfl/text/AutoCapitalize.html @@ -1,7 +1,7 @@ -openfl.text.AutoCapitalize - API Referenceopenfl.text.AutoCapitalize - OpenFL API Reference

      View source

      enum abstract AutoCapitalize(Null<Int>)

      package openfl.text

      @:enum

      Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

      The AutoCapitalize class defines constants for the autoCapitalize property +

      View source

      enum abstract AutoCapitalize(Null<Int>)

      package openfl.text

      @:enum

      Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

      The AutoCapitalize class defines constants for the autoCapitalize property of the StageText class.

      See also:

      Variables

      @:value(cast 0)@:impl@:enuminlineread onlyALL:AutoCapitalize = 0

      Capitalize every character.

      @:value(cast 1)@:impl@:enuminlineread onlyNONE:AutoCapitalize = 1

      No automatic capitalization.

      @:value(cast 2)@:impl@:enuminlineread onlySENTENCE:AutoCapitalize = 2

      Capitalize the first word of every sentence.

      @:value(cast 3)@:impl@:enuminlineread onlyWORD:AutoCapitalize = 3

      Capitalize every word.

      \ No newline at end of file diff --git a/openfl/text/Font.html b/openfl/text/Font.html index 9f1a25a..673999d 100644 --- a/openfl/text/Font.html +++ b/openfl/text/Font.html @@ -1,7 +1,7 @@ -openfl.text.Font - API Referenceopenfl.text.Font - OpenFL API Reference
      API Reference
      View source

      class Font

      package openfl.text

      extends Font

      @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

      Available on all platforms

      The Font class is used to manage embedded fonts in SWF files. Embedded +

      View source

      class Font

      package openfl.text

      extends Font

      @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

      Available on all platforms

      The Font class is used to manage embedded fonts in SWF files. Embedded fonts are represented as a subclass of the Font class. The Font class is currently useful only to find out information about embedded fonts; you cannot alter a font by using this class. You cannot use the Font class to diff --git a/openfl/text/FontStyle.html b/openfl/text/FontStyle.html index 51110c4..f49f0e8 100644 --- a/openfl/text/FontStyle.html +++ b/openfl/text/FontStyle.html @@ -1,7 +1,7 @@ -openfl.text.FontStyle - API Reference

      View source

      enum abstract FontStyle(Null<Int>)

      package openfl.text

      @:enum

      Available on all platforms

      The FontStyle class provides values for the TextRenderer class.

      Variables

      @:value(cast 0)@:impl@:enuminlineread onlyBOLD:FontStyle = 0

      Defines the bold style of a font for the fontStyle parameter +

      View source

      enum abstract FontStyle(Null<Int>)

      package openfl.text

      @:enum

      Available on all platforms

      The FontStyle class provides values for the TextRenderer class.

      Variables

      @:value(cast 0)@:impl@:enuminlineread onlyBOLD:FontStyle = 0

      Defines the bold style of a font for the fontStyle parameter in the setAdvancedAntiAliasingTable() method. Use the syntax FontStyle.BOLD.

      @:value(cast 1)@:impl@:enuminlineread onlyBOLD_ITALIC:FontStyle = 1

      Defines the italic style of a font for the fontStyle parameter in the setAdvancedAntiAliasingTable() method. Use diff --git a/openfl/text/FontType.html b/openfl/text/FontType.html index 204e195..5fec2f5 100644 --- a/openfl/text/FontType.html +++ b/openfl/text/FontType.html @@ -1,7 +1,7 @@ -openfl.text.FontType - API Referenceopenfl.text.FontType - OpenFL API Reference

      View source

      enum abstract FontType(Null<Int>)

      package openfl.text

      @:enum

      Available on all platforms

      The FontType class contains the enumerated constants +

      View source

      enum abstract FontType(Null<Int>)

      package openfl.text

      @:enum

      Available on all platforms

      The FontType class contains the enumerated constants "embedded" and "device" for the fontType property of the Font class.

      Variables

      @:value(cast 0)@:impl@:enuminlineread onlyDEVICE:FontType = 0

      Indicates that this is a device font. The SWF file renders fonts with those installed on the system.

      diff --git a/openfl/text/GridFitType.html b/openfl/text/GridFitType.html index d0bfc1d..76b642a 100644 --- a/openfl/text/GridFitType.html +++ b/openfl/text/GridFitType.html @@ -1,7 +1,7 @@ -openfl.text.GridFitType - API Referenceopenfl.text.GridFitType - OpenFL API Reference
      View source

      enum abstract GridFitType(Null<Int>)

      package openfl.text

      @:enum

      Available on all platforms

      The GridFitType class defines values for grid fitting in the TextField +

      View source

      enum abstract GridFitType(Null<Int>)

      package openfl.text

      @:enum

      Available on all platforms

      The GridFitType class defines values for grid fitting in the TextField class.

      Variables

      @:value(cast 0)@:impl@:enuminlineread onlyNONE:GridFitType = 0

      Doesn't set grid fitting. Horizontal and vertical lines in the glyphs are not forced to the pixel grid. This constant is used in setting the gridFitType property of the TextField class. This is often a good diff --git a/openfl/text/ReturnKeyLabel.html b/openfl/text/ReturnKeyLabel.html index e0650ba..3b2ccfa 100644 --- a/openfl/text/ReturnKeyLabel.html +++ b/openfl/text/ReturnKeyLabel.html @@ -1,7 +1,7 @@ -openfl.text.ReturnKeyLabel - API Referenceopenfl.text.ReturnKeyLabel - OpenFL API Reference

      View source

      enum abstract ReturnKeyLabel(Null<Int>)

      package openfl.text

      @:enum

      Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

      The ReturnKeyLabel class defines the values to use for the returnKeyLabel +

      View source

      enum abstract ReturnKeyLabel(Null<Int>)

      package openfl.text

      @:enum

      Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

      The ReturnKeyLabel class defines the values to use for the returnKeyLabel property of the StageText class.

      See also:

      Variables

      @:value(cast 0)@:impl@:enuminlineread onlyDEFAULT:ReturnKeyLabel = 0

      Use the default label.

      @:value(cast 1)@:impl@:enuminlineread onlyDONE:ReturnKeyLabel = 1

      Use the label, "Done".

      @:value(cast 2)@:impl@:enuminlineread onlyGO:ReturnKeyLabel = 2

      Use the label, "Go".

      @:value(cast 3)@:impl@:enuminlineread onlyNEXT:ReturnKeyLabel = 3

      Use the label, "Next".

      @:value(cast 4)@:impl@:enuminlineread onlySEARCH:ReturnKeyLabel = 4

      Use the label, "Search".

      \ No newline at end of file diff --git a/openfl/text/SoftKeyboardType.html b/openfl/text/SoftKeyboardType.html index e42fec5..db138b0 100644 --- a/openfl/text/SoftKeyboardType.html +++ b/openfl/text/SoftKeyboardType.html @@ -1,7 +1,7 @@ -openfl.text.SoftKeyboardType - API Referenceopenfl.text.SoftKeyboardType - OpenFL API Reference
      View source

      enum abstract SoftKeyboardType(Null<Int>)

      package openfl.text

      @:enum

      Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

      The SoftKeyboardType class defines the types of soft keyboards for mobile +

      View source

      enum abstract SoftKeyboardType(Null<Int>)

      package openfl.text

      @:enum

      Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

      The SoftKeyboardType class defines the types of soft keyboards for mobile applications. You select the keyboard type with the softKeyboardType property on the text input control.

      See also:

      Variables

      @:value(cast 0)@:impl@:enuminlineread onlyCONTACT:SoftKeyboardType = 0

      A keypad designed for entering a person's name or phone number. This keyboard type does not support auto-capitalization.

      @:value(cast 1)@:impl@:enuminlineread onlyDECIMAL:SoftKeyboardType = 1

      A keyboard optimized for entering numbers along with a decimal.

      @:value(cast 2)@:impl@:enuminlineread onlyDEFAULT:SoftKeyboardType = 2

      Default keyboard for the current input method.

      @:value(cast 3)@:impl@:enuminlineread onlyEMAIL:SoftKeyboardType = 3

      A keyboard optimized for specifying email addresses. This type features diff --git a/openfl/text/StageText.html b/openfl/text/StageText.html index f0b4de1..788fee5 100644 --- a/openfl/text/StageText.html +++ b/openfl/text/StageText.html @@ -1,7 +1,7 @@ -openfl.text.StageText - API Referenceopenfl.text.StageText - OpenFL API Reference

      View source

      class StageText

      package openfl.text

      extends EventDispatcher

      @:fileXml("tags=\"haxe,release\"")@:noDebug

      Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

      The StageText class is used to present the user with a native text input +

      View source

      class StageText

      package openfl.text

      extends EventDispatcher

      @:fileXml("tags=\"haxe,release\"")@:noDebug

      Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

      The StageText class is used to present the user with a native text input field.

      This class enables mobile applications to gather user input using native text input controls on mobile devices. Input controls on mobile devices @@ -298,7 +298,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

      Weak references are supported on some OpenFL diff --git a/openfl/text/StageTextClearButtonMode.html b/openfl/text/StageTextClearButtonMode.html index c2a0247..e77504a 100644 --- a/openfl/text/StageTextClearButtonMode.html +++ b/openfl/text/StageTextClearButtonMode.html @@ -1,7 +1,7 @@ -openfl.text.StageTextClearButtonMode - API Referenceopenfl.text.StageTextClearButtonMode - OpenFL API Reference

      View source

      enum abstract StageTextClearButtonMode(Null<Int>)

      package openfl.text

      @:enum

      Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

      The StageTextClearButtonMode class defines the values to use for the +

      View source

      enum abstract StageTextClearButtonMode(Null<Int>)

      package openfl.text

      @:enum

      Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

      The StageTextClearButtonMode class defines the values to use for the clearButtonMode property of the StageText class.

      See also:

      Variables

      @:value(cast 0)@:impl@:enuminlineread onlyALWAYS:StageTextClearButtonMode = 0

      The StageText clear button is always shown.

      @:value(cast 1)@:impl@:enuminlineread onlyNEVER:StageTextClearButtonMode = 1

      The StageText clear button is never shown.

      @:value(cast 2)@:impl@:enuminlineread onlyUNLESS_EDITING:StageTextClearButtonMode = 2

      The StageText clear button is not visible while editing.

      @:value(cast 3)@:impl@:enuminlineread onlyWHILE_EDITING:StageTextClearButtonMode = 3

      The StageText clear button is visible while editing.

      \ No newline at end of file diff --git a/openfl/text/StageTextInitOptions.html b/openfl/text/StageTextInitOptions.html index 74c2898..309402d 100644 --- a/openfl/text/StageTextInitOptions.html +++ b/openfl/text/StageTextInitOptions.html @@ -1,7 +1,7 @@ -openfl.text.StageTextInitOptions - API Reference
      View source

      class StageTextInitOptions

      package openfl.text

      @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

      Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

      The StageTextInitOptions class defines the options available for initializing a StageText object.

      See also:

      • openfl.text.StageText

      Constructor

      @:value({ multiline : false })new(multiline:Bool = false)

      Creates a StageTextInitOptions object.

      Variables

      multiline:Bool

      Specifies whether the StageText object displays multiple lines of text.

      \ No newline at end of file +
      View source

      class StageTextInitOptions

      package openfl.text

      @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

      Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

      The StageTextInitOptions class defines the options available for initializing a StageText object.

      See also:

      • openfl.text.StageText

      Constructor

      @:value({ multiline : false })new(multiline:Bool = false)

      Creates a StageTextInitOptions object.

      Variables

      multiline:Bool

      Specifies whether the StageText object displays multiple lines of text.

      \ No newline at end of file diff --git a/openfl/text/StaticText.html b/openfl/text/StaticText.html index 22a5f7b..690e5d5 100644 --- a/openfl/text/StaticText.html +++ b/openfl/text/StaticText.html @@ -1,12 +1,12 @@ -openfl.text.StaticText - API Referenceopenfl.text.StaticText - OpenFL API Reference
      View source

      class StaticText

      package openfl.text

      extends DisplayObject › EventDispatcher

      @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Graphics)

      Available on all platforms

      This class represents StaticText objects on the display list. You cannot -create a StaticText object using ActionScript. Only the authoring tool can +

      View source

      class StaticText

      package openfl.text

      extends DisplayObject › EventDispatcher

      @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Graphics)

      Available on all platforms

      This class represents StaticText objects on the display list. You cannot +create a StaticText object using Haxe code. Only the authoring tool can create a StaticText object. An attempt to create a new StaticText object generates an ArgumentError. -To create a reference to an existing static text field in ActionScript -3.0, you can iterate over the items in the display list. For example, the +To create a reference to an existing static text field in Haxe code, +you can iterate over the items in the display list. For example, the following snippet checks to see if the display list contains a static text field and assigns the field to a variable:

      for (i in 0...numChildren) {
@@ -74,12 +74,12 @@
 		var myFieldLabel:StaticText = cast displayitem;
 		trace("and contains the text: " + myFieldLabel.text);
 	}
-}

      Variables

      read onlytext:String

      Returns the current text of the static text field. The authoring tool +}

      See also:

      Variables

      read onlytext:String

      Returns the current text of the static text field. The authoring tool may export multiple text field objects comprising the complete text. For example, for vertical text, the authoring tool will create one text field per character.

      Inherited Variables

      Defined by DisplayObject

      @:keepalpha:Float

      Indicates the alpha transparency value of the object specified. Valid values are 0 (fully transparent) to 1 (fully opaque). The default value is 1. -Display objects with alpha set to 0 are active, even though they are invisible.

      blendMode:BlendMode

      A value from the BlendMode class that specifies which blend mode to use. A +Display objects with alpha set to 0 are active, even though they are invisible.

      See also:

      blendMode:BlendMode

      A value from the BlendMode class that specifies which blend mode to use. A bitmap can be drawn internally in two ways. If you have a blend mode enabled or an external clipping mask, the bitmap is drawn by adding a bitmap-filled square shape to the vector render. If you attempt to set @@ -99,7 +99,7 @@ BlendMode class defines string values you can use. The illustrations in the table show blendMode values applied to a circular display object(2) superimposed on another display object(1).

      -

      Square Number 1 Circle Number 2

      BlendMode ConstantIllustrationDescription
      BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
      BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
      BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
      For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
      BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
      BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
      For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
      BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
      For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
      BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
      For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
      BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
      For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
      BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
      For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
      BlendMode.INVERTblend mode INVERTInverts the background.
      BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
      BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
      BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
      BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
      BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

      cacheAsBitmap:Bool

      All vector data for a display object that has a cached bitmap is drawn +

      Square Number 1 Circle Number 2

      BlendMode ConstantIllustrationDescription
      BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
      BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
      BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
      For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
      BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
      BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
      For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
      BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
      For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
      BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
      For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
      BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
      For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
      BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
      For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
      BlendMode.INVERTblend mode INVERTInverts the background.
      BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
      BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
      BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
      BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
      BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

      See also:

      cacheAsBitmap:Bool

      All vector data for a display object that has a cached bitmap is drawn to the bitmap instead of the main display. If cacheAsBitmapMatrix is null or unsupported, the bitmap is then copied to the main display as unstretched, unrotated pixels snapped @@ -130,12 +130,12 @@ number of pixels cannot exceed 16,777,215 pixels.(So, if a bitmap image is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is is 2880 pixels in height and 2,880 pixels -in width.

    • The bitmap fails to allocate(out of memory error).
      • +in width.
    • The bitmap fails to allocate (out of memory error).

      • The cacheAsBitmap property is best used with movie clips that have mostly static content and that do not scale and rotate frequently. With such movie clips, cacheAsBitmap can lead to -performance increases when the movie clip is translated(when its x -and y position is changed).

      cacheAsBitmapMatrix:Matrix

      If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to +performance increases when the movie clip is translated (when its x +and y position is changed).

      See also:

      cacheAsBitmapMatrix:Matrix

      If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. The application uses this matrix as a transformation matrix that is applied when rendering the bitmap version of the display object.

      Adobe AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop @@ -169,16 +169,16 @@

      Note: The cacheAsBitmapMatrix property is suitable for 2D transformations. If you need to apply transformations in 3D, you may do so by setting a 3D property of the object and manipulating its transform.matrix3D property. If the application is packaged using GPU mode, this allows the 3D transforms -to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

      filters:Array<BitmapFilter>

      An indexed array that contains each filter object currently associated +to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

      See also:

      filters:Array<BitmapFilter>

      An indexed array that contains each filter object currently associated with the display object. The openfl.filters package contains several classes that define specific filters you can use.

      Filters can be applied in Flash Professional at design time, or at run -time by using ActionScript code. To apply a filter by using ActionScript, +time by using Haxe code. To apply a filter by using Haxe, you must make a temporary copy of the entire filters array, modify the temporary array, then assign the value of the temporary array back to the filters array. You cannot directly add a new filter object to the filters array.

      -

      To add a filter by using ActionScript, perform the following steps +

      To add a filter by using Haxe, perform the following steps (assume that the target display object is named myDisplayObject):

      1. Create a new filter object by using the constructor method of your chosen filter class.
      2. Assign the value of the myDisplayObject.filters array @@ -209,7 +209,7 @@

        The openfl.filters package includes classes for filters. For example, to create a DropShadow filter, you would write:

        Throws:

        ArgumentError

        When filters includes a ShaderFilter and the shader output type is not compatible with -this operation(the shader must specify a +this operation (the shader must specify a pixel4 output).

        ArgumentError

        When filters includes a ShaderFilter and the shader doesn't specify any image input or the first input is not an image4 input.

        ArgumentError

        When filters includes a ShaderFilter @@ -227,10 +227,10 @@ is adjusted accordingly, as shown in the following code:

        Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a height of 0, even if you try to -set height to a different value.

        read onlyloaderInfo:LoaderInfo

        Returns a LoaderInfo object containing information about loading the file +set height to a different value.

        See also:

        read onlyloaderInfo:LoaderInfo

        Returns a LoaderInfo object containing information about loading the file to which this display object belongs. The loaderInfo property is defined only for the root display object of a SWF file or for a loaded -Bitmap(not for a Bitmap that is drawn with ActionScript). To find the +Bitmap (not for a Bitmap that is drawn with Haxe). To find the loaderInfo object associated with the SWF file that contains a display object named myDisplayObject, use myDisplayObject.root.loaderInfo.

        @@ -242,7 +242,7 @@ list. The mask object itself is not drawn. Set mask to null to remove the mask.

        To be able to scale a mask object, it must be on the display list. To -be able to drag a mask Sprite object(by calling its +be able to drag a mask Sprite object (by calling its startDrag() method), it must be on the display list. To call the startDrag() method for a mask sprite based on a mouseDown event being dispatched by the sprite, set the @@ -261,23 +261,23 @@ more than one calling display object. When the mask is assigned to a second display object, it is removed as the mask of the first object, and that object's mask property becomes -null.

        read onlymouseX:Float

        Indicates the x coordinate of the mouse or user input device position, in +null.

        See also:

        read onlymouseX:Float

        Indicates the x coordinate of the mouse or user input device position, in pixels.

        Note: For a DisplayObject that has been rotated, the returned x -coordinate will reflect the non-rotated object.

        read onlymouseY:Float

        Indicates the y coordinate of the mouse or user input device position, in +coordinate will reflect the non-rotated object.

        See also:

        read onlymouseY:Float

        Indicates the y coordinate of the mouse or user input device position, in pixels.

        Note: For a DisplayObject that has been rotated, the returned y -coordinate will reflect the non-rotated object.

        name:String

        Indicates the instance name of the DisplayObject. The object can be +coordinate will reflect the non-rotated object.

        See also:

        name:String

        Indicates the instance name of the DisplayObject. The object can be identified in the child list of its parent display object container by calling the getChildByName() method of the display object container.

        Throws:

        IllegalOperationError

        If you are attempting to set this property on an object that was placed on the timeline in the Flash authoring tool.

        opaqueBackground:Null<Int>

        Specifies whether the display object is opaque with a certain background color. A transparent bitmap contains alpha channel data and is drawn -transparently. An opaque bitmap has no alpha channel(and renders faster +transparently. An opaque bitmap has no alpha channel (and renders faster than a transparent bitmap). If the bitmap is opaque, you specify its own background color to use.

        -

        If set to a number value, the surface is opaque(not transparent) with +

        If set to a number value, the surface is opaque (not transparent) with the RGB background color that the number specifies. If set to null(the default value), the display object has a transparent background.

        @@ -289,7 +289,7 @@

        The opaque background region is not matched when calling the hitTestPoint() method with the shapeFlag parameter set to true.

        -

        The opaque background region does not respond to mouse events.

        read onlyparent:DisplayObjectContainer

        Indicates the DisplayObjectContainer object that contains this display +

        The opaque background region does not respond to mouse events.

        See also:

        read onlyparent:DisplayObjectContainer

        Indicates the DisplayObjectContainer object that contains this display object. Use the parent property to specify a relative path to display objects that are above the current display object in the display list hierarchy.

        @@ -298,7 +298,7 @@ 
        this.parent.parent.alpha = 20;

        Throws:

        SecurityError

        The parent display object belongs to a security sandbox to which you do not have access. You can avoid this situation by having the parent movie call -the Security.allowDomain() method.

        read onlyroot:DisplayObject

        For a display object in a loaded SWF file, the root property +the Security.allowDomain() method.

        See also:

      read onlyroot:DisplayObject

      For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. For a Bitmap object representing a loaded image file, the root property is the Bitmap object @@ -311,7 +311,7 @@ is a child of the top-most display object in a loaded SWF file.

      For example, if you create a new Sprite object by calling the Sprite() constructor method, its root property -is null until you add it to the display list(or to a display +is null until you add it to the display list (or to a display object container that is off the display list but that is a child of the top-most display object in a SWF file).

      For a loaded SWF file, even though the Loader object used to load the @@ -319,12 +319,12 @@ SWF file has its root property set to itself. The Loader object does not have its root property set until it is added as a child of a display object for which the root property is -set.

      @:keeprotation:Float

      Indicates the rotation of the DisplayObject instance, in degrees, from its +set.

      See also:

      @:keeprotation:Float

      Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement my_video.rotation = 450 -is the same as my_video.rotation = 90.

      scale9Grid:Rectangle

      The current scaling grid that is in effect. If set to null, +is the same as my_video.rotation = 90.

      See also:

      scale9Grid:Rectangle

      The current scaling grid that is in effect. If set to null, the entire display object is scaled normally when any scale transformation is applied.

      When you define the scale9Grid property, the display @@ -352,11 +352,11 @@ the registration point. The default registration point is (0,0). 1.0 equals 100% scale.

      Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

      @:keepscaleY:Float

      Indicates the vertical scale (percentage) of an object as applied from the +y property values, which are defined in whole pixels.

      See also:

      @:keepscaleY:Float

      Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. The default registration point is (0,0). 1.0 is 100% scale.

      Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

      scrollRect:Rectangle

      The scroll rectangle bounds of the display object. The display object is +y property values, which are defined in whole pixels.

      See also:

      scrollRect:Rectangle

      The scroll rectangle bounds of the display object. The display object is cropped to the size defined by the rectangle, and it scrolls within the rectangle when you change the x and y properties of the scrollRect object.

      @@ -373,17 +373,17 @@ an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated 90° and you scroll it left and right, the display object actually scrolls -up and down.

      @:betashader:Shader

      BETA**

      +up and down.

      See also:

      @:betashader:Shader

      BETA**

      Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to apply a post-process effect to multiple display objects at once, enable cacheAsBitmap or use the filters property with a ShaderFilter

      read onlystage:Stage

      The Stage of the display object. A Flash runtime application has only one Stage object. For example, you can create and load multiple display objects into the display list, and the stage property of each -display object refers to the same Stage object(even if the display object +display object refers to the same Stage object (even if the display object belongs to a loaded SWF file).

      If a display object is not added to the display list, its -stage property is set to null.

      @:keeptransform:Transform

      An object with properties pertaining to a display object's matrix, color +stage property is set to null.

      See also:

      @:keeptransform:Transform

      An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. The specific properties - matrix, colorTransform, and three read-only properties (concatenatedMatrix, concatenatedColorTransform, @@ -420,21 +420,21 @@ is adjusted accordingly, as shown in the following code:

      Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a width of 0, even if you try to set -width to a different value.

      @:keepx:Float

      Indicates the x coordinate of the DisplayObject instance relative +width to a different value.

      See also:

      @:keepx:Float

      Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

      @:keepy:Float

      Indicates the y coordinate of the DisplayObject instance relative +registration point position.

      See also:

      @:keepy:Float

      Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

      Inherited Methods

      Defined by DisplayObject

      getBounds(targetCoordinateSpace:DisplayObject):Rectangle

      Returns a rectangle that defines the area of the display object relative +registration point position.

      See also:

      Inherited Methods

      Defined by DisplayObject

      getBounds(targetCoordinateSpace:DisplayObject):Rectangle

      Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. Consider the following code, which shows how the rectangle returned can vary depending on the targetCoordinateSpace parameter that @@ -461,8 +461,8 @@ coordinates, respectively.

      Parameters:

      targetCoordinateSpace

      The display object that defines the coordinate system to use.

      Returns:

      The rectangle that defines the area of the display object relative to the targetCoordinateSpace object's coordinate -system.

      globalToLocal(pos:Point):Point

      Converts the point object from the Stage(global) coordinates -to the display object's(local) coordinates.

      +system.

      globalToLocal(pos:Point):Point

      Converts the point object from the Stage (global) coordinates +to the display object's (local) coordinates.

      To use this method, first create an instance of the Point class. The x and y values that you assign represent global coordinates because they relate to the origin(0,0) of the main display area. Then @@ -477,17 +477,17 @@ point specified by the x and y parameters. The x and y parameters specify a point in the coordinate space of the Stage, not the display object container that -contains the display object(unless that display object container is the +contains the display object (unless that display object container is the Stage).

      Parameters:

      x

      The x coordinate to test against this object.

      y

      The y coordinate to test against this object.

      shapeFlag

      Whether to check against the actual pixels of the object (true) or the bounding box (false).

      Returns:

      true if the display object overlaps or intersects with the specified point; false otherwise.

      invalidate():Void

      Calling the invalidate() method signals to have the current object -redrawn the next time the object is eligible to be rendered.

      localToGlobal(point:Point):Point

      Converts the point object from the display object's(local) -coordinates to the Stage(global) coordinates.

      +redrawn the next time the object is eligible to be rendered.

      localToGlobal(point:Point):Point

      Converts the point object from the display object's (local) +coordinates to the Stage (global) coordinates.

      This method allows you to convert any given x and y coordinates from values that are relative to the origin(0,0) of a -specific display object(local coordinates) to values that are relative to -the origin of the Stage(global coordinates).

      +specific display object (local coordinates) to values that are relative to +the origin of the Stage (global coordinates).

      To use this method, first create an instance of the Point class. The x and y values that you assign represent local coordinates because they relate to the origin of the display object.

      diff --git a/openfl/text/StyleSheet.html b/openfl/text/StyleSheet.html index 3a9edc2..108df29 100644 --- a/openfl/text/StyleSheet.html +++ b/openfl/text/StyleSheet.html @@ -1,7 +1,7 @@ -openfl.text.StyleSheet - API Referenceopenfl.text.StyleSheet - OpenFL API Reference
      API Reference
      View source

      class StyleSheet

      package openfl.text

      extends EventDispatcher

      Available on all platforms

      The StyleSheet class lets you create a StyleSheet object that contains text formatting rules +

      View source

      class StyleSheet

      package openfl.text

      extends EventDispatcher

      Available on all platforms

      The StyleSheet class lets you create a StyleSheet object that contains text formatting rules for font size, color, and other styles. You can then apply styles defined by a style sheet to a TextField object that contains HTML- or XML-formatted text. The text in the TextField object is automatically formatted according to the tag styles defined by the StyleSheet object. You @@ -74,7 +74,7 @@ supported Cascading Style Sheet (CSS) properties and values, as well as their corresponding Haxe property names. (Each Haxe property name is derived from the corresponding CSS property name; if the name contains a hyphen, the hyphen is omitted and the subsequent -character is capitalized.)

      CSS propertyHaxe propertyUsage and supported values
      colorcolorOnly hexadecimal color values are supported. Named colors (such as blue) are not supported. Colors are written in the following format: #FF0000.
      displaydisplaySupported values are inline, block, and none.
      font-familyfontFamilyA comma-separated list of fonts to use, in descending order of desirability. Any font family name can be used. If you specify a generic font name, it is converted to an appropriate device font. The following font conversions are available: mono is converted to _typewriter, sans-serif is converted to _sans, and serif is converted to _serif.
      font-sizefontSizeOnly the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points are equivalent.
      font-stylefontStyleRecognized values are normal and italic.
      font-weightfontWeightRecognized values are normal and bold.
      kerningkerningRecognized values are true and false. Kerning is supported for embedded fonts only. Certain fonts, such as Courier New, do not support kerning. The kerning property is only supported in SWF files created in Windows, not in SWF files created on the Macintosh. However, these SWF files can be played in non-Windows versions of Flash Player and the kerning still applies.
      leadingleadingThe amount of space that is uniformly distributed between lines. The value specifies the number of pixels that are added after each line. A negative value condenses the space between lines. Only the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points are equivalent.
      letter-spacingletterSpacingThe amount of space that is uniformly distributed between characters. The value specifies the number of pixels that are added after each character. A negative value condenses the space between characters. Only the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points are equivalent.
      margin-leftmarginLeftOnly the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points are equivalent.
      text-aligntextAlignRecognized values are left, center, right, and justify.
      text-decorationtextDecorationRecognized values are none and underline.
      text-indenttextIndentOnly the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points are equivalent.

      Constructor

      new()

      Creates a new StyleSheet object.

      Variables

      read onlystyleNames:Array<String>

      An array that contains the names (as strings) of all of the styles registered in this style sheet.

      Methods

      clear():Void

      Removes all styles from the style sheet object.

      getStyle(styleName:String):Object

      Returns a copy of the style object associated with the style named styleName. +character is capitalized.)

      CSS propertyHaxe propertyUsage and supported values
      colorcolorOnly hexadecimal color values are supported. Named colors (such as blue) are not supported. Colors are written in the following format: #FF0000.
      displaydisplaySupported values are inline, block, and none.
      font-familyfontFamilyA comma-separated list of fonts to use, in descending order of desirability. Any font family name can be used. If you specify a generic font name, it is converted to an appropriate device font. The following font conversions are available: mono is converted to _typewriter, sans-serif is converted to _sans, and serif is converted to _serif.
      font-sizefontSizeOnly the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points are equivalent.
      font-stylefontStyleRecognized values are normal and italic.
      font-weightfontWeightRecognized values are normal and bold.
      kerningkerningRecognized values are true and false. Kerning is supported for embedded fonts only. Certain fonts, such as Courier New, do not support kerning. The kerning property is only supported in SWF files created in Windows, not in SWF files created on the Macintosh. However, these SWF files can be played in non-Windows versions of Flash Player and the kerning still applies.
      leadingleadingThe amount of space that is uniformly distributed between lines. The value specifies the number of pixels that are added after each line. A negative value condenses the space between lines. Only the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points are equivalent.
      letter-spacingletterSpacingThe amount of space that is uniformly distributed between characters. The value specifies the number of pixels that are added after each character. A negative value condenses the space between characters. Only the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points are equivalent.
      margin-leftmarginLeftOnly the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points are equivalent.
      text-aligntextAlignRecognized values are left, center, right, and justify.
      text-decorationtextDecorationRecognized values are none and underline.
      text-indenttextIndentOnly the numeric part of the value is used. Units (px, pt) are not parsed; pixels and points are equivalent.

      See also:

      Constructor

      new()

      Creates a new StyleSheet object.

      Variables

      read onlystyleNames:Array<String>

      An array that contains the names (as strings) of all of the styles registered in this style sheet.

      Methods

      clear():Void

      Removes all styles from the style sheet object.

      getStyle(styleName:String):Object

      Returns a copy of the style object associated with the style named styleName. If there is no style object associated with styleName, null is returned.

      Parameters:

      styleName

      A string that specifies the name of the style to retrieve.

      Returns:

      An object.

      parseCSS(CSSText:String):Void

      Parses the CSS in CSSText and loads the style sheet with it. If a style in CSSText is already in styleSheet, the properties in styleSheet are retained, and only the ones in CSSText are added or changed in styleSheet.

      @@ -159,7 +159,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

      Weak references are supported on some OpenFL diff --git a/openfl/text/TextField.html b/openfl/text/TextField.html index f3b55b6..63efaf8 100644 --- a/openfl/text/TextField.html +++ b/openfl/text/TextField.html @@ -1,13 +1,13 @@ -openfl.text.TextField - API Referenceopenfl.text.TextField - OpenFL API Reference

      View source

      class TextField

      package openfl.text

      extends InteractiveObject › DisplayObject › EventDispatcher

      extended by FPS

      @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Graphics)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)@:access(openfl.text._internal.TextEngine)@:access(openfl.text.TextFormat)

      Available on all platforms

      The TextField class is used to create display objects for text display and +

      View source

      class TextField

      package openfl.text

      extends InteractiveObject › DisplayObject › EventDispatcher

      extended by FPS

      @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Graphics)@:access(openfl.errors.Error)@:access(openfl.geom.ColorTransform)@:access(openfl.geom.Matrix)@:access(openfl.geom.Rectangle)@:access(openfl.text._internal.TextEngine)@:access(openfl.text.TextFormat)

      Available on all platforms

      The TextField class is used to create display objects for text display and input. You can use the TextField class to perform low-level text rendering. However, in Flex, you typically use the Label, Text, TextArea, and TextInput controls to process text. <ph outputclass="flashonly">You can give a text field an instance name in the Property inspector and use the methods and properties of the TextField -class to manipulate it with ActionScript. TextField instance names are +class to manipulate it with Haxe code. TextField instance names are displayed in the Movie Explorer and in the Insert Target Path dialog box in the Actions panel.

      To create a text field dynamically, use the TextField() @@ -74,14 +74,14 @@

      The methods of the TextField class let you set, select, and manipulate text in a dynamic or input text field that you create during authoring or at runtime.

      -

      ActionScript provides several ways to format your text at runtime. The +

      OpenFL provides several ways to format your text at runtime. The TextFormat class lets you set character and paragraph formatting for -TextField objects. You can apply Cascading Style Sheets(CSS) styles to +TextField objects. You can apply Cascading Style Sheets (CSS) styles to text fields by using the TextField.styleSheet property and the StyleSheet class. You can use CSS to style built-in HTML tags, define new formatting tags, or apply styles. You can assign HTML formatted text, which optionally uses CSS styles, directly to a text field. HTML text that you -assign to a text field can contain embedded media(movie clips, SWF files, +assign to a text field can contain embedded media (movie clips, SWF files, GIF files, PNG files, and JPEG files). The text wraps around the embedded media in the same way that a web browser wraps text around media embedded in an HTML document.

      @@ -94,7 +94,7 @@ Unlike the W3C DOM Event Model version of the change event, which dispatches the event only after the -control loses focus, the ActionScript 3.0 +control loses focus, the OpenFL version of the change event is dispatched any time the control changes. For example, if a user types text @@ -125,13 +125,13 @@ mode of a text field. for example on Android, one can toggle from NORMAL mode to SELECTION mode using context menu -options

      Constructor

      new()

      Creates a new TextField instance. After you create the TextField instance, +options

      See also:

      Constructor

      new()

      Creates a new TextField instance. After you create the TextField instance, call the addChild() or addChildAt() method of the parent DisplayObjectContainer object to add the TextField instance to the display list.

      The default size for a text field is 100 x 100 pixels.

      Variables

      antiAliasType:AntiAliasType

      The type of anti-aliasing used for this text field. Use openfl.text.AntiAliasType constants for this property. You can -control this setting only if the font is embedded(with the +control this setting only if the font is embedded (with the embedFonts property set to true). The default setting is openfl.text.AntiAliasType.NORMAL.

      To set values for this property, use the following string values:

      autoSize:TextFieldAutoSize

      Controls automatic sizing and alignment of text fields. Acceptable values @@ -153,7 +153,7 @@ TextFieldAutoSize.RIGHT, the text is treated as right-justified text, meaning that the right margin of the text field remains fixed and any resizing of a single line of the text field is on -the left margin. If the text includes a line break(for example, +the left margin. If the text includes a line break (for example, "\n" or "\r"), the bottom is also resized to fit the next line of text. If wordWrap is also set to true, only the bottom of the text field is resized and the left side remains @@ -162,7 +162,7 @@ TextFieldAutoSize.CENTER, the text is treated as center-justified text, meaning that any resizing of a single line of the text field is equally distributed to both the right and left margins. If -the text includes a line break(for example, "\n" or +the text includes a line break (for example, "\n" or "\r"), the bottom is also resized to fit the next line of text. If wordWrap is also set to true, only the bottom of the text field is resized and the left and right sides remain @@ -185,9 +185,9 @@ a window onto a block of text. The scrollV property is the 1-based index of the topmost visible line in the window.

      All the text between the lines indicated by scrollV and -bottomScrollV is currently visible in the text field.

      read onlycaretIndex:Int

      The index of the insertion point(caret) position. If no insertion point +bottomScrollV is currently visible in the text field.

      read onlycaretIndex:Int

      The index of the insertion point (caret) position. If no insertion point is displayed, the value is the position the insertion point would be if -you restored focus to the field(typically where the insertion point last +you restored focus to the field (typically where the insertion point last was, or 0 if the field has not had focus).

      Selection span indexes are zero-based(for example, the first position is 0, the second position is 1, and so on).

      @:value(false)condenseWhite:Bool = false

      A Boolean value that specifies whether extra white space (spaces, line @@ -216,7 +216,7 @@ is null.

      Note: You can't set this property if a style sheet is applied to the text field.

      Throws:

      Error

      This method cannot be used on a text field with a style -sheet.

      displayAsPassword:Bool

      Specifies whether the text field is a password text field. If the value of +sheet.

    See also:

    displayAsPassword:Bool

    Specifies whether the text field is a password text field. If the value of this property is true, the text field is treated as a password text field and hides the input characters using asterisks instead of the actual characters. If false, the text field is not @@ -230,7 +230,7 @@ for a text field, you must specify a font for that text by using the font property of a TextFormat object applied to the text field. If the specified font is not embedded in the SWF file, the text is -not displayed.

    gridFitType:GridFitType

    The type of grid fitting used for this text field. This property +not displayed.

    See also:

    gridFitType:GridFitType

    The type of grid fitting used for this text field. This property applies only if the openfl.text.AntiAliasType property of the text field is set to openfl.text.AntiAliasType.ADVANCED. The type of grid fitting used determines whether Flash Player forces @@ -238,7 +238,7 @@ grid, or not at all.

    For the openfl.text.GridFitType property, you can use the following string values:

    String valueDescription
    openfl.text.GridFitType.NONESpecifies no grid fitting. Horizontal and vertical lines in the glyphs are not forced to the pixel grid. This setting is recommended for animation or for large font sizes.
    openfl.text.GridFitType.PIXELSpecifies that strong horizontal and vertical lines are fit to the pixel grid. This setting works only for left-aligned text fields. To use this setting, the openfl.dispaly.AntiAliasType property of the text field must be set to openfl.text.AntiAliasType.ADVANCED. This setting generally provides the best legibility for left-aligned text.
    openfl.text.GridFitType.SUBPIXELSpecifies that strong horizontal and vertical lines are fit to the subpixel grid on an LCD monitor. To use this setting, the openfl.text.AntiAliasType property of the text field must be set to openfl.text.AntiAliasType.ADVANCED. The openfl.text.GridFitType.SUBPIXEL setting is often good for right-aligned or centered dynamic text, and it is sometimes a useful trade-off for animation versus text quality.

    htmlText:UTF8String

    Contains the HTML representation of the text field contents. -Flash Player supports the following HTML tags:

    TagDescription
    Anchor tagThe <a> tag creates a hypertext link and supports the following attributes:
    • target: Specifies the name of the target window where you load the page. Options include _self, _blank, _parent, and _top. The _self option specifies the current frame in the current window, _blank specifies a new window, _parent specifies the parent of the current frame, and _top specifies the top-level frame in the current window.
    • href: Specifies a URL or an ActionScript link event.The URL can be either absolute or relative to the location of the SWF file that is loading the page. An example of an absolute reference to a URL is http://www.adobe.com; an example of a relative reference is /index.html. Absolute URLs must be prefixed with http://; otherwise, Flash Player or AIR treats them as relative URLs. You can use the link event to cause the link to execute an ActionScript function in a SWF file instead of opening a URL. To specify a link event, use the event scheme instead of the http scheme in your href attribute. An example is href="event:myText" instead of href="http://myURL"; when the user clicks a hypertext link that contains the event scheme, the text field dispatches a link TextEvent with its text property set to "myText". You can then create an ActionScript function that executes whenever the link TextEvent is dispatched. You can also define a:link, a:hover, and a:active styles for anchor tags by using style sheets.
    Bold tagThe <b> tag renders text as bold. A bold typeface must be available for the font used.
    Break tagThe <br> tag creates a line break in the text field. Set the text field to be a multiline text field to use this tag.
    Font tagThe <font> tag specifies a font or list of fonts to display the text.The font tag supports the following attributes:
    • color: Only hexadecimal color (#FFFFFF) values are supported.
    • face: Specifies the name of the font to use. As shown in the following example, you can specify a list of comma-delimited font names, in which case Flash Player selects the first available font. If the specified font is not installed on the local computer system or isn't embedded in the SWF file, Flash Player selects a substitute font.
    • size: Specifies the size of the font. You can use absolute pixel sizes, such as 16 or 18, or relative point sizes, such as +2 or -4.
    Image tagThe <img> tag lets you embed external image files (JPEG, GIF, PNG), SWF files, and movie clips inside text fields. Text automatically flows around images you embed in text fields. You must set the text field to be multiline to wrap text around an image.
    The <img> tag supports the following attributes:
    • src: Specifies the URL to an image or SWF file, or the linkage identifier for a movie clip symbol in the library. This attribute is required; all other attributes are optional. External files (JPEG, GIF, PNG, and SWF files) do not show until they are downloaded completely.
    • width: The width of the image, SWF file, or movie clip being inserted, in pixels.
    • height: The height of the image, SWF file, or movie clip being inserted, in pixels.
    • align: Specifies the horizontal alignment of the embedded image within the text field. Valid values are left and right. The default value is left.
    • hspace: Specifies the amount of horizontal space that surrounds the image where no text appears. The default value is 8.
    • vspace: Specifies the amount of vertical space that surrounds the image where no text appears. The default value is 8.
    • id: Specifies the name for the movie clip instance (created by Flash Player) that contains the embedded image file, SWF file, or movie clip. This approach is used to control the embedded content with ActionScript.
    • checkPolicyFile: Specifies that Flash Player checks for a URL policy file on the server associated with the image domain. If a policy file exists, SWF files in the domains listed in the file can access the data of the loaded image, for example, by calling the BitmapData.draw() method with this image as the source parameter. For more information related to security, see the Flash Player Developer Center Topic: Security.
    Flash displays media embedded in a text field at full size. To specify the dimensions of the media you are embedding, use the <img> tag height and width attributes.
    In general, an image embedded in a text field appears on the line following the <img> tag. However, when the <img> tag is the first character in the text field, the image appears on the first line of the text field.
    For AIR content in the application security sandbox, AIR ignores img tags in HTML content in ActionScript TextField objects. This is to prevent possible phishing attacks.
    Italic tagThe <i> tag displays the tagged text in italics. An italic typeface must be available for the font used.
    List item tagThe <li> tag places a bullet in front of the text that it encloses.
    Note: Because Flash Player and AIR do not recognize ordered and unordered list tags (<ol> and <ul>, they do not modify how your list is rendered. All lists are unordered and all list items use bullets.
    Paragraph tagThe <p> tag creates a new paragraph. The text field must be set to be a multiline text field to use this tag. The <p> tag supports the following attributes:
    • align: Specifies alignment of text within the paragraph; valid values are left, right, justify, and center.
    • class: Specifies a CSS style class defined by a openfl.text.StyleSheet object.
    Span tagThe <span> tag is available only for use with CSS text styles. It supports the following attribute:
    • class: Specifies a CSS style class defined by a openfl.text.StyleSheet object.
    Text format tagThe <textformat> tag lets you use a subset of paragraph formatting properties of the TextFormat class within text fields, including line leading, indentation, margins, and tab stops. You can combine <textformat> tags with the built-in HTML tags.
    The <textformat> tag has the following attributes:
  • blockindent: Specifies the block indentation in points; corresponds to TextFormat.blockIndent.
  • indent: Specifies the indentation from the left margin to the first character in the paragraph; corresponds to TextFormat.indent. Both positive and negative numbers are acceptable.
  • leading: Specifies the amount of leading (vertical space) between lines; corresponds to TextFormat.leading. Both positive and negative numbers are acceptable.
  • leftmargin: Specifies the left margin of the paragraph, in points; corresponds to TextFormat.leftMargin.
  • rightmargin: Specifies the right margin of the paragraph, in points; corresponds to TextFormat.rightMargin.
  • tabstops: Specifies custom tab stops as an array of non-negative integers; corresponds to TextFormat.tabStops.
    • Underline tagThe <u> tag underlines the tagged text.
    +Flash Player supports the following HTML tags:

    TagDescription
    Anchor tagThe <a> tag creates a hypertext link and supports the following attributes:
    • target: Specifies the name of the target window where you load the page. Options include _self, _blank, _parent, and _top. The _self option specifies the current frame in the current window, _blank specifies a new window, _parent specifies the parent of the current frame, and _top specifies the top-level frame in the current window.
    • href: Specifies a URL or a link event. The URL can be either absolute or relative to the location of the SWF file that is loading the page. An example of an absolute reference to a URL is http://www.adobe.com; an example of a relative reference is /index.html. Absolute URLs must be prefixed with http://; otherwise, Flash Player or AIR treats them as relative URLs. You can use the link event to cause the link to execute a Haxe function instead of opening a URL. To specify a link event, use the event scheme instead of the http scheme in your href attribute. An example is href="event:myText" instead of href="http://myURL"; when the user clicks a hypertext link that contains the event scheme, the text field dispatches a link TextEvent with its text property set to "myText". You can then create a Haxe function that executes whenever the link TextEvent is dispatched. You can also define a:link, a:hover, and a:active styles for anchor tags by using style sheets.
    Bold tagThe <b> tag renders text as bold. A bold typeface must be available for the font used.
    Break tagThe <br> tag creates a line break in the text field. Set the text field to be a multiline text field to use this tag.
    Font tagThe <font> tag specifies a font or list of fonts to display the text.The font tag supports the following attributes:
    • color: Only hexadecimal color (#FFFFFF) values are supported.
    • face: Specifies the name of the font to use. As shown in the following example, you can specify a list of comma-delimited font names, in which case Flash Player selects the first available font. If the specified font is not installed on the local computer system or isn't embedded in the SWF file, Flash Player selects a substitute font.
    • size: Specifies the size of the font. You can use absolute pixel sizes, such as 16 or 18, or relative point sizes, such as +2 or -4.
    Image tagThe <img> tag lets you embed external image files (JPEG, GIF, PNG), SWF files, and movie clips inside text fields. Text automatically flows around images you embed in text fields. You must set the text field to be multiline to wrap text around an image.
    The <img> tag supports the following attributes:
    • src: Specifies the URL to an image or SWF file, or the linkage identifier for a movie clip symbol in the library. This attribute is required; all other attributes are optional. External files (JPEG, GIF, PNG, and SWF files) do not show until they are downloaded completely.
    • width: The width of the image, SWF file, or movie clip being inserted, in pixels.
    • height: The height of the image, SWF file, or movie clip being inserted, in pixels.
    • align: Specifies the horizontal alignment of the embedded image within the text field. Valid values are left and right. The default value is left.
    • hspace: Specifies the amount of horizontal space that surrounds the image where no text appears. The default value is 8.
    • vspace: Specifies the amount of vertical space that surrounds the image where no text appears. The default value is 8.
    • id: Specifies the name for the movie clip instance (created by Flash Player) that contains the embedded image file, SWF file, or movie clip. This approach is used to control the embedded content with Haxe.
    • checkPolicyFile: Specifies that Flash Player checks for a URL policy file on the server associated with the image domain. If a policy file exists, SWF files in the domains listed in the file can access the data of the loaded image, for example, by calling the BitmapData.draw() method with this image as the source parameter. For more information related to security, see the Flash Player Developer Center Topic: Security.
    Flash displays media embedded in a text field at full size. To specify the dimensions of the media you are embedding, use the <img> tag height and width attributes.
    In general, an image embedded in a text field appears on the line following the <img> tag. However, when the <img> tag is the first character in the text field, the image appears on the first line of the text field.
    For AIR content in the application security sandbox, AIR ignores img tags in HTML content in OpenFL TextField objects. This is to prevent possible phishing attacks.
    Italic tagThe <i> tag displays the tagged text in italics. An italic typeface must be available for the font used.
    List item tagThe <li> tag places a bullet in front of the text that it encloses.
    Note: Because Flash Player and AIR do not recognize ordered and unordered list tags (<ol> and <ul>, they do not modify how your list is rendered. All lists are unordered and all list items use bullets.
    Paragraph tagThe <p> tag creates a new paragraph. The text field must be set to be a multiline text field to use this tag. The <p> tag supports the following attributes:
    • align: Specifies alignment of text within the paragraph; valid values are left, right, justify, and center.
    • class: Specifies a CSS style class defined by a openfl.text.StyleSheet object.
    Span tagThe <span> tag is available only for use with CSS text styles. It supports the following attribute:
    • class: Specifies a CSS style class defined by a openfl.text.StyleSheet object.
    Text format tagThe <textformat> tag lets you use a subset of paragraph formatting properties of the TextFormat class within text fields, including line leading, indentation, margins, and tab stops. You can combine <textformat> tags with the built-in HTML tags.
    The <textformat> tag has the following attributes:
  • blockindent: Specifies the block indentation in points; corresponds to TextFormat.blockIndent.
  • indent: Specifies the indentation from the left margin to the first character in the paragraph; corresponds to TextFormat.indent. Both positive and negative numbers are acceptable.
  • leading: Specifies the amount of leading (vertical space) between lines; corresponds to TextFormat.leading. Both positive and negative numbers are acceptable.
  • leftmargin: Specifies the left margin of the paragraph, in points; corresponds to TextFormat.leftMargin.
  • rightmargin: Specifies the right margin of the paragraph, in points; corresponds to TextFormat.rightMargin.
  • tabstops: Specifies custom tab stops as an array of non-negative integers; corresponds to TextFormat.tabStops.
    • Underline tagThe <u> tag underlines the tagged text.

    Flash Player and AIR support the following HTML entities:

    EntityDescription
    &lt;< (less than)
    &gt;> (greater than)
    &amp;& (ampersand)
    &quot;" (double quotes)
    &apos;' (apostrophe, single quote)

    Flash Player and AIR also support explicit character codes, such as & (ASCII ampersand) and € (Unicode € symbol).

    read onlylength:Int

    The number of characters in a text field. A character such as tab @@ -253,7 +253,7 @@ true, the text field is multiline; if the value is false, the text field is a single-line text field. In a field of type TextFieldType.INPUT, the multiline value -determines whether the Enter key creates a new line(a value +determines whether the Enter key creates a new line (a value of false, and the Enter key is ignored). If you paste text into a TextField with a multiline value of false, newlines are stripped out of the text.

    read onlynumLines:Int

    Defines the number of text lines in a multiline text field. If @@ -282,7 +282,7 @@ my_txt.restrict = "^a-z";

    You can use a backslash to enter a ^ or - verbatim. The accepted backslash sequences are -, \^ or . The backslash must be an actual -character in the string, so when specified in ActionScript, a double +character in the string, so when specified in Haxe code, a double backslash must be used. For example, the following code includes only the dash(-) and caret(^): my_txt.restrict = "\\-\\^";

    @@ -292,8 +292,8 @@ my_txt.restrict = "A-Z^Q";

    You can use the \u escape sequence to construct restrict strings. The following code includes only the -characters from ASCII 32(space) to ASCII 126(tilde). -my_txt.restrict = "\u0020-\u007E";

    scrollH:Int

    The current horizontal scrolling position. If the scrollH +characters from ASCII 32 (space) to ASCII 126 (tilde). +my_txt.restrict = "\u0020-\u007E";

    See also:

    scrollH:Int

    The current horizontal scrolling position. If the scrollH property is 0, the text is not horizontally scrolled. This property value is an integer that represents the horizontal position in pixels.

    The units of horizontal scrolling are pixels, whereas the units of @@ -303,13 +303,13 @@ scrolling by line because users usually want to see a complete line of text rather than a partial line. Even if a line uses multiple fonts, the height of the line adjusts to fit the largest font in use.

    -

    Note: The scrollH property is zero-based, not +

    Note: The scrollH property is zero-based, not 1-based like the scrollV vertical scrolling property.

    scrollV:Int

    The vertical position of text in a text field. The scrollV property is useful for directing users to a specific paragraph in a long passage, or creating scrolling text fields.

    The units of vertical scrolling are lines, whereas the units of horizontal scrolling are pixels. If the first line displayed is the first -line in the text field, scrollV is set to 1(not 0). Horizontal scrolling +line in the text field, scrollV is set to 1 (not 0). Horizontal scrolling is measured in pixels because most fonts are proportionally spaced; that is, the characters can have different widths. Flash performs vertical scrolling by line because users usually want to see a complete line of @@ -326,19 +326,19 @@ selectable is set to true, the text in the text field can be selected with the mouse or keyboard, and the text can be copied with the Copy command. You can select text this way even if the -text field is a dynamic text field instead of an input text field.

    read onlyselectionBeginIndex:Int

    The zero-based character index value of the first character in the current +text field is a dynamic text field instead of an input text field.

    See also:

    read onlyselectionBeginIndex:Int

    The zero-based character index value of the first character in the current selection. For example, the first character is 0, the second character is 1, and so on. If no text is selected, this property is the value of -caretIndex.

    read onlyselectionEndIndex:Int

    The zero-based character index value of the last character in the current +caretIndex.

    See also:

    read onlyselectionEndIndex:Int

    The zero-based character index value of the last character in the current selection. For example, the first character is 0, the second character is 1, and so on. If no text is selected, this property is the value of -caretIndex.

    sharpness:Float

    The sharpness of the glyph edges in this text field. This property applies +caretIndex.

    See also:

    sharpness:Float

    The sharpness of the glyph edges in this text field. This property applies only if the openfl.text.AntiAliasType property of the text field is set to openfl.text.AntiAliasType.ADVANCED. The range for sharpness is a number from -400 to 400. If you attempt to set sharpness to a value outside that range, Flash sets the property to the nearest value in the range(either -400 or 400).

    styleSheet:StyleSheet

    Attaches a style sheet to the text field. For information on creating -style sheets, see the StyleSheet class and the ActionScript 3.0 +style sheets, see the StyleSheet class and the OpenFL Developer's Guide. You can change the style sheet associated with a text field at any time. If you change the style sheet in use, the text field is redrawn @@ -349,11 +349,11 @@ TextField.text and TextField.htmlText change to incorporate the formatting previously applied by the style sheet. To preserve the original TextField.htmlText contents without the formatting, save -the value in a variable before removing the style sheet.

    text:UTF8String

    A string that is the current text in the text field. Lines are separated +the value in a variable before removing the style sheet.

    See also:

    text:UTF8String

    A string that is the current text in the text field. Lines are separated by the carriage return character('\r', ASCII 13). This property contains unformatted text in the text field, without HTML tags.

    To get the text in HTML form, use the htmlText -property.

    textColor:Int

    The color of the text in a text field, in hexadecimal format. The +property.

    See also:

    textColor:Int

    The color of the text in a text field, in hexadecimal format. The hexadecimal color system uses six digits to represent color values. Each digit has 16 possible values or characters. The characters range from 0-9 and then A-F. For example, black is 0x000000; white is @@ -361,7 +361,7 @@ constants: TextFieldType.DYNAMIC, which specifies a dynamic text field, which a user cannot edit, or TextFieldType.INPUT, which specifies an input text field, which a user can edit.

    Throws:

    ArgumentError

    The type specified is not a member of -openfl.text.TextFieldType.

    wordWrap:Bool

    A Boolean value that indicates whether the text field has word wrap. If +openfl.text.TextFieldType.

    See also:

    wordWrap:Bool

    A Boolean value that indicates whether the text field has word wrap. If the value of wordWrap is true, the text field has word wrap; if the value is false, the text field does not have word wrap. The default value is false.

    Methods

    appendText(text:String):Void

    Appends the string specified by the newText parameter to the @@ -372,22 +372,22 @@ example, the first position is 0, the second position is 1, and so on).

    Returns:

    A rectangle with x and y minimum and maximum values defining the bounding box of the character.

    getCharIndexAtPoint(x:Float, y:Float):Int

    Returns the zero-based index value of the character at the point specified -by the x and y parameters.

    Parameters:

    x

    The x coordinate of the character.

    y

    The y coordinate of the character.

    Returns:

    The zero-based index value of the character(for example, the +by the x and y parameters.

    Parameters:

    x

    The x coordinate of the character.

    y

    The y coordinate of the character.

    Returns:

    The zero-based index value of the character (for example, the first position is 0, the second position is 1, and so on). Returns -1 if the point is not over any character.

    getFirstCharInParagraph(charIndex:Int):Int

    Given a character index, returns the index of the first character in the same paragraph.

    Parameters:

    charIndex

    The zero-based index value of the character (for example, the first character is 0, the second character is 1, and so on).

    Returns:

    The zero-based index value of the first character in the same paragraph.

    Throws:

    RangeError

    The character index specified is out of range.

    getLineIndexAtPoint(x:Float, y:Float):Int

    Returns the zero-based index value of the line at the point specified by -the x and y parameters.

    Parameters:

    x

    The x coordinate of the line.

    y

    The y coordinate of the line.

    Returns:

    The zero-based index value of the line(for example, the first +the x and y parameters.

    Parameters:

    x

    The x coordinate of the line.

    y

    The y coordinate of the line.

    Returns:

    The zero-based index value of the line (for example, the first line is 0, the second line is 1, and so on). Returns -1 if the point is not over any line.

    getLineIndexOfChar(charIndex:Int):Int

    Returns the zero-based index value of the line containing the character specified by the charIndex parameter.

    Parameters:

    charIndex

    The zero-based index value of the character (for example, the first character is 0, the second character is 1, and so on).

    Returns:

    The zero-based index value of the line.

    Throws:

    RangeError

    The character index specified is out of range.

    getLineLength(lineIndex:Int):Int

    Returns the number of characters in a specific text line.

    Parameters:

    lineIndex

    The line number for which you want the length.

    Returns:

    The number of characters in the line.

    Throws:

    RangeError

    The line number specified is out of range.

    getLineMetrics(lineIndex:Int):TextLineMetrics

    Returns metrics information about a given text line.

    Parameters:

    lineIndex

    The line number for which you want metrics information.

    Returns:

    A TextLineMetrics object.

    Throws:

    RangeError

    The line number specified is out of range.

    getLineOffset(lineIndex:Int):Int

    Returns the character index of the first character in the line that the -lineIndex parameter specifies.

    Parameters:

    lineIndex

    The zero-based index value of the line(for example, the +lineIndex parameter specifies.

    Parameters:

    lineIndex

    The zero-based index value of the line (for example, the first line is 0, the second line is 1, and so on).

    Returns:

    The zero-based index value of the first character in the line.

    Throws:

    RangeError

    The line number specified is out of range.

    getLineText(lineIndex:Int):String

    Returns the text of the line specified by the lineIndex -parameter.

    Parameters:

    lineIndex

    The zero-based index value of the line(for example, the +parameter.

    Parameters:

    lineIndex

    The zero-based index value of the line (for example, the first line is 0, the second line is 1, and so on).

    Returns:

    The text string contained in the specified line.

    Throws:

    RangeError

    The line number specified is out of range.

    getParagraphLength(charIndex:Int):Int

    Given a character index, returns the length of the paragraph containing the given character. The length is relative to the first character in the paragraph (as returned by @@ -427,7 +427,7 @@ caretIndex property.

    Parameters:

    beginIndex

    The zero-based index value of the first character in the selection(for example, the first character is 0, the second character is 1, and so on).

    endIndex

    The zero-based index value of the last character in the -selection.

    @:value({ endIndex : -1, beginIndex : -1 })setTextFormat(format:TextFormat, beginIndex:Int = -1, endIndex:Int = -1):Void

    Applies the text formatting that the format parameter +selection.

    See also:

    @:value({ endIndex : -1, beginIndex : -1 })setTextFormat(format:TextFormat, beginIndex:Int = -1, endIndex:Int = -1):Void

    Applies the text formatting that the format parameter specifies to the specified text in a text field. The value of format must be a TextFormat object that specifies the desired text formatting changes. Only the non-null properties of @@ -460,7 +460,7 @@ defaultTextFormat.

    Parameters:

    format

    A TextFormat object that contains character and paragraph formatting information.

    Throws:

    Error

    This method cannot be used on a text field with a style sheet.

    RangeError

    The beginIndex or endIndex -specified is out of range.

    Inherited Variables

    Defined by InteractiveObject

    doubleClickEnabled:Bool

    Specifies whether the object receives doubleClick events. The +specified is out of range.

    See also:

    Inherited Variables

    Defined by InteractiveObject

    doubleClickEnabled:Bool

    Specifies whether the object receives doubleClick events. The default value is false, which means that by default an InteractiveObject instance does not receive doubleClick events. If the doubleClickEnabled property is set to @@ -479,14 +479,14 @@ default any InteractiveObject instance that is on the display list receives mouse events or other user input events. If mouseEnabled is set to false, the instance does -not receive any mouse events(or other user input events like keyboard +not receive any mouse events (or other user input events like keyboard events). Any children of this instance on the display list are not affected. To change the mouseEnabled behavior for all children of an object on the display list, use openfl.display.DisplayObjectContainer.mouseChildren.

    No event is dispatched by setting this property. You must use the addEventListener() method to create interactive -functionality.

    needsSoftKeyboard:Bool

    Specifies whether a virtual keyboard(an on-screen, software keyboard) +functionality.

    needsSoftKeyboard:Bool

    Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.

    By default, the value is false and focusing an InteractiveObject instance does not raise a soft keyboard. If the @@ -546,7 +546,7 @@ cast(tlfInstance2.getChildAt(1), InteractiveObject).tabIndex = 2; cast(tlfInstance3.getChildAt(1), InteractiveObject).tabIndex = 1;

    Defined by DisplayObject

    @:keepalpha:Float

    Indicates the alpha transparency value of the object specified. Valid values are 0 (fully transparent) to 1 (fully opaque). The default value is 1. -Display objects with alpha set to 0 are active, even though they are invisible.

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A +Display objects with alpha set to 0 are active, even though they are invisible.

    See also:

    blendMode:BlendMode

    A value from the BlendMode class that specifies which blend mode to use. A bitmap can be drawn internally in two ways. If you have a blend mode enabled or an external clipping mask, the bitmap is drawn by adding a bitmap-filled square shape to the vector render. If you attempt to set @@ -566,7 +566,7 @@ BlendMode class defines string values you can use. The illustrations in the table show blendMode values applied to a circular display object(2) superimposed on another display object(1).

    -

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn +

    Square Number 1 Circle Number 2

    BlendMode ConstantIllustrationDescription
    BlendMode.NORMALblend mode NORMALThe display object appears in front of the background. Pixel values of the display object override those of the background. Where the display object is transparent, the background is visible.
    BlendMode.LAYERblend mode LAYERForces the creation of a transparency group for the display object. This means that the display object is pre-composed in a temporary buffer before it is processed further. This is done automatically if the display object is pre-cached using bitmap caching or if the display object is a display object container with at least one child object with a blendMode setting other than BlendMode.NORMAL. Not supported under GPU rendering.
    BlendMode.MULTIPLYblend mode MULTIPLYMultiplies the values of the display object constituent colors by the colors of the background color, and then normalizes by dividing by 0xFF, resulting in darker colors. This setting is commonly used for shadows and depth effects.
    For example, if a constituent color (such as red) of one pixel in the display object and the corresponding color of the pixel in the background both have the value 0x88, the multiplied result is 0x4840. Dividing by 0xFF yields a value of 0x48 for that constituent color, which is a darker shade than the color of the display object or the color of the background.
    BlendMode.SCREENblend mode SCREENMultiplies the complement (inverse) of the display object color by the complement of the background color, resulting in a bleaching effect. This setting is commonly used for highlights or to remove black areas of the display object.
    BlendMode.LIGHTENblend mode LIGHTENSelects the lighter of the constituent colors of the display object and the color of the background (the colors with the larger values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xFFF833 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DARKENblend mode DARKENSelects the darker of the constituent colors of the display object and the colors of the background (the colors with the smaller values). This setting is commonly used for superimposing type.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0xDDCC00 (because 0xFF > 0xDD, 0xCC < 0xF8, and 0x33 > 0x00 = 33). Not supported under GPU rendering.
    BlendMode.DIFFERENCEblend mode DIFFERENCECompares the constituent colors of the display object with the colors of its background, and subtracts the darker of the values of the two constituent colors from the lighter value. This setting is commonly used for more vibrant colors.
    For example, if the display object has a pixel with an RGB value of 0xFFCC33, and the background pixel has an RGB value of 0xDDF800, the resulting RGB value for the displayed pixel is 0x222C33 (because 0xFF - 0xDD = 0x22, 0xF8 - 0xCC = 0x2C, and 0x33 - 0x00 = 0x33).
    BlendMode.ADDblend mode ADDAdds the values of the constituent colors of the display object to the colors of its background, applying a ceiling of 0xFF. This setting is commonly used for animating a lightening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAAA633, and the background pixel has an RGB value of 0xDD2200, the resulting RGB value for the displayed pixel is 0xFFC833 (because 0xAA + 0xDD > 0xFF, 0xA6 + 0x22 = 0xC8, and 0x33 + 0x00 = 0x33).
    BlendMode.SUBTRACTblend mode SUBTRACTSubtracts the values of the constituent colors in the display object from the values of the background color, applying a floor of 0. This setting is commonly used for animating a darkening dissolve between two objects.
    For example, if the display object has a pixel with an RGB value of 0xAA2233, and the background pixel has an RGB value of 0xDDA600, the resulting RGB value for the displayed pixel is 0x338400 (because 0xDD - 0xAA = 0x33, 0xA6 - 0x22 = 0x84, and 0x00 - 0x33 < 0x00).
    BlendMode.INVERTblend mode INVERTInverts the background.
    BlendMode.ALPHAblend mode ALPHAApplies the alpha value of each pixel of the display object to the background. This requires the blendMode setting of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.ERASEblend mode ERASEErases the background based on the alpha value of the display object. This requires the blendMode of the parent display object to be set to BlendMode.LAYER. For example, in the illustration, the parent display object, which is a white background, has blendMode = BlendMode.LAYER. Not supported under GPU rendering.
    BlendMode.OVERLAYblend mode OVERLAYAdjusts the color of each pixel based on the darkness of the background. If the background is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the background is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.HARDLIGHTblend mode HARDLIGHTAdjusts the color of each pixel based on the darkness of the display object. If the display object is lighter than 50% gray, the display object and background colors are screened, which results in a lighter color. If the display object is darker than 50% gray, the colors are multiplied, which results in a darker color. This setting is commonly used for shading effects. Not supported under GPU rendering.
    BlendMode.SHADERN/AAdjusts the color using a custom shader routine. The shader that is used is specified as the Shader instance assigned to the blendShader property. Setting the blendShader property of a display object to a Shader instance automatically sets the display object's blendMode property to BlendMode.SHADER. If the blendMode property is set to BlendMode.SHADER without first setting the blendShader property, the blendMode property is set to BlendMode.NORMAL. Not supported under GPU rendering.

    See also:

    cacheAsBitmap:Bool

    All vector data for a display object that has a cached bitmap is drawn to the bitmap instead of the main display. If cacheAsBitmapMatrix is null or unsupported, the bitmap is then copied to the main display as unstretched, unrotated pixels snapped @@ -597,12 +597,12 @@ number of pixels cannot exceed 16,777,215 pixels.(So, if a bitmap image is 8,191 pixels wide, it can only be 2,048 pixels high.) In Flash Player 9 and earlier, the limitation is is 2880 pixels in height and 2,880 pixels -in width.

  • The bitmap fails to allocate(out of memory error).
    • +in width.
  • The bitmap fails to allocate (out of memory error).

    • The cacheAsBitmap property is best used with movie clips that have mostly static content and that do not scale and rotate frequently. With such movie clips, cacheAsBitmap can lead to -performance increases when the movie clip is translated(when its x -and y position is changed).

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to +performance increases when the movie clip is translated (when its x +and y position is changed).

    See also:

    cacheAsBitmapMatrix:Matrix

    If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. The application uses this matrix as a transformation matrix that is applied when rendering the bitmap version of the display object.

    Adobe AIR profile support: This feature is supported on mobile devices, but it is not supported on desktop @@ -636,16 +636,16 @@

    Note: The cacheAsBitmapMatrix property is suitable for 2D transformations. If you need to apply transformations in 3D, you may do so by setting a 3D property of the object and manipulating its transform.matrix3D property. If the application is packaged using GPU mode, this allows the 3D transforms -to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated +to be applied to the object by the GPU. The cacheAsBitmapMatrix is ignored for 3D objects.

    See also:

    filters:Array<BitmapFilter>

    An indexed array that contains each filter object currently associated with the display object. The openfl.filters package contains several classes that define specific filters you can use.

    Filters can be applied in Flash Professional at design time, or at run -time by using ActionScript code. To apply a filter by using ActionScript, +time by using Haxe code. To apply a filter by using Haxe, you must make a temporary copy of the entire filters array, modify the temporary array, then assign the value of the temporary array back to the filters array. You cannot directly add a new filter object to the filters array.

    -

    To add a filter by using ActionScript, perform the following steps +

    To add a filter by using Haxe, perform the following steps (assume that the target display object is named myDisplayObject):

    1. Create a new filter object by using the constructor method of your chosen filter class.
    2. Assign the value of the myDisplayObject.filters array @@ -676,7 +676,7 @@

      The openfl.filters package includes classes for filters. For example, to create a DropShadow filter, you would write:

      Throws:

      ArgumentError

      When filters includes a ShaderFilter and the shader output type is not compatible with -this operation(the shader must specify a +this operation (the shader must specify a pixel4 output).

      ArgumentError

      When filters includes a ShaderFilter and the shader doesn't specify any image input or the first input is not an image4 input.

      ArgumentError

      When filters includes a ShaderFilter @@ -694,10 +694,10 @@ is adjusted accordingly, as shown in the following code:

      Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a height of 0, even if you try to -set height to a different value.

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file +set height to a different value.

      See also:

      read onlyloaderInfo:LoaderInfo

      Returns a LoaderInfo object containing information about loading the file to which this display object belongs. The loaderInfo property is defined only for the root display object of a SWF file or for a loaded -Bitmap(not for a Bitmap that is drawn with ActionScript). To find the +Bitmap (not for a Bitmap that is drawn with Haxe). To find the loaderInfo object associated with the SWF file that contains a display object named myDisplayObject, use myDisplayObject.root.loaderInfo.

      @@ -709,7 +709,7 @@ list. The mask object itself is not drawn. Set mask to null to remove the mask.

      To be able to scale a mask object, it must be on the display list. To -be able to drag a mask Sprite object(by calling its +be able to drag a mask Sprite object (by calling its startDrag() method), it must be on the display list. To call the startDrag() method for a mask sprite based on a mouseDown event being dispatched by the sprite, set the @@ -728,23 +728,23 @@ more than one calling display object. When the mask is assigned to a second display object, it is removed as the mask of the first object, and that object's mask property becomes -null.

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in +null.

      See also:

      read onlymouseX:Float

      Indicates the x coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned x -coordinate will reflect the non-rotated object.

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in +coordinate will reflect the non-rotated object.

      See also:

      read onlymouseY:Float

      Indicates the y coordinate of the mouse or user input device position, in pixels.

      Note: For a DisplayObject that has been rotated, the returned y -coordinate will reflect the non-rotated object.

      name:String

      Indicates the instance name of the DisplayObject. The object can be +coordinate will reflect the non-rotated object.

      See also:

      name:String

      Indicates the instance name of the DisplayObject. The object can be identified in the child list of its parent display object container by calling the getChildByName() method of the display object container.

      Throws:

      IllegalOperationError

      If you are attempting to set this property on an object that was placed on the timeline in the Flash authoring tool.

      opaqueBackground:Null<Int>

      Specifies whether the display object is opaque with a certain background color. A transparent bitmap contains alpha channel data and is drawn -transparently. An opaque bitmap has no alpha channel(and renders faster +transparently. An opaque bitmap has no alpha channel (and renders faster than a transparent bitmap). If the bitmap is opaque, you specify its own background color to use.

      -

      If set to a number value, the surface is opaque(not transparent) with +

      If set to a number value, the surface is opaque (not transparent) with the RGB background color that the number specifies. If set to null(the default value), the display object has a transparent background.

      @@ -756,7 +756,7 @@

      The opaque background region is not matched when calling the hitTestPoint() method with the shapeFlag parameter set to true.

      -

      The opaque background region does not respond to mouse events.

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display +

      The opaque background region does not respond to mouse events.

      See also:

      read onlyparent:DisplayObjectContainer

      Indicates the DisplayObjectContainer object that contains this display object. Use the parent property to specify a relative path to display objects that are above the current display object in the display list hierarchy.

      @@ -765,7 +765,7 @@ 
      this.parent.parent.alpha = 20;

      Throws:

      SecurityError

      The parent display object belongs to a security sandbox to which you do not have access. You can avoid this situation by having the parent movie call -the Security.allowDomain() method.

      read onlyroot:DisplayObject

      For a display object in a loaded SWF file, the root property +the Security.allowDomain() method.

      See also:

    read onlyroot:DisplayObject

    For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. For a Bitmap object representing a loaded image file, the root property is the Bitmap object @@ -778,7 +778,7 @@ is a child of the top-most display object in a loaded SWF file.

    For example, if you create a new Sprite object by calling the Sprite() constructor method, its root property -is null until you add it to the display list(or to a display +is null until you add it to the display list (or to a display object container that is off the display list but that is a child of the top-most display object in a SWF file).

    For a loaded SWF file, even though the Loader object used to load the @@ -786,12 +786,12 @@ SWF file has its root property set to itself. The Loader object does not have its root property set until it is added as a child of a display object for which the root property is -set.

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its +set.

    See also:

    @:keeprotation:Float

    Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. For example, the statement my_video.rotation = 450 -is the same as my_video.rotation = 90.

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, +is the same as my_video.rotation = 90.

    See also:

    scale9Grid:Rectangle

    The current scaling grid that is in effect. If set to null, the entire display object is scaled normally when any scale transformation is applied.

    When you define the scale9Grid property, the display @@ -819,11 +819,11 @@ the registration point. The default registration point is (0,0). 1.0 equals 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the +y property values, which are defined in whole pixels.

    See also:

    @:keepscaleY:Float

    Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. The default registration point is (0,0). 1.0 is 100% scale.

    Scaling the local coordinate system changes the x and -y property values, which are defined in whole pixels.

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is +y property values, which are defined in whole pixels.

    See also:

    scrollRect:Rectangle

    The scroll rectangle bounds of the display object. The display object is cropped to the size defined by the rectangle, and it scrolls within the rectangle when you change the x and y properties of the scrollRect object.

    @@ -840,17 +840,17 @@ an object up and down by setting the y property of the scrollRect Rectangle object. If the display object is rotated 90° and you scroll it left and right, the display object actually scrolls -up and down.

    @:betashader:Shader

    BETA**

    +up and down.

    See also:

    @:betashader:Shader

    BETA**

    Applies a custom Shader object to use when rendering this display object (or its children) when using hardware rendering. This occurs as a single-pass render on this object only, if visible. In order to apply a post-process effect to multiple display objects at once, enable cacheAsBitmap or use the filters property with a ShaderFilter

    read onlystage:Stage

    The Stage of the display object. A Flash runtime application has only one Stage object. For example, you can create and load multiple display objects into the display list, and the stage property of each -display object refers to the same Stage object(even if the display object +display object refers to the same Stage object (even if the display object belongs to a loaded SWF file).

    If a display object is not added to the display list, its -stage property is set to null.

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color +stage property is set to null.

    See also:

    @:keeptransform:Transform

    An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. The specific properties - matrix, colorTransform, and three read-only properties (concatenatedMatrix, concatenatedColorTransform, @@ -887,21 +887,21 @@ is adjusted accordingly, as shown in the following code:

    Except for TextField and Video objects, a display object with no content(such as an empty sprite) has a width of 0, even if you try to set -width to a different value.

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative +width to a different value.

    See also:

    @:keepx:Float

    Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative +registration point position.

    See also:

    @:keepy:Float

    Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. If the object is inside a DisplayObjectContainer that has transformations, it is in the local coordinate system of the enclosing DisplayObjectContainer. Thus, for a DisplayObjectContainer rotated 90° counterclockwise, the DisplayObjectContainer's children inherit a coordinate system that is rotated 90° counterclockwise. The object's coordinates refer to the -registration point position.

    Inherited Methods

    Defined by InteractiveObject

    requestSoftKeyboard():Bool

    Raises a virtual keyboard.

    +registration point position.

    See also:

    Inherited Methods

    Defined by InteractiveObject

    requestSoftKeyboard():Bool

    Raises a virtual keyboard.

    Calling this method focuses the InteractiveObject instance and raises the soft keyboard, if necessary. The needsSoftKeyboard must also be true. A keyboard is not raised if a hardware keyboard @@ -937,8 +937,8 @@ coordinates, respectively.

    Parameters:

    targetCoordinateSpace

    The display object that defines the coordinate system to use.

    Returns:

    The rectangle that defines the area of the display object relative to the targetCoordinateSpace object's coordinate -system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage(global) coordinates -to the display object's(local) coordinates.

    +system.

    globalToLocal(pos:Point):Point

    Converts the point object from the Stage (global) coordinates +to the display object's (local) coordinates.

    To use this method, first create an instance of the Point class. The x and y values that you assign represent global coordinates because they relate to the origin(0,0) of the main display area. Then @@ -953,17 +953,17 @@ point specified by the x and y parameters. The x and y parameters specify a point in the coordinate space of the Stage, not the display object container that -contains the display object(unless that display object container is the +contains the display object (unless that display object container is the Stage).

    Parameters:

    x

    The x coordinate to test against this object.

    y

    The y coordinate to test against this object.

    shapeFlag

    Whether to check against the actual pixels of the object (true) or the bounding box (false).

    Returns:

    true if the display object overlaps or intersects with the specified point; false otherwise.

    invalidate():Void

    Calling the invalidate() method signals to have the current object -redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's(local) -coordinates to the Stage(global) coordinates.

    +redrawn the next time the object is eligible to be rendered.

    localToGlobal(point:Point):Point

    Converts the point object from the display object's (local) +coordinates to the Stage (global) coordinates.

    This method allows you to convert any given x and y coordinates from values that are relative to the origin(0,0) of a -specific display object(local coordinates) to values that are relative to -the origin of the Stage(global coordinates).

    +specific display object (local coordinates) to values that are relative to +the origin of the Stage (global coordinates).

    To use this method, first create an instance of the Point class. The x and y values that you assign represent local coordinates because they relate to the origin of the display object.

    diff --git a/openfl/text/TextFieldAutoSize.html b/openfl/text/TextFieldAutoSize.html index b7f03ce..cd937ad 100644 --- a/openfl/text/TextFieldAutoSize.html +++ b/openfl/text/TextFieldAutoSize.html @@ -1,7 +1,7 @@ -openfl.text.TextFieldAutoSize - API Referenceopenfl.text.TextFieldAutoSize - OpenFL API Reference
    View source

    enum abstract TextFieldAutoSize(Null<Int>)

    package openfl.text

    @:enum

    Available on all platforms

    The TextFieldAutoSize class is an enumeration of constant values used in +

    View source

    enum abstract TextFieldAutoSize(Null<Int>)

    package openfl.text

    @:enum

    Available on all platforms

    The TextFieldAutoSize class is an enumeration of constant values used in setting the autoSize property of the TextField class.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyCENTER:TextFieldAutoSize = 0

    Specifies that the text is to be treated as center-justified text. Any resizing of a single line of a text field is equally distributed to both the right and left sides.

    @:value(cast 1)@:impl@:enuminlineread onlyLEFT:TextFieldAutoSize = 1

    Specifies that the text is to be treated as left-justified text, meaning diff --git a/openfl/text/TextFieldType.html b/openfl/text/TextFieldType.html index b98a83f..cb8dc87 100644 --- a/openfl/text/TextFieldType.html +++ b/openfl/text/TextFieldType.html @@ -1,7 +1,7 @@ -openfl.text.TextFieldType - API Referenceopenfl.text.TextFieldType - OpenFL API Reference

    View source

    enum abstract TextFieldType(Null<Int>)

    package openfl.text

    @:enum

    Available on all platforms

    The TextFieldType class is an enumeration of constant values used in -setting the type property of the TextField class.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyDYNAMIC:TextFieldType = 0

    Used to specify a dynamic TextField.

    @:value(cast 1)@:impl@:enuminlineread onlyINPUT:TextFieldType = 1

    Used to specify an input TextField.

    \ No newline at end of file +
    View source

    enum abstract TextFieldType(Null<Int>)

    package openfl.text

    @:enum

    Available on all platforms

    The TextFieldType class is an enumeration of constant values used in +setting the type property of the TextField class.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyDYNAMIC:TextFieldType = 0

    Used to specify a dynamic TextField.

    @:value(cast 1)@:impl@:enuminlineread onlyINPUT:TextFieldType = 1

    Used to specify an input TextField.

    See also:

    \ No newline at end of file diff --git a/openfl/text/TextFormat.html b/openfl/text/TextFormat.html index e69302a..cc28749 100644 --- a/openfl/text/TextFormat.html +++ b/openfl/text/TextFormat.html @@ -1,7 +1,7 @@ -openfl.text.TextFormat - API Referenceopenfl.text.TextFormat - OpenFL API Reference
    API Reference
    View source

    class TextFormat

    package openfl.text

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The TextFormat class represents character formatting information. Use the +

    View source

    class TextFormat

    package openfl.text

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The TextFormat class represents character formatting information. Use the TextFormat class to create specific text formatting for text fields. You can apply text formatting to both static and dynamic text fields. The properties of the TextFormat class apply to device and embedded fonts. @@ -79,7 +79,7 @@ default formatting. The default formatting that Flash Player uses for each property (if property's value is null) is as follows:

    align = "left"
    blockIndent = 0
    bold = false
    bullet = false
    color = 0x000000
    font = "Times New Roman" (default font is Times on Mac OS X)
    indent = 0
    italic = false
    kerning = false
    leading = 0
    leftMargin = 0
    letterSpacing = 0
    rightMargin = 0
    size = 12
    tabStops = [] (empty array)
    target = "" (empty string)
    underline = false
    url = "" (empty string)

    The default formatting for each property is also described in each -property description.

    Constructor

    @:value({ leading : null, indent : null, rightMargin : null, leftMargin : null, align : null, target : null, url : null, underline : null, italic : null, bold : null, color : null, size : null, font : null })new(?font:String, ?size:Int, ?color:Int, ?bold:Bool, ?italic:Bool, ?underline:Bool, ?url:String, ?target:String, ?align:TextFormatAlign, ?leftMargin:Int, ?rightMargin:Int, ?indent:Int, ?leading:Int)

    Creates a TextFormat object with the specified properties. You can then +property description.

    See also:

    Constructor

    @:value({ leading : null, indent : null, rightMargin : null, leftMargin : null, align : null, target : null, url : null, underline : null, italic : null, bold : null, color : null, size : null, font : null })new(?font:String, ?size:Int, ?color:Int, ?bold:Bool, ?italic:Bool, ?underline:Bool, ?url:String, ?target:String, ?align:TextFormatAlign, ?leftMargin:Int, ?rightMargin:Int, ?indent:Int, ?leading:Int)

    Creates a TextFormat object with the specified properties. You can then change the properties of the TextFormat object to change the formatting of text fields.

    Any parameter may be set to null to indicate that it is @@ -106,7 +106,7 @@ an entire block of text; that is, to all lines of the text. In contrast, normal indentation(TextFormat.indent) affects only the first line of each paragraph. If this property is null, the -TextFormat object does not specify block indentation(block indentation is +TextFormat object does not specify block indentation (block indentation is 0).

    bold:Null<Bool>

    Specifies whether the text is boldface. The default value is null, which means no boldface is used. If the value is true, then the text is boldface.

    bullet:Null<Bool>

    Indicates that the text is part of a bulleted list. In a bulleted list, @@ -121,7 +121,7 @@ the paragraph. The default value is null, which indicates that no indentation is used.

    italic:Null<Bool>

    Indicates whether text in this text format is italicized. The default value is null, which means no italics are used.

    kerning:Null<Bool>

    A Boolean value that indicates whether kerning is enabled -(true) or disabled(false). Kerning adjusts the +(true) or disabled (false). Kerning adjusts the pixels between certain character pairs to improve readability, and should be used only when necessary, such as with headings in large fonts. Kerning is supported for embedded fonts only.

    @@ -139,7 +139,7 @@ null, which indicates that the right margin is 0 pixels.

    size:Null<Int>

    The size in pixels of text in this text format. The default value is null, which means that a size of 12 is used.

    tabStops:Array<Int>

    Specifies custom tab stops as an array of non-negative integers. Each tab stop is specified in pixels. If custom tab stops are not specified -(null), the default tab stop is 4(average character width).

    target:String

    Indicates the target window where the hyperlink is displayed. If the +(null), the default tab stop is 4 (average character width).

    target:String

    Indicates the target window where the hyperlink is displayed. If the target window is an empty string, the text is displayed in the default target window _self. You can choose a custom name or one of the following four names: _self specifies the current frame @@ -149,7 +149,7 @@ the TextFormat.url property is an empty string or null, you can get or set this property, but the property will have no effect.

    underline:Null<Bool>

    Indicates whether the text that uses this text format is underlined -(true) or not(false). This underlining is +(true) or not (false). This underlining is similar to that produced by the <U> tag, but the latter is not true underlining, because it does not skip descenders correctly. The default value is null, which indicates that underlining is diff --git a/openfl/text/TextFormatAlign.html b/openfl/text/TextFormatAlign.html index fc7fb1e..8fbd160 100644 --- a/openfl/text/TextFormatAlign.html +++ b/openfl/text/TextFormatAlign.html @@ -1,7 +1,7 @@ -openfl.text.TextFormatAlign - API Referenceopenfl.text.TextFormatAlign - OpenFL API Reference

    View source

    enum abstract TextFormatAlign(Null<Int>)

    package openfl.text

    @:enum

    Available on all platforms

    The TextFormatAlign class provides values for text alignment in the +

    View source

    enum abstract TextFormatAlign(Null<Int>)

    package openfl.text

    @:enum

    Available on all platforms

    The TextFormatAlign class provides values for text alignment in the TextFormat class.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyCENTER:TextFormatAlign = 0

    Constant; centers the text in the text field. Use the syntax TextFormatAlign.CENTER.

    @:value(cast 1)@:impl@:enuminlineread onlyEND:TextFormatAlign = 1

    Constant; aligns text to the end edge of a line. Same as right for left-to-right languages and same as left for right-to-left languages.

    diff --git a/openfl/text/TextLineMetrics.html b/openfl/text/TextLineMetrics.html index 82c3b71..7a153be 100644 --- a/openfl/text/TextLineMetrics.html +++ b/openfl/text/TextLineMetrics.html @@ -1,7 +1,7 @@ -openfl.text.TextLineMetrics - API Referenceopenfl.text.TextLineMetrics - OpenFL API Reference
    API Reference
    View source

    class TextLineMetrics

    package openfl.text

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The TextLineMetrics class contains information about the text position and +

    View source

    class TextLineMetrics

    package openfl.text

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The TextLineMetrics class contains information about the text position and measurements of a line of text within a text field. All measurements are in pixels. Objects of this class are returned by the openfl.text.TextField.getLineMetrics() method. diff --git a/openfl/text/engine/FontPosture.html b/openfl/text/engine/FontPosture.html index aa0e66a..5f607b1 100644 --- a/openfl/text/engine/FontPosture.html +++ b/openfl/text/engine/FontPosture.html @@ -1,7 +1,7 @@ -openfl.text.engine.FontPosture - API Referenceopenfl.text.engine.FontPosture - OpenFL API Reference

    View source

    enum abstract FontPosture(Null<Int>)

    package openfl.text.engine

    @:enum

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The FontPosture class is an enumeration of constant values used with +

    View source

    enum abstract FontPosture(Null<Int>)

    package openfl.text.engine

    @:enum

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The FontPosture class is an enumeration of constant values used with FontDescription.fontPosture and StageText.fontPostures to set text to italic or normal.

    See also:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyITALIC:FontPosture = 0

    Used to indicate italic font posture.

    @:value(cast 1)@:impl@:enuminlineread onlyNORMAL:FontPosture = 1

    Used to indicate normal font posture.

    \ No newline at end of file diff --git a/openfl/text/engine/FontWeight.html b/openfl/text/engine/FontWeight.html index 978a014..3070ff8 100644 --- a/openfl/text/engine/FontWeight.html +++ b/openfl/text/engine/FontWeight.html @@ -1,7 +1,7 @@ -openfl.text.engine.FontWeight - API Referenceopenfl.text.engine.FontWeight - OpenFL API Reference
    View source

    enum abstract FontWeight(Null<Int>)

    package openfl.text.engine

    @:enum

    Available on AIR, Android, Flash, Linux, Neko, Windows, iOS, macOS

    The FontWeight class is an enumeration of constant values used with +

    View source

    enum abstract FontWeight(Null<Int>)

    package openfl.text.engine

    @:enum

    Available on AIR, Android, HashLink, Linux, Neko, Windows, iOS, macOS

    The FontWeight class is an enumeration of constant values used with FontDescription.fontWeight and StageText.fontWeight to set text to bold or normal.

    See also:

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyBOLD:FontWeight = 0

    Used to indicate bold font weight.

    @:value(cast 1)@:impl@:enuminlineread onlyNORMAL:FontWeight = 1

    Used to indicate normal font weight.

    \ No newline at end of file diff --git a/openfl/text/engine/index.html b/openfl/text/engine/index.html index 1da1d53..fe9a454 100644 --- a/openfl/text/engine/index.html +++ b/openfl/text/engine/index.html @@ -1,7 +1,7 @@ -openfl.text.engine - API Reference

    openfl.text.engine

    -
    ..
    FontPosture

    The FontPosture class is an enumeration of constant values used with +

    openfl.text.engine

    ..
    FontPosture

    The FontPosture class is an enumeration of constant values used with FontDescription.fontPosture and StageText.fontPostures to set text to italic or normal.

    FontWeight

    The FontWeight class is an enumeration of constant values used with FontDescription.fontWeight and StageText.fontWeight to set text to bold diff --git a/openfl/text/index.html b/openfl/text/index.html index 34d929b..7877385 100644 --- a/openfl/text/index.html +++ b/openfl/text/index.html @@ -1,7 +1,7 @@ -openfl.text - API Reference

    openfl.text

    -
    ..
    engine
    AntiAliasType

    The AntiAliasType class provides values for anti-aliasing in the +

    openfl.text

    Here are some selections from the OpenFL Developer's Guide to help you get started with the openfl.text package:

    ..
    engine
    AntiAliasType

    The AntiAliasType class provides values for anti-aliasing in the openfl.text.TextField class.

    AutoCapitalize

    The AutoCapitalize class defines constants for the autoCapitalize property of the StageText class.

    Font

    The Font class is used to manage embedded fonts in SWF files. Embedded fonts are represented as a subclass of the Font class. The Font class is @@ -101,11 +68,11 @@

    package ::full::

    property on the text input control.

    StageText

    The StageText class is used to present the user with a native text input field.

    StageTextClearButtonMode

    The StageTextClearButtonMode class defines the values to use for the clearButtonMode property of the StageText class.

    StageTextInitOptions

    The StageTextInitOptions class defines the options available for initializing a StageText object.

    StaticText

    This class represents StaticText objects on the display list. You cannot -create a StaticText object using ActionScript. Only the authoring tool can +create a StaticText object using Haxe code. Only the authoring tool can create a StaticText object. An attempt to create a new StaticText object generates an ArgumentError. -To create a reference to an existing static text field in ActionScript -3.0, you can iterate over the items in the display list. For example, the +To create a reference to an existing static text field in Haxe code, +you can iterate over the items in the display list. For example, the following snippet checks to see if the display list contains a static text field and assigns the field to a variable:

    StyleSheet

    The StyleSheet class lets you create a StyleSheet object that contains text formatting rules for font size, color, and other styles. You can then apply styles defined by a style sheet to @@ -118,7 +85,7 @@

    package ::full::

    Label, Text, TextArea, and TextInput controls to process text. <ph outputclass="flashonly">You can give a text field an instance name in the Property inspector and use the methods and properties of the TextField -class to manipulate it with ActionScript. TextField instance names are +class to manipulate it with Haxe code. TextField instance names are displayed in the Movie Explorer and in the Insert Target Path dialog box in the Actions panel.

    TextFieldAutoSize

    The TextFieldAutoSize class is an enumeration of constant values used in setting the autoSize property of the TextField class.

    TextFieldType

    The TextFieldType class is an enumeration of constant values used in diff --git a/openfl/ui/GameInput.html b/openfl/ui/GameInput.html index 79650bf..b436fca 100644 --- a/openfl/ui/GameInput.html +++ b/openfl/ui/GameInput.html @@ -1,7 +1,7 @@ -openfl.ui.GameInput - API Referenceopenfl.ui.GameInput - OpenFL API Reference

    View source

    final class GameInput

    package openfl.ui

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.ui.GameInputControl)@:access(openfl.ui.GameInputDevice)@:final

    Available on all platforms

    The GameInput class is the entry point into the GameInput API. You can use this API to +

    View source

    final class GameInput

    package openfl.ui

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.ui.GameInputControl)@:access(openfl.ui.GameInputDevice)@:final

    Available on all platforms

    The GameInput class is the entry point into the GameInput API. You can use this API to manage the communications between an application and game input devices (for example: joysticks, gamepads, and wands).

    The main purpose of this class is to provide access to the supported input devices that diff --git a/openfl/ui/GameInputControl.html b/openfl/ui/GameInputControl.html index 373cc99..d7990ea 100644 --- a/openfl/ui/GameInputControl.html +++ b/openfl/ui/GameInputControl.html @@ -1,7 +1,7 @@ -openfl.ui.GameInputControl - API Reference

    View source

    class GameInputControl

    package openfl.ui

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Variables

    read onlydevice:GameInputDevice

    Returns the GameInputDevice object that contains this control.

    read onlyid:String

    Returns the id of this control.

    read onlymaxValue:Float

    Returns the maximum value for this control.

    read onlyminValue:Float

    Returns the minimum value for this control.

    read onlyvalue:Float

    Returns the value for this control.

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that +

    View source

    class GameInputControl

    package openfl.ui

    extends EventDispatcher

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Variables

    read onlydevice:GameInputDevice

    Returns the GameInputDevice object that contains this control.

    read onlyid:String

    Returns the id of this control.

    read onlymaxValue:Float

    Returns the maximum value for this control.

    read onlyminValue:Float

    Returns the minimum value for this control.

    read onlyvalue:Float

    Returns the value for this control.

    Inherited Variables

    Inherited Methods

    Defined by EventDispatcher

    @:value({ useWeakReference : false, priority : 0, useCapture : false })addEventListener<T>(type:EventType<T>, listener:T ‑> Void, useCapture:Bool = false, priority:Int = 0, useWeakReference:Bool = false):Void

    Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. You can register event listeners on all nodes in the display list for a specific type of event, phase, and priority.

    @@ -125,7 +125,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/ui/GameInputDevice.html b/openfl/ui/GameInputDevice.html index 58236fb..3006540 100644 --- a/openfl/ui/GameInputDevice.html +++ b/openfl/ui/GameInputDevice.html @@ -1,7 +1,7 @@ -openfl.ui.GameInputDevice - API Reference

    View source

    final class GameInputDevice

    package openfl.ui

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.ui.GameInputControl)@:final

    Available on all platforms

    Static variables

    @:value(32000)staticinlineread onlyMAX_BUFFER_SIZE:Int = 32000

    Specifies the maximum size for the buffer used to cache sampled control values. +

    View source

    final class GameInputDevice

    package openfl.ui

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.ui.GameInputControl)@:final

    Available on all platforms

    Static variables

    @:value(32000)staticinlineread onlyMAX_BUFFER_SIZE:Int = 32000

    Specifies the maximum size for the buffer used to cache sampled control values. If startCachingSamples returns samples that require more memory than you specify, it throws a memory error.

    Variables

    enabled:Bool

    Enables or disables this device.

    read onlyid:String

    Returns the ID of this device.

    read onlyname:String

    Returns the name of this device.

    read onlynumControls:Int

    Returns the number of controls on this device.

    sampleInterval:Int

    Specifies the rate (in milliseconds) at which to retrieve control values.

    Methods

    @:value({ append : false })getCachedSamples(data:ByteArray, append:Bool = false):Int

    Writes cached sample values to the ByteArray. @return

    Parameters:

    data
    append

    getControlAt(i:Int):GameInputControl

    Retrieves a specific control from a device. diff --git a/openfl/ui/KeyLocation.html b/openfl/ui/KeyLocation.html index 505f330..07b75e3 100644 --- a/openfl/ui/KeyLocation.html +++ b/openfl/ui/KeyLocation.html @@ -1,7 +1,7 @@ -openfl.ui.KeyLocation - API Referenceopenfl.ui.KeyLocation - OpenFL API Reference

    View source

    enum abstract KeyLocation(Int)

    package openfl.ui

    from Int, UInt to Int, UInt

    @:enum

    Available on all platforms

    The KeyLocation class contains constants that indicate the location of a +

    View source

    enum abstract KeyLocation(Int)

    package openfl.ui

    from Int, UInt to Int, UInt

    @:enum

    Available on all platforms

    The KeyLocation class contains constants that indicate the location of a key pressed on the keyboard or keyboard-like input device. The KeyLocation constants are used in the KeyboardEvent.keyLocation property.

    Variables

    @:value(cast 1)@:impl@:enuminlineread onlyLEFT:KeyLocation = 1

    Indicates the key activated is in the left key location (there is more diff --git a/openfl/ui/Keyboard.html b/openfl/ui/Keyboard.html index 55cfb71..944e01d 100644 --- a/openfl/ui/Keyboard.html +++ b/openfl/ui/Keyboard.html @@ -1,7 +1,7 @@ -openfl.ui.Keyboard - API Referenceopenfl.ui.Keyboard - OpenFL API Reference

    API Reference
    View source

    final class Keyboard

    package openfl.ui

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The Keyboard class is used to build an interface that can be controlled by +

    View source

    final class Keyboard

    package openfl.ui

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The Keyboard class is used to build an interface that can be controlled by a user with a standard keyboard. You can use the methods and properties of the Keyboard class without using a constructor. The properties of the Keyboard class are constants representing the keys that are most commonly -used to control games.

    Static variables

    @:value(65)staticinlineread onlyA:Int = 65

    Constant associated with the key code value for the A key(65).

    @:value(18)staticinlineread onlyALTERNATE:Int = 18

    Constant associated with the key code value for the Alternate(Option) key -(18).

    @:value(66)staticinlineread onlyB:Int = 66

    Constant associated with the key code value for the B key(66).

    @:value(192)staticinlineread onlyBACKQUOTE:Int = 192

    Constant associated with the key code value for the ` key(192).

    @:value(220)staticinlineread onlyBACKSLASH:Int = 220

    Constant associated with the key code value for the \ key(220).

    @:value(8)staticinlineread onlyBACKSPACE:Int = 8

    Constant associated with the key code value for the Backspace key(8).

    @:value(67)staticinlineread onlyC:Int = 67

    Constant associated with the key code value for the C key(67).

    @:value(20)staticinlineread onlyCAPS_LOCK:Int = 20

    Constant associated with the key code value for the Caps Lock key(20).

    @:value(188)staticinlineread onlyCOMMA:Int = 188

    Constant associated with the key code value for the , key(188).

    @:value(15)staticinlineread onlyCOMMAND:Int = 15

    Constant associated with the Mac command key(15). This constant is +used to control games.

    See also:

    Static variables

    @:value(65)staticinlineread onlyA:Int = 65

    Constant associated with the key code value for the A key(65).

    @:value(18)staticinlineread onlyALTERNATE:Int = 18

    Constant associated with the key code value for the Alternate (Option) key +(18).

    @:value(66)staticinlineread onlyB:Int = 66

    Constant associated with the key code value for the B key(66).

    @:value(192)staticinlineread onlyBACKQUOTE:Int = 192

    Constant associated with the key code value for the ` key(192).

    @:value(220)staticinlineread onlyBACKSLASH:Int = 220

    Constant associated with the key code value for the \ key(220).

    @:value(8)staticinlineread onlyBACKSPACE:Int = 8

    Constant associated with the key code value for the Backspace key(8).

    @:value(67)staticinlineread onlyC:Int = 67

    Constant associated with the key code value for the C key(67).

    @:value(20)staticinlineread onlyCAPS_LOCK:Int = 20

    Constant associated with the key code value for the Caps Lock key(20).

    @:value(188)staticinlineread onlyCOMMA:Int = 188

    Constant associated with the key code value for the , key(188).

    @:value(15)staticinlineread onlyCOMMAND:Int = 15

    Constant associated with the Mac command key (15). This constant is currently only used for setting menu key equivalents.

    @:value(17)staticinlineread onlyCONTROL:Int = 17

    Constant associated with the key code value for the Control key(17).

    @:value(68)staticinlineread onlyD:Int = 68

    Constant associated with the key code value for the D key(68).

    @:value(46)staticinlineread onlyDELETE:Int = 46

    Constant associated with the key code value for the Delete key(46).

    @:value(40)staticinlineread onlyDOWN:Int = 40

    Constant associated with the key code value for the Down Arrow key(40).

    @:value(69)staticinlineread onlyE:Int = 69

    Constant associated with the key code value for the E key(69).

    @:value(35)staticinlineread onlyEND:Int = 35

    Constant associated with the key code value for the End key(35).

    @:value(13)staticinlineread onlyENTER:Int = 13

    Constant associated with the key code value for the Enter key(13).

    @:value(187)staticinlineread onlyEQUAL:Int = 187

    Constant associated with the key code value for the:Int = key(187).

    @:value(27)staticinlineread onlyESCAPE:Int = 27

    Constant associated with the key code value for the Escape key(27).

    @:value(70)staticinlineread onlyF:Int = 70

    Constant associated with the key code value for the F key(70).

    @:value(112)staticinlineread onlyF1:Int = 112

    Constant associated with the key code value for the F1 key(112).

    @:value(121)staticinlineread onlyF10:Int = 121

    Constant associated with the key code value for the F10 key(121).

    @:value(122)staticinlineread onlyF11:Int = 122

    Constant associated with the key code value for the F11 key(122).

    @:value(123)staticinlineread onlyF12:Int = 123

    Constant associated with the key code value for the F12 key(123).

    @:value(124)staticinlineread onlyF13:Int = 124

    Constant associated with the key code value for the F13 key(124).

    @:value(125)staticinlineread onlyF14:Int = 125

    Constant associated with the key code value for the F14 key(125).

    @:value(126)staticinlineread onlyF15:Int = 126

    Constant associated with the key code value for the F15 key(126).

    @:value(113)staticinlineread onlyF2:Int = 113

    Constant associated with the key code value for the F2 key(113).

    @:value(114)staticinlineread onlyF3:Int = 114

    Constant associated with the key code value for the F3 key(114).

    @:value(115)staticinlineread onlyF4:Int = 115

    Constant associated with the key code value for the F4 key(115).

    @:value(116)staticinlineread onlyF5:Int = 116

    Constant associated with the key code value for the F5 key(116).

    @:value(117)staticinlineread onlyF6:Int = 117

    Constant associated with the key code value for the F6 key(117).

    @:value(118)staticinlineread onlyF7:Int = 118

    Constant associated with the key code value for the F7 key(118).

    @:value(119)staticinlineread onlyF8:Int = 119

    Constant associated with the key code value for the F8 key(119).

    @:value(120)staticinlineread onlyF9:Int = 120

    Constant associated with the key code value for the F9 key(120).

    @:value(71)staticinlineread onlyG:Int = 71

    Constant associated with the key code value for the G key(71).

    @:value(72)staticinlineread onlyH:Int = 72

    Constant associated with the key code value for the H key(72).

    @:value(36)staticinlineread onlyHOME:Int = 36

    Constant associated with the key code value for the Home key(36).

    @:value(73)staticinlineread onlyI:Int = 73

    Constant associated with the key code value for the I key(73).

    @:value(45)staticinlineread onlyINSERT:Int = 45

    Constant associated with the key code value for the Insert key(45).

    @:value(74)staticinlineread onlyJ:Int = 74

    Constant associated with the key code value for the J key(74).

    @:value(75)staticinlineread onlyK:Int = 75

    Constant associated with the key code value for the K key(75).

    @:value(76)staticinlineread onlyL:Int = 76

    Constant associated with the key code value for the L key(76).

    @:value(37)staticinlineread onlyLEFT:Int = 37

    Constant associated with the key code value for the Left Arrow key(37).

    @:value(219)staticinlineread onlyLEFTBRACKET:Int = 219

    Constant associated with the key code value for the [ key(219).

    @:value(77)staticinlineread onlyM:Int = 77

    Constant associated with the key code value for the M key(77).

    @:value(189)staticinlineread onlyMINUS:Int = 189

    Constant associated with the key code value for the - key(189).

    @:value(78)staticinlineread onlyN:Int = 78

    Constant associated with the key code value for the N key(78).

    @:value(48)staticinlineread onlyNUMBER_0:Int = 48

    Constant associated with the key code value for the 0 key(48).

    @:value(49)staticinlineread onlyNUMBER_1:Int = 49

    Constant associated with the key code value for the 1 key(49).

    @:value(50)staticinlineread onlyNUMBER_2:Int = 50

    Constant associated with the key code value for the 2 key(50).

    @:value(51)staticinlineread onlyNUMBER_3:Int = 51

    Constant associated with the key code value for the 3 key(51).

    @:value(52)staticinlineread onlyNUMBER_4:Int = 52

    Constant associated with the key code value for the 4 key(52).

    @:value(53)staticinlineread onlyNUMBER_5:Int = 53

    Constant associated with the key code value for the 5 key(53).

    @:value(54)staticinlineread onlyNUMBER_6:Int = 54

    Constant associated with the key code value for the 6 key(54).

    @:value(55)staticinlineread onlyNUMBER_7:Int = 55

    Constant associated with the key code value for the 7 key(55).

    @:value(56)staticinlineread onlyNUMBER_8:Int = 56

    Constant associated with the key code value for the 8 key(56).

    @:value(57)staticinlineread onlyNUMBER_9:Int = 57

    Constant associated with the key code value for the 9 key(57).

    @:value(21)staticinlineread onlyNUMPAD:Int = 21

    Constant associated with the pseudo-key code for the the number pad(21). Use to set numpad modifier on key equivalents

    @:value(96)staticinlineread onlyNUMPAD_0:Int = 96

    Constant associated with the key code value for the number 0 key on the number pad(96).

    @:value(97)staticinlineread onlyNUMPAD_1:Int = 97

    Constant associated with the key code value for the number 1 key on the @@ -79,8 +79,8 @@ number pad(111).

    @:value(108)staticinlineread onlyNUMPAD_ENTER:Int = 108

    Constant associated with the key code value for the Enter key on the number pad(108).

    @:value(106)staticinlineread onlyNUMPAD_MULTIPLY:Int = 106

    Constant associated with the key code value for the multiplication key on the number pad(106).

    @:value(109)staticinlineread onlyNUMPAD_SUBTRACT:Int = 109

    Constant associated with the key code value for the subtraction key on the -number pad(109).

    @:value(79)staticinlineread onlyO:Int = 79

    Constant associated with the key code value for the O key(79).

    @:value(80)staticinlineread onlyP:Int = 80

    Constant associated with the key code value for the P key(80).

    @:value(34)staticinlineread onlyPAGE_DOWN:Int = 34

    Constant associated with the key code value for the Page Down key(34).

    @:value(33)staticinlineread onlyPAGE_UP:Int = 33

    Constant associated with the key code value for the Page Up key(33).

    @:value(190)staticinlineread onlyPERIOD:Int = 190

    Constant associated with the key code value for the . key(190).

    @:value(81)staticinlineread onlyQ:Int = 81

    Constant associated with the key code value for the Q key(81).

    @:value(222)staticinlineread onlyQUOTE:Int = 222

    Constant associated with the key code value for the ' key(222).

    @:value(82)staticinlineread onlyR:Int = 82

    Constant associated with the key code value for the R key(82).

    @:value(39)staticinlineread onlyRIGHT:Int = 39

    Constant associated with the key code value for the Right Arrow key(39).

    @:value(221)staticinlineread onlyRIGHTBRACKET:Int = 221

    Constant associated with the key code value for the ] key(221).

    @:value(83)staticinlineread onlyS:Int = 83

    Constant associated with the key code value for the S key(83).

    @:value(186)staticinlineread onlySEMICOLON:Int = 186

    Constant associated with the key code value for the ; key(186).

    @:value(16)staticinlineread onlySHIFT:Int = 16

    Constant associated with the key code value for the Shift key(16).

    @:value(191)staticinlineread onlySLASH:Int = 191

    Constant associated with the key code value for the / key(191).

    @:value(32)staticinlineread onlySPACE:Int = 32

    Constant associated with the key code value for the Spacebar(32).

    @:value(84)staticinlineread onlyT:Int = 84

    Constant associated with the key code value for the T key(84).

    @:value(9)staticinlineread onlyTAB:Int = 9

    Constant associated with the key code value for the Tab key(9).

    @:value(85)staticinlineread onlyU:Int = 85

    Constant associated with the key code value for the U key(85).

    @:value(38)staticinlineread onlyUP:Int = 38

    Constant associated with the key code value for the Up Arrow key(38).

    @:value(86)staticinlineread onlyV:Int = 86

    Constant associated with the key code value for the V key(85).

    @:value(87)staticinlineread onlyW:Int = 87

    Constant associated with the key code value for the W key(87).

    @:value(88)staticinlineread onlyX:Int = 88

    Constant associated with the key code value for the X key(88).

    @:value(89)staticinlineread onlyY:Int = 89

    Constant associated with the key code value for the Y key(89).

    @:value(90)staticinlineread onlyZ:Int = 90

    Constant associated with the key code value for the Z key(90).

    staticread onlycapsLock:Bool

    Specifies whether the Caps Lock key is activated(true) or -not(false).

    staticread onlynumLock:Bool

    Specifies whether the Num Lock key is activated(true) or not +number pad(109).

    @:value(79)staticinlineread onlyO:Int = 79

    Constant associated with the key code value for the O key(79).

    @:value(80)staticinlineread onlyP:Int = 80

    Constant associated with the key code value for the P key(80).

    @:value(34)staticinlineread onlyPAGE_DOWN:Int = 34

    Constant associated with the key code value for the Page Down key(34).

    @:value(33)staticinlineread onlyPAGE_UP:Int = 33

    Constant associated with the key code value for the Page Up key(33).

    @:value(190)staticinlineread onlyPERIOD:Int = 190

    Constant associated with the key code value for the . key(190).

    @:value(81)staticinlineread onlyQ:Int = 81

    Constant associated with the key code value for the Q key(81).

    @:value(222)staticinlineread onlyQUOTE:Int = 222

    Constant associated with the key code value for the ' key(222).

    @:value(82)staticinlineread onlyR:Int = 82

    Constant associated with the key code value for the R key(82).

    @:value(39)staticinlineread onlyRIGHT:Int = 39

    Constant associated with the key code value for the Right Arrow key(39).

    @:value(221)staticinlineread onlyRIGHTBRACKET:Int = 221

    Constant associated with the key code value for the ] key(221).

    @:value(83)staticinlineread onlyS:Int = 83

    Constant associated with the key code value for the S key(83).

    @:value(186)staticinlineread onlySEMICOLON:Int = 186

    Constant associated with the key code value for the ; key(186).

    @:value(16)staticinlineread onlySHIFT:Int = 16

    Constant associated with the key code value for the Shift key(16).

    @:value(191)staticinlineread onlySLASH:Int = 191

    Constant associated with the key code value for the / key(191).

    @:value(32)staticinlineread onlySPACE:Int = 32

    Constant associated with the key code value for the Spacebar(32).

    @:value(84)staticinlineread onlyT:Int = 84

    Constant associated with the key code value for the T key(84).

    @:value(9)staticinlineread onlyTAB:Int = 9

    Constant associated with the key code value for the Tab key(9).

    @:value(85)staticinlineread onlyU:Int = 85

    Constant associated with the key code value for the U key(85).

    @:value(38)staticinlineread onlyUP:Int = 38

    Constant associated with the key code value for the Up Arrow key(38).

    @:value(86)staticinlineread onlyV:Int = 86

    Constant associated with the key code value for the V key(85).

    @:value(87)staticinlineread onlyW:Int = 87

    Constant associated with the key code value for the W key(87).

    @:value(88)staticinlineread onlyX:Int = 88

    Constant associated with the key code value for the X key(88).

    @:value(89)staticinlineread onlyY:Int = 89

    Constant associated with the key code value for the Y key(89).

    @:value(90)staticinlineread onlyZ:Int = 90

    Constant associated with the key code value for the Z key(90).

    staticread onlycapsLock:Bool

    Specifies whether the Caps Lock key is activated (true) or +not (false).

    staticread onlynumLock:Bool

    Specifies whether the Num Lock key is activated (true) or not (false).

    Static methods

    staticisAccessible():Bool

    Specifies whether the last key pressed is accessible by other SWF files. By default, security restrictions prevent code from a SWF file in one domain from accessing a keystroke generated from a SWF file in another diff --git a/openfl/ui/Mouse.html b/openfl/ui/Mouse.html index 2c326b4..62ad99d 100644 --- a/openfl/ui/Mouse.html +++ b/openfl/ui/Mouse.html @@ -1,7 +1,7 @@ -openfl.ui.Mouse - API Referenceopenfl.ui.Mouse - OpenFL API Reference

    API Reference
    View source

    final class Mouse

    package openfl.ui

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Stage)@:final

    Available on all platforms

    The methods of the Mouse class are used to hide and show the mouse pointer, +

    View source

    final class Mouse

    package openfl.ui

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Stage)@:final

    Available on all platforms

    The methods of the Mouse class are used to hide and show the mouse pointer, or to set the pointer to a specific style. The Mouse class is a top-level class whose properties and methods you can access without using a constructor. The pointer is visible by default, diff --git a/openfl/ui/MouseCursor.html b/openfl/ui/MouseCursor.html index 4df5f6b..648a034 100644 --- a/openfl/ui/MouseCursor.html +++ b/openfl/ui/MouseCursor.html @@ -1,7 +1,7 @@ -openfl.ui.MouseCursor - API Referenceopenfl.ui.MouseCursor - OpenFL API Reference

    View source

    enum abstract MouseCursor(String)

    package openfl.ui

    from String, to String,

    @:enum

    Available on all platforms

    The MouseCursor class is an enumeration of constant values used in setting +

    View source

    enum abstract MouseCursor(String)

    package openfl.ui

    from String, to String,

    @:enum

    Available on all platforms

    The MouseCursor class is an enumeration of constant values used in setting the cursor property of the Mouse class.

    Variables

    @:value(cast "arrow")@:impl@:enuminlineread onlyARROW:MouseCursor = "arrow"

    Used to specify that the arrow cursor should be used.

    @:value(cast "auto")@:impl@:enuminlineread onlyAUTO:MouseCursor = "auto"

    Used to specify that the cursor should be selected automatically based on the object under the mouse.

    @:value(cast "button")@:impl@:enuminlineread onlyBUTTON:MouseCursor = "button"

    Used to specify that the button pressing hand cursor should be used.

    @:value(cast "hand")@:impl@:enuminlineread onlyHAND:MouseCursor = "hand"

    Used to specify that the dragging hand cursor should be used.

    @:value(cast "ibeam")@:impl@:enuminlineread onlyIBEAM:MouseCursor = "ibeam"

    Used to specify that the I-beam cursor should be used.

    \ No newline at end of file diff --git a/openfl/ui/Multitouch.html b/openfl/ui/Multitouch.html index 03bee1e..b16389b 100644 --- a/openfl/ui/Multitouch.html +++ b/openfl/ui/Multitouch.html @@ -1,9 +1,9 @@ -openfl.ui.Multitouch - API Referenceopenfl.ui.Multitouch - OpenFL API Reference
    API Reference
    View source

    final class Multitouch

    package openfl.ui

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The Multitouch class manages and provides information about the current +

    View source

    final class Multitouch

    package openfl.ui

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:final

    Available on all platforms

    The Multitouch class manages and provides information about the current environment's support for handling contact from user input devices, -including contact that has two or more touch points(such as a user's +including contact that has two or more touch points (such as a user's fingers on a touch screen). When a user interacts with a device such as a mobile phone or tablet with a touch screen, the user typically touches the screen with his or her fingers or a pointing device. While there is a broad @@ -85,20 +85,20 @@ Multitouch class to determine the current environment's support for touch interaction, and to manage the support of touch interaction if the current environment supports touch input.

    -

    You cannot create a Multitouch object directly from ActionScript code. +

    You cannot create a Multitouch object directly from Haxe code. If you call new Multitouch(), an exception is thrown.

    Note: The Multitouch feature is not supported for SWF files embedded in HTML running on Mac OS.

    Static variables

    staticinputMode:MultitouchInputMode

    Identifies the multi-touch mode for touch and gesture event handling. Use this property to manage whether or not events are dispatched as touch events with multiple points of contact and specific events for different gestures(such as rotation and pan), or only a single point of contact -(such as tap), or none at all(contact is handled as a mouse event). To +(such as tap), or none at all (contact is handled as a mouse event). To set this property, use values from the openfl.ui.MultitouchInputMode class.

    staticread onlymaxTouchPoints:Int

    The maximum number of concurrent touch points supported by the current -environment.

    staticread onlysupportedGestures:Vector<String>

    A Vector array(a typed array of string values) of multi-touch contact +environment.

    staticread onlysupportedGestures:Vector<String>

    A Vector array (a typed array of string values) of multi-touch contact types supported in the current environment. The array of strings can be used as event types to register event listeners. Possible values are constants from the GestureEvent, PressAndTapGestureEvent, and -TransformGestureEvent classes(such as GESTURE_PAN).

    +TransformGestureEvent classes (such as GESTURE_PAN).

    If the Flash runtime is in an environment that does not support any multi-touch gestures, the value is null.

    Note: For Mac OS 10.5.3 and later, diff --git a/openfl/ui/MultitouchInputMode.html b/openfl/ui/MultitouchInputMode.html index 4aa33ce..4afe27c 100644 --- a/openfl/ui/MultitouchInputMode.html +++ b/openfl/ui/MultitouchInputMode.html @@ -1,7 +1,7 @@ -openfl.ui.MultitouchInputMode - API Referenceopenfl.ui.MultitouchInputMode - OpenFL API Reference

    View source

    enum abstract MultitouchInputMode(Null<Int>)

    package openfl.ui

    @:enum

    Available on all platforms

    The MultitouchInputMode class provides values for the +

    View source

    enum abstract MultitouchInputMode(Null<Int>)

    package openfl.ui

    @:enum

    Available on all platforms

    The MultitouchInputMode class provides values for the inputMode property in the openfl.ui.Multitouch class. These values set the type of touch events the Flash runtime dispatches when the user interacts with a touch-enabled device.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyGESTURE:MultitouchInputMode = 0

    Specifies that TransformGestureEvent, PressAndTapGestureEvent, and GestureEvent events are dispatched for the related user interaction -supported by the current environment, and other touch events(such as a +supported by the current environment, and other touch events (such as a simple tap) are interpreted as mouse events.

    @:value(cast 1)@:impl@:enuminlineread onlyNONE:MultitouchInputMode = 1

    Specifies that all user contact with a touch-enabled device is interpreted as a type of mouse event.

    @:value(cast 2)@:impl@:enuminlineread onlyTOUCH_POINT:MultitouchInputMode = 2

    Specifies that all user contact with a touch-enabled device is interpreted as a type of mouse event.

    \ No newline at end of file diff --git a/openfl/ui/index.html b/openfl/ui/index.html index 9f5f636..b7619fd 100644 --- a/openfl/ui/index.html +++ b/openfl/ui/index.html @@ -1,7 +1,7 @@ -openfl.ui - API Reference

    openfl.ui

    -
    ..
    GameInput

    The GameInput class is the entry point into the GameInput API. You can use this API to +

    openfl.ui

    ..
    GameInput

    The GameInput class is the entry point into the GameInput API. You can use this API to manage the communications between an application and game input devices (for example: joysticks, gamepads, and wands).

    GameInputControl

    GameInputDevice

    KeyLocation

    The KeyLocation class contains constants that indicate the location of a key pressed on the keyboard or keyboard-like input device. @@ -101,7 +68,7 @@

    package ::full::

    but you can hide it and implement a custom pointer.

    MouseCursor

    The MouseCursor class is an enumeration of constant values used in setting the cursor property of the Mouse class.

    Multitouch

    The Multitouch class manages and provides information about the current environment's support for handling contact from user input devices, -including contact that has two or more touch points(such as a user's +including contact that has two or more touch points (such as a user's fingers on a touch screen). When a user interacts with a device such as a mobile phone or tablet with a touch screen, the user typically touches the screen with his or her fingers or a pointing device. While there is a broad diff --git a/openfl/utils/AGALMiniAssembler.html b/openfl/utils/AGALMiniAssembler.html index 7908f34..9622839 100644 --- a/openfl/utils/AGALMiniAssembler.html +++ b/openfl/utils/AGALMiniAssembler.html @@ -1,7 +1,7 @@ -openfl.utils.AGALMiniAssembler - API Reference

    View source

    class AGALMiniAssembler

    package openfl.utils

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@SuppressWarnings(["checkstyle:ConstantName", "checkstyle:FieldDocComment"])

    Available on all platforms

    Constructor

    @:value({ debugging : false })new(debugging:Bool = false)

    Variables

    read onlyagalcode:ByteArray

    read onlyerror:String

    verbose:Bool

    Methods

    @:value({ ignoreLimits : false, version : 1 })assemble(mode:String, source:String, version:Int = 1, ignoreLimits:Bool = false):ByteArray

    assemble2(context3D:Context3D, version:Int, vertexSource:String, fragmentSource:String):Program3D

    \ No newline at end of file +
    View source

    class AGALMiniAssembler

    package openfl.utils

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@SuppressWarnings(["checkstyle:ConstantName", "checkstyle:FieldDocComment"])

    Available on all platforms

    Constructor

    @:value({ debugging : false })new(debugging:Bool = false)

    Variables

    read onlyagalcode:ByteArray

    read onlyerror:String

    verbose:Bool

    Methods

    @:value({ ignoreLimits : false, version : 1 })assemble(mode:String, source:String, version:Int = 1, ignoreLimits:Bool = false):ByteArray

    assemble2(context3D:Context3D, version:Int, vertexSource:String, fragmentSource:String):Program3D

    \ No newline at end of file diff --git a/openfl/utils/AssetBundle.html b/openfl/utils/AssetBundle.html index 5953df9..447b183 100644 --- a/openfl/utils/AssetBundle.html +++ b/openfl/utils/AssetBundle.html @@ -1,7 +1,7 @@ -openfl.utils.AssetBundle - API Reference
    View source

    typedef AssetBundle

    package openfl.utils

    Available on all platforms

    Alias

    alias for AssetBundle
    \ No newline at end of file +
    View source

    typedef AssetBundle

    package openfl.utils

    Available on all platforms

    Alias

    alias for AssetBundle
    \ No newline at end of file diff --git a/openfl/utils/AssetCache.html b/openfl/utils/AssetCache.html index 51eee98..616e899 100644 --- a/openfl/utils/AssetCache.html +++ b/openfl/utils/AssetCache.html @@ -1,7 +1,7 @@ -openfl.utils.AssetCache - API Referenceopenfl.utils.AssetCache - OpenFL API Reference
    View source

    class AssetCache

    package openfl.utils

    implements IAssetCache

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The AssetCache class is the default cache implementation used +

    View source

    class AssetCache

    package openfl.utils

    implements IAssetCache

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The AssetCache class is the default cache implementation used by openfl.utils.Assets, objects will be cached for the lifetime of the application unless removed explicitly, or using Assets unloadLibrary

    Constructor

    new()

    Creates a new AssetCache instance.

    Variables

    enabled:Bool

    Whether caching is currently enabled.

    Methods

    @:value({ prefix : null })clear(?prefix:String):Void

    Clears all cached assets, or all assets with an ID that diff --git a/openfl/utils/AssetLibrary.html b/openfl/utils/AssetLibrary.html index 0f6baa2..d4b0851 100644 --- a/openfl/utils/AssetLibrary.html +++ b/openfl/utils/AssetLibrary.html @@ -1,7 +1,7 @@ -openfl.utils.AssetLibrary - API Reference

    View source

    class AssetLibrary

    package openfl.utils

    extends AssetLibrary

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Static methods

    staticfromBundle(bundle:AssetBundle):AssetLibrary

    @:value({ rootPath : null })staticfromBytes(bytes:ByteArray, ?rootPath:String):AssetLibrary

    @:value({ rootPath : null })staticfromFile(path:String, ?rootPath:String):AssetLibrary

    staticfromManifest(manifest:AssetManifest):AssetLibrary

    @:value({ rootPath : null })staticloadFromBytes(bytes:ByteArray, ?rootPath:String):Future<AssetLibrary>

    @:value({ rootPath : null })staticloadFromFile(path:String, ?rootPath:String):Future<AssetLibrary>

    staticloadFromManifest(manifest:AssetManifest):Future<AssetLibrary>

    Constructor

    new()

    Methods

    @:value({ instance : null })bind(className:String, ?instance:Dynamic):Bool

    getMovieClip(id:String):MovieClip

    loadMovieClip(id:String):Future<MovieClip>

    \ No newline at end of file +
    View source

    class AssetLibrary

    package openfl.utils

    extends AssetLibrary

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Static methods

    staticfromBundle(bundle:AssetBundle):AssetLibrary

    @:value({ rootPath : null })staticfromBytes(bytes:ByteArray, ?rootPath:String):AssetLibrary

    @:value({ rootPath : null })staticfromFile(path:String, ?rootPath:String):AssetLibrary

    staticfromManifest(manifest:AssetManifest):AssetLibrary

    @:value({ rootPath : null })staticloadFromBytes(bytes:ByteArray, ?rootPath:String):Future<AssetLibrary>

    @:value({ rootPath : null })staticloadFromFile(path:String, ?rootPath:String):Future<AssetLibrary>

    staticloadFromManifest(manifest:AssetManifest):Future<AssetLibrary>

    Constructor

    new()

    Methods

    @:value({ instance : null })bind(className:String, ?instance:Dynamic):Bool

    getMovieClip(id:String):MovieClip

    loadMovieClip(id:String):Future<MovieClip>

    \ No newline at end of file diff --git a/openfl/utils/AssetManifest.html b/openfl/utils/AssetManifest.html index 6cdf5bf..16598f6 100644 --- a/openfl/utils/AssetManifest.html +++ b/openfl/utils/AssetManifest.html @@ -1,7 +1,7 @@ -openfl.utils.AssetManifest - API Reference
    View source

    class AssetManifest

    package openfl.utils

    extends AssetManifest

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Static methods

    @:value({ rootPath : null })staticfromBytes(bytes:Bytes, ?rootPath:String):AssetManifest

    @:value({ rootPath : null })staticfromFile(path:String, ?rootPath:String):AssetManifest

    @:value({ rootPath : null })staticloadFromBytes(bytes:Bytes, ?rootPath:String):Future<AssetManifest>

    @:value({ rootPath : null })staticloadFromFile(path:String, ?rootPath:String):Future<AssetManifest>

    @:value({ rootPath : null })staticparse(data:String, ?rootPath:String):AssetManifest

    Constructor

    new()

    Methods

    @:value({ id : null })addBitmapData(path:String, ?id:String):Void

    @:value({ id : null })addBytes(path:String, ?id:String):Void

    @:value({ id : null })addFont(name:String, ?id:String):Void

    @:value({ id : null })addSound(paths:Array<String>, ?id:String):Void

    @:value({ id : null })addText(path:String, ?id:String):Void

    \ No newline at end of file +
    View source

    class AssetManifest

    package openfl.utils

    extends AssetManifest

    @:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    Static methods

    @:value({ rootPath : null })staticfromBytes(bytes:Bytes, ?rootPath:String):AssetManifest

    @:value({ rootPath : null })staticfromFile(path:String, ?rootPath:String):AssetManifest

    @:value({ rootPath : null })staticloadFromBytes(bytes:Bytes, ?rootPath:String):Future<AssetManifest>

    @:value({ rootPath : null })staticloadFromFile(path:String, ?rootPath:String):Future<AssetManifest>

    @:value({ rootPath : null })staticparse(data:String, ?rootPath:String):AssetManifest

    Constructor

    new()

    Methods

    @:value({ id : null })addBitmapData(path:String, ?id:String):Void

    @:value({ id : null })addBytes(path:String, ?id:String):Void

    @:value({ id : null })addFont(name:String, ?id:String):Void

    @:value({ id : null })addSound(paths:Array<String>, ?id:String):Void

    @:value({ id : null })addText(path:String, ?id:String):Void

    \ No newline at end of file diff --git a/openfl/utils/AssetType.html b/openfl/utils/AssetType.html index fac79e7..16a0c72 100644 --- a/openfl/utils/AssetType.html +++ b/openfl/utils/AssetType.html @@ -1,7 +1,7 @@ -openfl.utils.AssetType - API Referenceopenfl.utils.AssetType - OpenFL API Reference
    View source

    enum abstract AssetType(String)

    package openfl.utils

    @:enum

    Available on all platforms

    The AssetType enum lists the core set of available +

    View source

    enum abstract AssetType(String)

    package openfl.utils

    @:enum

    Available on all platforms

    The AssetType enum lists the core set of available asset types from the OpenFL command-line tools.

    Variables

    @:value(cast "BINARY")@:impl@:enuminlineread onlyBINARY:AssetType = "BINARY"

    Binary assets (data that is not readable as text)

    @:value(cast "FONT")@:impl@:enuminlineread onlyFONT:AssetType = "FONT"

    Font assets, such as .ttf or .otf files

    @:value(cast "IMAGE")@:impl@:enuminlineread onlyIMAGE:AssetType = "IMAGE"

    Image assets, such as .png or .jpg files

    @:value(cast "MOVIE_CLIP")@:impl@:enuminlineread onlyMOVIE_CLIP:AssetType = "MOVIE_CLIP"

    MovieClip assets, such as from a *.swf file

    @:value(cast "MUSIC")@:impl@:enuminlineread onlyMUSIC:AssetType = "MUSIC"

    Audio assets, such as .ogg or .wav files

    In previous versions of OpenFL, AssetType.MUSIC was recommended for long background music, but in current versions, both diff --git a/openfl/utils/Assets.html b/openfl/utils/Assets.html index 49c8093..8649fb7 100644 --- a/openfl/utils/Assets.html +++ b/openfl/utils/Assets.html @@ -1,7 +1,7 @@ -openfl.utils.Assets - API Referenceopenfl.utils.Assets - OpenFL API Reference

    View source

    class Assets

    package openfl.utils

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.BitmapData)@:access(openfl.display.Sprite)@:access(openfl.text.Font)@:access(openfl.utils.AssetLibrary)

    Available on all platforms

    The Assets class provides a cross-platform interface to access +

    View source

    class Assets

    package openfl.utils

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.BitmapData)@:access(openfl.display.Sprite)@:access(openfl.text.Font)@:access(openfl.utils.AssetLibrary)

    Available on all platforms

    The Assets class provides a cross-platform interface to access embedded images, fonts, sounds and other resource files.

    The contents are populated automatically when an application is compiled using the OpenFL command-line tools, based on the diff --git a/openfl/utils/ByteArray.html b/openfl/utils/ByteArray.html index 718af21..5312f99 100644 --- a/openfl/utils/ByteArray.html +++ b/openfl/utils/ByteArray.html @@ -1,7 +1,7 @@ -openfl.utils.ByteArray - API Referenceopenfl.utils.ByteArray - OpenFL API Reference

    View source

    abstract ByteArray(ByteArrayData)

    package openfl.utils

    from ByteArrayData, to ByteArrayData,

    @:access(haxe.io.Bytes)@:access(openfl.utils.ByteArrayData)@:transitive

    Available on all platforms

    The ByteArray class provides methods and properties to optimize reading, +

    View source

    abstract ByteArray(ByteArrayData)

    package openfl.utils

    from ByteArrayData, to ByteArrayData,

    @:access(haxe.io.Bytes)@:access(openfl.utils.ByteArrayData)@:transitive

    Available on all platforms

    The ByteArray class provides methods and properties to optimize reading, writing, and working with binary data.

    Note: The ByteArray class is for advanced developers who need to access data on the byte level.

    @@ -68,7 +68,7 @@ type, then compare with ByteArrayData, such as Std.is (ba, ByteArrayData).

    In addition, all platforms support zlib compression and decompression, as well as additional formats for object serialization.

    -

    Possible uses of the ByteArray class include the following:

    • Creating a custom protocol to connect to a server.
    • Writing your own URLEncoder/URLDecoder.
    • Writing your own AMF/Remoting packet.
    • Optimizing the size of your data by using data types.
    • Working with binary data loaded from a local file.
    • Supporting new binary file formats.

    Static variables

    staticread onlybytesAvailable:UInt

    The number of bytes of data available for reading from the current +

    Possible uses of the ByteArray class include the following:

    • Creating a custom protocol to connect to a server.
    • Writing your own URLEncoder/URLDecoder.
    • Writing your own AMF/Remoting packet.
    • Optimizing the size of your data by using data types.
    • Working with binary data loaded from a local file.
    • Supporting new binary file formats.

    See also:

    Static variables

    staticread onlybytesAvailable:UInt

    The number of bytes of data available for reading from the current position in the byte array to the end of the array.

    Use the bytesAvailable property in conjunction with the read methods each time you access a ByteArray object to ensure that you @@ -88,15 +88,15 @@ between platforms.

    When an object is written to or read from binary data, the objectEncoding value is used to determine whether the -Haxe, JavaScript, ActionScript 3.0, ActionScript 2.0 or ActionScript 1.0 +Haxe Serialization Format, JSON, AMF0, or AMF3 format should be used. The value is a constant from the ObjectEncoding class.

    staticendian:Endian

    Changes or reads the byte order for the data; either Endian.BIG_ENDIAN or Endian.LITTLE_ENDIAN.

    staticlength:UInt

    The length of the ByteArray object, in bytes.

    If the length is set to a value that is larger than the current length, the right side of the byte array is filled with zeros.

    If the length is set to a value that is smaller than the current -length, the byte array is truncated.

    staticobjectEncoding:ObjectEncoding

    Used to determine whether the ActionScript 3.0, ActionScript 2.0, or -ActionScript 1.0 format should be used when writing to, or reading from, a +length, the byte array is truncated.

    staticobjectEncoding:ObjectEncoding

    Used to determine whether the Haxe Serialization Format, JSON, AMF0, +or AMF3 format should be used when writing to, or reading from, a ByteArray instance. The value is a constant from the ObjectEncoding class.

    On the Flash and AIR targets, support for Action Message Format (AMF) object serialization is included in the Flash runtime. For other targets, AMF @@ -114,7 +114,7 @@ and position properties to 0. Calling this method explicitly frees up the memory used by the ByteArray instance.

    @:value({ algorithm : null })staticinlinecompress(this:ByteArrayData, ?algorithm:CompressionAlgorithm):Void

    Compresses the byte array. The entire byte array is compressed. For content running in Adobe AIR, you can specify a compression algorithm by -passing a value(defined in the CompressionAlgorithm class) as the +passing a value (defined in the CompressionAlgorithm class) as the algorithm parameter. Flash Player supports only the default algorithm, zlib.

    After the call, the length property of the ByteArray is @@ -128,7 +128,7 @@ formats, such as zlib, gzip, some zip implementations, and others. When data is compressed using one of those compression formats, in addition to storing the compressed version of the original data, the compression -format data(for example, the .zip file) includes metadata information. +format data (for example, the .zip file) includes metadata information. Some examples of the types of metadata included in various file formats are file name, file modification date/time, original file size, optional comments, checksum data, and more.

    @@ -136,7 +136,7 @@ the resulting ByteArray is structured in a specific format. Certain bytes contain metadata about the compressed data, while other bytes contain the actual compressed version of the original ByteArray data. As defined by -the zlib compressed data format specification, those bytes(that is, the +the zlib compressed data format specification, those bytes (that is, the portion containing the compressed version of the original data) are compressed using the deflate algorithm. Consequently those bytes are identical to the result of calling compress(<ph @@ -198,18 +198,19 @@ thread using callbacks attached to a returned Future object.

    Parameters:

    path

    A local file path or web address

    Returns:

    A Future ByteArray

    staticinlinereadBoolean(this:ByteArrayData):Bool

    Reads a Boolean value from the byte stream. A single byte is read, and true is returned if the byte is nonzero, false otherwise.

    Returns:

    Returns true if the byte is nonzero, -false otherwise.

    Throws:

    EOFError

    There is not sufficient data available to read.

    staticinlinereadByte(this:ByteArrayData):Int

    Reads a signed byte from the byte stream.

    -

    The returned value is in the range -128 to 127.

    Returns:

    An integer between -128 and 127.

    Throws:

    EOFError

    There is not sufficient data available to read.

    @:value({ length : 0, offset : 0 })staticinlinereadBytes(this:ByteArrayData, bytes:ByteArray, offset:UInt = 0, length:UInt = 0):Void

    Reads the number of data bytes, specified by the length +false otherwise.

    Throws:

    EOFError

    There is not sufficient data available to read.

    See also:

    staticinlinereadByte(this:ByteArrayData):Int

    Reads a signed byte from the byte stream.

    +

    The returned value is in the range -128 to 127.

    Returns:

    An integer between -128 and 127.

    Throws:

    EOFError

    There is not sufficient data available to read.

    See also:

    @:value({ length : 0, offset : 0 })staticinlinereadBytes(this:ByteArrayData, bytes:ByteArray, offset:UInt = 0, length:UInt = 0):Void

    Reads the number of data bytes, specified by the length parameter, from the byte stream. The bytes are read into the ByteArray object specified by the bytes parameter, and the bytes are written into the destination ByteArray starting at the position specified -by offset.

    Parameters:

    bytes

    The ByteArray object to read data into.

    offset

    The offset(position) in bytes at which the +by offset.

    Parameters:

    bytes

    The ByteArray object to read data into.

    offset

    The offset (position) in bytes at which the read data should be written.

    length

    The number of bytes to read. The default value of 0 causes all available data to be read.

    Throws:

    EOFError

    There is not sufficient data available to read.

    RangeError

    The value of the supplied offset and length, combined, -is greater than the maximum for a uint.

    staticinlinereadDouble(this:ByteArrayData):Float

    Reads an IEEE 754 double-precision(64-bit) floating-point number from the -byte stream.

    Returns:

    A double-precision(64-bit) floating-point number.

    Throws:

    EOFError

    There is not sufficient data available to read.

    staticinlinereadFloat(this:ByteArrayData):Float

    Reads an IEEE 754 single-precision(32-bit) floating-point number from the -byte stream.

    Returns:

    A single-precision(32-bit) floating-point number.

    Throws:

    EOFError

    There is not sufficient data available to read.

    staticinlinereadInt(this:ByteArrayData):Int

    Reads a signed 32-bit integer from the byte stream.

    -

    The returned value is in the range -2147483648 to 2147483647.

    Returns:

    A 32-bit signed integer between -2147483648 and 2147483647.

    Throws:

    EOFError

    There is not sufficient data available to read.

    staticinlinereadMultiByte(this:ByteArrayData, length:UInt, charSet:String):String

    Reads a multibyte string of specified length from the byte stream using +is greater than the maximum for a uint.

    See also:

    staticinlinereadDouble(this:ByteArrayData):Float

    Reads an IEEE 754 double-precision(64-bit) floating-point number from the +byte stream.

    Returns:

    A double-precision(64-bit) floating-point number.

    Throws:

    EOFError

    There is not sufficient data available to read.

    See also:

    staticinlinereadFloat(this:ByteArrayData):Float

    Reads an IEEE 754 single-precision(32-bit) floating-point number from the +byte stream.

    Returns:

    A single-precision(32-bit) floating-point number.

    Throws:

    EOFError

    There is not sufficient data available to read.

    See also:

    staticinlinereadInt(this:ByteArrayData):Int

    Reads a signed 32-bit integer from the byte stream.

    +

    The returned value is in the range -2147483648 to 2147483647.

    Returns:

    A 32-bit signed integer between -2147483648 and 2147483647.

    Throws:

    EOFError

    There is not sufficient data available to read.

    See also:

    staticinlinereadInt64(this:ByteArrayData):Int64

    Reads a signed 64-bit integer from the byte stream. +The returned value is in the range −9223372036854775808 to 9223372036854775807.

    Returns:

    A 64-bit signed integer between −9223372036854775808 to 9223372036854775807.

    Throws:

    EOFError

    There is not sufficient data available to read.

    staticinlinereadMultiByte(this:ByteArrayData, length:UInt, charSet:String):String

    Reads a multibyte string of specified length from the byte stream using the specified character set.

    Parameters:

    length

    The number of bytes from the byte stream to read.

    charSet

    The string denoting the character set to use to interpret the bytes. Possible character set strings include "shift-jis", "cn-gb", @@ -225,18 +226,18 @@ uses 01 instead of 1 might work on your development system, but not on another system. On the other system, the application will use the system's -default code page.

    Returns:

    UTF-8 encoded string.

    Throws:

    EOFError

    There is not sufficient data available to read.

    staticinlinereadObject(this:ByteArrayData):Dynamic

    Reads an object from the byte array, encoded in AMF serialized format.

    Returns:

    The deserialized object.

    Throws:

    EOFError

    There is not sufficient data available to read.

    staticinlinereadShort(this:ByteArrayData):Int

    Reads a signed 16-bit integer from the byte stream.

    -

    The returned value is in the range -32768 to 32767.

    Returns:

    A 16-bit signed integer between -32768 and 32767.

    Throws:

    EOFError

    There is not sufficient data available to read.

    staticinlinereadUTF(this:ByteArrayData):String

    Reads a UTF-8 string from the byte stream. The string is assumed to be -prefixed with an unsigned short indicating the length in bytes.

    Returns:

    UTF-8 encoded string.

    Throws:

    EOFError

    There is not sufficient data available to read.

    staticinlinereadUTFBytes(this:ByteArrayData, length:UInt):String

    Reads a sequence of UTF-8 bytes specified by the length -parameter from the byte stream and returns a string.

    Parameters:

    length

    An unsigned short indicating the length of the UTF-8 bytes.

    Returns:

    A string composed of the UTF-8 bytes of the specified length.

    Throws:

    EOFError

    There is not sufficient data available to read.

    staticinlinereadUnsignedByte(this:ByteArrayData):UInt

    Reads an unsigned byte from the byte stream.

    -

    The returned value is in the range 0 to 255.

    Returns:

    A 32-bit unsigned integer between 0 and 255.

    Throws:

    EOFError

    There is not sufficient data available to read.

    staticinlinereadUnsignedInt(this:ByteArrayData):UInt

    Reads an unsigned 32-bit integer from the byte stream.

    -

    The returned value is in the range 0 to 4294967295.

    Returns:

    A 32-bit unsigned integer between 0 and 4294967295.

    Throws:

    EOFError

    There is not sufficient data available to read.

    staticinlinereadUnsignedShort(this:ByteArrayData):UInt

    Reads an unsigned 16-bit integer from the byte stream.

    -

    The returned value is in the range 0 to 65535.

    Returns:

    A 16-bit unsigned integer between 0 and 65535.

    Throws:

    EOFError

    There is not sufficient data available to read.

    staticinlinetoString(this:ByteArrayData):String

    Converts the byte array to a string. If the data in the array begins with +default code page.

    Returns:

    UTF-8 encoded string.

    Throws:

    EOFError

    There is not sufficient data available to read.

    See also:

    staticinlinereadObject(this:ByteArrayData):Dynamic

    Reads an object from the byte array, encoded in AMF serialized format.

    Returns:

    The deserialized object.

    Throws:

    EOFError

    There is not sufficient data available to read.

    See also:

    staticinlinereadShort(this:ByteArrayData):Int

    Reads a signed 16-bit integer from the byte stream.

    +

    The returned value is in the range -32768 to 32767.

    Returns:

    A 16-bit signed integer between -32768 and 32767.

    Throws:

    EOFError

    There is not sufficient data available to read.

    See also:

    staticinlinereadUTF(this:ByteArrayData):String

    Reads a UTF-8 string from the byte stream. The string is assumed to be +prefixed with an unsigned short indicating the length in bytes.

    Returns:

    UTF-8 encoded string.

    Throws:

    EOFError

    There is not sufficient data available to read.

    See also:

    staticinlinereadUTFBytes(this:ByteArrayData, length:UInt):String

    Reads a sequence of UTF-8 bytes specified by the length +parameter from the byte stream and returns a string.

    Parameters:

    length

    An unsigned short indicating the length of the UTF-8 bytes.

    Returns:

    A string composed of the UTF-8 bytes of the specified length.

    Throws:

    EOFError

    There is not sufficient data available to read.

    See also:

    staticinlinereadUnsignedByte(this:ByteArrayData):UInt

    Reads an unsigned byte from the byte stream.

    +

    The returned value is in the range 0 to 255.

    Returns:

    A 32-bit unsigned integer between 0 and 255.

    Throws:

    EOFError

    There is not sufficient data available to read.

    See also:

    staticinlinereadUnsignedInt(this:ByteArrayData):UInt

    Reads an unsigned 32-bit integer from the byte stream.

    +

    The returned value is in the range 0 to 4294967295.

    Returns:

    A 32-bit unsigned integer between 0 and 4294967295.

    Throws:

    EOFError

    There is not sufficient data available to read.

    See also:

    staticinlinereadUnsignedShort(this:ByteArrayData):UInt

    Reads an unsigned 16-bit integer from the byte stream.

    +

    The returned value is in the range 0 to 65535.

    Returns:

    A 16-bit unsigned integer between 0 and 65535.

    Throws:

    EOFError

    There is not sufficient data available to read.

    See also:

    staticinlinetoString(this:ByteArrayData):String

    Converts the byte array to a string. If the data in the array begins with a Unicode byte order mark, the application will honor that mark when converting to a string. If System.useCodePage is set to true, the application will treat the data in the array as being in the current system code page when converting.

    Returns:

    The string representation of the byte array.

    @:value({ algorithm : null })staticinlineuncompress(this:ByteArrayData, ?algorithm:CompressionAlgorithm):Void

    Decompresses the byte array. For content running in Adobe AIR, you can -specify a compression algorithm by passing a value(defined in the +specify a compression algorithm by passing a value (defined in the CompressionAlgorithm class) as the algorithm parameter. The byte array must have been compressed using the same algorithm. Flash Player supports only the default algorithm, zlib.

    @@ -256,11 +257,12 @@ compressed with the same compression algorithm used to compress.

    staticinlinewriteBoolean(this:ByteArrayData, value:Bool):Void

    Writes a Boolean value. A single byte is written according to the value parameter, either 1 if true or 0 if -false.

    Parameters:

    value

    A Boolean value determining which byte is written. If the +false.

    +

    @see Reading and writing a byte array

    Parameters:

    value

    A Boolean value determining which byte is written. If the parameter is true, the method writes a 1; if false, the method writes a 0.

    staticinlinewriteByte(this:ByteArrayData, value:Int):Void

    Writes a byte to the byte stream.

    The low 8 bits of the parameter are used. The high 24 bits are ignored.

    Parameters:

    value

    A 32-bit integer. The low 8 bits are written to the byte -stream.

    @:value({ length : 0, offset : 0 })staticinlinewriteBytes(this:ByteArrayData, bytes:ByteArray, offset:UInt = 0, length:UInt = 0):Void

    Writes a sequence of length bytes from the specified byte +stream.

    See also:

    @:value({ length : 0, offset : 0 })staticinlinewriteBytes(this:ByteArrayData, bytes:ByteArray, offset:UInt = 0, length:UInt = 0):Void

    Writes a sequence of length bytes from the specified byte array, bytes, starting offset(zero-based index) bytes into the byte stream.

    If the length parameter is omitted, the default length of @@ -270,18 +272,18 @@

    If offset or length is out of range, they are clamped to the beginning and end of the bytes array.

    Parameters:

    bytes

    The ByteArray object.

    offset

    A zero-based index indicating the position into the array to begin writing.

    length

    An unsigned integer indicating how far into the buffer to -write.

    staticinlinewriteDouble(this:ByteArrayData, value:Float):Void

    Writes an IEEE 754 double-precision(64-bit) floating-point number to the -byte stream.

    Parameters:

    value

    A double-precision(64-bit) floating-point number.

    staticinlinewriteFloat(this:ByteArrayData, value:Float):Void

    Writes an IEEE 754 single-precision(32-bit) floating-point number to the -byte stream.

    Parameters:

    value

    A single-precision(32-bit) floating-point number.

    staticinlinewriteInt(this:ByteArrayData, value:Int):Void

    Writes a 32-bit signed integer to the byte stream.

    Parameters:

    value

    An integer to write to the byte stream.

    staticinlinewriteMultiByte(this:ByteArrayData, value:String, charSet:String):Void

    Writes a multibyte string to the byte stream using the specified character +write.

    See also:

    staticinlinewriteDouble(this:ByteArrayData, value:Float):Void

    Writes an IEEE 754 double-precision(64-bit) floating-point number to the +byte stream.

    Parameters:

    value

    A double-precision(64-bit) floating-point number.

    See also:

    staticinlinewriteFloat(this:ByteArrayData, value:Float):Void

    Writes an IEEE 754 single-precision(32-bit) floating-point number to the +byte stream.

    Parameters:

    value

    A single-precision(32-bit) floating-point number.

    See also:

    staticinlinewriteInt(this:ByteArrayData, value:Int):Void

    Writes a 32-bit signed integer to the byte stream.

    Parameters:

    value

    An integer to write to the byte stream.

    See also:

    staticinlinewriteInt64(this:ByteArrayData, value:Int64):Void

    Writes a 64-bit signed integer to the byte stream.

    Parameters:

    value

    An integer to write to the byte stream.

    staticinlinewriteMultiByte(this:ByteArrayData, value:String, charSet:String):Void

    Writes a multibyte string to the byte stream using the specified character set.

    Parameters:

    value

    The string value to be written.

    charSet

    The string denoting the character set to use. Possible character set strings include "shift-jis", "cn-gb", "iso-8859-1", and others. For a complete list, see <a href="../../charset-codes.html">Supported Character -Sets.

    staticinlinewriteObject(this:ByteArrayData, object:Dynamic):Void

    Writes an object into the byte array in AMF serialized format.

    Parameters:

    object

    The object to serialize.

    staticinlinewriteShort(this:ByteArrayData, value:Int):Void

    Writes a 16-bit integer to the byte stream. The low 16 bits of the +Sets.

    See also:

    staticinlinewriteObject(this:ByteArrayData, object:Dynamic):Void

    Writes an object into the byte array in AMF serialized format.

    Parameters:

    object

    The object to serialize.

    See also:

    staticinlinewriteShort(this:ByteArrayData, value:Int):Void

    Writes a 16-bit integer to the byte stream. The low 16 bits of the parameter are used. The high 16 bits are ignored.

    Parameters:

    value

    32-bit integer, whose low 16 bits are written to the byte -stream.

    staticinlinewriteUTF(this:ByteArrayData, value:String):Void

    Writes a UTF-8 string to the byte stream. The length of the UTF-8 string +stream.

    See also:

    staticinlinewriteUTF(this:ByteArrayData, value:String):Void

    Writes a UTF-8 string to the byte stream. The length of the UTF-8 string in bytes is written first, as a 16-bit integer, followed by the bytes -representing the characters of the string.

    Parameters:

    value

    The string value to be written.

    Throws:

    RangeError

    If the length is larger than 65535.

    staticinlinewriteUTFBytes(this:ByteArrayData, value:String):Void

    Writes a UTF-8 string to the byte stream. Similar to the +representing the characters of the string.

    Parameters:

    value

    The string value to be written.

    Throws:

    RangeError

    If the length is larger than 65535.

    See also:

    staticinlinewriteUTFBytes(this:ByteArrayData, value:String):Void

    Writes a UTF-8 string to the byte stream. Similar to the writeUTF() method, but writeUTFBytes() does not -prefix the string with a 16-bit length word.

    Parameters:

    value

    The string value to be written.

    staticinlinewriteUnsignedInt(this:ByteArrayData, value:UInt):Void

    Writes a 32-bit unsigned integer to the byte stream.

    Parameters:

    value

    An unsigned integer to write to the byte stream.

    \ No newline at end of file +prefix the string with a 16-bit length word.

    Parameters:

    value

    The string value to be written.

    See also:

    staticinlinewriteUnsignedInt(this:ByteArrayData, value:UInt):Void

    Writes a 32-bit unsigned integer to the byte stream.

    Parameters:

    value

    An unsigned integer to write to the byte stream.

    See also:

    \ No newline at end of file diff --git a/openfl/utils/CompressionAlgorithm.html b/openfl/utils/CompressionAlgorithm.html index 581b2b4..03f0341 100644 --- a/openfl/utils/CompressionAlgorithm.html +++ b/openfl/utils/CompressionAlgorithm.html @@ -1,7 +1,7 @@ -openfl.utils.CompressionAlgorithm - API Referenceopenfl.utils.CompressionAlgorithm - OpenFL API Reference
    View source

    enum abstract CompressionAlgorithm(Null<Int>)

    package openfl.utils

    @:enum

    Available on all platforms

    The CompressionAlgorithm class defines string constants for the names of +

    View source

    enum abstract CompressionAlgorithm(Null<Int>)

    package openfl.utils

    @:enum

    Available on all platforms

    The CompressionAlgorithm class defines string constants for the names of compress and uncompress options. These constants are used as values of the algorithm parameter of the ByteArray.compress() and ByteArray.uncompress() methods.

    Variables

    @:value(cast 0)@:impl@:enuminlineread onlyDEFLATE:CompressionAlgorithm = 0

    Defines the string to use for the deflate compression algorithm.

    @:value(cast 1)@:impl@:enuminlineread onlyLZMA:CompressionAlgorithm = 1

    @:value(cast 2)@:impl@:enuminlineread onlyZLIB:CompressionAlgorithm = 2

    Defines the string to use for the zlib compression algorithm.

    \ No newline at end of file diff --git a/openfl/utils/Dictionary.html b/openfl/utils/Dictionary.html index f06301f..7187914 100644 --- a/openfl/utils/Dictionary.html +++ b/openfl/utils/Dictionary.html @@ -1,7 +1,7 @@ -openfl.utils.Dictionary - API Referenceopenfl.utils.Dictionary - OpenFL API Reference
    API Reference
    View source

    abstract Dictionary<K, V>(IMap<K, V>)

    package openfl.utils

    @:multiType(K)

    Available on all platforms

    The Dictionary class lets you create a dynamic collection of properties, +

    View source

    abstract Dictionary<K, V>(IMap<K, V>)

    package openfl.utils

    @:multiType(K)

    Available on all platforms

    The Dictionary class lets you create a dynamic collection of properties, which uses strict equality (===) for key comparison. When an object is used as a key, the object's identity is used to look up the object, and not the value returned from calling toString() on it. diff --git a/openfl/utils/Endian.html b/openfl/utils/Endian.html index 8db980c..e1968f2 100644 --- a/openfl/utils/Endian.html +++ b/openfl/utils/Endian.html @@ -1,7 +1,7 @@ -openfl.utils.Endian - API Referenceopenfl.utils.Endian - OpenFL API Reference

    View source

    enum abstract Endian(Null<Int>)

    package openfl.utils

    @:enum

    Available on all platforms

    The Endian class contains values that denote the byte order used to +

    View source

    enum abstract Endian(Null<Int>)

    package openfl.utils

    @:enum

    Available on all platforms

    The Endian class contains values that denote the byte order used to represent multibyte numbers. The byte order is either bigEndian (most significant byte first) or littleEndian (least significant byte first).

    OpenFL content can interface with a server by using the binary protocol of diff --git a/openfl/utils/Function.html b/openfl/utils/Function.html index eac212b..708f733 100644 --- a/openfl/utils/Function.html +++ b/openfl/utils/Function.html @@ -1,7 +1,7 @@ -openfl.utils.Function - API Reference

    View source

    typedef Function

    package openfl.utils

    Available on all platforms

    Alias

    alias for Function
    \ No newline at end of file +
    View source

    typedef Function

    package openfl.utils

    Available on all platforms

    Alias

    alias for Function
    \ No newline at end of file diff --git a/openfl/utils/Future.html b/openfl/utils/Future.html index d3b3bf2..e82619e 100644 --- a/openfl/utils/Future.html +++ b/openfl/utils/Future.html @@ -1,7 +1,7 @@ -openfl.utils.Future - API Reference
    View source

    typedef Future<T>

    package openfl.utils

    Available on all platforms

    Alias

    alias for Future<T>
    \ No newline at end of file +
    View source

    typedef Future<T>

    package openfl.utils

    Available on all platforms

    Alias

    alias for Future<T>
    \ No newline at end of file diff --git a/openfl/utils/IAssetCache.html b/openfl/utils/IAssetCache.html index a6af8a7..3e4888b 100644 --- a/openfl/utils/IAssetCache.html +++ b/openfl/utils/IAssetCache.html @@ -1,7 +1,7 @@ -openfl.utils.IAssetCache - API Referenceopenfl.utils.IAssetCache - OpenFL API Reference
    View source

    interface IAssetCache

    package openfl.utils

    extended by AssetCache

    Available on all platforms

    The IAssetCache interface provides methods for caching +

    View source

    interface IAssetCache

    package openfl.utils

    extended by AssetCache

    Available on all platforms

    The IAssetCache interface provides methods for caching resources loaded from openfl.utils.Assets to improve performance.

    Variables

    enabled:Bool

    Whether caching is currently enabled.

    Methods

    @:value({ prefix : null })clear(?prefix:String):Void

    Clears all cached assets, or all assets with an ID that matches an optional prefix.

    diff --git a/openfl/utils/IDataInput.html b/openfl/utils/IDataInput.html index 03a3b9b..ce32541 100644 --- a/openfl/utils/IDataInput.html +++ b/openfl/utils/IDataInput.html @@ -1,7 +1,7 @@ -openfl.utils.IDataInput - API Referenceopenfl.utils.IDataInput - OpenFL API Reference
    View source

    interface IDataInput

    package openfl.utils

    extended by FileStream, Socket, URLStream

    Available on all platforms

    The IDataInput interface provides a set of methods for reading binary data. This +

    View source

    interface IDataInput

    package openfl.utils

    extended by FileStream, Socket, URLStream, AMF3ReaderInput

    Available on all platforms

    The IDataInput interface provides a set of methods for reading binary data. This interface is the I/O counterpart to the IDataOutput interface, which writes binary data.

    All IDataInput and IDataOutput operations are "bigEndian" by default (the most significant byte in the sequence is stored at the lowest or first storage address), and diff --git a/openfl/utils/IDataOutput.html b/openfl/utils/IDataOutput.html index 58edba9..9590d9c 100644 --- a/openfl/utils/IDataOutput.html +++ b/openfl/utils/IDataOutput.html @@ -1,7 +1,7 @@ -openfl.utils.IDataOutput - API Referenceopenfl.utils.IDataOutput - OpenFL API Reference

    View source

    interface IDataOutput

    package openfl.utils

    extended by FileStream, Socket

    Available on all platforms

    The IDataOutput interface provides a set of methods for writing binary data. This +

    View source

    interface IDataOutput

    package openfl.utils

    extended by FileStream, Socket

    Available on all platforms

    The IDataOutput interface provides a set of methods for writing binary data. This interface is the I/O counterpart to the IDataInput interface, which reads binary data. The IDataOutput interface is implemented by the FileStream, Socket and ByteArray classes.

    All IDataInput and IDataOutput operations are "bigEndian" by default (the most diff --git a/openfl/utils/IExternalizable.html b/openfl/utils/IExternalizable.html index 91810a6..66c2024 100644 --- a/openfl/utils/IExternalizable.html +++ b/openfl/utils/IExternalizable.html @@ -1,7 +1,7 @@ -openfl.utils.IExternalizable - API Referenceopenfl.utils.IExternalizable - OpenFL API Reference

    API Reference
    View source

    interface IExternalizable

    package openfl.utils

    Available on all platforms

    The IExternalizable interface provides control over serialization of a class as it is +

    View source

    interface IExternalizable

    package openfl.utils

    @:directlyUsed

    Available on all platforms

    The IExternalizable interface provides control over serialization of a class as it is encoded into a data stream. The writeExternal() and readExternal() methods of the IExternalizable interface are implemented by a class to allow customization of the contents and format of the data stream (but not the classname or type) for an object diff --git a/openfl/utils/Namespace.html b/openfl/utils/Namespace.html index c68af85..544850a 100644 --- a/openfl/utils/Namespace.html +++ b/openfl/utils/Namespace.html @@ -1,7 +1,7 @@ -openfl.utils.Namespace - API Referenceopenfl.utils.Namespace - OpenFL API Reference

    API Reference
    View source

    class Namespace

    package openfl.utils

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Namespace class contains methods and properties for defining and working +

    View source

    class Namespace

    package openfl.utils

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    The Namespace class contains methods and properties for defining and working with namespaces. There are three scenarios for using namespaces: - Namespaces of XML objects Namespaces associate a namespace prefix with a Uniform Resource Identifier (URI) that identifies the namespace. The prefix diff --git a/openfl/utils/Object.html b/openfl/utils/Object.html index 10d9527..edd54a8 100644 --- a/openfl/utils/Object.html +++ b/openfl/utils/Object.html @@ -1,7 +1,7 @@ -openfl.utils.Object - API Reference

    View source

    abstract Object(ObjectType)

    package openfl.utils

    from ObjectType, Dynamic to Dynamic,

    @:transitive@:callable

    Available on all platforms

    Static methods

    staticinlinehasOwnProperty(this:ObjectType, name:String):Bool

    staticisPrototypeOf(this:ObjectType, theClass:Class<Dynamic>):Bool

    staticinlinepropertyIsEnumerable(this:ObjectType, name:String):Bool

    staticinlinetoLocaleString(this:ObjectType):String

    @:tostaticinlinetoString(this:ObjectType):String

    staticinlinevalueOf(this:ObjectType):Object

    \ No newline at end of file +
    View source

    abstract Object(ObjectType)

    package openfl.utils

    from ObjectType, Dynamic to Dynamic,

    @:transitive@:callable

    Available on all platforms

    Static methods

    staticinlinehasOwnProperty(this:ObjectType, name:String):Bool

    staticisPrototypeOf(this:ObjectType, theClass:Class<Dynamic>):Bool

    staticinlinepropertyIsEnumerable(this:ObjectType, name:String):Bool

    staticinlinetoLocaleString(this:ObjectType):String

    @:tostaticinlinetoString(this:ObjectType):String

    staticinlinevalueOf(this:ObjectType):Object

    \ No newline at end of file diff --git a/openfl/utils/ObjectPool.html b/openfl/utils/ObjectPool.html index fb61a57..debc900 100644 --- a/openfl/utils/ObjectPool.html +++ b/openfl/utils/ObjectPool.html @@ -1,7 +1,7 @@ -openfl.utils.ObjectPool - API Reference
    View source

    typedef ObjectPool<T>

    package openfl.utils

    Available on all platforms

    Alias

    alias for ObjectPool<T>
    \ No newline at end of file +
    View source

    typedef ObjectPool<T>

    package openfl.utils

    Available on all platforms

    Alias

    alias for ObjectPool<T>
    \ No newline at end of file diff --git a/openfl/utils/PerspectiveMatrix3D.html b/openfl/utils/PerspectiveMatrix3D.html index 0238098..40431ee 100644 --- a/openfl/utils/PerspectiveMatrix3D.html +++ b/openfl/utils/PerspectiveMatrix3D.html @@ -1,7 +1,7 @@ -openfl.utils.PerspectiveMatrix3D - API Reference
    View source

    class PerspectiveMatrix3D

    package openfl.utils

    extends Matrix3D

    @SuppressWarnings("checkstyle:FieldDocComment")

    Available on all platforms

    Constructor

    @:value({ v : null })new(?v:Vector<Float>)

    Methods

    lookAtLH(eye:Vector3D, at:Vector3D, up:Vector3D):Void

    lookAtRH(eye:Vector3D, at:Vector3D, up:Vector3D):Void

    orthoLH(width:Float, height:Float, zNear:Float, zFar:Float):Void

    orthoOffCenterLH(left:Float, right:Float, bottom:Float, top:Float, zNear:Float, zFar:Float):Void

    orthoOffCenterRH(left:Float, right:Float, bottom:Float, top:Float, zNear:Float, zFar:Float):Void

    orthoRH(width:Float, height:Float, zNear:Float, zFar:Float):Void

    perspectiveFieldOfViewLH(fieldOfViewY:Float, aspectRatio:Float, zNear:Float, zFar:Float):Void

    perspectiveFieldOfViewRH(fieldOfViewY:Float, aspectRatio:Float, zNear:Float, zFar:Float):Void

    perspectiveLH(width:Float, height:Float, zNear:Float, zFar:Float):Void

    perspectiveOffCenterLH(left:Float, right:Float, bottom:Float, top:Float, zNear:Float, zFar:Float):Void

    perspectiveOffCenterRH(left:Float, right:Float, bottom:Float, top:Float, zNear:Float, zFar:Float):Void

    perspectiveRH(width:Float, height:Float, zNear:Float, zFar:Float):Void

    Inherited Variables

    Defined by Matrix3D

    read onlydeterminant:Float

    A Number that determines whether a matrix is invertible.

    +
    View source

    class PerspectiveMatrix3D

    package openfl.utils

    extends Matrix3D

    @SuppressWarnings("checkstyle:FieldDocComment")

    Available on all platforms

    Constructor

    @:value({ v : null })new(?v:Vector<Float>)

    Methods

    lookAtLH(eye:Vector3D, at:Vector3D, up:Vector3D):Void

    lookAtRH(eye:Vector3D, at:Vector3D, up:Vector3D):Void

    orthoLH(width:Float, height:Float, zNear:Float, zFar:Float):Void

    orthoOffCenterLH(left:Float, right:Float, bottom:Float, top:Float, zNear:Float, zFar:Float):Void

    orthoOffCenterRH(left:Float, right:Float, bottom:Float, top:Float, zNear:Float, zFar:Float):Void

    orthoRH(width:Float, height:Float, zNear:Float, zFar:Float):Void

    perspectiveFieldOfViewLH(fieldOfViewY:Float, aspectRatio:Float, zNear:Float, zFar:Float):Void

    perspectiveFieldOfViewRH(fieldOfViewY:Float, aspectRatio:Float, zNear:Float, zFar:Float):Void

    perspectiveLH(width:Float, height:Float, zNear:Float, zFar:Float):Void

    perspectiveOffCenterLH(left:Float, right:Float, bottom:Float, top:Float, zNear:Float, zFar:Float):Void

    perspectiveOffCenterRH(left:Float, right:Float, bottom:Float, top:Float, zNear:Float, zFar:Float):Void

    perspectiveRH(width:Float, height:Float, zNear:Float, zFar:Float):Void

    Inherited Variables

    Defined by Matrix3D

    read onlydeterminant:Float

    A Number that determines whether a matrix is invertible.

    A Matrix3D object must be invertible. You can use the determinant property to make sure that a Matrix3D object is invertible. If determinant is zero, an inverse of the matrix does not exist. For example, if an entire row or column of a matrix is @@ -171,6 +171,35 @@ are eulerAngles (constant EULER_ANGLES), axisAngle (constant AXIS_ANGLE), and quaternion (constant QUATERNION). For additional information on the different orientation style, see the geom.Orientation3D class.

    Returns:

    A Vector of three Vector3D objects, each holding the translation, +rotation, and scale settings, respectively.

    @:value({ orientationStyle : EULER_ANGLES })decomposeToOutput(orientationStyle:Orientation3D = EULER_ANGLES, ?output:Vector<Vector3D>):Vector<Vector3D>

    Returns the transformation matrix's translation, rotation, and scale settings as +a Vector of three Vector3D objects. The first Vector3D object holds the +translation elements. The second Vector3D object holds the rotation elements. +The third Vector3D object holds the scale elements.

    +

    Some Matrix3D methods, such as the interpolateTo() method, automatically +decompose and recompose the matrix to perform their transformation.

    +

    To modify the matrix's transformation with an absolute parent frame of reference, +retrieve the settings with the decompose() method and make the appropriate +changes. You can then set the Matrix3D object to the modified transformation +using the recompose() method.

    +

    The decompose() method's parameter specifies the orientation style that is +meant to be used for the transformation. The default orientation is eulerAngles, +which defines the orientation with three separate angles of rotation for each +axis. The rotations occur consecutively and do not change the axis of each other. +The display object's axis rotation properties perform Euler Angles orientation +style transformation. The other orientation style options are axisAngle and +quaternion. The Axis Angle orientation uses a combination of an axis and an +angle to determine the orientation. The axis around which the object is rotated +is a unit vector that represents a direction. The angle represents the magnitude +of the rotation about the vector. The direction also determines where a display +object is facing and the angle determines which way is up. The appendRotation() +and prependRotation() methods use the Axis Angle orientation. The quaternion +orientation uses complex numbers and the fourth element of a vector. The three +axes of rotation (x,y,z) and an angle of rotation (w) represent the orientation. +The interpolate() method uses quaternion.

    Parameters:

    orientationStyle

    An optional parameter that determines the orientation +style used for the matrix transformation. The three types of orientation style +are eulerAngles (constant EULER_ANGLES), axisAngle (constant AXIS_ANGLE), +and quaternion (constant QUATERNION). For additional information on the +different orientation style, see the geom.Orientation3D class.

    output

    An optional vector of three Vector3D objects to be used and returned to avoid the runtime creating new objects.

    Returns:

    A Vector of three Vector3D objects, each holding the translation, rotation, and scale settings, respectively.

    deltaTransformVector(v:Vector3D):Vector3D

    Uses the transformation matrix without its translation elements to transform a Vector3D object from one space coordinate to another. The returned Vector3D object holds the new coordinates after the rotation and scaling transformations @@ -188,7 +217,24 @@ You can then use the 2D points to draw the rotating 3D object.

    Note: This method automatically sets the w component of the passed Vector3D to 0.0.

    Parameters:

    v

    A Vector3D object holding the coordinates that are going to be -transformed.

    Returns:

    Vector3D A Vector3D object with the transformed coordinates.

    identity():Void

    Converts the current matrix to an identity or unit matrix. An identity matrix has +transformed.

    Returns:

    Vector3D A Vector3D object with the transformed coordinates.

    deltaTransformVectorToOutput(v:Vector3D, output:Vector3D):Vector3D

    Uses the transformation matrix without its translation elements to transform a +Vector3D object from one space coordinate to another. The returned Vector3D +object holds the new coordinates after the rotation and scaling transformations +have been applied. If the deltaTransformVector() method applies a matrix that +only contains a translation transformation, the returned Vector3D is the same as +the original Vector3D object.

    +

    You can use the deltaTransformVector() method to have a display object in one +coordinate space respond to the rotation transformation of a second display +object. The object does not copy the rotation; it only changes its position to +reflect the changes in the rotation. For example, to use the display.Graphics +API for drawing a rotating 3D display object, you must map the object's rotating +coordinates to a 2D point. First, retrieve the object's 3D coordinates after each +rotation, using the deltaTransformVector() method. Next, apply the display +object's local3DToGlobal() method to translate the 3D coordinates to 2D points. +You can then use the 2D points to draw the rotating 3D object.

    +

    Note: This method automatically sets the w component of the passed Vector3D +to 0.0.

    Parameters:

    v

    A Vector3D object holding the coordinates that are going to be +transformed.

    output

    An optional Vector3D object to be used and returned to avoid the runtime creating a new object.

    Returns:

    Vector3D A Vector3D object with the transformed coordinates.

    identity():Void

    Converts the current matrix to an identity or unit matrix. An identity matrix has a value of one for the elements on the main diagonal and a value of zero for all other elements. The result is a matrix where the rawData value is 1,0,0,0,0,1,0,0,0,0,1,0,0,0,0,1 and the rotation setting is set to @@ -381,7 +427,17 @@ rotation and scale elements remain the same.

    Note: This method automatically sets the w component of the passed Vector3D to 1.0.

    Parameters:

    v

    A Vector3D object holding the coordinates that are going to be -transformed.

    Returns:

    A Vector3D object with the transformed coordinates.

    transformVectors(vin:Vector<Float>, vout:Vector<Float>):Void

    Uses the transformation matrix to transform a Vector of Numbers from one +transformed.

    Returns:

    A Vector3D object with the transformed coordinates.

    transformVectorToOutput(v:Vector3D, output:Vector3D):Vector3D

    Uses the transformation matrix to transform a Vector3D object from one space +coordinate to another. The returned Vector3D object holds the new coordinates +after the transformation. All the matrix transformations including translation +are applied to the Vector3D object.

    +

    If the result of the transformVector() method was applied to the position of a +display object, only the display object's position changes. The display object's +rotation and scale elements remain the same.

    +

    Note: This method automatically sets the w component of the passed Vector3D +to 1.0.

    Parameters:

    v

    A Vector3D object holding the coordinates that are going to be +transformed.

    output

    An optional Vector3D object to be used and returned to +avoid the runtime creating a new object.

    Returns:

    A Vector3D object with the transformed coordinates.

    transformVectors(vin:Vector<Float>, vout:Vector<Float>):Void

    Uses the transformation matrix to transform a Vector of Numbers from one coordinate space to another. The tranformVectors() method reads every three Numbers in the vin Vector object as a 3D coordinate (x,y,z) and places a transformed 3D coordinate in the vout Vector object. All the matrix diff --git a/openfl/utils/Promise.html b/openfl/utils/Promise.html index bf90ce1..050fbfd 100644 --- a/openfl/utils/Promise.html +++ b/openfl/utils/Promise.html @@ -1,7 +1,7 @@ -openfl.utils.Promise - API Reference

    View source

    typedef Promise<T>

    package openfl.utils

    Available on all platforms

    Alias

    alias for Promise<T>
    \ No newline at end of file +
    View source

    typedef Promise<T>

    package openfl.utils

    Available on all platforms

    Alias

    alias for Promise<T>
    \ No newline at end of file diff --git a/openfl/utils/QName.html b/openfl/utils/QName.html index c041cc4..51a5dc8 100644 --- a/openfl/utils/QName.html +++ b/openfl/utils/QName.html @@ -1,7 +1,7 @@ -openfl.utils.QName - API Referenceopenfl.utils.QName - OpenFL API Reference
    API Reference
    View source

    class QName

    package openfl.utils

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    QName objects represent qualified names of XML elements and attributes. Each +

    View source

    class QName

    package openfl.utils

    @:directlyUsed@:fileXml("tags=\"haxe,release\"")@:noDebug

    Available on all platforms

    QName objects represent qualified names of XML elements and attributes. Each QName object has a local name and a namespace Uniform Resource Identifier (URI). When the value of the namespace URI is null, the QName object matches any namespace. Use the QName constructor to create a new QName diff --git a/openfl/utils/Timer.html b/openfl/utils/Timer.html index b53eaa2..56f5283 100644 --- a/openfl/utils/Timer.html +++ b/openfl/utils/Timer.html @@ -1,7 +1,7 @@ -openfl.utils.Timer - API Referenceopenfl.utils.Timer - OpenFL API Reference

    View source

    class Timer

    package openfl.utils

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Stage)@:access(openfl.events.TimerEvent)

    Available on all platforms

    The Timer class is the interface to timers, which let you run code on a +

    View source

    class Timer

    package openfl.utils

    extends EventDispatcher

    @:fileXml("tags=\"haxe,release\"")@:noDebug@:access(openfl.display.Stage)@:access(openfl.events.TimerEvent)

    Available on all platforms

    The Timer class is the interface to timers, which let you run code on a specified time sequence. Use the start() method to start a timer. Add an event listener for the timer event to set up code to be run on the timer interval.

    You can create Timer objects to run once or repeat at specified intervals to execute code on a schedule. Depending on the SWF file's -framerate or the runtime environment(available memory and other factors), +framerate or the runtime environment (available memory and other factors), the runtime may dispatch events at slightly offset intervals. For example, if a SWF file is set to play at 10 frames per second(fps), which is 100 millisecond intervals, but your timer is set to fire an event at 80 @@ -169,7 +169,7 @@ for a listener that is a nested inner function, the function will be garbage-collected and no longer persistent. If you create references to the -inner function(save it in another variable) then +inner function (save it in another variable) then it is not garbage-collected and stays persistent.

    Weak references are supported on some OpenFL diff --git a/openfl/utils/index.html b/openfl/utils/index.html index 719b509..91d8d45 100644 --- a/openfl/utils/index.html +++ b/openfl/utils/index.html @@ -1,7 +1,7 @@ -openfl.utils - API Reference

    openfl.utils

    -
    ..
    AGALMiniAssembler

    AssetBundle

    AssetCache

    The AssetCache class is the default cache implementation used +

    openfl.utils

    ..
    AGALMiniAssembler

    AssetBundle

    AssetCache

    The AssetCache class is the default cache implementation used by openfl.utils.Assets, objects will be cached for the lifetime of the application unless removed explicitly, or using Assets unloadLibrary

    AssetLibrary

    AssetManifest

    AssetType

    The AssetType enum lists the core set of available