ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.graphics.codec 

PNGEncoder  - AS3 Flex
Packagemx.graphics.codec
Classpublic class PNGEncoder
InheritancePNGEncoder Inheritance Object
Implements IImageEncoder

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The PNGEncoder class converts raw bitmap images into encoded images using Portable Network Graphics (PNG) lossless compression.

For the PNG specification, see http://www.w3.org/TR/PNG/

.


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  contentType : String
[read-only] The MIME type for the PNG encoded image.
PNGEncoder
Public Methods
 MethodDefined By
  
PNGEncoder()
Constructor.
PNGEncoder
  
encode(bitmapData:BitmapData):ByteArray
Converts the pixels of a BitmapData object to a PNG-encoded ByteArray object.
PNGEncoder
  
encodeByteArray(byteArray:ByteArray, width:int, height:int, transparent:Boolean = true):ByteArray
Converts a ByteArray object containing raw pixels in 32-bit ARGB (Alpha, Red, Green, Blue) format to a new PNG-encoded ByteArray object.
PNGEncoder
 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

contentType

property
contentType:String  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The MIME type for the PNG encoded image. The value is "image/png".



Implementation
    public function get contentType():String
Constructor Detail

PNGEncoder

()Constructor
public function PNGEncoder()

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Method Detail

encode

()method
public function encode(bitmapData:BitmapData):ByteArray

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Converts the pixels of a BitmapData object to a PNG-encoded ByteArray object.

Parameters

bitmapData:BitmapData — The input BitmapData object.

Returns
ByteArray — Returns a ByteArray object containing PNG-encoded image data.

encodeByteArray

()method 
public function encodeByteArray(byteArray:ByteArray, width:int, height:int, transparent:Boolean = true):ByteArray

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Converts a ByteArray object containing raw pixels in 32-bit ARGB (Alpha, Red, Green, Blue) format to a new PNG-encoded ByteArray object. The original ByteArray is left unchanged.

Parameters

byteArray:ByteArray — The input ByteArray object containing raw pixels. This ByteArray should contain 4 width height bytes. Each pixel is represented by 4 bytes, in the order ARGB. The first four bytes represent the top-left pixel of the image. The next four bytes represent the pixel to its right, etc. Each row follows the previous one without any padding.
 
width:int — The width of the input image, in pixels.
 
height:int — The height of the input image, in pixels.
 
transparent:Boolean (default = true) — If false, alpha channel information is ignored but you still must represent each pixel as four bytes in ARGB format.

Returns
ByteArray — Returns a ByteArray object containing PNG-encoded image data.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy