asdoc/org/apache/royale/utils/PNGEncoder.swf.json

{ "type": "class",
  "qname": "org.apache.royale.utils.PNGEncoder",
  "baseClassname": ""
  ,
    "description": "The PNGEncoder class converts raw bitmap images into encoded images using Portable Network Graphics (PNG) lossless compression.  <p>For the PNG specification, see http://www.w3.org/TR/PNG/</p>.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 9", "AIR 1.1"]},
      {  "tagName": "productversion",
         "values": ["Royale 1.0.0"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "org.apache.royale.utils.PNGEncoder",
        "namespace": "",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Constructor.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Royale 1.0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "",
          "params": []}
      ,
      { "type": "accessor",
        "access": "read-only",
        "return": "String",
        "qname": "contentType",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "The MIME type for the PNG encoded image. The value is <code>&quot;image/png&quot;</code>.",
        "tags": [
        {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Royale 1.0.0"]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ]},
      { "type": "method",
        "qname": "encode",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "Converts the pixels of a BitmapData object to a PNG-encoded ByteArray object.",
        "tags": [
        {  "tagName": "param",
               "values": ["bitmapData The input BitmapData object."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Royale 1.0.0"]},
            {  "tagName": "return",
               "values": ["Returns a ByteArray object containing PNG-encoded image data."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "flash.utils.ByteArray",
          "params": [{ "name": "bitmapData", "type": "flash.display.BitmapData"}]}
      ,
      { "type": "method",
        "qname": "encodeByteArray",
        "namespace": "public",
        "bindable": [],
        "details": [],
        "deprecated": {},
          "description": "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.  This ByteArray should contain <code>4 * width * height</code> 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.    is ignored but you still must represent each pixel as four bytes in ARGB format.",
        "tags": [
        {  "tagName": "param",
               "values": ["byteArray The input ByteArray object containing raw pixels.", "width The width of the input image, in pixels.", "height The height of the input image, in pixels.", "transparent If <code>false</code>, alpha channel information"]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Royale 1.0.0"]},
            {  "tagName": "return",
               "values": ["Returns a ByteArray object containing PNG-encoded image data."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "flash.utils.ByteArray",
          "params": [{ "name": "byteArray", "type": "flash.utils.ByteArray"},
        { "name": "width", "type": "int"},
        { "name": "height", "type": "int"},
        { "name": "transparent", "type": "Boolean"}]}
      ]
  }