Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
PNGEncoder

Package | mx.graphics.codec
Class | public class PNGEncoder
Inheritance | PNGEncoder 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

| Property | Defined By
--- | --- | ---
|  | contentType : String [read-only] The MIME type for the PNG encoded image. | PNGEncoder

Public Methods

| Method | Defined 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

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.

Sun Mar 5 2017, 03:42 PM +11:00