diff --git a/static/reference/actionscript/3.0/Array.html b/static/reference/actionscript/3.0/Array.html index 9a1fa279e..894ec9d75 100644 --- a/static/reference/actionscript/3.0/Array.html +++ b/static/reference/actionscript/3.0/Array.html @@ -1307,7 +1307,7 @@ Each element is checked in turn to see if it matches the item that is passed in, - using the standard comparison operator (i.e. similar to if (array[0] == item)). + using the standard comparison operator (i.e. similar to if (array[i] == item)).

Parameters @@ -3632,11 +3632,11 @@

-Submit Feedback +Submit Feedback
-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/Function.html b/static/reference/actionscript/3.0/Function.html index 8edde76a8..dabf101ff 100644 --- a/static/reference/actionscript/3.0/Function.html +++ b/static/reference/actionscript/3.0/Function.html @@ -246,7 +246,7 @@

This can be used to find out naming and parameter details, and also determine what kind of function - the object is (anonymous function vs member fnction, etc).

+ the object is (anonymous function vs member function, etc).

Implementation
@@ -574,11 +574,11 @@

-Submit Feedback +Submit Feedback
-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 19 2024, 3:46 PM GMT
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/String.html b/static/reference/actionscript/3.0/String.html index ec19e7d3e..b65633487 100644 --- a/static/reference/actionscript/3.0/String.html +++ b/static/reference/actionscript/3.0/String.html @@ -100,6 +100,23 @@ function if you need to use undefined. +

+ + From AIR SDK version 50 (when using the ActionScript compiler from the 'normal' AIR SDK, rather than Flex or Animate), + + a "verbatim string" mechanism was added. In a normal string literal, a backslash is used as + + an escape character, so for example "\n" is used for a newline character. This behaviour can be removed if + + the string literal is preceeded by the @ character. Hence "sometimes\never" would result in + + a string split across two lines with "sometimes" and "ever", whereas @"sometimes\never" would retain the + + value as written here. This is particularly useful for strings containing file paths on Windows. + +

+ +

View the examples. @@ -2464,11 +2481,11 @@

-Submit Feedback +Submit Feedback
-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/TimeZone.html b/static/reference/actionscript/3.0/TimeZone.html index b097f9147..1b3ae3eb2 100644 --- a/static/reference/actionscript/3.0/TimeZone.html +++ b/static/reference/actionscript/3.0/TimeZone.html @@ -1,558 +1,558 @@ - - - - - - - - -TimeZone (ActionScript 3.0) - - - - - - - - - - - - - - - -
- - - - - - - - - - -
PackageTop Level
Classpublic class TimeZone
InheritanceTimeZone Inheritance Object
-

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50 - -
-

-

- - The TimeZone class provides information about timezones that can be used in date calculations - - and to find out about different locations and their time zone offsets. The information available - - will vary according to the operating system being used as the time zone objects are created based - - on APIs that are made available by the device OS. - - -

To list available time zones, use the TimeZone.availableTimeZoneNames property which will - - be initialized on first use by the operating system. Strings that are available here can then be - - used to create a TimeZone object using the TimeZone.getTimeZone method.

- - -

-
-
-
- -
-
Public Properties
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
 PropertyDefined by
  availableTimeZoneNames : Vector.<String>
[static][read-only] - - Retrieves a list of the available time zone names that can be used on this operating system.
-		TimeZone
 Inheritedconstructor : Object -
- - A reference to the class object or constructor function for a given object instance.
-		Object
  daylightSavingsOffset : int -
[read-only] - - The offset between this time zone and UTC during daylight savings, in milliseconds.
-		TimeZone
  displayName : String -
[read-only] - - The display name of this time zone.
-		TimeZone
 Inheritedprototype : Object -
[static] - - A reference to the prototype object of a class or function object.
-		Object
  rawOffset : int -
[read-only] - - The standard offset between this time zone and UTC, in milliseconds.
-		TimeZone
  usesDaylightSavings : Boolean -
[read-only] - - Whether this time zone has a daylight savings change.
-		TimeZone
-
- -
-
Public Methods
-
- - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 MethodDefined by
   -
-getOffset(date:Date):int -
-
- - The time offset between this timezone and UTC, for a particular (UTC) date.
-		TimeZone
   -
-getTimeZone(timeZoneName:String):TimeZone -
-
[static] - - Obtains a TimeZone object using a string that is found in the list of availableTimeZoneNames.
-		TimeZone
 Inherited -
-hasOwnProperty(name:String):Boolean -
-
- - Indicates whether an object has a specified property defined.
-		Object
 Inherited -
-isPrototypeOf(theClass:Object):Boolean -
-
- - Indicates whether an instance of the Object class is in the prototype chain of the object specified - - as the parameter.
-		Object
 Inherited -
-propertyIsEnumerable(name:String):Boolean -
-
- - Indicates whether the specified property exists and is enumerable.
-		Object
 Inherited -
-setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void -
-
- - Sets the availability of a dynamic property for loop operations.
-		Object
 Inherited -
-toLocaleString():String -
-
- - Returns the string representation of this object, formatted according to locale-specific conventions.
-		Object
 Inherited -
-toString():String -
-
- - Returns the string representation of the specified object.
-		Object
 Inherited -
-valueOf():Object -
-
- - Returns the primitive value of the specified object.
-		Object
-
- -
- -
Property detail
- - - - - -
availableTimeZoneNamesproperty
-
-availableTimeZoneNames:Vector.<String>  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50 - -
-

- - Retrieves a list of the available time zone names that can be used on this operating system. - - -

Implementation -
-    public static function get availableTimeZoneNames():Vector.<String> -
-
- - - - - -
daylightSavingsOffsetproperty 
-
-daylightSavingsOffset:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50 - -
-

- - The offset between this time zone and UTC during daylight savings, in milliseconds. - -

Note: if this time zone does not use daylight savings, this value will be the same - - as the value of rawOffset.

- - - Implementation -
-    public function get daylightSavingsOffset():int -
-
- - - - - -
displayNameproperty 
-
-displayName:String  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50 - -
-

- - The display name of this time zone. - - -

Implementation -
-    public function get displayName():String -
-
- - - - - -
rawOffsetproperty 
-
-rawOffset:int  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50 - -
-

- - The standard offset between this time zone and UTC, in milliseconds. - - -

Implementation -
-    public function get rawOffset():int -
-
- - - - - -
usesDaylightSavingsproperty 
-
-usesDaylightSavings:Boolean  [read-only]

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50 - -
-

- - Whether this time zone has a daylight savings change. - - -

Implementation -
-    public function get usesDaylightSavings():Boolean -
-
- -
Method detail
- - - - - -
getOffset()method
-
-public function getOffset(date:Date):int -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50 - -
-

- - The time offset between this timezone and UTC, for a particular (UTC) date. - -

Note: for any date in UTC format, there should be exactly one match for the - - offset value. Reversing this process does not always work, for example some local - - times do not exist due to clocks changing forward, and some local times happen twice - - due to the clocks changing backwards. Hence to find the correct offset, the input - - date must be in UTC format.

- - - Parameters - - - - -
date:Date — The date/time information at which to check the time offset - -
-

-Returns - - - - -
int — - The offset, in milliseconds, between GMT and local time at the given date. - - - - -
-
- - - - - -
getTimeZone()method 
-
-public static function getTimeZone(timeZoneName:String):TimeZone -

- - - - -
Language version: ActionScript 3.0 -
- - - - -
Runtime version: AIR 50 - -
-

- - Obtains a TimeZone object using a string that is found in the list of availableTimeZoneNames. - - Pass in a null string to get the TimeZone object representing the current location of the device. - - -

Parameters - - - - -
timeZoneName:String — The name of the time zone to retrieve, or null or the current device time zone. - -
-

-Returns - - - - -
TimeZone — - The TimeZone object corresponding to the requested time zone - - - - -
-
-Throws - - - - -
ArgumentError — If the requested timeZoneName is not a valid name (and isn't null) - - -
-
-
-
-
-
-

-
-
-Submit Feedback -
-
-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
-
- - - + + + + + + + + +TimeZone (ActionScript 3.0) + + + + + + + + + + + + + + + +
+ + + + + + + + + + +
PackageTop Level
Classpublic class TimeZone
InheritanceTimeZone Inheritance Object
+

+ + + + +
Language version: ActionScript 3.0 +
+ + + + +
Runtime version: AIR 50 + +
+

+

+ + The TimeZone class provides information about timezones that can be used in date calculations + + and to find out about different locations and their time zone offsets. The information available + + will vary according to the operating system being used as the time zone objects are created based + + on APIs that are made available by the device OS. + + +

To list available time zones, use the TimeZone.availableTimeZoneNames property which will + + be initialized on first use by the operating system. Strings that are available here can then be + + used to create a TimeZone object using the TimeZone.getTimeZone method.

+ + +

+
+
+
+ +
+
Public Properties
+
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
 PropertyDefined by
  availableTimeZoneNames : Vector.<String>
[static][read-only] + + Retrieves a list of the available time zone names that can be used on this operating system.
+		TimeZone
 Inheritedconstructor : Object +
+ + A reference to the class object or constructor function for a given object instance.
+		Object
  daylightSavingsOffset : int +
[read-only] + + The offset between this time zone and UTC during daylight savings, in milliseconds.
+		TimeZone
  displayName : String +
[read-only] + + The display name of this time zone.
+		TimeZone
 Inheritedprototype : Object +
[static] + + A reference to the prototype object of a class or function object.
+		Object
  rawOffset : int +
[read-only] + + The standard offset between this time zone and UTC, in milliseconds.
+		TimeZone
  usesDaylightSavings : Boolean +
[read-only] + + Whether this time zone has a daylight savings change.
+		TimeZone
+
+ +
+
Public Methods
+
+ + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 MethodDefined by
   +
+getOffset(date:Date):int +
+
+ + The time offset between this timezone and UTC, for a particular (UTC) date.
+		TimeZone
   +
+getTimeZone(timeZoneName:String):TimeZone +
+
[static] + + Obtains a TimeZone object using a string that is found in the list of availableTimeZoneNames.
+		TimeZone
 Inherited +
+hasOwnProperty(name:String):Boolean +
+
+ + Indicates whether an object has a specified property defined.
+		Object
 Inherited +
+isPrototypeOf(theClass:Object):Boolean +
+
+ + Indicates whether an instance of the Object class is in the prototype chain of the object specified + + as the parameter.
+		Object
 Inherited +
+propertyIsEnumerable(name:String):Boolean +
+
+ + Indicates whether the specified property exists and is enumerable.
+		Object
 Inherited +
+setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void +
+
+ + Sets the availability of a dynamic property for loop operations.
+		Object
 Inherited +
+toLocaleString():String +
+
+ + Returns the string representation of this object, formatted according to locale-specific conventions.
+		Object
 Inherited +
+toString():String +
+
+ + Returns the string representation of the specified object.
+		Object
 Inherited +
+valueOf():Object +
+
+ + Returns the primitive value of the specified object.
+		Object
+
+ +
+ +
Property detail
+ + + + + +
availableTimeZoneNamesproperty
+
+availableTimeZoneNames:Vector.<String>  [read-only]

+ + + + +
Language version: ActionScript 3.0 +
+ + + + +
Runtime version: AIR 50 + +
+

+ + Retrieves a list of the available time zone names that can be used on this operating system. + + +

Implementation +
+    public static function get availableTimeZoneNames():Vector.<String> +
+
+ + + + + +
daylightSavingsOffsetproperty 
+
+daylightSavingsOffset:int  [read-only]

+ + + + +
Language version: ActionScript 3.0 +
+ + + + +
Runtime version: AIR 50 + +
+

+ + The offset between this time zone and UTC during daylight savings, in milliseconds. + +

Note: if this time zone does not use daylight savings, this value will be the same + + as the value of rawOffset.

+ + + Implementation +
+    public function get daylightSavingsOffset():int +
+
+ + + + + +
displayNameproperty 
+
+displayName:String  [read-only]

+ + + + +
Language version: ActionScript 3.0 +
+ + + + +
Runtime version: AIR 50 + +
+

+ + The display name of this time zone. + + +

Implementation +
+    public function get displayName():String +
+
+ + + + + +
rawOffsetproperty 
+
+rawOffset:int  [read-only]

+ + + + +
Language version: ActionScript 3.0 +
+ + + + +
Runtime version: AIR 50 + +
+

+ + The standard offset between this time zone and UTC, in milliseconds. + + +

Implementation +
+    public function get rawOffset():int +
+
+ + + + + +
usesDaylightSavingsproperty 
+
+usesDaylightSavings:Boolean  [read-only]

+ + + + +
Language version: ActionScript 3.0 +
+ + + + +
Runtime version: AIR 50 + +
+

+ + Whether this time zone has a daylight savings change. + + +

Implementation +
+    public function get usesDaylightSavings():Boolean +
+
+ +
Method detail
+ + + + + +
getOffset()method
+
+public function getOffset(date:Date):int +

+ + + + +
Language version: ActionScript 3.0 +
+ + + + +
Runtime version: AIR 50 + +
+

+ + The time offset between this timezone and UTC, for a particular (UTC) date. + +

Note: for any date in UTC format, there should be exactly one match for the + + offset value. Reversing this process does not always work, for example some local + + times do not exist due to clocks changing forward, and some local times happen twice + + due to the clocks changing backwards. Hence to find the correct offset, the input + + date must be in UTC format.

+ + + Parameters + + + + +
date:Date — The date/time information at which to check the time offset + +
+

+Returns + + + + +
int — + The offset, in milliseconds, between GMT and local time at the given date. + + + + +
+
+ + + + + +
getTimeZone()method 
+
+public static function getTimeZone(timeZoneName:String):TimeZone +

+ + + + +
Language version: ActionScript 3.0 +
+ + + + +
Runtime version: AIR 50 + +
+

+ + Obtains a TimeZone object using a string that is found in the list of availableTimeZoneNames. + + Pass in a null string to get the TimeZone object representing the current location of the device. + + +

Parameters + + + + +
timeZoneName:String — The name of the time zone to retrieve, or null for the current device time zone. + +
+

+Returns + + + + +
TimeZone — + The TimeZone object corresponding to the requested time zone + + + + +
+
+Throws + + + + +
ArgumentError — If the requested timeZoneName is not a valid name (and isn't null) + + +
+
+
+
+
+
+

+
+
+Submit Feedback +
+
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
+
+ + + diff --git a/static/reference/actionscript/3.0/Vector.html b/static/reference/actionscript/3.0/Vector.html index 7fa8cd7d5..7312211a9 100644 --- a/static/reference/actionscript/3.0/Vector.html +++ b/static/reference/actionscript/3.0/Vector.html @@ -247,7 +247,7 @@   
-concat(... args):Vector.<T>
+concat(... args):Vector.<T>
Concatenates the Vectors specified in the parameters list with the elements in this Vector and creates a new Vector.
@@ -266,7 +266,7 @@   
-filter(callback:Function, thisObject:Object = null):Vector.<T>
+filter(callback:Function, thisObject:Object = null):Vector.<T>
Executes a test function on each item in the Vector and returns a new Vector containing all items that return true for the @@ -363,7 +363,7 @@   
-map(callback:Function, thisObject:Object = null):Vector.<T>
+map(callback:Function, thisObject:Object = null):Vector.<T>
Executes a function on each item in the Vector, and returns a new Vector of items corresponding to the results of calling the function on @@ -409,7 +409,7 @@   
-reverse():Vector.<T>
+reverse():Vector.<T>
Reverses the order of the elements in the Vector.
Vector @@ -435,7 +435,7 @@   
-slice(startIndex:int = 0, endIndex:int = 16777215):Vector.<T>
+slice(startIndex:int = 0, endIndex:int = 16777215):Vector.<T>
Returns a new Vector that consists of a range of elements from the original Vector, without modifying the original Vector.
@@ -454,7 +454,7 @@   
-sort(sortBehavior:*):Vector.<T>
+sort(sortBehavior:*):Vector.<T>
Sorts the elements in the Vector object, and also returns a sorted Vector object.
Vector @@ -462,7 +462,7 @@   
-splice(startIndex:int, deleteCount:uint = 4294967295, ... items):Vector.<T>
+splice(startIndex:int, deleteCount:uint = 4294967295, ... items):Vector.<T>
Adds elements to and removes elements from the Vector.
Vector @@ -735,7 +735,7 @@
-AS3 function concat(... args):Vector.<T> +AS3 function concat(... args):Vector.<T>

@@ -767,7 +767,7 @@ Returns
-
Vector.<T> — A Vector with the same base type as this Vector that contains +Vector.<T> — A Vector with the same base type as this Vector that contains the elements from this Vector followed by elements from the Vectors in the parameters list. @@ -894,7 +894,7 @@
-AS3 function filter(callback:Function, thisObject:Object = null):Vector.<T> +AS3 function filter(callback:Function, thisObject:Object = null):Vector.<T>

@@ -972,7 +972,7 @@ Returns
- @@ -1085,7 +1085,7 @@

Checks whether the vector includes the item that is passed in. Each element is checked in turn to see if it matches the item that is passed in, - using the standard comparison operator (i.e. similar to if (vector[0] == item)). + using the standard comparison operator (i.e. similar to if (vector[i] == item)).

Parameters
Vector.<T> — A new Vector that contains all items from the original Vector +Vector.<T> — A new Vector that contains all items from the original Vector for which the callback function returned true.
@@ -1385,7 +1385,7 @@
-AS3 function map(callback:Function, thisObject:Object = null):Vector.<T> +AS3 function map(callback:Function, thisObject:Object = null):Vector.<T>

@@ -1464,7 +1464,7 @@ Returns
- @@ -1677,7 +1677,7 @@
Vector.<T> — A new Vector that contains the results of calling the function +Vector.<T> — A new Vector that contains the results of calling the function on each item in this Vector. The result Vector has the same base type and length as the original.
-AS3 function reverse():Vector.<T> +AS3 function reverse():Vector.<T>

@@ -1698,7 +1698,7 @@ Returns
- @@ -1764,7 +1764,7 @@
Vector.<T> — The Vector with the elements in reverse order. +Vector.<T> — The Vector with the elements in reverse order.
-AS3 function slice(startIndex:int = 0, endIndex:int = 16777215):Vector.<T> +AS3 function slice(startIndex:int = 0, endIndex:int = 16777215):Vector.<T>

@@ -1811,7 +1811,7 @@ Returns
- @@ -1924,7 +1924,7 @@
Vector.<T> — a Vector that consists of a range of elements from the original Vector. +Vector.<T> — a Vector that consists of a range of elements from the original Vector.
-AS3 function sort(sortBehavior:*):Vector.<T> +AS3 function sort(sortBehavior:*):Vector.<T>

@@ -1996,7 +1996,7 @@ Returns
-
Vector.<T> — A Vector object, with elements in the new order. +Vector.<T> — A Vector object, with elements in the new order.
@@ -2014,7 +2014,7 @@
-AS3 function splice(startIndex:int, deleteCount:uint = 4294967295, ... items):Vector.<T> +AS3 function splice(startIndex:int, deleteCount:uint = 4294967295, ... items):Vector.<T>

@@ -2074,7 +2074,7 @@ Returns
- @@ -2277,11 +2277,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 5:35 PM GMT
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/air/net/WebSocket.html b/static/reference/actionscript/3.0/air/net/WebSocket.html index 8db8527b0..dc4577255 100644 --- a/static/reference/actionscript/3.0/air/net/WebSocket.html +++ b/static/reference/actionscript/3.0/air/net/WebSocket.html @@ -45,36 +45,62 @@

Vector.<T> — a Vector containing the elements that were removed from the original Vector. +Vector.<T> — a Vector containing the elements that were removed from the original Vector.
- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 51.0 +

+ The WebSocket class is a utility that encapsulates a normal Socket object + and implements the WebSocket protocol (RFC 6455). -

This can be used in conjunction with + + +

This can be used in conjunction with + a ServerSocket object to allow web pages to connect to and communicate with + an AIR application - once a connection is received, create a new WebSocket instance + and call startServer() to handle the protocol handshake.

-

To initiate an outgoing WebSocket connection to a server, use the connect() + + +

To initiate an outgoing WebSocket connection to a server, use the connect() + method, passing in the URL string in format "ws://some.example.com/ws/demo" + ('wss' can be used for secure WebSocket over TLS connections).

-

If a PING message is received by a WebSocket object, it will automatically response + + +

If a PING message is received by a WebSocket object, it will automatically response + with the appropriate PONG message. It is up to the developer to implement any + outgoing PING messages (or unsolicited PONGs) should those be desired.

-

Note: implementation is not yet complete, there are a number of restrictions currently:

    + + +

    Note: implementation is not yet complete, there are a number of restrictions currently:

      +
    • Outgoing connections are not yet implemented +
    • Incoming messages can only be handled up to 4GB in size +
    • Outgoing messages can be a maximum of 125 bytes +
    • Outgoing messages are not chunked +

    -

    + + +


@@ -96,6 +122,7 @@   closeReason : int
[read-only] + Retrieves the 'close' reason code, after the WebSocket has been closed.
WebSocket @@ -135,6 +162,7 @@
WebSocket()
+ Constructor for a WebSocket object.
WebSocket @@ -154,6 +182,7 @@ close(reasonCode:uint = 1000):void
+ Closes the WebSocket.
WebSocket @@ -163,6 +192,7 @@ connect(url:String):void
+ Initiates a connection as a WebSocket client.
WebSocket @@ -232,6 +262,7 @@ sendMessage(opcode:uint, data:*):void
+ Sends a message via the WebSocket protocol.
WebSocket @@ -251,6 +282,7 @@ startServer(s:Socket):*
+ Takes over an existing connection in order to act as a socket server.
WebSocket @@ -326,6 +358,7 @@ close
+ Dispatched when the WebSocket is closed by the other party.WebSocket @@ -343,6 +376,7 @@ websocketData
+ Dispatched when the WebSocket receives a message.WebSocket @@ -356,26 +390,31 @@   fmtBINARY : uint = 2
[static] + Code for a BINARY websocket message.
WebSocket   fmtCLOSE : uint = 8
[static] + Code for a CLOSE websocket message.
WebSocket   fmtPING : uint = 9
[static] + Code for a PING websocket message.
WebSocket   fmtPONG : uint = 10
[static] + Code for a PONG websocket message.
WebSocket   fmtTEXT : uint = 1
[static] + Code for a TEXT websocket message.
WebSocket @@ -398,18 +437,23 @@ closeReason:int  [read-only]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 51.0 +

+ Retrieves the 'close' reason code, after the WebSocket has been closed. -

Implementation + + +

Implementation
    public function get closeReason():int
@@ -427,20 +471,27 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 51.0 +

+ Constructor for a WebSocket object. Once created, the object can + either be used as a server (via startServer()) or as a client + (via connect()). -

+ + +

Method detail
@@ -454,23 +505,31 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 51.0 +

+ Closes the WebSocket. +

Note that if this method is used, no Event.CLOSE event is dispatched.

- Parameters + + + Parameters + + +
reasonCode:uint (default = 1000) — The code to use in the 'close' WebSocket message, defaulting to 1000 ("normal closure"). -
@@ -485,26 +544,37 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 51.0 +

+ Initiates a connection as a WebSocket client. +

This will connect to the host provided in the url, either via a normal Socket or using + a SecureSocket if a 'wss' protocol is requested. It will then initiate an HTTP protocol + handshake to upgrade the connection to use WebSockets. If the upgrade fails, the socket will be closed + and a Event.CLOSE event will be dispatched.

- Parameters + + + Parameters + + +
url:String — The target WebSocket URL. -

@@ -512,7 +582,9 @@ + + +
ArgumentError — When there is already a socket connection open, or if the url is an invalid protocol. -
@@ -527,21 +599,27 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 51.0 +

+ Sends a message via the WebSocket protocol. -

Parameters + + +

Parameters @@ -549,7 +627,9 @@ + + +
opcode:uint — The message type to send (text, binary, ping, pong etc). +
data:* — The data to send (either a String or a ByteArray). -

@@ -557,7 +637,9 @@ + + +
ArgumentError — When the data is null or an invalid object type, or is too long. -
@@ -572,27 +654,39 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 51.0 +

+ Takes over an existing connection in order to act as a socket server. +

Calling this method will set up the WebSocket object to + listen out for an HTTP request to upgrade the connection to the WebSocket + protocol.

+

If the data that's received is not an HTTP upgrade request, the socket + will be closed and a Event.CLOSE event will trigger.

- Parameters + + + Parameters + + +
s:Socket — The Socket object to adopt for the WebSocket server. -

@@ -607,7 +701,9 @@ + + +
ArgumentError — If the provided socket argument is null. -
@@ -626,19 +722,25 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 51.0 +

+ Dispatched when the WebSocket is closed by the other party. + The reason for the closure can be obtained from the closeReason property. -

+ + +

The Event.CLOSE constant defines the value of the type property of a close event object.

This event has the following properties:

@@ -666,18 +768,23 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 51.0 +

+ Dispatched when the WebSocket receives a message. -

+ + +

Constant detail
@@ -691,17 +798,21 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 51.0 +

+ Code for a BINARY websocket message. +

@@ -714,17 +825,21 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 51.0 +

+ Code for a CLOSE websocket message. +

@@ -737,17 +852,21 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 51.0 +

+ Code for a PING websocket message. +

@@ -760,17 +879,21 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 51.0 +

+ Code for a PONG websocket message. +

@@ -783,17 +906,21 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 51.0 +

+ Code for a TEXT websocket message. +



@@ -802,11 +929,11 @@

-Submit Feedback +Submit Feedback
-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/air/utils/ZipArchive.html b/static/reference/actionscript/3.0/air/utils/ZipArchive.html index 59f35ee91..afec7bf43 100644 --- a/static/reference/actionscript/3.0/air/utils/ZipArchive.html +++ b/static/reference/actionscript/3.0/air/utils/ZipArchive.html @@ -139,7 +139,7 @@ Object -  entries : Vector.<ZipEntry>
[read-only] +  entries : Vector.<ZipEntry>
[read-only] The entries within this zip archive.
ZipArchive @@ -428,7 +428,7 @@
-entries:Vector.<ZipEntry>  [read-only]

+entries:Vector.<ZipEntry>  [read-only]

+ + + + + + @@ -2752,11 +2760,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 19 2024, 3:46 PM GMT
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/all-index-P.html b/static/reference/actionscript/3.0/all-index-P.html index 7686e7708..be5778ebc 100644 --- a/static/reference/actionscript/3.0/all-index-P.html +++ b/static/reference/actionscript/3.0/all-index-P.html @@ -224,6 +224,7 @@ @@ -372,7 +373,9 @@ @@ -577,6 +580,7 @@ @@ -584,6 +588,7 @@ @@ -663,6 +668,7 @@ @@ -689,7 +695,8 @@ - + @@ -1240,6 +1247,7 @@ @@ -1366,6 +1374,7 @@ @@ -1426,6 +1435,7 @@ @@ -1665,7 +1675,9 @@ @@ -1673,6 +1685,7 @@ @@ -1737,6 +1750,7 @@ @@ -1744,6 +1758,7 @@ @@ -1872,6 +1887,7 @@ @@ -1887,6 +1903,7 @@ @@ -1902,7 +1919,9 @@ @@ -1918,7 +1937,9 @@ @@ -1934,7 +1955,9 @@ @@ -1950,7 +1973,9 @@ @@ -1966,8 +1991,11 @@ @@ -2092,11 +2120,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/all-index-R.html b/static/reference/actionscript/3.0/all-index-R.html index 7ff435327..3d92c1b30 100644 --- a/static/reference/actionscript/3.0/all-index-R.html +++ b/static/reference/actionscript/3.0/all-index-R.html @@ -178,6 +178,7 @@ @@ -185,6 +186,7 @@ @@ -216,6 +218,7 @@ @@ -223,6 +226,7 @@ @@ -256,7 +260,9 @@ @@ -264,6 +270,7 @@ @@ -297,6 +304,7 @@ @@ -304,6 +312,7 @@ @@ -345,6 +354,7 @@ @@ -352,6 +362,7 @@ @@ -391,6 +402,7 @@ @@ -398,6 +410,7 @@ @@ -431,6 +444,7 @@ @@ -438,7 +452,9 @@ @@ -476,6 +492,7 @@ @@ -483,6 +500,7 @@ @@ -518,6 +536,7 @@ @@ -525,6 +544,7 @@ @@ -556,6 +576,7 @@ @@ -563,6 +584,7 @@ @@ -594,6 +616,7 @@ @@ -601,6 +624,7 @@ @@ -632,6 +656,7 @@ @@ -639,6 +664,7 @@ @@ -670,6 +696,7 @@ @@ -677,6 +704,7 @@ @@ -708,7 +736,9 @@ @@ -716,7 +746,9 @@ @@ -762,6 +794,7 @@ @@ -1060,6 +1093,7 @@ @@ -1067,6 +1101,7 @@ @@ -1089,6 +1124,7 @@ @@ -1153,8 +1189,11 @@ @@ -1162,6 +1201,7 @@ @@ -1206,6 +1246,7 @@ @@ -1220,6 +1261,7 @@ @@ -1227,6 +1269,7 @@ @@ -1277,6 +1320,7 @@ @@ -1284,6 +1328,7 @@ @@ -1530,6 +1575,7 @@ @@ -1678,6 +1724,7 @@ @@ -1685,8 +1732,11 @@ @@ -1789,6 +1839,7 @@ @@ -1838,13 +1889,15 @@ - + @@ -1859,8 +1912,11 @@ + + + @@ -1987,7 +2043,9 @@ @@ -2077,6 +2135,7 @@ @@ -2329,7 +2388,9 @@ @@ -2337,6 +2398,7 @@ @@ -2373,6 +2435,7 @@ @@ -2380,6 +2443,7 @@ @@ -2402,7 +2466,9 @@ @@ -2410,6 +2476,7 @@ @@ -2517,7 +2584,9 @@ @@ -2525,6 +2594,7 @@ @@ -2532,6 +2602,7 @@ @@ -2539,6 +2610,7 @@ @@ -2774,11 +2846,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/all-index-Symbols.html b/static/reference/actionscript/3.0/all-index-Symbols.html index f0aa989aa..1cd65d4f7 100644 --- a/static/reference/actionscript/3.0/all-index-Symbols.html +++ b/static/reference/actionscript/3.0/all-index-Symbols.html @@ -348,6 +348,18 @@ + + + + + + + + + + + + @@ -429,11 +441,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/flash/desktop/NativeProcessStartupInfo.html b/static/reference/actionscript/3.0/flash/desktop/NativeProcessStartupInfo.html index 606626f2e..184bb17e9 100644 --- a/static/reference/actionscript/3.0/flash/desktop/NativeProcessStartupInfo.html +++ b/static/reference/actionscript/3.0/flash/desktop/NativeProcessStartupInfo.html @@ -86,7 +86,7 @@ - @@ -230,7 +230,7 @@
Language version: ActionScript 3.0 @@ -449,7 +449,7 @@

Implementation
-    public function get entries():Vector.<ZipEntry> +    public function get entries():Vector.<ZipEntry>
@@ -986,11 +986,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/all-index-D.html b/static/reference/actionscript/3.0/all-index-D.html index c7d70f867..087d43adc 100644 --- a/static/reference/actionscript/3.0/all-index-D.html +++ b/static/reference/actionscript/3.0/all-index-D.html @@ -1546,6 +1546,14 @@ type property of the event object for a directoryListing event.
disableNetworkChanges — Property in class flash.net.NetworkInfo
+ + Disables the network change detection within AIR.
disablePageRange — Property in class flash.printing.PrintUIOptions
+ The directory that contains the file or directory referenced by this File object.
+ Dispatched when the user activates the platform-specific accelerator key combination for a paste operation + or selects 'Paste' from the text context menu.
+ Dispatched when the application requests permission to access filesystem.
+ Determine whether the application has been granted the permission to access filesystem.
+ Determine whether the application has been granted the permission to access NetworkInfo.
permissionStatus — Static property in class flash.sensors.Geolocation
+ Determine whether the application has been granted the permission to use geolocation services.
PermissionStatus — Final class in package flash.permissions
+ Posts a message to the HTML content within the StageWebView host.
+ Displays the back rendering buffer.
+ Indicates whether or not the runtime prevents this File object from being backed up to the cloud.
+ Definition for a Professional license level +
+ The feature-support profile in use by this Context3D object.
+ Dispatched when data is received as the download operation progresses.
+ Dispatched when data is received as the download operation progresses.
+ Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.
+ Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.
+ Dispatched when the user moves an active stylus over the screen while remaining within + the proximity detection threshold.
+ Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within + the proximity detection threshold of the screen.
+ Dispatched when the user moves an active stylus directly above this InteractiveObject + while remaining within the proximity detection threshold of the screen.
+ Dispatched when the user moves an active stylus away from this InteractiveObject + and any of its children while remaining within the proximity detection threshold of the screen.
+ Dispatched when the user moves an active stylus over this InteractiveObject from outside the + object's tree of descendents in the display list + (while remaining within the proximity detection threshold of the screen).
+ Reads a Boolean value from the socket.
+ Reads a Boolean value from the stream.
+ Reads a signed byte from the socket.
+ Reads a signed byte from the stream.
+ Reads the number of data bytes specified by the length + parameter from the socket.
+ Reads length bytes of data from the stream.
+ Reads an IEEE 754 double-precision floating-point number from the socket.
+ Reads an IEEE 754 double-precision floating-point number from the stream.
+ Reads an IEEE 754 single-precision floating-point number from the socket.
+ Reads an IEEE 754 single-precision floating-point number from the stream.
+ Reads a signed 32-bit integer from the socket.
+ Reads a signed 32-bit integer from the stream.
+ Reads a multibyte string from the byte stream, using the specified character set.
+ Reads a multibyte string of specified length from the byte stream using the + specified character set.
+ Reads an object from the socket, encoded in AMF serialized format.
+ Reads an object from the socket, encoded in Action Message Format (AMF).
+ Reads a signed 16-bit integer from the socket.
+ Reads a signed 16-bit integer from the stream.
+ Reads an unsigned byte from the socket.
+ Reads an unsigned byte from the stream.
+ Reads an unsigned 32-bit integer from the socket.
+ Reads an unsigned 32-bit integer from the stream.
+ Reads an unsigned 16-bit integer from the socket.
+ Reads an unsigned 16-bit integer from the stream.
+ Reads a UTF-8 string from the socket.
+ Reads a UTF-8 string from the stream.
+ Reads the number of UTF-8 data bytes specified by the length + parameter from the socket, and returns a string.
+ Reads a sequence of length UTF-8 + bytes from the stream, and returns a string.
+ Enables this DatagramSocket object to receive incoming packets on the bound IP address and port.
+ Registers a font class in the global font list.
+ Registers a font class in the global font list, using dynamic data.
+ A reference to a display list object that is related to the event.
+ Dispatched when a user releases the button on the pointing device after the + user first pressed the button over an InteractiveObject instance + and then moved the pointing device off of the InteractiveObject instance.
+ Defines the value of the type property of a releaseOutside event object.
+ Reloads the current page.
+ The IP address of the remote machine to which this socket is connected.
+ The IP address of the remote machine to which this socket is connected.
+ The port on the remote machine to which this socket is connected.
+ The port on the remote machine to which this socket is connected.
+ The rendering mode used for this text.
+ Replaces the current selection with the contents of the value parameter.
+ Replaces the range of characters that the beginIndex and + endIndex parameters specify with the contents + of the newText parameter.
+ Requests permission to access filesystem.
requestPermission() — Method in class flash.sensors.Geolocation
+ Requests geolocation permission for the application.
requestSoftKeyboard() — Method in class flash.display.InteractiveObject
+ Raises a virtual keyboard.
+ Resets the object for re-use by removing all earlier data -
reset() — Static method in class flash.data.EncryptedLocalStore
+ Creates a new File object with a path relative to this File object's path, based on the + path parameter (a string).
+ Indicates the set of characters that a user can enter into the text field.
+ Dispatched when a user presses and releases the right button of the user's + pointing device over the same InteractiveObject.
+ Defines the value of the type property of a rightClick event object.
+ Dispatched when a user presses the pointing device button over an InteractiveObject instance.
+ Defines the value of the type property of a rightMouseDown event object.
+ Dispatched when a user releases the pointing device button over an + InteractiveObject instance.
+ Defines the value of the type property of a rightMouseUp event object.
+ Dispatched when the user moves a pointing device away from an InteractiveObject + instance.
+ Defines the value of the type property of a rollOut event object.
+ Dispatched when the user moves a pointing device over an InteractiveObject instance.
+ Defines the value of the type property of a rollOver event object.
Identifies the namespace of a property, a method, an XML property, or an XML attribute.
?. (null condition member access) — Operator
Accesses class variables and methods, gets and sets object properties, with an inherent null-object check.
?? (nullish coalescing) — Operator
Returns expression1 unless if it is null or undefined, and expression2 otherwise.
{} (object initializer) — Operator
 PropertyDefined by
  arguments : Vector.<String>
+
  arguments : Vector.<String>
The command line arguments that will be passed to the process on startup.
NativeProcessStartupInfo
-arguments:Vector.<String>  [read-write]

+arguments:Vector.<String>  [read-write]

@@ -251,9 +251,9 @@ Implementation
-    public function get arguments():Vector.<String> +    public function get arguments():Vector.<String>
-    public function set arguments(value:Vector.<String>):void +    public function set arguments(value:Vector.<String>):void
@@ -369,11 +369,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/flash/display/BitmapData.html b/static/reference/actionscript/3.0/flash/display/BitmapData.html index ec7f3834c..0a033d03f 100644 --- a/static/reference/actionscript/3.0/flash/display/BitmapData.html +++ b/static/reference/actionscript/3.0/flash/display/BitmapData.html @@ -510,7 +510,7 @@
Language version: ActionScript 3.0
  
-getVector(rect:Rectangle):Vector.<uint>
+getVector(rect:Rectangle):Vector.<uint>
Generates a vector array from a rectangular region of pixel data.
@@ -529,7 +529,7 @@
  
-histogram(hRect:Rectangle = null):Vector.<Vector.<Number>>
+histogram(hRect:Rectangle = null):Vector.<Vector.<Number>>
Computes a 256-value binary number histogram of a BitmapData object.
@@ -688,7 +688,7 @@
  
-setVector(rect:Rectangle, inputVector:Vector.<uint>):void +setVector(rect:Rectangle, inputVector:Vector.<uint>):void
@@ -3656,7 +3656,7 @@
-public function getVector(rect:Rectangle):Vector.<uint> +public function getVector(rect:Rectangle):Vector.<uint>

@@ -3697,7 +3697,7 @@ Returns
- @@ -3721,7 +3721,7 @@
Vector.<uint> — A Vector representing the given Rectangle. +Vector.<uint> — A Vector representing the given Rectangle.
-public function histogram(hRect:Rectangle = null):Vector.<Vector.<Number>> +public function histogram(hRect:Rectangle = null):Vector.<Vector.<Number>>

@@ -3766,7 +3766,7 @@ Returns
- +
Vector.<Vector.<Number>>Vector.<Vector.<Number>>
@@ -5308,7 +5308,7 @@
-public function setVector(rect:Rectangle, inputVector:Vector.<uint>):void +public function setVector(rect:Rectangle, inputVector:Vector.<uint>):void

@@ -5346,7 +5346,7 @@ -
 
inputVector:Vector.<uint> — A Vector object that consists of 32-bit unmultiplied pixel values to be used +inputVector:Vector.<uint> — A Vector object that consists of 32-bit unmultiplied pixel values to be used in the rectangular region. @@ -5797,11 +5797,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/flash/display/Graphics.html b/static/reference/actionscript/3.0/flash/display/Graphics.html index 829aebda7..2d3be1307 100644 --- a/static/reference/actionscript/3.0/flash/display/Graphics.html +++ b/static/reference/actionscript/3.0/flash/display/Graphics.html @@ -221,7 +221,7 @@
  
-drawGraphicsData(graphicsData:Vector.<IGraphicsData>):void +drawGraphicsData(graphicsData:Vector.<IGraphicsData>):void
Submits a series of IGraphicsData instances for drawing.
@@ -230,7 +230,7 @@
  
-drawPath(commands:Vector.<int>, data:Vector.<Number>, winding:String = "evenOdd"):void +drawPath(commands:Vector.<int>, data:Vector.<Number>, winding:String = "evenOdd"):void
Submits a series of commands for drawing.
@@ -257,7 +257,7 @@
  
-drawTriangles(vertices:Vector.<Number>, indices:Vector.<int> = null, uvtData:Vector.<Number> = null, culling:String = "none"):void +drawTriangles(vertices:Vector.<Number>, indices:Vector.<int> = null, uvtData:Vector.<Number> = null, culling:String = "none"):void
Renders a set of triangles, typically to distort bitmaps and give them a three-dimensional appearance.
@@ -365,7 +365,7 @@
  
-readGraphicsData(recurse:Boolean = true):Vector.<IGraphicsData>
+readGraphicsData(recurse:Boolean = true):Vector.<IGraphicsData>
Queries a Sprite or Shape object (and optionally, its children) for its vector graphics content.
@@ -1525,7 +1525,7 @@
-public function drawGraphicsData(graphicsData:Vector.<IGraphicsData>):void +public function drawGraphicsData(graphicsData:Vector.<IGraphicsData>):void

@@ -1553,7 +1553,7 @@ Parameters
-
graphicsData:Vector.<IGraphicsData> — A Vector containing graphics objects, each of which much implement the IGraphicsData interface. +graphicsData:Vector.<IGraphicsData> — A Vector containing graphics objects, each of which much implement the IGraphicsData interface.
@@ -1643,7 +1643,7 @@
-public function drawPath(commands:Vector.<int>, data:Vector.<Number>, winding:String = "evenOdd"):void +public function drawPath(commands:Vector.<int>, data:Vector.<Number>, winding:String = "evenOdd"):void

@@ -1691,7 +1691,7 @@ Parameters
- @@ -1700,7 +1700,7 @@ -
commands:Vector.<int> — A Vector of integers representing drawing commands. The set +commands:Vector.<int> — A Vector of integers representing drawing commands. The set of accepted values is defined by the constants in the GraphicsPathCommand class.  
data:Vector.<Number> — A Vector of Number instances where each pair of numbers is treated as a coordinate location (an x, y pair). +data:Vector.<Number> — A Vector of Number instances where each pair of numbers is treated 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. @@ -1989,7 +1989,7 @@
-public function drawTriangles(vertices:Vector.<Number>, indices:Vector.<int> = null, uvtData:Vector.<Number> = null, culling:String = "none"):void +public function drawTriangles(vertices:Vector.<Number>, indices:Vector.<int> = null, uvtData:Vector.<Number> = null, culling:String = "none"):void

@@ -2017,7 +2017,7 @@ Parameters
- @@ -2025,7 +2025,7 @@ - -
vertices:Vector.<Number> — A Vector of Numbers where each pair of numbers is treated as a coordinate location (an x, y pair). The +vertices:Vector.<Number> — A Vector of Numbers where each pair of numbers is treated as a coordinate location (an x, y pair). The vertices parameter is required.
 
indices:Vector.<int> (default = null) — A Vector of integers or indexes, where every three indexes define a triangle. If the indexes parameter +indices:Vector.<int> (default = null) — A Vector of integers or indexes, where every three indexes define a triangle. If the indexes parameter is null then every three vertices (six x,y pairs in the vertices Vector) defines a triangle. Otherwise each index refers to a vertex, which is a pair of numbers in the vertices Vector. For example indexes[1] refers to (vertices[2], vertices[3]). @@ -2037,7 +2037,7 @@  
uvtData:Vector.<Number> (default = null) — A Vector of normalized coordinates used to apply texture mapping. +uvtData:Vector.<Number> (default = null) — A Vector of normalized coordinates used to apply texture mapping. Each coordinate refers to a point on the bitmap used for the fill. You must have one UV or one UVT coordinate per vertex. In UV coordinates, (0,0) is the upper left of the bitmap, and (1,1) is the lower right of the bitmap. @@ -2904,7 +2904,7 @@
-public function readGraphicsData(recurse:Boolean = true):Vector.<IGraphicsData> +public function readGraphicsData(recurse:Boolean = true):Vector.<IGraphicsData>

@@ -2994,7 +2994,7 @@ Returns
- @@ -3203,11 +3203,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/flash/display/GraphicsPath.html b/static/reference/actionscript/3.0/flash/display/GraphicsPath.html index 17b251763..f66d891ae 100644 --- a/static/reference/actionscript/3.0/flash/display/GraphicsPath.html +++ b/static/reference/actionscript/3.0/flash/display/GraphicsPath.html @@ -95,7 +95,7 @@ - @@ -107,7 +107,7 @@ - @@ -144,7 +144,7 @@ @@ -297,7 +297,7 @@
Vector.<IGraphicsData> — A Vector of IGraphicsData objects representing the vector graphics +Vector.<IGraphicsData> — A Vector of IGraphicsData objects representing the vector graphics content of the related display object  PropertyDefined by
  commands : Vector.<int>
+
  commands : Vector.<int>
The Vector of drawing commands as integers representing the path.
GraphicsPath
Object
  data : Vector.<Number>
+
  data : Vector.<Number>
The Vector of Numbers containing the parameters used with the drawing commands.
GraphicsPath
  
-GraphicsPath(commands:Vector.<int> = null, data:Vector.<Number> = null, winding:String = "evenOdd")
+GraphicsPath(commands:Vector.<int> = null, data:Vector.<Number> = null, winding:String = "evenOdd")
Creates a new GraphicsPath object.
GraphicsPath
-public var commands:Vector.<int> +public var commands:Vector.<int>

@@ -327,7 +327,7 @@
-public var data:Vector.<Number> +public var data:Vector.<Number>

@@ -386,7 +386,7 @@
-public function GraphicsPath(commands:Vector.<int> = null, data:Vector.<Number> = null, winding:String = "evenOdd") +public function GraphicsPath(commands:Vector.<int> = null, data:Vector.<Number> = null, winding:String = "evenOdd")

@@ -404,14 +404,14 @@

Parameters
- - @@ -770,11 +770,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/flash/display/GraphicsTrianglePath.html b/static/reference/actionscript/3.0/flash/display/GraphicsTrianglePath.html index 920a34414..890e87251 100644 --- a/static/reference/actionscript/3.0/flash/display/GraphicsTrianglePath.html +++ b/static/reference/actionscript/3.0/flash/display/GraphicsTrianglePath.html @@ -107,7 +107,7 @@ - @@ -119,12 +119,12 @@ - - @@ -148,7 +148,7 @@ @@ -278,7 +278,7 @@
commands:Vector.<int> (default = null) — A Vector of integers representing commands defined by the GraphicsPathCommand class. +commands:Vector.<int> (default = null) — A Vector of integers representing commands defined by the GraphicsPathCommand class.
 
data:Vector.<Number> (default = null) — A Vector of Numbers where each pair of numbers is treated as a point (an x, y pair). +data:Vector.<Number> (default = null) — A Vector of Numbers where each pair of numbers is treated as a point (an x, y pair).
GraphicsTrianglePath
  indices : Vector.<int>
+
  indices : Vector.<int>
A Vector of integers or indexes, where every three indexes define a triangle.
GraphicsTrianglePath
Object
  uvtData : Vector.<Number>
+
  uvtData : Vector.<Number>
A Vector of normalized coordinates used to apply texture mapping.
GraphicsTrianglePath
  vertices : Vector.<Number>
+
  vertices : Vector.<Number>
A Vector of Numbers where each pair of numbers is treated as a point (an x, y pair).
GraphicsTrianglePath
  
-GraphicsTrianglePath(vertices:Vector.<Number> = null, indices:Vector.<int> = null, uvtData:Vector.<Number> = null, culling:String = "none")
+GraphicsTrianglePath(vertices:Vector.<Number> = null, indices:Vector.<int> = null, uvtData:Vector.<Number> = null, culling:String = "none")
Creates a new GraphicsTrianglePath object.
GraphicsTrianglePath
-public var indices:Vector.<int> +public var indices:Vector.<int>

@@ -303,7 +303,7 @@
-public var uvtData:Vector.<Number> +public var uvtData:Vector.<Number>

@@ -342,7 +342,7 @@
-public var vertices:Vector.<Number> +public var vertices:Vector.<Number>

@@ -366,7 +366,7 @@
-public function GraphicsTrianglePath(vertices:Vector.<Number> = null, indices:Vector.<int> = null, uvtData:Vector.<Number> = null, culling:String = "none") +public function GraphicsTrianglePath(vertices:Vector.<Number> = null, indices:Vector.<int> = null, uvtData:Vector.<Number> = null, culling:String = "none")

@@ -383,21 +383,21 @@

Parameters
- - - @@ -428,11 +428,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/flash/display/InteractiveObject.html b/static/reference/actionscript/3.0/flash/display/InteractiveObject.html index 00daaa90a..d86ceb68d 100644 --- a/static/reference/actionscript/3.0/flash/display/InteractiveObject.html +++ b/static/reference/actionscript/3.0/flash/display/InteractiveObject.html @@ -49,7 +49,9 @@

vertices:Vector.<Number> (default = null) — A Vector of Numbers where each pair of numbers is treated as a point (an x, y pair). Required. +vertices:Vector.<Number> (default = null) — A Vector of Numbers where each pair of numbers is treated as a point (an x, y pair). Required.
 
indices:Vector.<int> (default = null) — A Vector of integers or indexes, where every three indexes define a triangle. +indices:Vector.<int> (default = null) — A Vector of integers or indexes, where every three indexes define a triangle.
 
uvtData:Vector.<Number> (default = null) — A Vector of normalized coordinates used to apply texture mapping. +uvtData:Vector.<Number> (default = null) — A Vector of normalized coordinates used to apply texture mapping.
- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 + +
@@ -59,17 +61,29 @@

+ 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 the new + InteractiveObject() constructor throws an ArgumentError exception.

+ +

The InteractiveObject class itself does not include any APIs for rendering content onscreen. + To create a custom subclass of the InteractiveObject class, + extend one of the subclasses that do have APIs for rendering content onscreen, + such as the Sprite, SimpleButton, TextField, or MovieClip classes.

-

+ + +

View the examples.

@@ -94,7 +108,9 @@   accessibilityImplementation : AccessibilityImplementation
+ The current accessibility implementation (AccessibilityImplementation) + for this InteractiveObject instance.
InteractiveObject @@ -146,12 +162,14 @@   contextMenu : NativeMenu
+ Specifies the context menu associated with this object.
InteractiveObject   doubleClickEnabled : Boolean
+ Specifies whether the object receives doubleClick events.
InteractiveObject @@ -164,6 +182,7 @@   focusRect : Object
+ Specifies whether this object displays a focus rectangle.
InteractiveObject @@ -196,6 +215,7 @@   mouseEnabled : Boolean
+ Specifies whether this object receives mouse, or other user input, messages.
InteractiveObject @@ -220,7 +240,9 @@   needsSoftKeyboard : Boolean
+ Specifies whether a virtual keyboard (an on-screen, software keyboard) should display + when this InteractiveObject instance receives focus.
InteractiveObject @@ -307,12 +329,14 @@   softKeyboard : String
+ Controls the appearance of the soft keyboard.
InteractiveObject   softKeyboardInputAreaOfInterest : Rectangle
+ Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
InteractiveObject @@ -325,12 +349,14 @@   tabEnabled : Boolean
+ Specifies whether this object is in the tab order.
InteractiveObject   tabIndex : int
+ Specifies the tab ordering of objects in a SWF file.
InteractiveObject @@ -395,7 +421,9 @@
InteractiveObject()
+ Calling the new InteractiveObject() constructor + throws an ArgumentError exception.
InteractiveObject @@ -556,6 +584,7 @@ requestSoftKeyboard():Boolean
+ Raises a virtual keyboard.
InteractiveObject @@ -658,6 +687,7 @@ clear
+ Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject @@ -666,7 +696,9 @@ click
+ Dispatched when a user presses and releases the main button of the user's + pointing device over the same InteractiveObject.InteractiveObject @@ -675,7 +707,9 @@ contextMenu
+ Dispatched when a user gesture triggers the context menu associated with this interactive + object in an AIR application.InteractiveObject @@ -684,7 +718,9 @@ copy
+ Dispatched when the user activates the platform-specific accelerator key combination for a copy operation + or selects 'Copy' from the text context menu.InteractiveObject @@ -693,7 +729,9 @@ cut
+ Dispatched when the user activates the platform-specific accelerator key combination for a cut operation + or selects 'Cut' from the text context menu.InteractiveObject @@ -711,8 +749,11 @@ doubleClick
+ Dispatched when a user presses and releases the main button of a pointing device twice in + rapid succession over the same InteractiveObject when that object's + doubleClickEnabled flag is set to true.InteractiveObject @@ -738,6 +779,7 @@ focusIn
+ Dispatched after a display object gains focus.InteractiveObject @@ -746,6 +788,7 @@ focusOut
+ Dispatched after a display object loses focus.InteractiveObject @@ -762,8 +805,11 @@ gestureDirectionalTap
+ Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, + (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) + Some devices might also interpret this contact as a combination of several touch events, as well.InteractiveObject @@ -772,8 +818,11 @@ gestureLongPress
+ Dispatched when the user presses two points of contact over the same InteractiveObject 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).InteractiveObject @@ -782,8 +831,11 @@ gesturePan
+ Dispatched when the user moves a point of contact over the InteractiveObject instance + 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).InteractiveObject @@ -792,7 +844,9 @@ gestureRotate
+ Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers + and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject @@ -801,7 +855,9 @@ gestureSwipe
+ Dispatched when the user performs a swipe gesture at a point of contact with an 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).InteractiveObject @@ -810,8 +866,11 @@ gestureTap
+ Dispatched when the user creates a point of contact with an InteractiveObject instance, 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 tablet with a touch screen).InteractiveObject @@ -820,7 +879,9 @@ gestureZoom
+ Dispatched when the user performs a zoom gesture at a point of contact with an 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 touch screen).InteractiveObject @@ -829,8 +890,11 @@ imeStartComposition + This event is dispatched to any client app that supports inline input with an IME + + InteractiveObject @@ -839,6 +903,7 @@ keyDown + Dispatched when the user presses a key.InteractiveObject @@ -847,6 +912,7 @@ keyFocusChange + Dispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject @@ -855,6 +921,7 @@ keyUp + Dispatched when the user releases a key.InteractiveObject @@ -863,7 +930,9 @@ middleClick + Dispatched when a user presses and releases the middle button of the user's + pointing device over the same InteractiveObject.InteractiveObject @@ -872,6 +941,7 @@ middleMouseDown + Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject @@ -880,7 +950,9 @@ middleMouseUp + Dispatched when a user releases the pointing device button over an + InteractiveObject instance.InteractiveObject @@ -889,6 +961,7 @@ mouseDown + Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject @@ -897,6 +970,7 @@ mouseFocusChange + Dispatched when the user attempts to change focus by using a pointer device.InteractiveObject @@ -905,6 +979,7 @@ mouseMove + Dispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject @@ -913,6 +988,7 @@ mouseOut + Dispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject @@ -921,6 +997,7 @@ mouseOver + Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject @@ -929,7 +1006,9 @@ mouseUp + Dispatched when a user releases the pointing device button over an + InteractiveObject instance.InteractiveObject @@ -938,6 +1017,7 @@ mouseWheel + Dispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject @@ -946,6 +1026,7 @@ mouseWheelHorizontal + Dispatched when a horizontal mouse wheel is spun over an InteractiveObject instance.InteractiveObject @@ -954,6 +1035,7 @@ nativeDragComplete + Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject @@ -962,8 +1044,11 @@ nativeDragDrop + Dispatched by the target InteractiveObject when a dragged object is + dropped on it and the drop has been accepted with a call to + DragManager.acceptDragDrop().InteractiveObject @@ -972,6 +1057,7 @@ nativeDragEnter + Dispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject @@ -980,6 +1066,7 @@ nativeDragExit + Dispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject @@ -988,7 +1075,9 @@ nativeDragOver + Dispatched by an InteractiveObject continually while a drag gesture remains within its + boundary.InteractiveObject @@ -997,7 +1086,9 @@ nativeDragStart + Dispatched at the beginning of a drag operation by the InteractiveObject that is + specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject @@ -1006,7 +1097,9 @@ nativeDragUpdate + Dispatched during a drag operation by the InteractiveObject that is + specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject @@ -1015,7 +1108,9 @@ paste + Dispatched when the user activates the platform-specific accelerator key combination for a paste operation + or selects 'Paste' from the text context menu.InteractiveObject @@ -1024,6 +1119,7 @@ proximityBegin + Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject @@ -1032,6 +1128,7 @@ proximityEnd + Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject @@ -1040,7 +1137,9 @@ proximityMove + Dispatched when the user moves an active stylus over the screen while remaining within + the proximity detection threshold.InteractiveObject @@ -1049,7 +1148,9 @@ proximityOut + Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within + the proximity detection threshold of the screen.InteractiveObject @@ -1058,7 +1159,9 @@ proximityOver + Dispatched when the user moves an active stylus directly above this InteractiveObject + while remaining within the proximity detection threshold of the screen.InteractiveObject @@ -1067,7 +1170,9 @@ proximityRollOut + Dispatched when the user moves an active stylus away from this InteractiveObject + and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject @@ -1076,8 +1181,11 @@ proximityRollOver + Dispatched when the user moves an active stylus over this InteractiveObject from outside the + object's tree of descendents in the display list + (while remaining within the proximity detection threshold of the screen).InteractiveObject @@ -1086,8 +1194,11 @@ releaseOutside + Dispatched when a user releases the button on the pointing device after the + user first pressed the button over an InteractiveObject instance + and then moved the pointing device off of the InteractiveObject instance.InteractiveObject @@ -1121,7 +1232,9 @@ rightClick + Dispatched when a user presses and releases the right button of the user's + pointing device over the same InteractiveObject.InteractiveObject @@ -1130,6 +1243,7 @@ rightMouseDown + Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject @@ -1138,7 +1252,9 @@ rightMouseUp + Dispatched when a user releases the pointing device button over an + InteractiveObject instance.InteractiveObject @@ -1147,7 +1263,9 @@ rollOut + Dispatched when the user moves a pointing device away from an InteractiveObject + instance.InteractiveObject @@ -1156,6 +1274,7 @@ rollOver + Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject @@ -1164,7 +1283,9 @@ selectAll + Dispatched when the user activates the platform-specific accelerator key combination for a select all operation + or selects 'Select All' from the text context menu.InteractiveObject @@ -1173,6 +1294,7 @@ softKeyboardActivate + Dispatched immediately after the soft keyboard is raised.InteractiveObject @@ -1181,6 +1303,7 @@ softKeyboardActivating + Dispatched immediately before the soft keyboard is raised.InteractiveObject @@ -1189,6 +1312,7 @@ softKeyboardDeactivate + Dispatched immediately after the soft keyboard is lowered.InteractiveObject @@ -1197,6 +1321,7 @@ tabChildrenChange + Dispatched when the value of the object's tabChildren flag changes.InteractiveObject @@ -1205,6 +1330,7 @@ tabEnabledChange + Dispatched when the object's tabEnabled flag changes.InteractiveObject @@ -1213,6 +1339,7 @@ tabIndexChange + Dispatched when the value of the object's tabIndex property changes.InteractiveObject @@ -1221,7 +1348,9 @@ textInput + Dispatched when a user enters one or more + characters of text.InteractiveObject @@ -1230,6 +1359,7 @@ touchBegin + Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject @@ -1238,6 +1368,7 @@ touchEnd + Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject @@ -1246,6 +1377,7 @@ touchMove + Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.InteractiveObject @@ -1254,7 +1386,9 @@ touchOut + Dispatched when the user moves the point of contact away from InteractiveObject instance 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).InteractiveObject @@ -1263,7 +1397,9 @@ touchOver + Dispatched when the user moves the point of contact over an InteractiveObject instance on 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).InteractiveObject @@ -1272,7 +1408,9 @@ touchRollOut + Dispatched when the user moves the point of contact away from an InteractiveObject 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).InteractiveObject @@ -1281,7 +1419,9 @@ touchRollOver + Dispatched when the user moves the point of contact over an InteractiveObject instance on 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).InteractiveObject @@ -1290,8 +1430,11 @@ 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 and releases a finger from a single point over a display object + on a mobile phone or tablet with a touch screen).InteractiveObject @@ -1313,12 +1456,16 @@ accessibilityImplementation:AccessibilityImplementation  [read-write]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +

+ The current accessibility implementation (AccessibilityImplementation) + for this InteractiveObject instance. +

Implementation
    public function get accessibilityImplementation():AccessibilityImplementation @@ -1342,7 +1489,9 @@ contextMenu:NativeMenu  [read-write]

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -1352,16 +1501,29 @@

+ Specifies the context menu associated with this object. -

For content running in Flash Player, this property is a ContextMenu object. In the AIR runtime, + + +

For content running in Flash Player, this property is a ContextMenu object. In the AIR runtime, + the ContextMenu class extends the NativeMenu class, however Flash Player only supports the + ContextMenu class, not the NativeMenu class. +

-

Note: TextField objects always include a clipboard menu in the context menu. The clipboard menu contains + + +

Note: TextField objects always include a clipboard menu in the context menu. The clipboard menu contains + Cut, Copy, Paste, Clear, and Select All commands. You cannot remove these commands from the context menu for TextField objects. + For TextField objects, selecting these commands (or their keyboard equivalents) does not generate clear, + copy, cut, paste, or selectAll events.

- Implementation + + + Implementation
    public function get contextMenu():NativeMenu
@@ -1409,7 +1571,8 @@ doubleClickEnabled:Boolean  [read-write]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
@@ -1418,17 +1581,29 @@

+ 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 + true, the instance receives doubleClick events within its bounds. + The mouseEnabled property of the InteractiveObject instance must also be + set to true for the object to receive doubleClick events. + +

No event is dispatched by setting this property. You must use the + addEventListener() method to add an event listener + for the doubleClick event.

+ + Implementation
    public function get doubleClickEnabled():Boolean @@ -1456,7 +1631,9 @@ focusRect:Object  [read-write]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 + +
@@ -1465,12 +1642,19 @@

+ Specifies whether this object displays a focus rectangle. It can take one of three + values: true, false, or null. Values of true + and false work as expected, specifying whether or not the focus rectangle + appears. A value of null indicates that this object obeys the + stageFocusRect property of the Stage. -

Implementation + + +

Implementation
    public function get focusRect():Object
@@ -1487,7 +1671,8 @@ mouseEnabled:Boolean  [read-write]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
@@ -1496,16 +1681,27 @@

+ Specifies whether this object receives mouse, or other user input, messages. The default value is true, + which means that by 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 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 + flash.display.DisplayObjectContainer.mouseChildren. +

No event is dispatched by setting this property. You must use the + addEventListener() method to create interactive functionality.

- Implementation + + + Implementation
    public function get mouseEnabled():Boolean
@@ -1528,33 +1724,53 @@ needsSoftKeyboard:Boolean  [read-write]

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 2.6 +

+ 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 needsSoftKeyboard property is set to true, + the runtime raises a soft keyboard when the InteractiveObject instance is ready to accept user input. + An InteractiveObject instance is ready to accept user input after a programmatic call to set the Stage + focus property or a user interaction, such as a "tap." If the client system has a + hardware keyboard available or does not support virtual keyboards, then the soft keyboard is not raised.

+ +

The InteractiveObject instance dispatches softKeyboardActivating, + softKeyboardActivate, and softKeyboardDeactivate events + when the soft keyboard raises and lowers.

+ +

Note: This property is not supported in AIR applications on iOS.

+ + Implementation
    public function get needsSoftKeyboard():Boolean @@ -1582,55 +1798,97 @@ softKeyboard:String  [read-write]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 + +
Runtime version: AIR 21.0 +

+ Controls the appearance of the soft keyboard. +

+ Devices with soft keyboards can customize the keyboard's buttons + to match the type of input expected. For example, if numeric + input is expected, a device can use SoftKeyboardType.NUMBER to + display only numbers on the soft keyboard. + Valid values are defined as constants in the SoftKeyboardType class: +

+ +

+ These values serve as hints, to help a device display the best keyboard for the current operation. +

-

The default value is SoftKeyboardType.DEFAULT.

-Implementation + + +

The default value is SoftKeyboardType.DEFAULT.

+Implementation
    public function get softKeyboard():String
@@ -1642,7 +1900,9 @@ + + +
ArgumentError — If set to any value which is not a member of SoftKeyboardType -

@@ -1662,34 +1922,55 @@ softKeyboardInputAreaOfInterest:Rectangle  [read-write]

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 2.6 +

+ Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). + +

If the needsSoftKeyboard property of this InteractiveObject is + true, then the runtime adjusts the display as needed to keep the + object in view while the user types. Ordinarily, the runtime uses the object + bounds obtained from the DisplayObject.getBounds() method. You can + specify a different area using this softKeyboardInputAreaOfInterest + property.

+ +

Specify the softKeyboardInputAreaOfInterest in stage coordinates.

+ +

Note: On Android, the softKeyboardInputAreaOfInterest is not + respected in landscape orientations.

+ +

Note: softKeyboardInputAreaOfInterest is not + supported on iOS.

+ + Implementation
    public function get softKeyboardInputAreaOfInterest():Rectangle @@ -1713,7 +1994,9 @@ tabEnabled:Boolean  [read-write]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 + +
@@ -1722,13 +2005,21 @@

+ Specifies whether this object is in the tab order. If this object is in the tab order, + the value is true; otherwise, the value is false. By default, + the value is false, except for the following: +

+ +

Implementation
    public function get tabEnabled():Boolean @@ -1746,7 +2037,9 @@ tabIndex:int  [read-write]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 + +
@@ -1755,38 +2048,71 @@

+ Specifies the tab ordering of objects in a SWF file. The tabIndex + property is -1 by default, meaning no tab index is set for the object. + +

If any currently displayed object in the SWF file contains a tabIndex property, automatic + tab ordering is disabled, and the tab ordering is calculated from the tabIndex properties of + objects in the SWF file. The custom tab ordering includes only objects that have tabIndex + properties.

+ +

The tabIndex property can be a non-negative integer. The objects are ordered according to + their tabIndex properties, in ascending order. An object with a tabIndex + value of 1 precedes an object with a tabIndex value of 2. Do not use the same tabIndex + + value for multiple objects.

+ +

The custom tab ordering that the tabIndex property defines is flat. + This means that no attention is paid to the hierarchical relationships of objects in the SWF file. + All objects in the SWF file with tabIndex properties are placed in the tab order, and the + tab order is determined by the order of the tabIndex values.

+

Note: To set the tab order for TLFTextField instances, cast the display object child + of the TLFTextField as an InteractiveObject, then set the tabIndex property. For example:
+ 

+
 	 InteractiveObject(tlfInstance.getChildAt(1)).tabIndex = 3;
+
+ To reverse the tab order from the default setting for three instances of a TLFTextField object + (tlfInstance1, tlfInstance2 and tlfInstance3), use:
+ 
+
 	 InteractiveObject(tlfInstance1.getChildAt(1)).tabIndex = 3;
+
 	 InteractiveObject(tlfInstance2.getChildAt(1)).tabIndex = 2;
+
 	 InteractiveObject(tlfInstance3.getChildAt(1)).tabIndex = 1;
+
+

- Implementation + + + Implementation
    public function get tabIndex():int
@@ -1806,7 +2132,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -1816,21 +2144,37 @@

+ Calling the new InteractiveObject() constructor + throws an ArgumentError exception. + You can, however, call constructors for the following subclasses of InteractiveObject: + +

+ + +

Method detail
@@ -1845,31 +2189,44 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 2.6 +

+ 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 is available, or if the client system does not support virtual keyboards.

+ +

Note: This method is not supported in AIR applications on iOS.

+ +

Returns @@ -1897,21 +2254,29 @@

Boolean — A value of true means that the soft keyboard request was granted; false means that the soft keyboard was not raised. + +
-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 1.5 +

+ Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu. + This event is dispatched to the object that currently has focus. + If the object that currently has focus is a TextField, the default behavior of this event is to cause + any currently selected text in the text field to be deleted. +

@@ -1927,7 +2292,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -1937,42 +2304,79 @@

+ Dispatched when a user presses and releases the main button of the user's + pointing device over the same InteractiveObject. For a click event to occur, it must always follow this series of + events in the order of occurrence: mouseDown event, then mouseUp. The target object + must be identical for both of these events; otherwise the click event does not + occur. Any number of other mouse events can occur at any time between the + mouseDown or mouseUp events; the click event + still occurs. +

+ 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, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
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.
+ + @@ -1988,50 +2392,87 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 1.0 +

+ Dispatched when a user gesture triggers the context menu associated with this interactive + object in an AIR application. + +

+ The MouseEvent.CONTEXT_MENU constant defines the value of the + type property of a contextMenu event object. + +

This event has the following properties:

+ + + + + + + + + + + + + + + + + + + +
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the right mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
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, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
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.
+ +

See also

@@ -2053,22 +2494,31 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 1.5 +

+ Dispatched when the user activates the platform-specific accelerator key combination for a copy operation + or selects 'Copy' from the text context menu. + This event is dispatched to the object that currently has focus. + If the object that currently has focus is a TextField, the default behavior of this event is to cause + any currently selected text in the text field to be copied to the clipboard. +

Defines the value of the type property of a copy event object.

This event has the following properties:

@@ -2102,22 +2552,31 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 1.5 +

+ Dispatched when the user activates the platform-specific accelerator key combination for a cut operation + or selects 'Cut' from the text context menu. + This event is dispatched to the object that currently has focus. + If the object that currently has focus is a TextField, the default behavior of this event is to cause + any currently selected text in the text field to be cut to the clipboard. +

Defines the value of the type property of a cut event object.

This event has the following properties:

@@ -2151,7 +2610,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -2161,56 +2622,107 @@

+ Dispatched when a user presses and releases the main button of a pointing device twice in + rapid succession over the same InteractiveObject when that object's + doubleClickEnabled flag is set to true. + For a doubleClick event to occur, it must immediately follow the following + series of events: mouseDown, mouseUp, click, + mouseDown, mouseUp. All of these events must share the same + target as the doubleClick event. The second click, represented by + the second mouseDown and mouseUp events, must occur within + a specific period of time after the click event. The allowable length of + this period varies by operating system and can often be configured by the user. + If the target is a selectable text field, the word under the pointer is selected as the + default behavior. If the target InteractiveObject does not have its + doubleClickEnabled flag set to true it receives two + click events. + +

The doubleClickEnabled property defaults + to false.

+ +

The double-click text selection behavior of a TextField object + is not related to the doubleClick event. Use + TextField.doubleClickEnabled to control TextField selections.

+

+ 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. + +

This event has the following properties:

+ + + + + + + + + + + + + + + + + + +
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownFor double-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, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
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.
+ +

See also

@@ -2232,7 +2744,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -2242,13 +2756,21 @@

+ Dispatched after a display object gains focus. + This situation happens when a user highlights the object with a pointing device or keyboard navigation. + The recipient of such focus is called the target object of this event, + while the corresponding InteractiveObject instance that lost focus because of this change is called the related object. + A reference to the related object is stored in the receiving object's relatedObject property. + The shiftKey property is not used. + This event follows the dispatch of the previous object's focusOut event. +

Defines the value of the type property of a focusIn event object.

This event has the following properties:

@@ -2288,7 +2810,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -2298,12 +2822,19 @@

+ Dispatched after a display object loses focus. + This happens when a user highlights a different object with a pointing device or keyboard navigation. + The object that loses focus is called the target object of this event, while the corresponding InteractiveObject + instance that receives focus is called the related object. A reference to the related object is stored in the target object's + relatedObject property. The shiftKey property is not used. This event precedes the dispatch + of the focusIn event by the related object. +

Defines the value of the type property of a focusOut event object.

This event has the following properties:

@@ -2338,30 +2869,47 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 24 +

+ Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, + (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) + Some devices might also interpret this contact as a combination of several touch events, as well. +

Specifically, if a user touches a finger over an InteractiveObject, and then moves the fingers away, the InteractiveObject instance can + dispatch a touchBegin event and a touchEnd event (among others), as well as the gestureDirectionalTap event, or all if + the current environment supports it. Choose how you want to handle the user interaction. Use the flash.ui.Multitouch class to manage 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 to + handle the touchBegin event, then the same event handler will run on a touch-enabled device. However, if you choose to handle + the gestureDirectionalTap event, you can design your event handler to respond to the specific needs of a touch-enabled environment and provide + users with a richer touch-enabled experience. You can also handle both events, separately, to provide a different response for a gesture event than a touch + event. But flash.ui.Multitouch class decides whether touch event or gesture event will get triggered.

+

When handling the properties of the event object, note that the localX and localY properties are set to the primary point of + contact(For Apple TV it is centre of the screen). The offsetX and offsetY properties correspond to the direction of the gesture.

+

Note: This API only supports a single-finger directional tap.

+

Defines the value of the type property of a GESTURE_DIRECTIONAL_TAP touch event object. @@ -2414,29 +2962,45 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 2 +

+ Dispatched when the user presses two points of contact over the same InteractiveObject 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 interpret this contact as a doubleClick event. +

Specifically, if a user taps two fingers over an InteractiveObject, the InteractiveObject instance can dispatch a doubleClick + event or a gestureTwoFingerTap event, or both if the current environment supports it. Choose how you want to handle the user interaction. + Use the flash.ui.Multitouch class to manage 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 to handle the doubleClick event, then the same event handler will run on a touch-enabled device and + a mouse enabled device. However, if you choose to handle the gestureTwoFingerTap event, you can design your event handler + to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled + experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.

+

Note: See the Multitouch class for environment compatibility information.

+

See also

@@ -2460,29 +3024,45 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 2 +

+ Dispatched when the user moves a point of contact over the InteractiveObject instance + 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 interpret this contact as a mouseOver event and as a touchOver event. +

Specifically, if a user moves a finger over an InteractiveObject, the InteractiveObject instance can dispatch a mouseOver + event or a touchOver event or a gesturePan event, or all if the current environment supports it. + Choose how you want to handle the user interaction. Use the flash.ui.Multitouch class to manage 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 to handle the mouseOver event, then the same event handler will run on a touch-enabled device and + a mouse enabled device. However, if you choose to handle the gesturePan event, you can design your event handler + to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled + experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.

+

Note: See the Multitouch class for environment compatibility information.

+

Defines the value of the type property of a GESTURE_PAN touch event object. @@ -2573,33 +3153,53 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 2 +

+ Dispatched when the user performs a rotation gesture at a point of contact with an 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 common rotation gesture, + but each device and operating system can have its own requirements to indicate rotation. + Some devices might also interpret this contact as a combination of several mouse events, as well. +

Specifically, if a user moves a finger over an InteractiveObject, the InteractiveObject instance can + dispatch a mouseOver + event and a click event (among others), in addition to the gestureRotate event, or all if the current environment supports it. + Choose how you want to handle the user interaction. Use the flash.ui.Multitouch class to manage 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 to handle the mouseOver event, then the same event handler will run on a touch-enabled device and + a mouse enabled device. However, if you choose to handle the gestureRotate event, you can design your event handler + to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled + experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.

+

When handling the properties of the event object, note that the localX and localY properties are set to the + primary point of contact. The offsetX and offsetY properties are the distance to the point of contact where the rotation gesture + is complete.

+

Note: See the Multitouch class for environment compatibility information.

+

Defines the value of the type property of a GESTURE_ROTATE touch event object. @@ -2696,34 +3296,55 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 2 +

+ Dispatched when the user performs a swipe gesture at a point of contact with an 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). + Moving several fingers in parallel is a common swipe gesture, + but each device and operating system can have its own requirements for a swipe. + Some devices might also interpret this contact as a combination of several mouse events, as well. +

Specifically, if a user moves a finger over an InteractiveObject, and then moves the fingers together, the InteractiveObject instance can + dispatch a rollOver + event and a rollOut event (among others), in addition to the gestureSwipe event, or all if the current environment supports it. + Choose how you want to handle the user interaction. + If you choose to handle the rollOver event, then the same event handler will run on a touch-enabled device and + a mouse enabled device. However, if you choose to handle the gestureSwipe event, you can design your event handler + to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled + experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.

+

When handling the properties of the event object, note that the localX and localY properties are set to the + primary point of contact. The offsetX and offsetY properties are the distance to the point of contact where the swipe gesture + is complete.

+

Note: While some devices using the Mac OS operating system can + interpret a four-finger swipe, this API only supports a three-finger swipe.

+

Defines the value of the type property of a GESTURE_SWIPE touch event object. @@ -2811,32 +3432,51 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 2 +

+ Dispatched when the user creates a point of contact with an InteractiveObject instance, 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 tablet with a touch screen). + Some devices might also interpret this contact as a combination of several mouse events, as well. +

Specifically, if a user moves a finger over an InteractiveObject, and then provides a secondary tap, the InteractiveObject instance can + dispatch a mouseOver + event and a click event (among others) as well as the gesturePressAndTap event, or all if the current environment supports it. + Choose how you want to handle the user interaction. Use the flash.ui.Multitouch class to manage 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 to handle the mouseOver event, then the same event handler will run on a touch-enabled device and + a mouse enabled device. However, if you choose to handle the gesturePressAndTap event, you can design your event handler + to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled + experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.

+

When handling the properties of the event object, note that the localX and localY properties are set to the + primary point of contact (the "push"). The offsetX and offsetY properties are the distance to the secondary point of + contact (the "tap").

+

See also

@@ -2862,34 +3502,55 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 2 +

+ Dispatched when the user performs a zoom gesture at a point of contact with an 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 touch screen). + Moving fingers apart is a common zoom gesture, + but each device and operating system can have its own requirements to indicate zoom. + Some devices might also interpret this contact as a combination of several mouse events, as well. +

Specifically, if a user moves a finger over an InteractiveObject, and then moves the fingers apart, the InteractiveObject instance can + dispatch a mouseOver + event and a click event (among others), in addition to the gestureZoom event, or all if the current environment supports it. + Choose how you want to handle the user interaction. Use the flash.ui.Multitouch class to manage 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 to handle the mouseOver event, then the same event handler will run on a touch-enabled device and + a mouse enabled device. However, if you choose to handle the gestureZoom event, you can design your event handler + to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled + experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.

+

When handling the properties of the event object, note that the localX and localY properties are set to the + primary point of contact. The offsetX and offsetY properties are the distance to the point of contact where the zoom gesture + is complete.

+

Note: See the Multitouch class for environment compatibility information.

+

Defines the value of the type property of a GESTURE_ZOOM touch event object. @@ -2982,8 +3643,11 @@

+ This event is dispatched to any client app that supports inline input with an IME + +

@@ -2999,7 +3663,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -3009,13 +3675,22 @@

+ Dispatched when the user presses a key. Mappings between keys and specific characters + 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 characters, such as Chinese ideographs, that the standard QWERTY keyboard is ill-equipped + to produce. This event occurs before the keyUp event. -

In AIR, canceling this event prevents the character from being entered into a text field.

-

+ + +

In AIR, canceling this event prevents the character from being entered into a text field.

+ + +

The KeyboardEvent.KEY_DOWN constant defines the value of the type property of a keyDown event object. @@ -3079,7 +3754,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -3089,17 +3766,29 @@

+ Dispatched when the user attempts to change focus by using keyboard navigation. + The default behavior of this event is to change the focus and dispatch the + corresponding focusIn and focusOut events. + +

This event is dispatched to the object that currently has focus. + The related object for this event is the InteractiveObject instance that receives focus + if you do not prevent the default behavior. + You can prevent the change in focus by calling the preventDefault() method + in an event listener that is properly registered with the target object. + Focus changes and focusIn and focusOut + events are dispatched by default.

+

Defines the value of the type property of a keyFocusChange event object. @@ -3137,7 +3826,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -3147,12 +3838,19 @@

+ Dispatched when the user releases a key. Mappings between keys and specific characters 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 + characters, such as Chinese ideographs, that the standard QWERTY keyboard is + ill-equipped to produce. This event occurs after a keyDown event and has + the following characteristics: +

The KeyboardEvent.KEY_UP constant defines the value of the type property of a keyUp event object. @@ -3214,53 +3912,93 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 1.0 +

+ Dispatched when a user presses and releases the middle button of the user's + pointing device over the same InteractiveObject. For a middleClick event to occur, it must always follow this series of + events in the order of occurrence: middleMouseDown event, then middleMouseUp. The target object + must be identical for both of these events; otherwise the middleClick event does not + occur. Any number of other mouse events can occur at any time between the + middleMouseDown or middleMouseUp events; the middleClick event + still occurs. +

+ Defines the value of the type property of a middleClick event object. + +

This event has the following properties:

+ + + + + + + + + + + + + + + + + + + +
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDownFor middle-click events, this property 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, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
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.
+ + @@ -3276,46 +4014,79 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 1.0 +

+ Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. +

+ Defines the value of the type property of a middleMouseDown event object. +

This event has the following properties:

+ + + + + + + + + + + + + + + + + + + +
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the middle mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
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, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
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.
- + + + @@ -3330,48 +4101,83 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 1.0 +

+ Dispatched when a user releases the pointing device button over an + InteractiveObject instance. +

+ Defines the value of the type property of a middleMouseUp event object. + +

This event has the following properties:

+ + + + + + + + + + + + + + + + + + + +
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblestrue
buttonDowntrue if the middle mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
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, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
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.
+ + @@ -3387,7 +4193,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -3397,38 +4205,71 @@

+ Dispatched when a user presses the pointing device button over an InteractiveObject instance. + If the target is a SimpleButton instance, the SimpleButton instance displays the + downState display object as the default behavior. If the target is a + selectable text field, the text field begins selection as the default behavior. +

+ Defines the value of the type property of a mouseDown 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; the default behavior cannot be canceled.
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 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.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
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.
+ + @@ -3444,7 +4285,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -3454,14 +4297,24 @@

+ Dispatched when the user attempts to change focus by using a pointer device. + The default behavior of this event is to change the focus and dispatch the corresponding + focusIn and focusOut events. -

This event is dispatched to the object that currently has focus. The related object for this event is the + + +

This event is dispatched to the object that currently has focus. The related object for this event is the + InteractiveObject instance that receives focus if you do not prevent the default behavior. You can prevent the change in + focus by calling preventDefault() in an event listener that is properly registered with the target object. + The shiftKey property is not used. Focus changes and + focusIn and focusOut events are dispatched by default.

+

Defines the value of the type property of a mouseFocusChange event object.

This event has the following properties:

@@ -3498,7 +4351,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -3508,35 +4363,66 @@

+ Dispatched when a user moves the pointing device while it is over an InteractiveObject. + If the target is a text field that the user is selecting, the selection is updated as the default behavior. +

+ Defines the value of the type property of a mouseMove event object. -

This event has the following properties:

+ + +

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; the default behavior cannot be canceled.
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, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
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.
+ + @@ -3552,7 +4438,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -3562,48 +4450,91 @@

+ Dispatched when the user moves a pointing device away from an InteractiveObject instance. + The event target is the object previously under the pointing device. The relatedObject + is the object the pointing device has moved to. + If the target is a SimpleButton instance, the button displays the upState + display object as the default behavior. +

The mouseOut event is dispatched each time the mouse leaves the + area of any child object of the display object container, even if the mouse remains over another + child object of the display object container. This is different behavior than the purpose of the rollOut event, which is to simplify the + coding of rollover behaviors for display object containers with children. When the mouse leaves + the area of a display object or the area of any of its children to go to an object that is not + one of its children, the display object dispatches the rollOut event.The rollOut events are dispatched consecutively + up the parent chain of the object, starting with the object and ending with the highest parent that is neither the root nor an + ancestor of the relatedObject.

+

+ Defines the value of the type property of a mouseOut 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; the default behavior cannot be canceled.
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.
relatedObjectThe display list object to which the pointing device now points.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
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.
+ + @@ -3619,7 +4550,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -3629,47 +4562,89 @@

+ Dispatched when the user moves a pointing device over an InteractiveObject instance. + The relatedObject is the object that was previously under + the pointing device. + If the target is a SimpleButton instance, the object displays the overState + or upState display object, depending on whether the mouse button is down, as the default behavior. +

The mouseOver event is dispatched each time the mouse enters the area of any child object of the display object container, + even if the mouse was already over another child object of the display object container. + This is different behavior than the purpose of the rollOver event, which is to simplify the coding of rollout behaviors for + display object containers with children. When the mouse enters the area of a display object or the area of any of its children from an object + that is not one of its children, the display object dispatches the rollOver event. + The rollOver events are dispatched consecutively down the parent chain of the object, + starting with the highest parent that is neither the root nor an ancestor of the relatedObject and ending with the object.

+

+ Defines the value of the type property of a mouseOver 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; the default behavior cannot be canceled.
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.
relatedObjectThe display list object to which the pointing device was pointing.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
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.
+ + @@ -3685,7 +4660,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -3695,41 +4672,77 @@

+ Dispatched when a user releases the pointing device button over an + InteractiveObject instance. + If the target is a SimpleButton instance, the object displays the upState + display object. + If the target is a selectable text field, the text field ends selection as the default + behavior. +

+ Defines the value of the type property of a mouseUp 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; the default behavior cannot be canceled.
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, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
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.
+ + @@ -3745,7 +4758,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -3755,37 +4770,70 @@

+ Dispatched when a mouse wheel is spun over an InteractiveObject instance. + If the target is a text field, the text scrolls as the default behavior. + Only available on Microsoft Windows operating systems. +

+ Defines the value of the type property of a mouseWheel event object. -

This event has the following properties:

+ + +

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; the default behavior cannot be canceled.
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.
deltaThe number of lines that that each notch on the mouse wheel represents.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
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.
+ + @@ -3801,47 +4849,83 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 + +
-
Runtime version: AIR 52 +Runtime version: AIR 51 +

+ Dispatched when a horizontal mouse wheel is spun over an InteractiveObject instance. + If the target is a text field, the text scrolls as the default behavior. + Only available on Microsoft Windows operating systems. +

+ Defines the value of the type property of a mouseWheelHorizontal event object. -

This event has the following properties:

+ + +

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; the default behavior cannot be canceled.
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.
deltaThe number of lines that that each notch on the mouse wheel represents.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
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.
- + + + @@ -3856,27 +4940,41 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 1.0 +

+ Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. + +

The event's dropAction property indicates the action set + by the drag target object; a value of "none" (DragActions.NONE) + indicates that the drop was canceled or was not accepted.

+ +

The nativeDragComplete event handler is a convenient place + to update the state of the initiating display object, for example, by removing + an item from a list (on a drag action of "move"), or by changing the visual + properties.

-

+ + +

NativeDragEvent.NATIVE_DRAG_COMPLETE defines the value of the type property of a nativeDragComplete event object. @@ -3905,27 +5003,42 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 1.0 +

+ Dispatched by the target InteractiveObject when a dragged object is + dropped on it and the drop has been accepted with a call to + DragManager.acceptDragDrop(). -

Access the dropped data using the event object clipboard + + +

Access the dropped data using the event object clipboard + property.

+ +

The handler for this event should set the DragManager.dropAction + property to provide feedback to the initiator object about which drag action + was taken. If no value is set, the DragManager will select a default value + from the list of allowed actions.

-

+ + +

NativeDragEvent.NATIVE_DRAG_DROP defines the value of the type property of a nativeDragDrop event object. @@ -3954,26 +5067,39 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 1.0 +

+ Dispatched by an InteractiveObject when a drag gesture enters its boundary. + +

Handle either the nativeDragEnter or nativeDragOver + events to allow the display object to become the drop target.

+ +

To determine whether the dispatching display object can accept the drop, + check the suitability of the data in clipboard property of + the event object, and the allowed drag actions in the allowedActions + property.

-

+ + +

NativeDragEvent.NATIVE_DRAG_ENTER defines the value of the type property of a nativeDragEnter event object. @@ -4002,18 +5128,23 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 1.0 +

+ Dispatched by an InteractiveObject when a drag gesture leaves its boundary. -

+ + +

NativeDragEvent.NATIVE_DRAG_EXIT defines the value of the type property of a nativeDragExit event object. @@ -4042,30 +5173,47 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 1.0 +

+ Dispatched by an InteractiveObject continually while a drag gesture remains within its + boundary. + +

nativeDragOver events are dispatched whenever the mouse is moved. On Windows and + Mac, they are also dispatched on a short timer interval even when the mouse has not moved.

+ +

Handle either the nativeDragOver or nativeDragEnter + events to allow the display object to become the drop target.

+ +

To determine whether the dispatching display object can accept the drop, + check the suitability of the data in clipboard property of + the event object, and the allowed drag actions in the allowedActions + property.

+ +

NativeDragEvent.NATIVE_DRAG_OVER defines the value of the type property of a nativeDragOver event object. @@ -4095,19 +5243,25 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 1.0 +

+ Dispatched at the beginning of a drag operation by the InteractiveObject that is + specified as the drag initiator in the DragManager.doDrag() call. -

+ + +

NativeDragEvent.NATIVE_DRAG_START defines the value of the type property of a nativeDragStart event object. @@ -4136,20 +5290,28 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 1.0 +

+ Dispatched during a drag operation by the InteractiveObject that is + specified as the drag initiator in the DragManager.doDrag() call. -

nativeDragUpdate events are not dispatched on Linux.

+ +

nativeDragUpdate events are not dispatched on Linux.

+ + +

NativeDragEvent.NATIVE_DRAG_UPDATE defines the value of the type property of a nativeDragUpdate event object. @@ -4178,23 +5340,33 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 1.5 +

+ Dispatched when the user activates the platform-specific accelerator key combination for a paste operation + or selects 'Paste' from the text context menu. + This event is dispatched to the object that currently has focus. + If the object that currently has focus is a TextField, the default behavior of this event is to cause + the contents of the clipboard to be pasted into the text field at the current insertion point + replacing any currently selected text in the text field. +

The Event.PASTE constant defines the value of the type property of a paste event object.

This event has the following properties:

@@ -4228,31 +5400,49 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen. + +

The typical sequence of events that occurs when a user lowers a stylus to the screen, + moves it across the screen, and lifts it away is:

+ +

Note: See the Multitouch class for environment compatibility information.

+ +

Defines the value of the type property of a PROXIMITY_BEGIN touch event object. @@ -4311,33 +5501,53 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen. + +

A proximityEnd event is not dispatched when the stylus touches the screen.

+ +

The typical sequence of events that occurs when a user lowers a stylus to the screen, + moves it across the screen, and lifts it away is:

+ +

Note: See the Multitouch class for environment compatibility information.

+ +

Defines the value of the type property of a PROXIMITY_END touch event object. @@ -4396,32 +5606,51 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Dispatched when the user moves an active stylus over the screen while remaining within + the proximity detection threshold. + +

The typical sequence of events that occurs when a user lowers a stylus to the screen, + moves it across the screen, and lifts it away is:

+ +

Note: See the Multitouch class for environment compatibility information.

+ +

Defines the value of the type property of a PROXIMITY_MOVE touch event object. @@ -4480,21 +5709,29 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within + the proximity detection threshold of the screen. + +

Note: See the Multitouch class for environment compatibility information.

+ +

See also

@@ -4516,21 +5753,29 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Dispatched when the user moves an active stylus directly above this InteractiveObject + while remaining within the proximity detection threshold of the screen. + +

Note: See the Multitouch class for environment compatibility information.

+ +

Defines the value of the type property of a PROXIMITY_OVER touch event object. @@ -4589,35 +5834,57 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Dispatched when the user moves an active stylus away from this InteractiveObject + and any of its children while remaining within the proximity detection threshold of the screen. + +

The event target is the object previously under the stylus or a parent of + that object. The relatedObject is the object that the stylus has moved above. + The proximityRollOut events are dispatched consecutively up the parent chain of the object, + starting with the object and ending with the highest parent that is neither the root nor an + ancestor of the relatedObject.

+ +

The purpose of the proximityRollOut event is to simplify the + coding of rollover behaviors for display object containers with children. When the stylus leaves + the area of a display object, including the area of any of its children, to go to an object that is not + one of its children, the display object dispatches the proximityRollOut event. This is different behavior + than that of the proximityOut event, which is dispatched each time the mouse leaves the + area of any child object of the display object container, even if the mouse remains over another + child object of the display object container.

+ +

Note: See the Multitouch class for environment compatibility information.

+ +

Defines the value of the type property of a PROXIMITY_ROLL_OUT touch event object. @@ -4676,36 +5943,59 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Dispatched when the user moves an active stylus over this InteractiveObject from outside the + object's tree of descendents in the display list + (while remaining within the proximity detection threshold of the screen). + +

The event target is the object under the stylus or a parent of that object. + The relatedObject is the object that was previously under the stylus. + The proximityRollOver events are dispatched consecutively down the parent + chain of the object, starting with the highest parent that is neither the root + nor an ancestor of the relatedObject and ending with the object.

+ +

The purpose of the proximityRollOver event is to simplify the coding of rollout behaviors for + display object containers with children. When the stylus enters the area above a display + object or above any of its children from an object that is not one of its + children, the display object dispatches the proximityRollOver event. This is different behavior + than that of the proximityOver event, which is dispatched each time the mouse + enters the area of any child object of the display object container, even if the mouse + was already over another child object of the display object container.

+ +

Note: See the Multitouch class for environment compatibility information.

+ +

Defines the value of the type property of a PROXIMITY_ROLL_OVER touch event object. @@ -4764,25 +6054,37 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 3.3 +

+ Dispatched when a user releases the button on the pointing device after the + user first pressed the button over an InteractiveObject instance + and then moved the pointing device off of the InteractiveObject instance. + If the target is a SimpleButton instance, the object displays the upState + display object. + If the target is a selectable text field, the text field ends selection as the default + behavior. + +

@@ -4798,53 +6100,93 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 1.0 +

+ Dispatched when a user presses and releases the right button of the user's + pointing device over the same InteractiveObject. For a rightClick event to occur, it must always follow this series of + events in the order of occurrence: rightMouseDown event, then rightMouseUp. The target object + must be identical for both of these events; otherwise the rightClick event does not + occur. Any number of other mouse events can occur at any time between the + rightMouseDown or rightMouseUp events; the rightClick event + still occurs. +

+ 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
buttonDownFor right-click events, this property 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, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
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.
+ + @@ -4860,18 +6202,23 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 1.0 +

+ Dispatched when a user presses the pointing device button over an InteractiveObject instance. +

@@ -4887,48 +6234,83 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 1.0 +

+ Dispatched when a user releases the pointing device button over an + InteractiveObject instance. +

+ 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 right mouse button is pressed; false otherwise.
cancelablefalse; the default behavior cannot be canceled.
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, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
clickCountCount of the number of mouse clicks to indicate whether the event is part of a multi-click sequence.
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.
+ + @@ -4944,7 +6326,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -4954,48 +6338,91 @@

+ Dispatched when the user moves a pointing device away from an InteractiveObject + instance. The event target is the object previously under the pointing device or a parent of + that object. The relatedObject is the object that the pointing device has moved to. + The rollOut events are dispatched consecutively up the parent chain of the object, + starting with the object and ending with the highest parent that is neither the root nor an + ancestor of the relatedObject. +

The purpose of the rollOut event is to simplify the + coding of rollover behaviors for display object containers with children. When the mouse leaves + the area of a display object or the area of any of its children to go to an object that is not + one of its children, the display object dispatches the rollOut event. This is different behavior + than that of the mouseOut event, which is dispatched each time the mouse leaves the + area of any child object of the display object container, even if the mouse remains over another + child object of the display object container.

+

+ Defines the value of the type property of a rollOut event object. + +

This event has the following properties:

+ + + + + + + + + + + + + + + + + + + +
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblesfalse
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.
relatedObjectThe display list object to which the pointing device now points.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
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.
+ + @@ -5011,7 +6438,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -5021,48 +6450,91 @@

+ Dispatched when the user moves a pointing device over an InteractiveObject instance. + The event target is the object under the pointing device or a parent of that object. + The relatedObject is the object that was previously under the pointing + device. The rollOver events are dispatched consecutively down the parent + chain of the object, starting with the highest parent that is neither the root + nor an ancestor of the relatedObject and ending with the object. +

The purpose of the rollOver event is to simplify the coding of rollout behaviors for + display object containers with children. When the mouse enters the area of a display + object or the area of any of its children from an object that is not one of its + children, the display object dispatches the rollOver event. This is different behavior + than that of the mouseOver event, which is dispatched each time the mouse + enters the area of any child object of the display object container, even if the mouse + was already over another child object of the display object container.

+

+ Defines the value of the type property of a rollOver event object. + +

This event has the following properties:

+ + + + + + + + + + + + + + + + + + + +
PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblesfalse
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.
relatedObjectThe display list object to which the pointing device was pointing.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
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.
+ + @@ -5078,22 +6550,31 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 1.5 +

+ Dispatched when the user activates the platform-specific accelerator key combination for a select all operation + or selects 'Select All' from the text context menu. + This event is dispatched to the object that currently has focus. + If the object that currently has focus is a TextField, the default behavior of this event is to cause + all the contents of the text field to be selected. +

The Event.SELECT_ALL constant defines the value of the type property of a selectAll event object.

This event has the following properties:

@@ -5126,17 +6607,21 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 2.6 +

+ Dispatched immediately after the soft keyboard is raised. +

See also

@@ -5157,17 +6642,21 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 2.6 +

+ Dispatched immediately before the soft keyboard is raised. +

See also

@@ -5188,7 +6677,8 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
@@ -5197,7 +6687,9 @@

+ Dispatched immediately after the soft keyboard is lowered. +

See also

@@ -5219,7 +6711,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -5229,7 +6723,9 @@

+ Dispatched when the value of the object's tabChildren flag changes. +

The Event.TAB_CHILDREN_CHANGE constant defines the value of the type property of a tabChildrenChange event object.

This event has the following properties:

@@ -5260,7 +6756,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -5270,7 +6768,9 @@

+ Dispatched when the object's tabEnabled flag changes. +

The Event.TAB_ENABLED_CHANGE constant defines the value of the type property of a tabEnabledChange event object. @@ -5306,7 +6806,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -5316,7 +6818,9 @@

+ Dispatched when the value of the object's tabIndex property changes. +

The Event.TAB_INDEX_CHANGE constant defines the value of the type property of a tabIndexChange event object. @@ -5352,7 +6856,9 @@

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -5362,11 +6868,17 @@

+ 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 no formatting or style information. +

Defines the value of the type property of a textInput event object.

Note: This event is not dispatched for the Delete or Backspace keys.

@@ -5400,27 +6912,41 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 2 +

+ Dispatched when the user first contacts 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 mouseDown event. +

Specifically, if a user touches a finger to a touch screen, the InteractiveObject instance can dispatch a mouseDown + event or a touchBegin event, or both if the current environment supports it. Choose how you want to handle the user interaction. + Use the flash.ui.Multitouch class to manage 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 to handle the mouseDown event, then the same event handler will run on a touch-enabled device and + a mouse enabled device. However, if you choose to handle the touchBegin event, you can design your event handler + to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled + experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.

+

Note: See the Multitouch class for environment compatibility information.

+

Defines the value of the type property of a TOUCH_BEGIN touch event object. @@ -5508,27 +7034,41 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 2 +

+ Dispatched when the user removes contact with 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 mouseUp event. +

Specifically, if a user lifts a finger from a touch screen, the InteractiveObject instance can dispatch a mouseUp + event or a touchEnd event, or both if the current environment supports it. Choose how you want to handle the user interaction. + Use the flash.ui.Multitouch class to manage 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 to handle the mouseUp event, then the same event handler will run on a touch-enabled device and + a mouse enabled device. However, if you choose to handle the touchEnd event, you can design your event handler + to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled + experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.

+

Note: See the Multitouch class for environment compatibility information.

+

Defines the value of the type property of a TOUCH_END touch event object. @@ -5616,29 +7156,47 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 2 +

+ Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed. + Note that this event does not require actual movement of the point of contact to be dispatched. -

Some devices might interpret this contact as a mouseMove event. + + +

Some devices might interpret this contact as a mouseMove event. + Specifically, if a user moves a finger across a touch screen, the InteractiveObject instance can dispatch a mouseMove + event or a touchMove event, or both if the current environment supports it. Choose how you want to handle the user interaction. + Use the flash.ui.Multitouch class to manage 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 to handle the mouseMove event, then the same event handler will run on a touch-enabled device and + a mouse enabled device. However, if you choose to handle the touchMove event, you can design your event handler + to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled + experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.

-

Note: See the Multitouch class for environment compatibility information.

+ +

Note: See the Multitouch class for environment compatibility information.

+ + +

Defines the value of the type property of a TOUCH_MOVE touch event object. @@ -5726,28 +7284,43 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 2 +

+ Dispatched when the user moves the point of contact away from InteractiveObject instance 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 this contact as a mouseOut event. +

Specifically, if a user moves a finger across a touch screen, the InteractiveObject instance can dispatch a mouseOut + event or a touchOut event, or both if the current environment supports it. Choose how you want to handle the user interaction. + Use the flash.ui.Multitouch class to manage 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 to handle the mouseOut event, then the same event handler will run on a touch-enabled device and + a mouse enabled device. However, if you choose to handle the touchOut event, you can design your event handler + to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled + experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.

+

Note: See the Multitouch class for environment compatibility information.

+

Defines the value of the type property of a TOUCH_OUT touch event object. @@ -5804,28 +7377,43 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 2 +

+ Dispatched when the user moves the point of contact over an InteractiveObject instance on 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 devices might also interpret this contact as a mouseOver event. +

Specifically, if a user moves a finger over an InteractiveObject, the InteractiveObject instance can dispatch a mouseOver + event or a touchOver event, or both if the current environment supports it. Choose how you want to handle the user interaction. + Use the flash.ui.Multitouch class to manage 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 to handle the mouseOver event, then the same event handler will run on a touch-enabled device and + a mouse enabled device. However, if you choose to handle the touchOver event, you can design your event handler + to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled + experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.

+

Note: See the Multitouch class for environment compatibility information.

+

Defines the value of the type property of a TOUCH_OVER touch event object. @@ -5882,28 +7470,43 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 2 +

+ Dispatched when the user moves the point of contact away from an InteractiveObject 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). + Some devices might also interpret this contact as a rollOut event. +

Specifically, if a user moves a finger over an InteractiveObject, the InteractiveObject instance can dispatch a rollOut + event or a touchRollOut event, or both if the current environment supports it. Choose how you want to handle the user interaction. + Use the flash.ui.Multitouch class to manage 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 to handle the rollOut event, then the same event handler will run on a touch-enabled device and + a mouse enabled device. However, if you choose to handle the touchRollOut event, you can design your event handler + to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled + experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.

+

Note: See the Multitouch class for environment compatibility information.

+

Defines the value of the type property of a TOUCH_ROLL_OUT touch event object. @@ -5960,28 +7563,43 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 2 +

+ Dispatched when the user moves the point of contact over an InteractiveObject instance on 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 devices might also interpret this contact as a rollOver event. +

Specifically, if a user moves a finger over an InteractiveObject, the InteractiveObject instance can dispatch a rollOver + event or a touchRollOver event, or both if the current environment supports it. Choose how you want to handle the user interaction. + Use the flash.ui.Multitouch class to manage 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 to handle the rollOver event, then the same event handler will run on a touch-enabled device and + a mouse enabled device. However, if you choose to handle the touchRollOver event, you can design your event handler + to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled + experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.

+

Note: See the Multitouch class for environment compatibility information.

+

Defines the value of the type property of a TOUCH_ROLL_OVER touch event object. @@ -6038,29 +7656,45 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 2 +

+ 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 and releases a finger from a single point over a display object + on a mobile phone or tablet with a touch screen). + Some devices might also interpret this contact as a click event. +

Specifically, if a user taps a finger over an InteractiveObject, the InteractiveObject instance can dispatch a click + event or a touchTap event, or both if the current environment supports it. Choose how you want to handle the user interaction. + Use the flash.ui.Multitouch class to manage 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 to handle the click event, then the same event handler will run on a touch-enabled device and + a mouse enabled device. However, if you choose to handle the touchTap event, you can design your event handler + to respond to the specific needs of a touch-enabled environment and provide users with a richer touch-enabled + experience. You can also handle both events, separately, to provide a different response for a touch event than a mouse event.

+

Note: See the Multitouch class for environment compatibility information.

+

Defines the value of the type property of a TOUCH_TAP touch event object. @@ -6231,11 +7865,11 @@

-Submit Feedback +Submit Feedback
-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/flash/display/NativeWindow.html b/static/reference/actionscript/3.0/flash/display/NativeWindow.html index 0c5676366..5048bdb1f 100644 --- a/static/reference/actionscript/3.0/flash/display/NativeWindow.html +++ b/static/reference/actionscript/3.0/flash/display/NativeWindow.html @@ -550,7 +550,7 @@   
-listOwnedWindows():Vector.<NativeWindow>
+listOwnedWindows():Vector.<NativeWindow>
Returns a list of the NativeWindow objects that are owned by this window.
@@ -3752,7 +3752,7 @@
-public function listOwnedWindows():Vector.<NativeWindow> +public function listOwnedWindows():Vector.<NativeWindow>

@@ -3781,7 +3781,7 @@ Returns
- @@ -257,6 +259,7 @@ @@ -275,6 +278,7 @@ @@ -295,6 +299,7 @@ @@ -359,6 +364,7 @@ @@ -395,7 +401,9 @@ @@ -513,12 +521,14 @@ @@ -536,7 +546,7 @@ - @@ -553,7 +563,7 @@ - @@ -565,7 +575,7 @@ - @@ -584,12 +594,14 @@ @@ -971,6 +983,7 @@ requestSoftKeyboard():Boolean
+ Raises a virtual keyboard.
@@ -1136,6 +1149,7 @@ clear @@ -1144,7 +1158,9 @@ click @@ -1153,7 +1169,9 @@ contextMenu @@ -1162,7 +1180,9 @@ copy @@ -1171,7 +1191,9 @@ cut @@ -1189,8 +1211,11 @@ doubleClick @@ -1216,6 +1241,7 @@ focusIn @@ -1224,6 +1250,7 @@ focusOut @@ -1248,8 +1275,11 @@ gestureDirectionalTap @@ -1258,8 +1288,11 @@ gestureLongPress @@ -1268,8 +1301,11 @@ gesturePan @@ -1278,7 +1314,9 @@ gestureRotate @@ -1287,7 +1325,9 @@ gestureSwipe @@ -1296,8 +1336,11 @@ gestureTap @@ -1306,7 +1349,9 @@ gestureZoom @@ -1315,8 +1360,11 @@ imeStartComposition @@ -1325,6 +1373,7 @@ keyDown @@ -1333,6 +1382,7 @@ keyFocusChange @@ -1341,6 +1391,7 @@ keyUp @@ -1349,7 +1400,9 @@ middleClick @@ -1358,6 +1411,7 @@ middleMouseDown @@ -1366,7 +1420,9 @@ middleMouseUp @@ -1375,6 +1431,7 @@ mouseDown @@ -1383,6 +1440,7 @@ mouseFocusChange @@ -1400,6 +1458,7 @@ mouseMove @@ -1408,6 +1467,7 @@ mouseOut @@ -1416,6 +1476,7 @@ mouseOver @@ -1424,7 +1485,9 @@ mouseUp @@ -1433,6 +1496,7 @@ mouseWheel @@ -1441,6 +1505,7 @@ mouseWheelHorizontal @@ -1449,6 +1514,7 @@ nativeDragComplete @@ -1457,8 +1523,11 @@ nativeDragDrop @@ -1467,6 +1536,7 @@ nativeDragEnter @@ -1475,6 +1545,7 @@ nativeDragExit @@ -1483,7 +1554,9 @@ nativeDragOver @@ -1492,7 +1565,9 @@ nativeDragStart @@ -1501,7 +1576,9 @@ nativeDragUpdate @@ -1526,7 +1603,9 @@ paste @@ -1535,6 +1614,7 @@ proximityBegin @@ -1543,6 +1623,7 @@ proximityEnd @@ -1551,7 +1632,9 @@ proximityMove @@ -1560,7 +1643,9 @@ proximityOut @@ -1569,7 +1654,9 @@ proximityOver @@ -1578,7 +1665,9 @@ proximityRollOut @@ -1587,8 +1676,11 @@ proximityRollOver @@ -1597,8 +1689,11 @@ releaseOutside @@ -1641,7 +1736,9 @@ rightClick @@ -1650,6 +1747,7 @@ rightMouseDown @@ -1658,7 +1756,9 @@ rightMouseUp @@ -1667,7 +1767,9 @@ rollOut @@ -1676,6 +1778,7 @@ rollOver @@ -1684,7 +1787,9 @@ selectAll @@ -1693,6 +1798,7 @@ softKeyboardActivate @@ -1701,6 +1807,7 @@ softKeyboardActivating @@ -1709,6 +1816,7 @@ softKeyboardDeactivate @@ -1725,6 +1833,7 @@ tabChildrenChange @@ -1733,6 +1842,7 @@ tabEnabledChange @@ -1741,6 +1851,7 @@ tabIndexChange @@ -1749,7 +1860,9 @@ textInput @@ -1758,6 +1871,7 @@ touchBegin @@ -1766,6 +1880,7 @@ touchEnd @@ -1774,6 +1889,7 @@ touchMove @@ -1782,7 +1898,9 @@ touchOut @@ -1791,7 +1909,9 @@ touchOver @@ -1800,7 +1920,9 @@ touchRollOut @@ -1809,7 +1931,9 @@ touchRollOver @@ -1818,8 +1942,11 @@ touchTap @@ -2414,6 +2541,10 @@

On Linux, setting displayState to StageDisplayState.FULL_SCREEN or StageDisplayState.FULL_SCREEN_INTERACTIVE is an asynchronous operation.

+

Note that it is not possible to change the display state within an event handler that is dispatched due to + a change in the display state: this could lead to recursion and would also cause problems within the native + operating system handling for these mechanisms. A SecurityError is thrown if the displayState + property is changed within a FullScreenEvent event handler.

Implementation
    public function get displayState():String @@ -2432,7 +2563,8 @@ For more information, see the "Security" chapter in the ActionScript 3.0 Developer's Guide. Trying to set the displayState property while the settings dialog is displayed, without a user response, or if the param or embed HTML tag's allowFullScreen attribute is not set to - true throws a security error. + true throws a security error. It is also forbidden to set the displayState property within a + FullScreenEvent handler.
Vector.<NativeWindow> — an Vector.<NativeWindow> object containing zero or more NativeWindow objects that +Vector.<NativeWindow> — an Vector.<NativeWindow> object containing zero or more NativeWindow objects that are owned by this instance. @@ -5575,11 +5575,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/flash/display/Stage.html b/static/reference/actionscript/3.0/flash/display/Stage.html index f9492e818..ab25b9acd 100644 --- a/static/reference/actionscript/3.0/flash/display/Stage.html +++ b/static/reference/actionscript/3.0/flash/display/Stage.html @@ -148,7 +148,9 @@
 InheritedaccessibilityImplementation : AccessibilityImplementation
+ The current accessibility implementation (AccessibilityImplementation) + for this InteractiveObject instance.
InteractiveObject
 InheritedcontextMenu : NativeMenu
+ Specifies the context menu associated with this object.
InteractiveObject
 InheriteddoubleClickEnabled : Boolean
+ Specifies whether the object receives doubleClick events.
InteractiveObject
 InheritedfocusRect : Object
+ Specifies whether this object displays a focus rectangle.
InteractiveObject
 InheritedmouseEnabled : Boolean
+ Specifies whether this object receives mouse, or other user input, messages.
InteractiveObject
 InheritedneedsSoftKeyboard : Boolean
+ Specifies whether a virtual keyboard (an on-screen, software keyboard) should display + when this InteractiveObject instance receives focus.
InteractiveObject
 InheritedsoftKeyboard : String
+ Controls the appearance of the soft keyboard.
InteractiveObject
 InheritedsoftKeyboardInputAreaOfInterest : Rectangle
+ Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
InteractiveObject
DisplayObject
  stage3Ds : Vector.<Stage3D>
[read-only] +
  stage3Ds : Vector.<Stage3D>
[read-only] A list of Stage3D objects available for displaying 3-dimensional content.
Stage
Stage
  stageVideos : Vector.<StageVideo>
[read-only] +
  stageVideos : Vector.<StageVideo>
[read-only] A list of StageVideo objects available for playing external videos.
StageStage
  supportedOrientations : Vector.<String>
[read-only] +
  supportedOrientations : Vector.<String>
[read-only] The orientations supported by the current device.
Stage
 InheritedtabEnabled : Boolean
+ Specifies whether this object is in the tab order.
InteractiveObject
 InheritedtabIndex : int
+ Specifies the tab ordering of objects in a SWF file.
InteractiveObject
InteractiveObject
+ Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
+ Dispatched when a user presses and releases the main button of the user's + pointing device over the same InteractiveObject.InteractiveObject
+ Dispatched when a user gesture triggers the context menu associated with this interactive + object in an AIR application.InteractiveObject
+ Dispatched when the user activates the platform-specific accelerator key combination for a copy operation + or selects 'Copy' from the text context menu.InteractiveObject
+ Dispatched when the user activates the platform-specific accelerator key combination for a cut operation + or selects 'Cut' from the text context menu.InteractiveObject
+ Dispatched when a user presses and releases the main button of a pointing device twice in + rapid succession over the same InteractiveObject when that object's + doubleClickEnabled flag is set to true.InteractiveObject
+ Dispatched after a display object gains focus.InteractiveObject
+ Dispatched after a display object loses focus.InteractiveObject
+ Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, + (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) + Some devices might also interpret this contact as a combination of several touch events, as well.InteractiveObject
+ Dispatched when the user presses two points of contact over the same InteractiveObject 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).InteractiveObject
+ Dispatched when the user moves a point of contact over the InteractiveObject instance + 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).InteractiveObject
+ Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers + and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
+ Dispatched when the user performs a swipe gesture at a point of contact with an 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).InteractiveObject
+ Dispatched when the user creates a point of contact with an InteractiveObject instance, 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 tablet with a touch screen).InteractiveObject
+ Dispatched when the user performs a zoom gesture at a point of contact with an 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 touch screen).InteractiveObject
+ This event is dispatched to any client app that supports inline input with an IME + + InteractiveObject
+ Dispatched when the user presses a key.InteractiveObject
+ Dispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
+ Dispatched when the user releases a key.InteractiveObject
+ Dispatched when a user presses and releases the middle button of the user's + pointing device over the same InteractiveObject.InteractiveObject
+ Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
+ Dispatched when a user releases the pointing device button over an + InteractiveObject instance.InteractiveObject
+ Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
+ Dispatched when the user attempts to change focus by using a pointer device.InteractiveObject
+ Dispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
+ Dispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
+ Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
+ Dispatched when a user releases the pointing device button over an + InteractiveObject instance.InteractiveObject
+ Dispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
+ Dispatched when a horizontal mouse wheel is spun over an InteractiveObject instance.InteractiveObject
+ Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
+ Dispatched by the target InteractiveObject when a dragged object is + dropped on it and the drop has been accepted with a call to + DragManager.acceptDragDrop().InteractiveObject
+ Dispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
+ Dispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
+ Dispatched by an InteractiveObject continually while a drag gesture remains within its + boundary.InteractiveObject
+ Dispatched at the beginning of a drag operation by the InteractiveObject that is + specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
+ Dispatched during a drag operation by the InteractiveObject that is + specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
+ Dispatched when the user activates the platform-specific accelerator key combination for a paste operation + or selects 'Paste' from the text context menu.InteractiveObject
+ Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject
+ Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject
+ Dispatched when the user moves an active stylus over the screen while remaining within + the proximity detection threshold.InteractiveObject
+ Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within + the proximity detection threshold of the screen.InteractiveObject
+ Dispatched when the user moves an active stylus directly above this InteractiveObject + while remaining within the proximity detection threshold of the screen.InteractiveObject
+ Dispatched when the user moves an active stylus away from this InteractiveObject + and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject
+ Dispatched when the user moves an active stylus over this InteractiveObject from outside the + object's tree of descendents in the display list + (while remaining within the proximity detection threshold of the screen).InteractiveObject
+ Dispatched when a user releases the button on the pointing device after the + user first pressed the button over an InteractiveObject instance + and then moved the pointing device off of the InteractiveObject instance.InteractiveObject
+ Dispatched when a user presses and releases the right button of the user's + pointing device over the same InteractiveObject.InteractiveObject
+ Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
+ Dispatched when a user releases the pointing device button over an + InteractiveObject instance.InteractiveObject
+ Dispatched when the user moves a pointing device away from an InteractiveObject + instance.InteractiveObject
+ Dispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
+ Dispatched when the user activates the platform-specific accelerator key combination for a select all operation + or selects 'Select All' from the text context menu.InteractiveObject
+ Dispatched immediately after the soft keyboard is raised.InteractiveObject
+ Dispatched immediately before the soft keyboard is raised.InteractiveObject
+ Dispatched immediately after the soft keyboard is lowered.InteractiveObject
+ Dispatched when the value of the object's tabChildren flag changes.InteractiveObject
+ Dispatched when the object's tabEnabled flag changes.InteractiveObject
+ Dispatched when the value of the object's tabIndex property changes.InteractiveObject
+ Dispatched when a user enters one or more + characters of text.InteractiveObject
+ Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
+ Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
+ Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.InteractiveObject
+ Dispatched when the user moves the point of contact away from InteractiveObject instance 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).InteractiveObject
+ Dispatched when the user moves the point of contact over an InteractiveObject instance on 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).InteractiveObject
+ Dispatched when the user moves the point of contact away from an InteractiveObject 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).InteractiveObject
+ Dispatched when the user moves the point of contact over an InteractiveObject instance on 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).InteractiveObject
+ 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 and releases a finger from a single point over a display object + on a mobile phone or tablet with a touch screen).InteractiveObject
@@ -3688,7 +3820,7 @@
-stage3Ds:Vector.<Stage3D>  [read-only]

+stage3Ds:Vector.<Stage3D>  [read-only]

@@ -3711,7 +3843,7 @@ Implementation
-    public function get stage3Ds():Vector.<Stage3D> +    public function get stage3Ds():Vector.<Stage3D>

See also @@ -3836,7 +3968,7 @@

Language version: ActionScript 3.0
-stageVideos:Vector.<StageVideo>  [read-only]

+stageVideos:Vector.<StageVideo>  [read-only]

Language version: ActionScript 3.0 @@ -3877,7 +4009,7 @@

Note: AIR for TV devices support only one StageVideo object.

Implementation
-    public function get stageVideos():Vector.<StageVideo> +    public function get stageVideos():Vector.<StageVideo>

See also @@ -3975,7 +4107,7 @@

-supportedOrientations:Vector.<String>  [read-only]

+supportedOrientations:Vector.<String>  [read-only]

Language version: ActionScript 3.0 @@ -4019,7 +4151,7 @@
Implementation
-    public function get supportedOrientations():Vector.<String> +    public function get supportedOrientations():Vector.<String>

See also @@ -5762,11 +5894,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/flash/display/Stage3D.html b/static/reference/actionscript/3.0/flash/display/Stage3D.html index 337644baf..071c72905 100644 --- a/static/reference/actionscript/3.0/flash/display/Stage3D.html +++ b/static/reference/actionscript/3.0/flash/display/Stage3D.html @@ -245,7 +245,7 @@   
-requestContext3DMatchingProfiles(profiles:Vector.<String>):void +requestContext3DMatchingProfiles(profiles:Vector.<String>):void
Request the creation of a Context3D object for this Stage3D instance.
@@ -651,7 +651,7 @@
-public function requestContext3DMatchingProfiles(profiles:Vector.<String>):void +public function requestContext3DMatchingProfiles(profiles:Vector.<String>):void

@@ -704,7 +704,7 @@ Parameters
- @@ -290,36 +450,42 @@ @@ -333,12 +499,14 @@ @@ -375,7 +543,9 @@ clear(red:Number = 0.0, green:Number = 0.0, blue:Number = 0.0, alpha:Number = 1.0, depth:Number = 1.0, stencil:uint = 0, mask:uint = 0xffffffff):void
+ Clears the color, depth, and stencil buffers associated with this Context3D object and + fills them with the specified values.
@@ -385,6 +555,7 @@ configureBackBuffer(width:int, height:int, antiAlias:int, enableDepthAndStencil:Boolean = true, wantsBestResolution:Boolean = false, wantsBestResolutionOnBrowserZoom:Boolean = false):void
+ Sets the viewport dimensions and other attributes of the rendering buffer.
@@ -394,6 +565,7 @@ createCubeTexture(size:int, format:String, optimizeForRenderToTexture:Boolean, streamingLevels:int = 0):CubeTexture
+ Creates a CubeTexture object.
@@ -403,6 +575,7 @@ createIndexBuffer(numIndices:int, bufferUsage:String = "staticDraw"):IndexBuffer3D
+ Creates an IndexBuffer3D object.
@@ -412,6 +585,7 @@ createProgram():Program3D
+ Creates a Program3D object.
@@ -421,6 +595,7 @@ createRectangleTexture(width:int, height:int, format:String, optimizeForRenderToTexture:Boolean):RectangleTexture
+ Creates a Rectangle Texture object.
@@ -430,6 +605,7 @@ createTexture(width:int, height:int, format:String, optimizeForRenderToTexture:Boolean, streamingLevels:int = 0):Texture
+ Creates a Texture object.
@@ -439,6 +615,7 @@ createVertexBuffer(numVertices:int, data32PerVertex:int, bufferUsage:String = "staticDraw"):VertexBuffer3D
+ Creates a VertexBuffer3D object.
@@ -448,6 +625,7 @@ createVertexBufferForInstances(numVertices:int, data32PerVertex:int, instancesPerElement:int, bufferUsage:String = "staticDraw"):VertexBuffer3D
+ Creates a VertexBuffer3D object for instances data.
@@ -457,6 +635,7 @@ createVideoTexture():VideoTexture
+ Creates a VideoTexture object.
@@ -475,6 +654,7 @@ dispose(recreate:Boolean = true):void
+ Frees all resources and internal storage associated with this Context3D.
@@ -484,6 +664,7 @@ drawToBitmapData(destination:BitmapData, srcRect:Rectangle = null, destPoint:Point = null):void
+ Draws the current render buffer to a bitmap.
@@ -493,6 +674,7 @@ drawTriangles(indexBuffer:IndexBuffer3D, firstIndex:int = 0, numTriangles:int = -1):void
+ Render the specified triangles using the current buffers and state of this Context3D object.
@@ -502,6 +684,7 @@ drawTrianglesInstanced(indexBuffer:IndexBuffer3D, numInstances:int, firstIndex:int = 0, numTriangles:int = -1):void
+ Render the specified instanced triangles using the current buffers and state of this Context3D object.
@@ -543,6 +726,7 @@ present():void
+ Displays the back rendering buffer.
@@ -571,6 +755,7 @@ setBlendFactors(sourceFactor:String, destinationFactor:String):void
+ Specifies the factors used to blend the output color of a drawing operation with the existing color.
@@ -580,6 +765,7 @@ setColorMask(red:Boolean, green:Boolean, blue:Boolean, alpha:Boolean):void
+ Sets the mask used when writing colors to the render buffer.
@@ -589,6 +775,7 @@ setCulling(triangleFaceToCull:String):void
+ Sets triangle culling mode.
@@ -598,6 +785,7 @@ setDepthTest(depthMask:Boolean, passCompareMode:String):void
+ Sets type of comparison used for depth testing.
@@ -607,6 +795,7 @@ setFillMode(fillMode:String):void
+ Set fill mode used for render.
@@ -616,6 +805,7 @@ setProgram(program:Program3D):void
+ Sets vertex and fragment shader programs to use for subsequent rendering.
@@ -625,15 +815,17 @@ setProgramConstantsFromByteArray(programType:String, firstRegister:int, numRegisters:int, data:ByteArray, byteArrayOffset:uint):void
+ Set constants for use by shader programs using values stored in a ByteArray.
@@ -643,15 +835,17 @@ setProgramConstantsFromMatrix(programType:String, firstRegister:int, matrix:Matrix3D, transposedMatrix:Boolean = false):void
+ Sets constants for use by shader programs using values stored in a Matrix3D.
@@ -671,6 +865,7 @@ setRenderToBackBuffer():void
+ Sets the back rendering buffer as the render target.
@@ -680,6 +875,7 @@ setRenderToTexture(texture:TextureBase, enableDepthAndStencil:Boolean = false, antiAlias:int = 0, surfaceSelector:int = 0, colorOutputIndex:int = 0):void
+ Sets the specified texture as the rendering target.
@@ -689,6 +885,7 @@ setSamplerStateAt(sampler:int, wrap:String, filter:String, mipfilter:String):void
+ Manually override texture sampler state.
@@ -698,6 +895,7 @@ setScissorRectangle(rectangle:Rectangle):void
+ Sets a scissor rectangle, which is type of drawing mask.
@@ -707,6 +905,7 @@ setStencilActions(triangleFace:String = "frontAndBack", compareMode:String = "always", actionOnBothPass:String = "keep", actionOnDepthFail:String = "keep", actionOnDepthPassStencilFail:String = "keep"):void
+ Sets stencil mode and operation.
@@ -716,6 +915,7 @@ setStencilReferenceValue(referenceValue:uint, readMask:uint = 255, writeMask:uint = 255):void
+ Sets the stencil comparison value used for stencil tests.
@@ -725,6 +925,7 @@ setTextureAt(sampler:int, texture:TextureBase):void
+ Specifies the texture to use for a texture input register of a fragment program.
@@ -734,6 +935,7 @@ setVertexBufferAt(index:int, buffer:VertexBuffer3D, bufferOffset:int = 0, format:String = "float4"):void
+ Specifies which vertex data components correspond to a single vertex shader program input.
@@ -831,21 +1033,29 @@ backBufferHeight:int  [read-only]

profiles:Vector.<String> — (AIR 3.4 and higher) a profile arrays that developer want to use in their flash +profiles:Vector.<String> — (AIR 3.4 and higher) a profile arrays that developer want to use in their flash program. When developer pass profile array to Stage3D.requestContext3DMatchingProfiles, he will get a Context3D based on the high level profile in that array according to their hardware capability. The rendermode is setted to AUTO, so the param is omitted. @@ -841,11 +841,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/flash/display3D/Context3D.html b/static/reference/actionscript/3.0/flash/display3D/Context3D.html index 035b25236..40828341e 100644 --- a/static/reference/actionscript/3.0/flash/display3D/Context3D.html +++ b/static/reference/actionscript/3.0/flash/display3D/Context3D.html @@ -46,170 +46,328 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ 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 + + +

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 Context3D is not supported on a platform, the stage3Ds property of the Stage object contains + an empty list.)

-

The Context3D rendering context is a programmable pipeline that is very similar to OpenGL ES 2, but is abstracted + + +

The Context3D rendering context is a programmable pipeline that is very similar to OpenGL ES 2, but is abstracted + so that it is compatible with a range of hardware and GPU interfaces. Although designed for 3D graphics, + the rendering pipeline does not mandate that the rendering is three dimensional. Thus, you can create a 2D + renderer by supplying the appropriate vertex and pixel fragment programs. In both the 3D and 2D cases, the + only geometric primitive supported is the triangle.

+ +

Get an instance of the Context3D class by calling the requestContext3D() method of a Stage3D object. + A limited number of Context3D objects can exist per stage; one for each Stage3D in the Stage.stage3Ds list. + When the context is created, the Stage3D object dispatches a context3DCreate event. A rendering context can + be destroyed and recreated at any time, such as when another application that uses the GPU gains focus. + Your code should anticipate receiving multiple context3DCreate events. Position the rendering area on the stage + using the x and y properties of the associated Stage3D instance.

+ +

When the rendering context is attached to the stage of an HTML window, + the default background of the HTMLLoader object obscures the 3D viewport. To turn off the + default background, set the paintsDefaultBackground property to + false:

+

window.htmlLoader.paintsDefaultBackground = false;

+ +

To render and display a scene (after getting a Context3D object), the following steps are typical:

+
    +
  1. Configure the main display buffer attributes by calling configureBackBuffer().
    2. +
  2. Create and initialize your rendering resources, including: +
      +
    • Vertex and index buffers defining the scene geometry
      • +
    • Vertex and pixel programs (shaders) for rendering the scene
      • +
    • Textures
      • +
    +
    3. +
  3. Render a frame: +
      +
    • Set the render state as appropriate for an object or collection of objects in the scene.
      • +
    • Call the drawTriangles() method to render a set of triangles.
      • +
    • Change the rendering state for the next group of objects.
      • +
    • Call drawTriangles() to draw the triangles defining the objects.
      • +
    • Repeat until the scene is entirely rendered.
      • +
    • Call the present() method to display the rendered scene on the stage.
      • +
    +
    4. +
+ +

The following limits apply to rendering:

+

Resource limits: + + + + + + + + + + + + + + + + + + + + + + + + + + +
ResourceNumber allowedTotal memory
Vertex buffers4096256 MB
Index buffers4096128 MB
Programs409616 MB
Textures4096128 MB
Cube textures4096256 MB
+

+

AGAL limits: 200 opcodes per program.

+ +

Draw call limits: 32,768 drawTriangles() calls for each present() call.

+

The following limits apply to textures:

+

Texture limits for AIR 32 bit: + + + + + + + + + + + + + + + + + + + + + + + + + + +
TextureMaximum sizeTotal GPU memory
Normal Texture (below Baseline extended)2048x2048512 MB
Normal Texture (Baseline extended and above)4096x4096512 MB
Rectangular Texture (below Baseline extended)2048x2048512 MB
Rectangular Texture (Baseline extended and above)4096x4096512 MB
Cube Texture1024x1024256 MB
+

+

Texture limits for AIR 64 bit (Desktop): + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
TextureMaximum sizeTotal GPU memory
Normal Texture (below Baseline extended)2048x2048512 MB
Normal Texture (Baseline extended to Standard)4096x4096512 MB
Normal Texture (Standard extended and above)4096x40962048 MB
Rectangular Texture (below Baseline extended)2048x2048512 MB
Rectangular Texture (Baseline extended to Standard)4096x4096512 MB
Rectangular Texture (Standard extended and above)4096x40962048 MB
Cube Texture1024x1024256 MB
+

+

512 MB is the absolute limit for textures, including the texture memory required for mipmaps. + However, for Cube Textures, the memory limit is 256 MB.

+ +

You cannot create Context3D objects with the Context3D constructor. It is constructed and available as a property + of a Stage3D instance. + The Context3D class can be used on both desktop and mobile platforms, both when running in Flash Player and AIR.

+ +

View the examples. @@ -271,12 +429,14 @@

  backBufferHeight : int
[read-only] + Specifies the height of the back buffer, which can be changed by a successful call to the configureBackBuffer() method.
Context3D
  backBufferWidth : int
[read-only] + Specifies the width of the back buffer, which can be changed by a successful call to the configureBackBuffer() method.
Context3D
  driverInfo : String
[read-only] + The type of graphics library driver used by this rendering context.
Context3D
  enableErrorChecking : Boolean
+ Specifies whether errors encountered by the renderer are reported to the application.
Context3D
  ignoreResourceLimits : Boolean
+ Specifies whether to ignore all 'soft' resource limits associated with a profile.
Context3D
  maxBackBufferHeight : int
+ Specifies the maximum height of the back buffer.
Context3D
  maxBackBufferWidth : int
+ Specifies the maximum width of the back buffer.
Context3D
  profile : String
[read-only] + The feature-support profile in use by this Context3D object.
Context3D
  supportsVideoTexture : Boolean
[static][read-only] + Indicates if Context3D supports video texture.
Context3D
  totalGPUMemory : Number
[read-only] + Returns the total GPU memory allocated by Stage3D data structures of an application.
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
  
-setProgramConstantsFromFloatVector(programType:String, firstRegister:int, data:Vector.<float>, numRegisters:int = -1):void +setProgramConstantsFromFloatVector(programType:String, firstRegister:int, data:Vector.<float>, numRegisters:int = -1):void
+ Sets the constant inputs for the shader programs.
Context3D
Context3D
  
-setProgramConstantsFromVector(programType:String, firstRegister:int, data:Vector.<Number>, numRegisters:int = -1):void +setProgramConstantsFromVector(programType:String, firstRegister:int, data:Vector.<Number>, numRegisters:int = -1):void
+ Sets the constant inputs for the shader programs.
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
Context3D
- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 15 +

+ Specifies the height of the back buffer, which can be changed by a successful call to the configureBackBuffer() method. + The height may be modified when the browser zoom factor changes if the wantsBestResolutionOnBrowserZoom is set to true + in the last successful call to the configureBackBuffer() method. The change in height can be detected by registering an event listener for the + browser zoom change event. -

Implementation + + +

Implementation
    public function get backBufferHeight():int
@@ -868,21 +1078,29 @@ backBufferWidth:int  [read-only]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 15 +

+ Specifies the width of the back buffer, which can be changed by a successful call to the configureBackBuffer() method. + The width may be modified when the browser zoom factor changes if the wantsBestResolutionOnBrowserZoom is set to true + in the last successful call to the configureBackBuffer() method. The change in width can be detected by registering an event listener for the + browser zoom change event. -

Implementation + + +

Implementation
    public function get backBufferWidth():int
@@ -905,33 +1123,54 @@ driverInfo:String  [read-only]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ The type of graphics library driver used by this rendering context. Indicates whether the rendering is using + software, a DirectX driver, or an OpenGL driver. Also indicates whether hardware rendering failed. - If hardware rendering fails, Flash Player uses software rendering for Stage3D and + + + If hardware rendering fails, Flash Player uses software rendering for Stage3D and + driverInfo contains one of the following values: +

    +
  • "Software Hw_disabled=userDisabled" - The Enable hardware acceleration checkbox in the Adobe Flash Player + Settings UI is not selected.
    • +
  • "Software Hw_disabled=oldDriver" - There are known problems with the hardware graphics driver. + Updating the graphics driver may fix this problem.
    • +
  • "Software Hw_disabled=unavailable" - Known problems with the hardware graphics driver + or hardware graphics initialization failure.
    • +
  • "Software Hw_disabled=explicit" - The content explicitly requested software rendering through + requestContext3D.
    • +
  • "Software Hw_disabled=domainMemory" - The content uses domainMemory, which requires a license when + used with Stage3D hardware rendering. Visit adobe.com/go/fpl.
    • +
+ +

Implementation
    public function get driverInfo():String @@ -947,24 +1186,35 @@ enableErrorChecking:Boolean  [read-write]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Specifies whether errors encountered by the renderer are reported to the application. + +

When enableErrorChecking is true, the clear(), + and drawTriangles() methods are synchronous and can throw errors. When + enableErrorChecking is false, the default, the clear(), + and drawTriangles() methods are asynchronous and errors are not reported. + Enabling error checking reduces rendering performance. You should only enable error checking when debugging.

+ + Implementation
    public function get enableErrorChecking():Boolean @@ -990,25 +1240,39 @@ ignoreResourceLimits:Boolean  [read-write]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 50.0 +

+ Specifies whether to ignore all 'soft' resource limits associated with a profile. -

This property should be used with caution. By default this is set to false and the + + +

This property should be used with caution. By default this is set to false and the + GPU resources (number of and memory used by elements such as vertex and index buffers, programs and textures) + are limited per the resource limits described in the Context3D documentation.

-

If this property is set to true, these limits are no longer applied and the program can + + +

If this property is set to true, these limits are no longer applied and the program can + continue to allocate GPU memory for new elements. Note that any subsequent error handling will be down to + the application developers, but it may not be immediately obvious when resource failures occur due to the + asynchronous nature of the Stage3D implementation within AIR.

- Implementation + + + Implementation
    public function get ignoreResourceLimits():Boolean
@@ -1025,21 +1289,29 @@ maxBackBufferHeight:int  [read-write]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 15 +

+ Specifies the maximum height of the back buffer. The inital value is the system limit in the platform. The property can be set to a value smaller than + or equal to, but not greater than, the system limit. The property can be set to a value greater than or equal to, but not smaller than, the minimum limit. + The minimum limit is a constant value, 32, when the back buffer is not configured. The minimum limit will be the value of the height parameter in the last + successful call to the configureBackBuffer() method after the back buffer is configured. -

Implementation + + +

Implementation
    public function get maxBackBufferHeight():int
@@ -1056,21 +1328,29 @@ maxBackBufferWidth:int  [read-write]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 15 +

+ Specifies the maximum width of the back buffer. The inital value is the system limit in the platform. The property can be set to a value smaller than + or equal to, but not greater than, the system limit. The property can be set to a value greater than or equal to, but not smaller than, the minimum limit. + The minimum limit is a constant value, 32, when the back buffer is not configured. The minimum limit will be the value of the width parameter in the last + successful call to the configureBackBuffer() method after the back buffer is configured. -

Implementation + + +

Implementation
    public function get maxBackBufferWidth():int
@@ -1087,17 +1367,21 @@ profile:String  [read-only]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 4 +

+ The feature-support profile in use by this Context3D object. +

Implementation
    public function get profile():String @@ -1119,18 +1403,23 @@ supportsVideoTexture:Boolean  [read-only]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 17.0 +

+ Indicates if Context3D supports video texture. -

Implementation + + +

Implementation
    public static function get supportsVideoTexture():Boolean
@@ -1145,26 +1434,39 @@ totalGPUMemory:Number  [read-only]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 21 +

+ Returns the total GPU memory allocated by Stage3D data structures of an application. +

Whenever a GPU resource object is created, memory utilized is stored in Context3D. This memory includes index buffers, vertex buffers, + textures(excluding video texture), and programs that were created through this Context3D.

+

API totalGPUMemory returns the total memory consumed by the above resources to the user. Default value returned is 0.The total GPU memory returned is in bytes. + The information is only provided in Direct mode on mobile, and in Direct and GPU modes on desktop. (On desktop, using <renderMode>gpu</renderMode> + will fall back to <renderMode>direct</renderMode>)

+ + This API can be used when the SWF version is 32 or later. + + + Implementation
    public function get totalGPUMemory():Number @@ -1183,29 +1485,44 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Clears the color, depth, and stencil buffers associated with this Context3D object and + fills them with the specified values. -

Set the mask parameter to specify which buffers to clear. Use the constants defined in the + + +

Set the mask parameter to specify which buffers to clear. Use the constants defined in the + Context3DClearMask class to set the mask parameter. Use the bitwise OR operator, "|", to add + multiple buffers to the mask (or use Context3DClearMask.ALL). When rendering to the back buffer, + the configureBackBuffer() method must be called before any clear() calls.

+ +

Note: If you specify a parameter value outside the allowed range, Numeric parameter values are silently clamped to the range zero to one. + Likewise, if stencil is greater than 0xff it is set to 0xff.

- Parameters + + + Parameters @@ -1213,6 +1530,7 @@ @@ -1220,6 +1538,7 @@ @@ -1227,7 +1546,9 @@ @@ -1235,6 +1556,7 @@ @@ -1242,6 +1564,7 @@ @@ -1249,7 +1572,9 @@ + + +
red:Number (default = 0.0) — the red component of the color with which to clear the color buffer, in the range zero to one. +
green:Number (default = 0.0) — the green component of the color with which to clear the color buffer, in the range zero to one. +
blue:Number (default = 0.0) — the blue component of the color with which to clear the color buffer, in the range zero to one. +
alpha:Number (default = 1.0) — the alpha component of the color with which to clear the color buffer, in the range zero to one. + The alpha component is not used for blending. It is written to the buffer alpha directly. +
depth:Number (default = 1.0) — the value with which to clear the depth buffer, in the range zero to one. +
stencil:uint (default = 0) — the 8-bit value with which to clear the stencil buffer, in a range of 0x00 to 0xff. +
mask:uint (default = 0xffffffff) — specifies which buffers to clear. -

@@ -1257,15 +1582,20 @@ + + +
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or + because the underlying rendering hardware has been lost. -
 
Error — 3768: The Stage3D API may not be used during background execution. + +
@@ -1287,28 +1617,41 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Sets the viewport dimensions and other attributes of the rendering buffer. -

Rendering is double-buffered. The back buffer is swapped with the visible, + + +

Rendering is double-buffered. The back buffer is swapped with the visible, + front buffer when the present() method is called. The minimum size of the buffer is 32x32 pixels. + The maximum size of the back buffer is limited by the device capabilities and can also be set by the user + through the properties maxBackBufferWidth and maxBackBufferHeight. + Configuring the buffer is a slow operation. Avoid changing the buffer size or attributes during normal + rendering operations.

+ + Parameters @@ -1316,6 +1659,7 @@ @@ -1323,27 +1667,50 @@ @@ -1351,34 +1718,53 @@ + + + + + + + + +
width:int — width in pixels of the buffer. +
height:int — height in pixels of the buffer. +
antiAlias:int — an integer value specifying the requested antialiasing quality. + The value correlates to the number of subsamples used when antialiasing. + Using more subsamples requires more calculations to be performed, although + the relative performance impact depends on the specific rendering hardware. The + type of antialiasing and whether antialiasing is performed at all is dependent on the + device and rendering mode. Antialiasing is not supported at all by the + software rendering context. - + + +
+ + + + + + + + + + + + +
0No antialiasing
2Minimal antialiasing.
4High-quality antialiasing.
16Very high-quality antialiasing.
+ +
enableDepthAndStencil:Boolean (default = true) — false indicates no depth or stencil buffer is created, + true creates a depth and a stencil buffer. + For an AIR 3.2 or later application compiled with SWF version 15 or higher, + if the renderMode element in the application descriptor file + is direct, then the depthAndStencil element in the application descriptor file + must have the same value as this argument. + By default, the value of the depthAndStencil element is false. -
 
wantsBestResolution:Boolean (default = false) — true indicates that if the device supports HiDPI screens it + will attempt to allocate a larger back buffer than indicated with the width and height parameters. Since + this add more pixels and potentially changes the result of shader operations this is turned off by default. + Use Stage.contentsScaleFactor to determine by how much the native back buffer was scaled up. -
 
wantsBestResolutionOnBrowserZoom:Boolean (default = false) — true indicates that the size of the back buffer should increase + in proportion to the increase in the browser zoom factor. The setting of this value is persistent across multiple browser zooms. + The default value of the parameter is false. Set maxBackBufferWidth and maxBackBufferHeight properties + to limit the back buffer size increase. Use backBufferWidth and backBufferHeight to determine the current + size of the back buffer. -

@@ -1386,23 +1772,31 @@ + + + + + +
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or + because the underlying rendering hardware has been lost. -
 
Error — Bad Input Size: The width or height parameter is either less than the minimum back buffer allowed size or greater than the maximum back buffer size allowed. -
 
Error — 3709: The depthAndStencil flag in the application descriptor must match the + enableDepthAndStencil Boolean passed to configureBackBuffer() on the Context3D object. + +
@@ -1418,29 +1812,44 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Creates a CubeTexture object. -

Use a CubeTexture object to upload cube texture bitmaps to the rendering context and to + + +

Use a CubeTexture object to upload cube texture bitmaps to the rendering context and to + reference a cube texture during rendering. A cube texture consists of six equal-sized, square + textures arranged in a cubic topology and are useful for describing environment maps.

+ +

You cannot create CubeTexture objects with a CubeTexture constructor; use this method instead. After + creating a CubeTexture object, upload the texture bitmap data using the CubeTexture uploadFromBitmapData(), + uploadFromByteArray(), or uploadCompressedTextureFromByteArray() methods..

- Parameters + + + Parameters @@ -1448,19 +1857,33 @@ @@ -1468,28 +1891,47 @@ + + + + + +

Note: Setting this property to a value > 0 can impact memory usage and performance.

+ + +
size:int — The texture edge length in texels. + +
format:String — The texel format, of the Context3DTextureFormat enumerated list. +

Texture compression lets you store texture images in compressed format directly on the GPU, which saves GPU memory and + memory bandwidth. Typically, compressed textures are compressed offline and uploaded to the GPU in compressed form using the + Texture.uploadCompressedTextureFromByteArray method. + Flash Player 11.4 and AIR 3.4 on desktop platforms added support for runtime texture compression, which may be useful + in certain situations, such as when rendering dynamic textures from vector art. Note that this feature is not currently + available on mobile platforms and an ArgumentError (Texture Format Mismatch) will be thrown instead. + To use runtime texture compression, perform the following steps: + 1. Create the texture object by calling the Context3D.createCubeTexture() method, passing either + flash.display3D.Context3DTextureFormat.COMPRESSED or flash.display3D.Context3DTextureFormat.COMPRESSED_ALPHA as the format parameter. + 2. Using the flash.display3D.textures.Texture instance returned by createCubeTexture(), call either + flash.display3D.textures.CubeTexture.uploadFromBitmapData() or flash.display3D.textures.CubeTexture.uploadFromByteArray() to upload + and compress the texture in one step. +

+
optimizeForRenderToTexture:Boolean — Set to true if the texture is likely to be used as a render target. -
 
streamingLevels:int (default = 0) — The MIP map level that must be loaded before the image is rendered. + Texture streaming offers the ability to load and display the smallest mip levels first, progressively displaying higher quality images + as the textures are loaded. End users can view lower-quality images in an application while the higher quality images load. +

By default, streamingLevels is 0, meaning that the highest quality image in the MIP map must be loaded before the image is rendered. + This parameter was added in Flash Player 11.3 and AIR 3.3. + Using the default value maintains the behavior of the previous versions of Flash Player and AIR. +

+

Set streamingLevels to a value between 1 and the number of images in the MIP map to enable texture streaming. + For example, you have a MIP map that includes at the highest quality a main image at 64x64 pixels. + Lower quality images in the MIP map are 32x32, 16x16, 8x8, 4x4, 2x2, and 1x1 pixels, + for 7 images in total, or 7 levels. Level 0 is the highest quality image. + The maximum value of this property is log2(min(width,height)). + Therefore, for a main image that is 64x64 pixels, the maximum value of streamingLevels is 7. + Set this property to 3 to render the image after the 8x8 pixel image loads.

-

Note: Setting this property to a value > 0 can impact memory usage and performance.

-

@@ -1504,7 +1946,9 @@ @@ -1512,7 +1956,9 @@ @@ -1520,6 +1966,7 @@ @@ -1527,7 +1974,9 @@ @@ -1535,7 +1984,9 @@ @@ -1543,7 +1994,9 @@ @@ -1551,7 +2004,9 @@ @@ -1559,7 +2014,9 @@ + + +
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or + because the underlying rendering hardware has been lost. +
Error — Resource Limit Exceeded: if too many Texture objects are created or the amount of + memory allocated to textures is exceeded. +
ArgumentError — Depth Texture Not Implemented: if you attempt to create a depth texture. +
ArgumentError — Texture Size Is Zero: if the size + parameter is not greater than zero. +
ArgumentError — Texture Not Power Of Two: if the size + parameter is not a power of two. +
ArgumentError — Texture Too Big: if the size + parameter is greater than 1024. +
Error — Texture Creation Failed: if the CubeTexture object could not be created by the + rendering context (but information about the reason is not available). +
ArgumentError — Invalid streaming level: if streamingLevels is greater or equal to log2(size). -

@@ -1582,29 +2039,44 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Creates an IndexBuffer3D object. -

Use an IndexBuffer3D object to upload a set of triangle indices to the rendering context and to + + +

Use an IndexBuffer3D object to upload a set of triangle indices to the rendering context and to + reference that set of indices for rendering. Each index in the index buffer references a corresponding vertex + in a vertex buffer. Each set of three indices identifies a triangle. Pass the IndexBuffer3D object to the + drawTriangles() method to render one or more triangles defined in the index buffer.

+ +

You cannot create IndexBuffer3D objects with the IndexBuffer3D class constructor; use this method instead. After + creating a IndexBuffer3D object, upload the indices using the IndexBuffer3D uploadFromVector() + or uploadFromByteArray() methods.

- Parameters + + + Parameters @@ -1612,9 +2084,13 @@
numIndices:int — the number of vertices to be stored in the buffer. +
bufferUsage:String (default = "staticDraw") — the expected buffer usage. Use one of the constants defined in Context3DBufferUsage. + The hardware driver can do appropriate optimization when you set it correctly. + This parameter is only available after Flash 12/AIR 4. + +
@@ -1630,7 +2106,9 @@ @@ -1638,7 +2116,9 @@ @@ -1646,6 +2126,7 @@ @@ -1653,7 +2134,9 @@
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or + because the underlying rendering hardware has been lost. +
Error — Resource Limit Exceeded: if too many index buffers are created or the amount of + memory allocated to index buffers is exceeded. +
Error — 3768: The Stage3D API may not be used during background execution. +
ArgumentError — Buffer Too Big: when numIndices is greater than or equal to 0xf0000. + +
@@ -1675,25 +2158,38 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Creates a Program3D object. -

Use a Program3D object to upload shader programs to the rendering context and to + + +

Use a Program3D object to upload shader programs to the rendering context and to + reference uploaded programs during rendering. + A Program3D object stores two programs, a vertex program and a fragment program (also known as a + pixel program). The programs are written in a binary shader assembly language.

+ +

You cannot create Program3D objects with a Program3D constructor; use this method instead. After + creating a Program3D object, upload the programs using the Program3D upload() method.

-

+ + +

Returns @@ -1705,7 +2201,9 @@
@@ -1713,8 +2211,11 @@
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or + because the underlying rendering hardware has been lost. +
Error — The number of programs exceeds 4096 or the total memory size exceeds 16MB + (use dispose to free Program3D resources). + +
@@ -1768,57 +2269,85 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3.8 +

+ Creates a Rectangle Texture object. -

Use a RectangleTexture object to upload texture bitmaps to the rendering context and to + + +

Use a RectangleTexture object to upload texture bitmaps to the rendering context and to + reference a texture during rendering.

+ +

You cannot create RectangleTexture objects with a RectangleTexture constructor; use this method instead. After + creating a RectangleTexture object, upload the texture bitmaps using the Texture uploadFromBitmapData() or + uploadFromByteArray() methods.

+ +

Note that 32-bit integer textures are stored in a packed BGRA format to match the Flash BitmapData format. + Floating point textures use a conventional RGBA format.

-

Rectangle textures are different from regular 2D textures in that their width and height do not have to be powers of two. + + +

Rectangle textures are different from regular 2D textures in that their width and height do not have to be powers of two. + Also, they do not contain mip maps. They are most useful for use in render to texture cases. If a rectangle texture is used with + a sampler that uses mip map filtering or repeat wrapping the drawTriangles call will fail. Rectangle texture also do not allow streaming. The only texture formats supported by Rectangle textures are BGRA, BGR_PACKED, BGRA_PACKED. The compressed texture formats are not supported by Rectangle Textures. +

+ + Parameters + + + + + + + + +
width:int — The texture width in texels. -
 
height:int — The texture height in texels. -
 
format:String — The texel format, of the Context3DTextureFormat enumerated list. -
 
optimizeForRenderToTexture:Boolean — Set to true if the texture is likely to be used as a render target. + +
@@ -1834,7 +2363,9 @@ @@ -1842,7 +2373,9 @@ @@ -1850,7 +2383,9 @@ @@ -1858,7 +2393,9 @@ @@ -1866,7 +2403,9 @@ @@ -1874,7 +2413,9 @@ + + +
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or + because the underlying rendering hardware has been lost. +
Error — Resource Limit Exceeded: if too many Texture objects are created or the amount of + memory allocated to textures is exceeded. +
ArgumentError — Texture Size Is Zero: if both the width or height + parameters are not greater than zero. +
ArgumentError — Texture Too Big: if either the width or the height + parameter is greater than 2048. +
Error — Texture Creation Failed: if the Texture object could not be created by the + rendering context (but information about the reason is not available). +
Error — Requires Baseline Profile Or Above: if rectangular texture is created with baseline constrained profile. -

@@ -1895,57 +2436,90 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Creates a Texture object. -

Use a Texture object to upload texture bitmaps to the rendering context and to + + +

Use a Texture object to upload texture bitmaps to the rendering context and to + reference a texture during rendering.

+ +

You cannot create Texture objects with a Texture constructor; use this method instead. After + creating a Texture object, upload the texture bitmaps using the Texture uploadFromBitmapData(), + uploadFromByteArray(), or uploadCompressedTextureFromByteArray() methods.

+ +

Note that 32-bit integer textures are stored in a packed BGRA format to match the Flash BitmapData format. + Floating point textures use a conventional RGBA format.

- Parameters + + + Parameters + + + + + + @@ -1953,28 +2527,48 @@ + + +
width:int — The texture width in texels. -
 
height:int — The texture height in texels. -
 
format:String — The texel format, of the Context3DTextureFormat enumerated list. +

Texture compression lets you store texture images in compressed format directly on the GPU, which saves GPU memory and + memory bandwidth. Typically, compressed textures are compressed offline and uploaded to the GPU in compressed form using the + Texture.uploadCompressedTextureFromByteArray method. + Flash Player 11.4 and AIR 3.4 on desktop platforms added support for runtime texture compression, which may be useful + in certain situations, such as when rendering dynamic textures from vector art. Note that this feature is not currently + available on mobile platforms and an ArgumentError (Texture Format Mismatch) will be thrown instead. + To use runtime texture compression, perform the following steps: + 1. Create the texture object by calling the Context3D.createTexture() method, passing either + flash.display3D.Context3DTextureFormat.COMPRESSED or flash.display3D.Context3DTextureFormat.COMPRESSED_ALPHA as the format parameter. + 2. Using the flash.display3D.textures.Texture instance returned by createTexture(), call either + flash.display3D.textures.Texture.uploadFromBitmapData() or flash.display3D.textures.Texture.uploadFromByteArray() to upload + and compress the texture in one step. +

+
optimizeForRenderToTexture:Boolean — Set to true if the texture is likely to be used as a render target. -
 
streamingLevels:int (default = 0) — The MIP map level that must be loaded before the image is rendered. - Texture streaming offers the ability to load and display the smallest mip levels first, progressively displaying higher quality images + + + Texture streaming offers the ability to load and display the smallest mip levels first, progressively displaying higher quality images + as the textures are loaded. End users can view lower-quality images in an application while the higher quality images load. +

By default, streamingLevels is 0, meaning that the highest quality image in the MIP map must be loaded before the image is rendered. + This parameter was added in Flash Player 11.3 and AIR 3.3. + Using the default value maintains the behavior of the previous versions of Flash Player and AIR. +

+

Set streamingLevels to a value between 1 and the number of images in the MIP map to enable texture streaming. + For example, you have a MIP map that includes at the highest quality a main image at 64x64 pixels. + Lower quality images in the MIP map are 32x32, 16x16, 8x8, 4x4, 2x2, and 1x1 pixels, + for 7 images in total, or 7 levels. Level 0 is the highest quality image. + The maximum value of this property is log2(min(width,height)). + Therefore, for a main image that is 64x64 pixels, the maximum value of streamingLevels is 7. + Set this property to 3 to render the image after the 8x8 pixel image loads.

-

Note: Setting this property to a value > 0 can impact memory usage and performance.

+ + +

Note: Setting this property to a value > 0 can impact memory usage and performance.

+ +
@@ -1990,7 +2584,9 @@ @@ -1998,7 +2594,9 @@ @@ -2006,6 +2604,7 @@ @@ -2013,7 +2612,9 @@ @@ -2021,7 +2622,9 @@ @@ -2029,8 +2632,11 @@ @@ -2038,7 +2644,9 @@ @@ -2046,7 +2654,9 @@ + + +
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or + because the underlying rendering hardware has been lost. +
Error — Resource Limit Exceeded: if too many Texture objects are created or the amount of + memory allocated to textures is exceeded. +
ArgumentError — Depth Texture Not Implemented: if you attempt to create a depth texture. +
ArgumentError — Texture Size Is Zero: if both the width or height + parameters are not greater than zero. +
ArgumentError — Texture Not Power Of Two: if both the width and height + parameters are not a power of two. +
ArgumentError — Texture Too Big: if either the width or the height + parameter is greater than 2048 for baseline and baseline constrained profile or if either the + width or the height parameter is greater than 4096 for profile baseline extended and above. +
Error — Texture Creation Failed: if the Texture object could not be created by the + rendering context (but information about the reason is not available). +
ArgumentError — Invalid streaming level: if streamingLevels is greater or equal to log2(min(width,height)). -

@@ -2069,34 +2679,53 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Creates a VertexBuffer3D object. -

Use a VertexBuffer3D object to upload a set of vertex data to the rendering context. + + +

Use a VertexBuffer3D object to upload a set of vertex data to the rendering context. + A vertex buffer contains the data needed to render each point in the scene geometry. + The data attributes associated with each vertex typically includes position, color, and texture + coordinates and serve as the input to the vertex shader program. Identify the data + values that correspond to one of the inputs of the vertex program using the + setVertexBufferAt() method. You can specify up to sixty-four 32-bit values + for each vertex.

+ +

You cannot create VertexBuffer3D objects with a VertexBuffer3D constructor; use this method instead. After + creating a VertexBuffer3D object, upload the vertex data using the VertexBuffer3D uploadFromVector() + or uploadFromByteArray() methods.

+ + Parameters @@ -2104,10 +2733,15 @@ @@ -2115,9 +2749,13 @@
numVertices:int — the number of vertices to be stored in the buffer. The maximum number of + vertices in a single buffer is 65535. +
data32PerVertex:int — the number of 32-bit(4-byte) data values associated with each vertex. + The maximum number of 32-bit data elements per vertex is 64 (or 256 bytes). + Note that only eight attribute registers are + accessible by a vertex shader program at any given time. Use SetVertextBufferAt() to select attributes from within + a vertex buffer. +
bufferUsage:String (default = "staticDraw") — the expected buffer usage. Use one of the constants defined in Context3DBufferUsage. + The hardware driver can do appropriate optimization when you set it correctly. + This parameter is only available after Flash 12/AIR 4 + +
@@ -2133,7 +2771,9 @@ @@ -2141,7 +2781,9 @@ @@ -2149,6 +2791,7 @@ @@ -2156,6 +2799,7 @@ @@ -2163,7 +2807,9 @@ @@ -2171,7 +2817,9 @@
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or + because the underlying rendering hardware has been lost. +
Error — Resource Limit Exceeded: if too many vertex buffer objects are created or the amount of memory alloted to + vertex buffers is exceeded. +
ArgumentError — Buffer Too Big: when numVertices is greater than 0x10000 or data32PerVertex is greater than 64. +
ArgumentError — Buffer Has Zero Size: when numVertices is zero or data32PerVertex is zero. +
ArgumentError — Buffer Creation Failed: if the VertexBuffer3D object could not be created + by the rendering context (but additional information about the reason is not available). +
Error — 3768: The Stage3D API may not be used during background execution. + +
@@ -2226,33 +2874,51 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 20.0 +

+ Creates a VertexBuffer3D object for instances data. -

Use a VertexBuffer3D object to upload a set of instance data to the rendering context. + + +

Use a VertexBuffer3D object to upload a set of instance data to the rendering context. + The vertex buffer contains the data needed to render each instance in the scene geometry. + Vertex Buffers with instance data provide attributes that are common to all the vertices of an instance. + and serve as the input to the vertex shader program. Identify the data values that correspond to one of + the inputs of the vertex program using the setVertexBufferAt() method. You can specify up to sixty-four 32-bit values + for each element of vertex buffer.

+ +

You cannot create VertexBuffer3D objects with a VertexBuffer3D constructor; use this method instead. After + creating a VertexBuffer3D object, upload the vertex data using the VertexBuffer3D uploadFromVector() + or uploadFromByteArray() methods.

+ + Parameters @@ -2260,7 +2926,9 @@ @@ -2268,6 +2936,7 @@ @@ -2275,9 +2944,13 @@ + + +
numVertices:int — the number of elements to be stored in the buffer. The maximum number of + elements in a single buffer is 65535. +
data32PerVertex:int — the number of 32-bit(4-byte) data values associated with each element. + The maximum number of 32-bit data elements per vertex is 64 (or 256 bytes). +
instancesPerElement:int — the number of instances which will use one element of the vertex buffer. +
bufferUsage:String (default = "staticDraw") — the expected buffer usage. Use one of the constants defined in Context3DBufferUsage. + The hardware driver can do appropriate optimization when you set it correctly. + This parameter is only available after Flash 12/AIR 4 -

@@ -2292,7 +2965,9 @@ @@ -2300,7 +2975,9 @@ @@ -2308,6 +2985,7 @@ @@ -2315,6 +2993,7 @@ @@ -2322,7 +3001,9 @@ @@ -2330,6 +3011,7 @@ @@ -2337,6 +3019,7 @@ @@ -2344,8 +3027,11 @@
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or + because the underlying rendering hardware has been lost. +
Error — Resource Limit Exceeded: if too many vertex buffer objects are created or the amount of memory alloted to + vertex buffers is exceeded. +
ArgumentError — Buffer Too Big: when numVertices is greater than 0x10000 or data32PerVertex is greater than 64. +
ArgumentError — Buffer Has Zero Size: when numVertices is zero or data32PerVertex is zero. +
ArgumentError — Buffer Creation Failed: if the VertexBuffer3D object could not be created + by the rendering context (but additional information about the reason is not available). +
Error — 3768: The Stage3D API may not be used during background execution. +
Error — Requires Standard Extended Profile Or Above: if this method is called when the requested profile is less than standard extended profile. +
Error — Invalid Instances Per Element: if the instancesPerElement is not greater than zero. + + +
@@ -2369,33 +3055,56 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 17.0 +

+ Creates a VideoTexture object. -

Use a VideoTexture object to obtain video frames as texture from NetStream object or Camera + + +

Use a VideoTexture object to obtain video frames as texture from NetStream object or Camera + object and to upload the video frames to the rendering context.

+ +

The VideoTexture object cannot be created with the VideoTexture constructor; use this method instead. + After creating a VideoTexture object, attach NetStream object or Camera Object to get the video frames + with the VideoTexture attachNetStream() or attachCamera() methods.

+ +

Note that this method returns null if the system doesn't support this feature.

-

VideoTexture does not contain mipmaps. If VideoTexture is used with + + +

VideoTexture does not contain mipmaps. If VideoTexture is used with + a sampler that uses mip map filtering or repeat wrapping, the drawTriangles call will fail. VideoTexture + can be treated as BGRA texture by the shaders. + The attempt to instantiate the VideoTexture Object will fail if the Context3D was requested with sotfware rendering mode. +

-

A maximum of 4 VideoTexture objects are available per Context3D instance. + + +

A maximum of 4 VideoTexture objects are available per Context3D instance. + On mobile the actual number of supported VideoTexture objects may be less than 4 due to platform limitations.

+ +

Returns @@ -2408,7 +3117,9 @@
@@ -2416,7 +3127,9 @@ @@ -2424,8 +3137,11 @@ + + +
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or + because the underlying rendering hardware has been lost. +
Error — Resource Limit Exceeded: if too many Texture objects are created or the amount of + memory allocated to textures is exceeded. +
Error — Texture Creation Failed: if the Texture object could not be created by the + rendering context (but information about the reason is not available). -
@@ -2440,27 +3156,42 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Frees all resources and internal storage associated with this Context3D. + +

All index buffers, vertex buffers, textures, and programs that were created through this Context3D are disposed + just as if calling dispose() on each of them individually. + In addition, the Context3D itself is disposed freeing all temporary buffers and the back buffer. + If you call configureBackBuffer(), clear(), drawTriangles(), createCubeTexture(), createTexture(), createProgram(), + createIndexBuffer(), createVertexBuffer(), or drawToBitmapData() after calling dispose(), the runtime throws an exception.

-

Warning: calling dispose() on a Context3D while there is still a event listener for Events.CONTEXT3D_CREATE set on the asociated Stage3D object the dispose() call + + +

Warning: calling dispose() on a Context3D while there is still a event listener for Events.CONTEXT3D_CREATE set on the asociated Stage3D object the dispose() call + will simulate a device loss. It will create a new Context3D on the Stage3D and issue the Events.CONTEXT3D_CREATE event again. + If this is not desired remove the event listener from the Stage3D object before calling dispose() or set the recreate parameter to false.

- Parameters + + + Parameters @@ -2484,37 +3215,64 @@

recreate:Boolean (default = true)
- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Draws the current render buffer to a bitmap. -

The current contents of the back render buffer are copied to a BitmapData object. This is potentially a very slow + + +

The current contents of the back render buffer are copied to a BitmapData object. This is potentially a very slow + operation that can take up to a second. Use with care. + Note that this function does not copy the front render buffer (the one shown on stage), but the buffer being drawn to. + To capture the rendered image as it appears on the stage, call drawToBitmapData() + immediately before you calling present().

+ + +

Beginning with AIR 25, two new parameters have been introduced in the API drawToBitmapData(). + This API now takes three parameters. The first one is the existing parameter destination:BitmapData. + The second parameter is srcRect:Rectangle, which is target rectangle on stage3D. + The third parameter is destPoint:Point, which is the coordinate on the destination bitmap. + The parameters srcRect and destPoint are optional and default to (0,0,bitmapWidth,bitmapHeight) and (0,0), respectively.

-

When the image is drawn, it is not scaled to fit the bitmap. Instead, the contents are + + +

When the image is drawn, it is not scaled to fit the bitmap. Instead, the contents are + clipped to the size of the destination bitmap.

-

Flash BitmapData objects store colors already multiplied by the alpha component. For example, if the "pure" rgb color + + +

Flash BitmapData objects store colors already multiplied by the alpha component. For example, if the "pure" rgb color + components of a pixel are (0x0A, 0x12, 0xBB) and the alpha component is 0x7F (.5), then the pixel is stored in the + BitmapData object with the rgba values: (0x05, 0x09, 0x5D, 0x7F). You can set the blend factors so that the colors + rendered to the buffer are multiplied by alpha or perform the operation in the fragment shader. The rendering context + does not validate that the colors are stored in premultiplied format.

+ + Parameters @@ -2538,7 +3296,9 @@
@@ -2546,6 +3306,7 @@ @@ -2553,8 +3314,11 @@ + + +
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or + because the underlying rendering hardware has been lost. +
Error — 3768: The Stage3D API may not be used during background execution. +
Error — 3802: If either one of the parameters destPoint:Point or srcRect:Rectangle + is outside the bitmap/stage3D coordinate bound, or if non-Numeric(NaN) values are passed as input. -

@@ -2692,41 +3456,69 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Render the specified triangles using the current buffers and state of this Context3D object. -

For each triangle, the triangle vertices are processed by the vertex shader program and the + + +

For each triangle, the triangle vertices are processed by the vertex shader program and the + triangle surface is processed by the pixel shader program. + The output color from the pixel program for each pixel is drawn to the render target + depending on the stencil operations, depth test, source and destination alpha, and the current blend mode. + The render destination can be the main render buffer or a texture.

-

If culling is enabled, (with the setCulling() method), then triangles can be discarded from the + + +

If culling is enabled, (with the setCulling() method), then triangles can be discarded from the + scene before the pixel program is run. If stencil and depth testing are enabled, then output + pixels from the pixel program can be discarded without updating the render destination. + In addition, the pixel program can decide not to output a color for a pixel.

+ +

The rendered triangles are not displayed in the viewport until you call the present() method. + After each present() call, the clear() method must be called before the + first drawTriangles() call or rendering fails.

+ +

When enableErrorChecking is false, this function returns immediately, + does not wait for results, and throws exceptions only if this Context3D instance has been disposed + or there are too many draw calls. If the rendering context state is invalid + rendering fails silently. When the enableErrorChecking property is true, + this function returns after the triangles are drawn and throws exceptions for any drawing errors + or invalid context state.

- Parameters + + + Parameters @@ -2734,6 +3526,7 @@ @@ -2741,8 +3534,11 @@
indexBuffer:IndexBuffer3D — a set of vertex indices referencing the vertices to render. +
firstIndex:int (default = 0) — the index of the first vertex index selected to render. Default 0. +
numTriangles:int (default = -1) — the number of triangles to render. Each triangle consumes three indices. + Pass -1 to draw all triangles in the index buffer. Default -1. + +
@@ -2751,8 +3547,11 @@ @@ -2760,11 +3559,17 @@ @@ -2772,8 +3577,11 @@ @@ -2781,7 +3589,9 @@ @@ -2789,7 +3599,9 @@ @@ -2797,8 +3609,11 @@ @@ -2806,8 +3621,11 @@ @@ -2815,8 +3633,11 @@ @@ -2824,8 +3645,11 @@ @@ -2833,9 +3657,13 @@ @@ -2843,8 +3671,11 @@ @@ -2852,9 +3683,13 @@ @@ -2862,8 +3697,11 @@ @@ -2871,8 +3709,11 @@ @@ -2880,8 +3721,11 @@ @@ -2889,8 +3733,11 @@ @@ -2898,8 +3745,11 @@ @@ -2907,8 +3757,11 @@ + + +
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or + because the underlying rendering hardware has been lost. + +
Error — If this method is called too many times between calls to present(). + The maximum number of calls is 32,768. + +

The following errors are only thrown when enableErrorChecking + property is true:

+ +
Error — Need To Clear Before Draw: If the buffer has not been cleared + since the last present() call. + +
Error — If a valid Program3D object is not set. + +
Error — No Valid Index Buffer Set: If an IndexBuffer3D object is not set. + +
Error — Sanity Check On Parameters Failed: when the number of triangles to be drawn or the + firstIndex exceed allowed values. + +
RangeError — Not Enough Indices In This Buffer: when there aren't enough indices in the buffer to + define the number of triangles to be drawn. + +
Error — Sample Binds Texture Also Bound To Render: when the render target is a texture and that + texture assigned to a texture input of the current fragment program. + +
Error — Sample Binds Invalid Texture: an invalid texture is specified as the input to the current + fragment program. + +
Error — Sampler Format Does Not Match Texture Format: when the texture assigned as the input + to the current fragment program has a different format than that specified for the sampler + register. For example, a 2D texture is assigned to a cube texture sampler. + +
Error — Sample Binds Undefined Texture: The current fragment program accesses a texture + register that has not been set (using setTextureAt()). + +
Error — Same Texture Needs Same Sampler Params: If a texture is used for more than one + sampler register, all of the samplers must have the same settings. For example, you cannot + set one sampler to clamp and another to wrap. + +
Error — Texture Bound But Not Used: A texture is set as a shader input, but + it is not used. + +
Error — Stream Is Not Used: A vertex buffer is assigned to a vertex attribute input, + but the vertex program does not reference the corresponding register. + +
Error — Stream Is Invalid: a VertexBuffer3D object assigned to a vertex program input + is not a valid object. + +
RangeError — Stream Does Not Have Enough Vertices: A vertex buffer supplying data for drawing + the specified triangles does not have enough data. + +
RangeError — Stream Vertex Offset Out Of Bounds: The offset specified in a + setVertexBufferAt() call is negative or past the end of the buffer. + +
Error — Stream Read But Not Set: A vertex attribute used by the current vertex program + is not set (using setVertexBufferAt()). -

@@ -3056,51 +3909,89 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 20.0 +

+ Render the specified instanced triangles using the current buffers and state of this Context3D object. -

For each triangle of each instance, the triangle vertices are processed by the vertex shader program and the + + +

For each triangle of each instance, the triangle vertices are processed by the vertex shader program and the + triangle surface is processed by the pixel shader program. + The output color from the pixel program for each pixel is drawn to the render target + depending on the stencil operations, depth test, source and destination alpha, and the current blend mode. + The render destination can be the main render buffer or a texture.

-

If culling is enabled, (with the setCulling() method), then triangles can be discarded from the + + +

If culling is enabled, (with the setCulling() method), then triangles can be discarded from the + scene before the pixel program is run. If stencil and depth testing are enabled, then output + pixels from the pixel program can be discarded without updating the render destination. + In addition, the pixel program can decide not to output a color for a pixel.

+ +

The rendered instanced traingles are not displayed in the viewport until you call the present() method. + After each present() call, the clear() method must be called before the + first drawTrianglesInstanced() call or rendering fails.

+ +

When enableErrorChecking is false, this function returns immediately, + does not wait for results, and throws exceptions only if this Context3D instance has been disposed + or there are too many draw calls. If the rendering context state is invalid + rendering fails silently. When the enableErrorChecking property is true, + this function returns after the triangles are drawn and throws exceptions for any drawing errors + or invalid context state.

+ +

This method may throw an exception if the instanced buffer is improperly sequenced with SetVertexAt(). + With Direct 3D 9, for example, the indexed geometry data and the number of instances + to draw must always be set in stream zero with SetStreamSourceFreq() API.

+ +

This means that the vertex buffer created using CreateVertexBufferForInstance() should not be placed + with the minimal index number when arranged with SetVertexBufferAt() as input to the vertex shader program. + The vertex buffer generated using CreateVertexBuffer() must be placed with a smaller index number than that + for CreateVertexBufferForInstance(). In general, the geometry data must be placed before per-instance data, + with SetVertexBufferAt().

- Parameters + + + Parameters @@ -3108,6 +3999,7 @@ @@ -3115,6 +4007,7 @@ @@ -3122,8 +4015,11 @@ + + +
indexBuffer:IndexBuffer3D — a set of vertex indices referencing the vertices to render. +
numInstances:int — number of instances to render. +
firstIndex:int (default = 0) — the index of the first vertex index selected to render. Default 0. +
numTriangles:int (default = -1) — the number of triangles to render. Each triangle consumes three indices. + Pass -1 to draw all triangles in the index buffer. Default -1. -

@@ -3131,8 +4027,11 @@ @@ -3140,26 +4039,37 @@ + + + + + + @@ -3167,8 +4077,11 @@ @@ -3176,7 +4089,9 @@ @@ -3184,7 +4099,9 @@ @@ -3192,8 +4109,11 @@ @@ -3201,8 +4121,11 @@ @@ -3210,8 +4133,11 @@ @@ -3219,8 +4145,11 @@ @@ -3228,9 +4157,13 @@ @@ -3238,8 +4171,11 @@ @@ -3247,9 +4183,13 @@ @@ -3257,8 +4197,11 @@ @@ -3266,8 +4209,11 @@ @@ -3275,8 +4221,11 @@ @@ -3284,8 +4233,11 @@ @@ -3293,8 +4245,11 @@ @@ -3302,25 +4257,35 @@ + + + + + + + + +
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or + because the underlying rendering hardware has been lost. + +
Error — If this method is called too many times between calls to present(). + The maximum number of calls is 32,768. -
 
Error — Requires Standard Extended Profile Or Above: if this method is called when the requested profile is + less than standard extended profile. -
 
Error — If this method is called with negative numInstances. + +

The following errors are only thrown when enableErrorChecking + property is true:

+ +
Error — Need To Clear Before Draw: If the buffer has not been cleared + since the last present() call. + +
Error — If a valid Program3D object is not set. + +
Error — No Valid Index Buffer Set: If an IndexBuffer3D object is not set. + +
Error — Sanity Check On Parameters Failed: when the number of triangles to be drawn or the + firstIndex exceed allowed values. + +
RangeError — Not Enough Indices In This Buffer: when there aren't enough indices in the buffer to + define the number of triangles to be drawn. + +
Error — Sample Binds Texture Also Bound To Render: when the render target is a texture and that + texture assigned to a texture input of the current fragment program. + +
Error — Sample Binds Invalid Texture: an invalid texture is specified as the input to the current + fragment program. + +
Error — Sampler Format Does Not Match Texture Format: when the texture assigned as the input + to the current fragment program has a different format than that specified for the sampler + register. For example, a 2D texture is assigned to a cube texture sampler. + +
Error — Sample Binds Undefined Texture: The current fragment program accesses a texture + register that has not been set (using setTextureAt()). + +
Error — Same Texture Needs Same Sampler Params: If a texture is used for more than one + sampler register, all of the samplers must have the same settings. For example, you cannot + set one sampler to clamp and another to wrap. + +
Error — Texture Bound But Not Used: A texture is set as a shader input, but + it is not used. + +
Error — Stream Is Not Used: A vertex buffer is assigned to a vertex attribute input, + but the vertex program does not reference the corresponding register. + +
Error — Stream Is Invalid: a VertexBuffer3D object assigned to a vertex program input + is not a valid object. + +
RangeError — Stream Does Not Have Enough Vertices: A vertex buffer supplying data for drawing + the specified triangles does not have enough data. + +
RangeError — Stream Vertex Offset Out Of Bounds: The offset specified in a + setVertexBufferAt() call is negative or past the end of the buffer. + +
Error — Stream Read But Not Set: A vertex attribute used by the current vertex program + is not set (using setVertexBufferAt()). -
 
Error — Vertex Buffer Stream Does Not Contain Enough Elements For Instances: If a vertex buffer stream + does not contain enough elements for number of instances. -
 
Error — Vertex Buffer Stream For Instances Is Improperly Set With The Minimal Index Attribute Register: If the vertex + buffer generated using CreateVertexBuffer() is given a larger index number than that for the vertex buffer generated + using CreateVertexBufferForInstance(). -

@@ -3668,41 +4633,62 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Displays the back rendering buffer. + +

Calling the present() method makes the results of all + rendering operations since the last present() call visible and starts a new rendering cycle. + After calling present, you must call clear() before making another + drawTriangles() call. Otherwise, this function will alternately clear the render buffer + to yellow and green or, if enableErrorChecking has been set to true, + an exception is thrown.

-

Calling present() also resets the render target, just like calling + + +

Calling present() also resets the render target, just like calling + setRenderToBackBuffer().

-
+ + +
Throws + + +
Error — Need To Clear Before Draw: If the clear() has not been called since + the previous call to present(). (Two consecutive present() calls are not allowed + without calling clear() in between.) -
 
Error — 3768: The Stage3D API may not be used during background execution. + +
@@ -3718,34 +4704,54 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Specifies the factors used to blend the output color of a drawing operation with the existing color. -

The output (source) color of the pixel shader program is combined with the existing (destination) color at that pixel + + +

The output (source) color of the pixel shader program is combined with the existing (destination) color at that pixel + according to the following formula:

+

result color = (source color * sourceFactor) + (destination color * destinationFactor)

+

The destination color is the current color in the render buffer for that pixel. Thus it is the result of the most recent + clear() call and any intervening drawTriangles() calls.

+ +

Use setBlendFactors() to set the factors used to multiply the source and destination colors before they are added together. + The default blend factors are, sourceFactor = Context3DBlendFactor.ONE, and destinationFactor = Context3DBlendFactor.ZERO, which + results in the source color overwriting the destination color (in other words, no blending of the two colors occurs). For normal + alpha blending, use sourceFactor = Context3DBlendFactor.SOURCE_ALPHA and destinationFactor = Context3DBlendFactor.ONE_MINUS_SOURCE_ALPHA. +

-

Use the constants defined in the Context3DBlendFactor class to set the parameters of this function.

+ + +

Use the constants defined in the Context3DBlendFactor class to set the parameters of this function.

+ + Parameters @@ -3753,7 +4759,9 @@ + + +
sourceFactor:String — The factor with which to multiply the source color. Defaults to Context3DBlendFactor.ONE. +
destinationFactor:String — The factor with which to multiply the destination color. Defaults to Context3DBlendFactor.ZERO. -

@@ -3761,8 +4769,11 @@
Error — Invalid Enum: when sourceFactor or destinationFactor + is not one of the recognized values, which are defined in the Context3DBlendFactor class. + +
@@ -3982,26 +4993,38 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Sets the mask used when writing colors to the render buffer. -

Only color components for which the corresponding color mask parameter is true are updated + + +

Only color components for which the corresponding color mask parameter is true are updated + when a color is written to the render buffer. For example, if you call: + setColorMask( true, false, false, false ), only the red component of a color is written to the + buffer until you change the color mask again. The color mask does not affect the behavior of the + clear() method.

- Parameters + + + Parameters @@ -4009,6 +5032,7 @@ @@ -4016,6 +5040,7 @@ @@ -4023,7 +5048,9 @@
red:Boolean — set false to block changes to the red channel. +
green:Boolean — set false to block changes to the green channel. +
blue:Boolean — set false to block changes to the blue channel. +
alpha:Boolean — set false to block changes to the alpha channel. + +
@@ -4149,25 +5176,36 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Sets triangle culling mode. -

Triangles may be excluded from the scene early in the rendering pipeline based on their orientation + + +

Triangles may be excluded from the scene early in the rendering pipeline based on their orientation + relative to the view plane. Specify vertex order consistently (clockwise or counter-clockwise) as + seen from the outside of the model to cull correctly.

- Parameters + + + Parameters + + +
triangleFaceToCull:String — the culling mode. Use one of the constants defined in the Context3DTriangleFace class. -

@@ -4175,8 +5213,11 @@
Error — Invalid Enum Error: when triangleFaceToCull is not one of the values + defined in the Context3DTriangleFace class. + +
@@ -4198,31 +5239,48 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Sets type of comparison used for depth testing. -

The depth of the source pixel output from the pixel shader program is compared to the current + + +

The depth of the source pixel output from the pixel shader program is compared to the current + value in the depth buffer. If the comparison evaluates as false, then the source pixel + is discarded. If true, then the source pixel is processed by the next step in + the rendering pipeline, the stencil test. In addition, the depth buffer is updated with the depth of the source + pixel, as long as the depthMask parameter is set to true.

+ +

Sets the test used to compare depth values for source and destination pixels. The source + pixel is composited with the destination pixel when the comparison is true. The comparison + operator is applied as an infix operator between the source and destination pixel values, in + that order.

- Parameters + + + Parameters @@ -4230,7 +5288,9 @@
depthMask:Boolean — the destination depth value will be updated from the source pixel when true. +
passCompareMode:String — the depth comparison test operation. One of the values of Context3DCompareMode. + +
@@ -4252,23 +5312,31 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 16 +

+ Set fill mode used for render. The interface is only available in AIR desktop. -

Parameters + + +

Parameters + + +
fillMode:String — if the value is WIREFRAME, the object will be shown in a mesh of lines. + if the value is SOLID, the object will be shown in solid shaded polygons. -

@@ -4289,22 +5357,29 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Sets vertex and fragment shader programs to use for subsequent rendering. -

Parameters + + +

Parameters
program:Program3D — the Program3D object representing the vertex and fragment programs to use. + +
@@ -4358,22 +5433,30 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3.1 +

+ Set constants for use by shader programs using values stored in a ByteArray. -

Sets constants that can be accessed from the vertex or fragment program.

- Parameters + + +

Sets constants that can be accessed from the vertex or fragment program.

+ + + Parameters @@ -4381,6 +5464,7 @@ @@ -4388,6 +5472,7 @@ @@ -4395,6 +5480,7 @@ @@ -4402,6 +5488,7 @@
programType:String — one of Context3DProgramType. +
firstRegister:int — the index of the first shader program constant to set. +
numRegisters:int — the number of registers to set. Every register is read as four float values. +
data:ByteArray — the source ByteArray object +
byteArrayOffset:uint — an offset into the ByteArray for reading +
@@ -4410,6 +5497,7 @@ @@ -4417,6 +5505,7 @@ @@ -4424,8 +5513,11 @@
TypeError — kNullPointerError when data is null. +
RangeError — kConstantRegisterOutOfBounds when attempting to set more than the maximum number of shader constants. +
RangeError — kBadInputSize if byteArrayOffset is greater than or equal to the length of data or + no. of elements in data - byteArrayOffset is less than numRegisters*16 + +
@@ -4443,31 +5535,44 @@
-public function setProgramConstantsFromFloatVector(programType:String, firstRegister:int, data:Vector.<float>, numRegisters:int = -1):void +public function setProgramConstantsFromFloatVector(programType:String, firstRegister:int, data:Vector.<float>, numRegisters:int = -1):void

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 51.0 +

+ Sets the constant inputs for the shader programs. -

Sets an array of constants to be accessed by a vertex or fragment shader program. + + +

Sets an array of constants to be accessed by a vertex or fragment shader program. + Constants set in Program3D are accessed within the shader programs as constant registers. + Each constant register is comprised of 4 floating point values (x, y, z, w). + Therefore every register requires 4 entries in the data Vector. You can set 128 registers + for a vertex program and 28 for a fragment program.

- Parameters + + + Parameters @@ -4475,14 +5580,17 @@ - @@ -4490,8 +5598,11 @@ + + +
programType:String — The type of shader program, either Context3DProgramType.VERTEX or + Context3DProgramType.FRAGMENT. +
firstRegister:int — the index of the first constant register to set. +
 
data:Vector.<float> — the floating point constant values. There must be at least numRegisters 4 +data:Vector.<float> — the floating point constant values. There must be at least numRegisters 4 + elements in data. +
numRegisters:int (default = -1) — the number of constants to set. Specify -1, the default value, to set enough + registers to use all of the available data. -

@@ -4499,6 +5610,7 @@ @@ -4506,9 +5618,13 @@
TypeError — Null Pointer Error: when data is null. +
RangeError — Constant Register Out Of Bounds: when attempting to set more + than the maximum number of shader constant registers (128 for vertex programs; + 28 for fragment programs). + +
@@ -4532,28 +5648,41 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Sets constants for use by shader programs using values stored in a Matrix3D. -

Use this function to pass a matrix to a shader program. The function sets 4 constant + + +

Use this function to pass a matrix to a shader program. The function sets 4 constant + registers used by the vertex or fragment program. + The matrix is assigned to registers row by row. The first constant register is assigned the + top row of the matrix. You can set 128 registers for a vertex program and 28 for a + fragment program.

+ + Parameters @@ -4561,7 +5690,9 @@ @@ -4569,6 +5700,7 @@ @@ -4576,8 +5708,11 @@
programType:String — The type of shader program, either Context3DProgramType.VERTEX or + Context3DProgramType.FRAGMENT. +
firstRegister:int — the index of the first constant register to set. Since a Matrix3D has 16 values, + four registers are set. +
matrix:Matrix3D — the matrix containing the constant values. +
transposedMatrix:Boolean (default = false) — if true the matrix entries are copied to registers in + transposed order. The default value is false. + +
@@ -4586,6 +5721,7 @@ @@ -4593,8 +5729,11 @@
TypeError — Null Pointer Error: when matrix is null. +
RangeError — Constant Register Out Of Bounds: when attempting to set more than + the maximum number of shader constant registers. + +
@@ -4614,32 +5753,46 @@
-public function setProgramConstantsFromVector(programType:String, firstRegister:int, data:Vector.<Number>, numRegisters:int = -1):void +public function setProgramConstantsFromVector(programType:String, firstRegister:int, data:Vector.<Number>, numRegisters:int = -1):void

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Sets the constant inputs for the shader programs. -

Sets an array of constants to be accessed by a vertex or fragment shader program. + + +

Sets an array of constants to be accessed by a vertex or fragment shader program. + Constants set in Program3D are accessed within the shader programs as constant registers. + Each constant register is comprised of 4 floating point values (x, y, z, w). + Therefore every register requires 4 entries in the data Vector. The number of registers + that you can set for vertex program and fragment program depends on the + Context3DProfile.

- Parameters + + + Parameters @@ -4647,14 +5800,17 @@ - @@ -4662,8 +5818,11 @@ + + +
programType:String — The type of shader program, either Context3DProgramType.VERTEX or + Context3DProgramType.FRAGMENT. +
firstRegister:int — the index of the first constant register to set. +
 
data:Vector.<Number> — the floating point constant values. There must be at least numRegisters 4 +data:Vector.<Number> — the floating point constant values. There must be at least numRegisters 4 + elements in data. +
numRegisters:int (default = -1) — the number of constants to set. Specify -1, the default value, to set enough + registers to use all of the available data. -

@@ -4671,6 +5830,7 @@ @@ -4678,7 +5838,9 @@ @@ -4686,8 +5848,11 @@
TypeError — Null Pointer Error: when data is null. +
RangeError — Constant Register Out Of Bounds: when attempting to set more + than the maximum number of shader constant registers. +
RangeError — Bad Input Size: When the number of elements in data is less + than numRegisters*4 + +
@@ -4711,20 +5876,28 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Sets the back rendering buffer as the render target. Subsequent calls to drawTriangles() + and clear() methods result in updates to the back buffer. Use this method to resume normal rendering + after using the setRenderToTexture() method. - + + + +

@@ -4737,32 +5910,49 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Sets the specified texture as the rendering target. + +

Subsequent calls to drawTriangles() + and clear() methods update the specified texture instead of the back buffer. Mip maps + are created automatically. Use the setRenderToBackBuffer() to resume normal rendering + to the back buffer.

-

No clear is needed before drawing. If there is no clear operation, the render content will be retained. + + +

No clear is needed before drawing. If there is no clear operation, the render content will be retained. + depth buffer and stencil buffer will also not be cleared. But it is forced to clear when first drawing. + Calling present() resets the target to the back buffer.

+ + Parameters @@ -4770,7 +5960,9 @@ @@ -4778,8 +5970,11 @@ @@ -4787,7 +5982,9 @@ @@ -4795,7 +5992,9 @@
texture:TextureBase — the target texture to render into. Set to null to resume + rendering to the back buffer (setRenderToBackBuffer() and + present also reset the target to the back buffer). +
enableDepthAndStencil:Boolean (default = false) — if true, depth and stencil testing are available. + If false, all depth and stencil state is ignored for subsequent drawing operations. +
antiAlias:int (default = 0) — the antialiasing quality. Use 0 to disable antialiasing; higher values improve + antialiasing quality, but require more calculations. The value is currently ignored + by mobile platform and software rendering context. +
surfaceSelector:int (default = 0) — specifies which element of the texture to update. Texture objects have one surface, so you must + specify 0, the default value. CubeTexture objects have six surfaces, so you can specify an integer from 0 through 5. +
colorOutputIndex:int (default = 0) — The output color register. Must be 0 for constrained or baseline mode. Otherwise specifies the output color register. + +
@@ -4804,6 +6003,7 @@ @@ -4811,6 +6011,7 @@ @@ -4818,6 +6019,7 @@ @@ -4825,7 +6027,9 @@ + + +
ArgumentError — for a mismatched surfaceSelector parameter. The value must be 0 for 2D textures and 0..5 for cube maps. +
ArgumentError — texture is not derived from the TextureBase class (either Texture or CubeTexture classes). +
ArgumentError — colorOutputIndex must be an integer is from 0 through 3. +
ArgumentError — this call requires a Context3D that is created with the standard profile or above. -

@@ -4850,26 +6054,38 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3.6 +

+ Manually override texture sampler state. -

Texture sampling state is typically set at the time setProgram is called. + + +

Texture sampling state is typically set at the time setProgram is called. + However, you can override texture sampler state with this function. + If you do not want the program to change sampler state, set + the ignoresamnpler bit in AGAL and use this function. +

- Parameters + + + Parameters @@ -4877,6 +6093,7 @@ @@ -4884,6 +6101,7 @@ @@ -4891,7 +6109,9 @@
sampler:int — sampler The sampler register to use. Maps to the sampler register in AGAL. +
wrap:String — Wrapping mode. Defined in Context3DWrapMode. The default is repeat. +
filter:String — Texture filtering mode. Defined in Context3DTextureFilter. The default is nearest. +
mipfilter:String — Mip map filter. Defined in Context3DMipFilter. The default is none. + +
@@ -4900,6 +6120,7 @@ @@ -4907,6 +6128,7 @@ @@ -4914,8 +6136,11 @@ + + +
Error — sampler out of range +
Error — wrap, filter, mipfilter bad enum +
Error — Object Disposed: if this Context3D object has been disposed by a calling dispose() or + because the underlying rendering hardware has been lost. -

@@ -4940,27 +6165,39 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Sets a scissor rectangle, which is type of drawing mask. The renderer only draws to the area inside the + scissor rectangle. Scissoring does not affect clear operations. -

Pass null to turn off scissoring.

+ + +

Pass null to turn off scissoring.

+ + Parameters
rectangle:Rectangle — The rectangle in which to draw. Specify the rectangle position and dimensions in pixels. + The coordinate system origin is the top left corner of the viewport, with positive values increasing down + and to the right (the same as the normal Flash display coordinate system). + +
@@ -5125,35 +6362,56 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Sets stencil mode and operation. -

An 8-bit stencil reference value can be associated with each draw call. + + +

An 8-bit stencil reference value can be associated with each draw call. + During rendering, the reference value can be tested against values stored previously + in the frame buffer. The result of the test can control the draw action and + whether or how the stored stencil value is updated. In addition, depth testing + controls whether stencil testing is performed. A failed depth test can + also be used to control the action taken on the stencil buffer.

+ +

In the pixel processing pipeline, depth testing is performed first. + If the depth test fails, a stencil buffer update action can be taken, + but no further evaluation of the stencil buffer value can be made. If the + depth test passes, then the stencil test is performed. Alternate actions + can be taken depending on the outcome of the stencil test.

-

The stencil reference value is set using setStencilReferenceValue().

+ + +

The stencil reference value is set using setStencilReferenceValue().

+ + Parameters @@ -5161,10 +6419,15 @@ @@ -5172,7 +6435,9 @@ @@ -5180,6 +6445,7 @@ @@ -5187,8 +6453,11 @@ + + +
triangleFace:String (default = "frontAndBack") — the triangle orientations allowed to contribute to the stencil operation. One of Context3DTriangleFace. +
compareMode:String (default = "always") — the test operator used to compare the current stencil reference value and the destination pixel stencil value. Destination + pixel color and depth update is performed when the comparison is true. The stencil actions are performed as requested in the following action + parameters. The comparison operator is applied as an infix operator between the current and destination reference values, in + that order (in pseudocode: if stencilReference OPERATOR stencilBuffer then pass). Use one of the constants defined in the + Context3DCompareMode class. +
actionOnBothPass:String (default = "keep") — action to be taken when both depth and stencil comparisons pass. Use one of the constants defined in the + Context3DStencilAction class. +
actionOnDepthFail:String (default = "keep") — action to be taken when depth comparison fails. Use one of the constants defined in the Context3DStencilAction class. +
actionOnDepthPassStencilFail:String (default = "keep") — action to be taken when depth comparison passes and the stencil comparison fails. Use one of the constants + defined in the Context3DStencilAction class. -

@@ -5196,6 +6465,7 @@ @@ -5203,6 +6473,7 @@ @@ -5210,8 +6481,11 @@
Error — Invalid Enum Error: when triangleFace is not one of the values defined in the Context3DTriangleFace class. +
Error — Invalid Enum Error: when compareMode is not one of the values defined in the Context3DCompareMode class. +
Error — Invalid Enum Error: when actionOnBothPass, actionOnDepthFail, or actionOnDepthPassStencilFail + is not one of the values defined in the Context3DStencilAction class. + +
@@ -5465,24 +6739,33 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Sets the stencil comparison value used for stencil tests. + +

Only the lower 8 bits of the reference value are used. The stencil buffer value is also 8 bits in length. + Use the readMask and writeMask to use the stencil buffer as a bit field.

- Parameters + + + Parameters @@ -5490,6 +6773,7 @@ @@ -5497,7 +6781,9 @@
referenceValue:uint — an 8-bit reference value used in reference value comparison tests. +
readMask:uint (default = 255) — an 8-bit mask for applied to both the current stencil buffer value and the reference value before the comparison. +
writeMask:uint (default = 255) — an 8-bit mask applied to the reference value before updating the stencil buffer. + +
@@ -5519,31 +6805,47 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Specifies the texture to use for a texture input register of a fragment program. + +

A fragment program can read information from up to eight texture objects. + Use this function to assign a Texture or CubeTexture object to one + of the sampler registers used by the fragment program.

+ +

Note: if you change the active fragment program (with setProgram) + to a shader that uses fewer textures, set the unused registers to null:

+ 
+
          setTextureAt( 7, null );
+
- Parameters + + + Parameters @@ -5551,7 +6853,9 @@
sampler:int — the sampler register index, a value from 0 through 7. +
texture:TextureBase — the texture object to make available, either a Texture or a CubeTexture instance. + +
@@ -5573,44 +6877,76 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Specifies which vertex data components correspond to a single vertex shader program input. -

Use the setVertexBufferAt method to identify which components of the data + + +

Use the setVertexBufferAt method to identify which components of the data + defined for each vertex in a VertexBuffer3D buffer belong to which inputs to the vertex program. The + developer of the vertex program determines how much data is needed per vertex. That data is mapped from 1 or more + VertexBuffer3D stream(s) to the attribute registers of the vertex shader program.

+ +

The smallest unit of data consumed by the vertex shader is a 32-bit data. Offsets into the vertex stream + are specified in multiples of 32-bits.

- As an example, a programmer might define each vertex with the following data: + + + As an example, a programmer might define each vertex with the following data: + 
+
 position:  x    float32
+
            y    float32
+
            z    float32
+
 color:     r    unsigned byte
+
            g    unsigned byte
+
            b    unsigned byte
+
            a    unsigned byte
+
+ Assuming the vertex was defined in a VertexBuffer3D object named buffer, it would be assigned to a + vertex shader with the following code: + 
+
 setVertexBufferAt( 0, buffer, 0, Context3DVertexBufferFormat.FLOAT_3 );   // attribute #0 will contain the position information
+
 setVertexBufferAt( 1, buffer, 3, Context3DVertexBufferFormat.BYTES_4 );    // attribute #1 will contain the color information
+
- Parameters + + + + Parameters @@ -5618,6 +6954,7 @@ @@ -5625,9 +6962,13 @@ @@ -5635,7 +6976,9 @@ + + +
index:int — the index of the attribute register in the vertex shader (0 through 7). +
buffer:VertexBuffer3D — the buffer that contains the source vertex data to be fed to the vertex shader. +
bufferOffset:int (default = 0) — an offset from the start of the data for a single vertex at which to start + reading this attribute. In the example above, the position data has an offset of 0 because it is the + first attribute; color has an offset of 3 because the color attribute follows the three 32-bit position values. + The offset is specified in units of 32 bits. +
format:String (default = "float4") — a value from the Context3DVertexBufferFormat class specifying the data type of this attribute. -

@@ -5643,7 +6986,9 @@ @@ -5651,8 +6996,11 @@
Error — Invalid Enum: when format is not one of the values defined in the + Context3DVertexBufferFormat class. +
RangeError — Attribute Register Out Of Bounds: when the index parameter + is outside the range from 0 through 7. (A maximum of eight vertex attribute registers can be used by a shader.) + +
@@ -5876,11 +7224,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/flash/display3D/IndexBuffer3D.html b/static/reference/actionscript/3.0/flash/display3D/IndexBuffer3D.html index ff1a82381..64e24f4b9 100644 --- a/static/reference/actionscript/3.0/flash/display3D/IndexBuffer3D.html +++ b/static/reference/actionscript/3.0/flash/display3D/IndexBuffer3D.html @@ -202,7 +202,7 @@   
-uploadFromVector(data:Vector.<uint>, startOffset:int, count:int):void +uploadFromVector(data:Vector.<uint>, startOffset:int, count:int):void
Store in the graphics subsystem vertex indices.
@@ -337,7 +337,7 @@
-public function uploadFromVector(data:Vector.<uint>, startOffset:int, count:int):void +public function uploadFromVector(data:Vector.<uint>, startOffset:int, count:int):void

@@ -355,7 +355,7 @@

Parameters
- @@ -407,11 +407,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/flash/display3D/VertexBuffer3D.html b/static/reference/actionscript/3.0/flash/display3D/VertexBuffer3D.html index 76d91395c..48b216c0d 100644 --- a/static/reference/actionscript/3.0/flash/display3D/VertexBuffer3D.html +++ b/static/reference/actionscript/3.0/flash/display3D/VertexBuffer3D.html @@ -46,50 +46,88 @@

data:Vector.<uint> — a vector of vertex indices. Only the low 16 bits of each index value are used. +data:Vector.<uint> — a vector of vertex indices. Only the low 16 bits of each index value are used. The length of the vector must be greater than or equal to count.
- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ 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 + + +

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 discarding the + source array does not change the vertex data.)

+ +

The data associated with each vertex is in an application-defined format and is used as the + input for the vertex shader program. Identify which values belong + to which vertex program input using the Context3D setVertexBufferAt() function. + A vertex program can use up to eight inputs (also known as vertex attribute registers). Each + input can require between one and four 32-bit values. For example, the [x,y,z] position + coordinates of a vertex can be passed to a vertex program as a vector containing three 32 bit + values. The Context3DVertexBufferFormat class defines constants for the supported + formats for shader inputs. You can supply up to sixty-four 32-bit values (256 bytes) of data + for each point (but a single vertex shader cannot use all of the data in this case).

+ +

The setVertexBufferAt() function also identifies which vertex buffer to use + for rendering any subsequent drawTriangles() calls. To render data from a different + vertex buffer, call setVertexBufferAt() again with the appropriate arguments. + (You can store data for the same point in multiple vertex buffers, + say position data in one buffer and texture coordinates in another, but typically rendering is + more efficient if all the data for a point comes from a single buffer.)

+ +

The Index3DBuffer + object passed to the Context3D drawTriangles() method organizes the vertex data into + triangles. Each value in the index buffer is the index to a vertex in the vertex buffer. + A set of three indexes, in sequence, defines a triangle.

+ +

You cannot create a VertexBuffer3D object directly. Use the + Context3D createVertexBuffer() method instead.

-

To free the render context resources associated with a vertex buffer, call the object's dispose() + + +

To free the render context resources associated with a vertex buffer, call the object's dispose() + method.

+ +

View the examples. @@ -159,6 +197,7 @@ dispose():void

+ Frees all resources associated with this object.
VertexBuffer3D @@ -230,24 +269,27 @@ uploadFromByteArray(data:ByteArray, byteArrayOffset:int, startVertex:int, numVertices:int):void
+ Uploads the data for a set of points to the rendering context from a byte array.
VertexBuffer3D   
-uploadFromFloatVector(data:Vector.<float>, startVertex:int, numVertices:int):void +uploadFromFloatVector(data:Vector.<float>, startVertex:int, numVertices:int):void
+ Uploads the data for a set of points to the rendering context from a float vector array.
VertexBuffer3D   
-uploadFromVector(data:Vector.<Number>, startVertex:int, numVertices:int):void +uploadFromVector(data:Vector.<Number>, startVertex:int, numVertices:int):void
+ Uploads the data for a set of points to the rendering context from a vector array.
VertexBuffer3D @@ -281,19 +323,25 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Frees all resources associated with this object. + After disposing a vertex buffer, calling upload() and rendering using this object will fail. + +

@@ -306,24 +354,33 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Uploads the data for a set of points to the rendering context from a byte array. -

Parameters + + +

Parameters @@ -331,6 +388,7 @@ @@ -338,6 +396,7 @@ @@ -345,7 +404,9 @@ + + +
data:ByteArray — a byte array containing the vertex data. Each data value is four bytes long. The number of values in a vertex is specified at + buffer creation using the data32PerVertex parameter to the Context3D createVertexBuffer3D() method. + The length of the data in bytes must be byteArrayOffset plus four times the number of values per vertex times the number of vertices. + The ByteArray object must use the little endian format. +
byteArrayOffset:int — number of bytes to skip from the beginning of data +
startVertex:int — The index of the first vertex to be loaded. A value for startVertex not equal to zero may be used to load a sub-region of the vertex data. +
numVertices:int — The number of vertices to be loaded from data. -

@@ -353,6 +414,7 @@ @@ -360,10 +422,15 @@ @@ -371,7 +438,9 @@
TypeError — Null Pointer Error: when data is null. +
RangeError — Bad Input Size: if byteArrayOffset is less than 0, + or if byteArrayOffset is greater than or equal to the length of data, + or if no. of elements in data - byteArrayOffset is less than numVertices*data32pervertex*4 + given in Context3D::createVertexBuffer(). + +
Error — 3768: The Stage3D API may not be used during background execution. + +
@@ -383,28 +452,37 @@
-public function uploadFromFloatVector(data:Vector.<float>, startVertex:int, numVertices:int):void +public function uploadFromFloatVector(data:Vector.<float>, startVertex:int, numVertices:int):void

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 51.0 +

+ Uploads the data for a set of points to the rendering context from a float vector array. -

Parameters + + +

Parameters - @@ -412,6 +490,7 @@ @@ -419,7 +498,9 @@ + + +
data:Vector.<float> — a vector of 32-bit values. A single vertex is comprised of a number of values stored sequentially +data:Vector.<float> — a vector of 32-bit values. A single vertex is comprised of a number of values stored sequentially + in the vector. The number of values in a vertex is specified at buffer creation using the data32PerVertex + parameter to the Context3D createVertexBuffer3D() method. The length of the vector must + be the number of values per vertex times the number of vertexes. +
startVertex:int — The index of the first vertex to be loaded. A value for startVertex not equal to zero may be used to load a sub-region of the vertex data. +
numVertices:int — The number of vertices represented by data. -

@@ -427,6 +508,7 @@ @@ -434,7 +516,9 @@ @@ -442,7 +526,9 @@
TypeError — Null Pointer Error: when data is null. +
RangeError — Bad Input Size: when there isn't enough data in the vector for the + number of vertices uploaded. +
Error — 3768: The Stage3D API may not be used during background execution. + +
@@ -454,28 +540,37 @@
-public function uploadFromVector(data:Vector.<Number>, startVertex:int, numVertices:int):void +public function uploadFromVector(data:Vector.<Number>, startVertex:int, numVertices:int):void

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3 +

+ Uploads the data for a set of points to the rendering context from a vector array. -

Parameters + + +

Parameters - @@ -483,6 +578,7 @@ @@ -490,7 +586,9 @@ + + +
data:Vector.<Number> — a vector of 32-bit values. A single vertex is comprised of a number of values stored sequentially +data:Vector.<Number> — a vector of 32-bit values. A single vertex is comprised of a number of values stored sequentially + in the vector. The number of values in a vertex is specified at buffer creation using the data32PerVertex + parameter to the Context3D createVertexBuffer3D() method. The length of the vector must + be the number of values per vertex times the number of vertexes. +
startVertex:int — The index of the first vertex to be loaded. A value for startVertex not equal to zero may be used to load a sub-region of the vertex data. +
numVertices:int — The number of vertices represented by data. -

@@ -498,6 +596,7 @@ @@ -505,9 +604,13 @@
TypeError — Null Pointer Error: when data is null. +
RangeError — Bad Input Size: when number of elements in data is less than numVertices + * data32PerVertex given in Context3D::createVertexBuffer(), or when startVertex + + numVertices is greater than numVertices given in Context3D::createVertexBuffer(). + +
@@ -551,11 +654,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 12 2024, 3:03 PM GMT
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/flash/events/FullScreenEvent.html b/static/reference/actionscript/3.0/flash/events/FullScreenEvent.html index 6d7d2ed71..206f62d3e 100644 --- a/static/reference/actionscript/3.0/flash/events/FullScreenEvent.html +++ b/static/reference/actionscript/3.0/flash/events/FullScreenEvent.html @@ -59,6 +59,7 @@

The Stage object dispatches a FullScreenEvent object whenever the Stage enters or leaves full-screen display mode. There are two types of fullScreen events: FullScreenEvent.FULL_SCREEN and FullScreenEvent.FULL_SCREEN_INTERACTIVE_ACCEPTED. +

Note that when handling a FullScreenEvent, you must not try to change the full screen state i.e. Stage.displayState cannot be modified.

See also @@ -939,11 +940,11 @@

-
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Wed Sep 28 2022, 6:12 PM GMT+01:00
Creative Commons License
+
© 2004-2022 Adobe Systems Incorporated. All rights reserved.
Mon Feb 26 2024, 5:22 PM GMT
Creative Commons License
- + diff --git a/static/reference/actionscript/3.0/flash/events/MouseEvent.html b/static/reference/actionscript/3.0/flash/events/MouseEvent.html index 17b07384a..368dfe006 100644 --- a/static/reference/actionscript/3.0/flash/events/MouseEvent.html +++ b/static/reference/actionscript/3.0/flash/events/MouseEvent.html @@ -49,7 +49,9 @@

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 + +
@@ -59,16 +61,27 @@

+ 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 nested node that + is visible in the display list. This node is called the 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.

-

+ + +

View the examples.

@@ -93,6 +106,7 @@   altKey : Boolean
+ Indicates whether the Alt key is active (true) or inactive (false).
MouseEvent @@ -105,6 +119,7 @@   buttonDown : Boolean
+ Indicates whether the primary mouse button is pressed (true) or not (false).
MouseEvent @@ -117,15 +132,20 @@   clickCount : int
[read-only] + Indicates whether or not the mouse down event is part of a multi-click sequence.
MouseEvent   commandKey : Boolean
+ Indicates whether the command key is activated (Mac only.) + +

The value of property commandKey + will have the same value as property ctrlKey on the Mac.

MouseEvent @@ -139,12 +159,14 @@   controlKey : Boolean
+ Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux.
MouseEvent   ctrlKey : Boolean
+ On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false).
MouseEvent @@ -157,7 +179,9 @@   delta : int
+ Indicates how many lines should be scrolled for each unit the user rotates the + mouse wheel.
MouseEvent @@ -170,33 +194,41 @@   isRelatedObjectInaccessible : Boolean
+ If true, the relatedObject property is set to null for + reasons related to security sandboxes.
MouseEvent   localX : Number
+ When mouse locking is disabled, the horizontal coordinate at which the event occurred relative to the containing sprite.
MouseEvent   localY : Number
+ When mouse locking is disabled, the vertical coordinate at which the event occurred relative to the containing sprite.
MouseEvent   movementX : Number
+ When mouse locking is enabled, the change in mouse position + in the X direction since the last mouse event.
MouseEvent   movementY : Number
+ When mouse locking is enabled, the change in mouse position + in the Y direction since the last mouse event.
MouseEvent @@ -210,25 +242,30 @@   relatedObject : InteractiveObject
+ A reference to a display list object that is related to the event.
MouseEvent   shiftKey : Boolean
+ Indicates whether the Shift key is active (true) or inactive + (false).
MouseEvent   stageX : Number
[read-only] + The horizontal coordinate at which the event occurred in global Stage coordinates.
MouseEvent   stageY : Number
[read-only] + The vertical coordinate at which the event occurred in global Stage coordinates.
MouseEvent @@ -266,6 +303,7 @@
MouseEvent(type:String, bubbles:Boolean = true, cancelable:Boolean = false, localX:Number, localY:Number, relatedObject:InteractiveObject = null, ctrlKey:Boolean = false, altKey:Boolean = false, shiftKey:Boolean = false, buttonDown:Boolean = false, delta:int = 0, commandKey:Boolean = false, controlKey:Boolean = false, clickCount:int = 0)
+ Creates an Event object that contains information about mouse events.
MouseEvent @@ -275,6 +313,7 @@ clone():Event
+ Creates a copy of the MouseEvent object and sets the value of each property to match that of the original.
MouseEvent @@ -384,6 +423,7 @@ toString():String
+ Returns a string that contains all the properties of the MouseEvent object.
MouseEvent @@ -393,6 +433,7 @@ updateAfterEvent():void
+ Instructs Flash Player or Adobe AIR to render after processing of this event completes, if the display list has been modified.
MouseEvent @@ -474,6 +515,7 @@   CLICK : String = "click"
[static] + Defines the value of the type property of a click event object.
MouseEvent @@ -505,7 +547,9 @@   CONTEXT_MENU : String = "contextMenu"
[static] + The MouseEvent.CONTEXT_MENU constant defines the value of the + type property of a contextMenu event object.
MouseEvent @@ -531,6 +575,7 @@   DOUBLE_CLICK : String = "doubleClick"
[static] + Defines the value of the type property of a doubleClick event object.
MouseEvent @@ -597,21 +642,25 @@   MIDDLE_CLICK : String = "middleClick"
[static] + Defines the value of the type property of a middleClick event object.
MouseEvent   MIDDLE_MOUSE_DOWN : String = "middleMouseDown"
[static] + Defines the value of the type property of a middleMouseDown event object.
MouseEvent   MIDDLE_MOUSE_UP : String = "middleMouseUp"
[static] + Defines the value of the type property of a middleMouseUp event object.
MouseEvent   MOUSE_DOWN : String = "mouseDown"
[static] + Defines the value of the type property of a mouseDown event object.
MouseEvent @@ -622,31 +671,37 @@   MOUSE_MOVE : String = "mouseMove"
[static] + Defines the value of the type property of a mouseMove event object.
MouseEvent   MOUSE_OUT : String = "mouseOut"
[static] + Defines the value of the type property of a mouseOut event object.
MouseEvent   MOUSE_OVER : String = "mouseOver"
[static] + Defines the value of the type property of a mouseOver event object.
MouseEvent   MOUSE_UP : String = "mouseUp"
[static] + Defines the value of the type property of a mouseUp event object.
MouseEvent   MOUSE_WHEEL : String = "mouseWheel"
[static] + Defines the value of the type property of a mouseWheel event object.
MouseEvent   MOUSE_WHEEL_HORIZONTAL : String = "mouseWheelHorizontal"
[static] + Defines the value of the type property of a mouseWheelHorizontal event object.
MouseEvent @@ -672,6 +727,7 @@   RELEASE_OUTSIDE : String = "releaseOutside"
[static] + Defines the value of the type property of a releaseOutside event object.
MouseEvent @@ -699,26 +755,31 @@   RIGHT_CLICK : String = "rightClick"
[static] + Defines the value of the type property of a rightClick event object.
MouseEvent   RIGHT_MOUSE_DOWN : String = "rightMouseDown"
[static] + Defines the value of the type property of a rightMouseDown event object.
MouseEvent   RIGHT_MOUSE_UP : String = "rightMouseUp"
[static] + Defines the value of the type property of a rightMouseUp event object.
MouseEvent   ROLL_OUT : String = "rollOut"
[static] + Defines the value of the type property of a rollOut event object.
MouseEvent   ROLL_OVER : String = "rollOver"
[static] + Defines the value of the type property of a rollOver event object.
MouseEvent @@ -834,7 +895,9 @@ altKey:Boolean  [read-write]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 + +
@@ -843,9 +906,13 @@

+ 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. -

Implementation + + +

Implementation
    public function get altKey():Boolean
@@ -862,7 +929,9 @@ buttonDown:Boolean  [read-write]

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -872,8 +941,11 @@

+ Indicates whether the primary mouse button is pressed (true) or not (false). -

Implementation + + +

Implementation
    public function get buttonDown():Boolean
@@ -890,29 +962,47 @@ clickCount:int  [read-only]

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 1.0 +

+ 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 clicks, double clicks, or any multi-click sequence is possible with the clickCount parameter. - For example, an initial MouseEvent.mouseDown and MouseEvent.mouseUp will have a + + + For example, an initial MouseEvent.mouseDown and MouseEvent.mouseUp will have a + clickCount of 1, and the second MouseEvent.mouseDown and MouseEvent.mouseUp + in a double-click sequence will have a + clickCount of 2. If the mouse moves sufficiently or the multi-click sequence is + interrupted for some reason, then the next MouseEvent.mouseDown will have a clickCount of 1. - The doubleClick event will continue to fire as expected. -

Implementation + + + The doubleClick event will continue to fire as expected. + + +

Implementation
    public function get clickCount():int
@@ -927,23 +1017,33 @@ commandKey:Boolean  [read-write]

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 1.0 +

+ Indicates whether the command key is activated (Mac only.) + +

The value of property commandKey + will have the same value as property ctrlKey on the Mac. + Always false on Windows or Linux.

- Implementation + + + Implementation
    public function get commandKey():Boolean
@@ -960,19 +1060,25 @@ controlKey:Boolean  [read-write]

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
Runtime version: AIR 1.0 +

+ Indicates whether the Control key is activated on Mac and whether the Ctrl key is activated on Windows or Linux. -

Implementation + + +

Implementation
    public function get controlKey():Boolean
@@ -989,7 +1095,9 @@ ctrlKey:Boolean  [read-write]

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -999,9 +1107,13 @@

+ On Windows or Linux, indicates whether the Ctrl key is active (true) or inactive (false). + On Macintosh, indicates whether either the Control key or the Command key is activated. -

Implementation + + +

Implementation
    public function get ctrlKey():Boolean
@@ -1018,7 +1130,9 @@ delta:int  [read-write]

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -1028,13 +1142,21 @@

+ 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 faster + rotation may produce larger values. This setting depends on the device + and operating system and is usually configurable by the user. This + property applies only to the MouseEvent.mouseWheel event. -

Implementation + + +

Implementation
    public function get delta():int
@@ -1051,7 +1173,9 @@ isRelatedObjectInaccessible:Boolean  [read-write]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 + +
@@ -1060,14 +1184,23 @@

+ If true, the relatedObject property is set to null for + reasons related to security sandboxes. If the nominal value of relatedObject is a reference to a + DisplayObject in another sandbox, relatedObject is set to + null unless there is permission in both directions across this sandbox boundary. Permission is + established by calling Security.allowDomain() from a SWF file, or by providing + a policy file from the server of an image file, and setting the LoaderContext.checkPolicyFile + property when loading the image. -

Implementation + + +

Implementation
    public function get isRelatedObjectInaccessible():Boolean
@@ -1094,7 +1227,9 @@ localX:Number  [read-write]

-
Language version: ActionScript 3.0 +Language version: ActionScript 3.0 + +
@@ -1104,12 +1239,20 @@

+ When mouse locking is disabled, the horizontal coordinate at which the event occurred relative to the containing sprite. + Disable mouse locking by setting Stage.mouseLock to false. -

When mouse locking is enabled, localX and localY are 0. + + +

When mouse locking is enabled, localX and localY are 0. + Use movementX and movementY to determine the changes to mouse position + when mouse locking is enabled.

+ + Implementation
    public function get localX():Number @@ -1138,7 +1281,8 @@ localY:Number  [read-write]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
@@ -1147,12 +1291,20 @@

+ When mouse locking is disabled, the vertical coordinate at which the event occurred relative to the containing sprite. + Disable mouse locking by setting Stage.mouseLock to false. -

When mouse locking is enabled, localX and localY are 0. + + +

When mouse locking is enabled, localX and localY are 0. + Use movementX and movementY to determine the changes to mouse position + when mouse locking is enabled.

+ + Implementation
    public function get localY():Number @@ -1181,30 +1333,49 @@ movementX:Number  [read-write]

- +
Language version: ActionScript 3.0 Language version: ActionScript 3.0 +
Runtime version: AIR 3.2 +

+ When mouse locking is enabled, the change in mouse position + in the X direction since the last mouse event. + Enable mouse locking by setting Stage.mouseLock to true. -

When mouse locking is enabled:

-