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

{ "type": "class",
  "qname": "org.apache.royale.utils.ColorUtil",
  "baseClassname": ""
  ,
    "description": "The ColorUtil class is an all-static class with methods for working with RGB colors within Royale. You do not create instances of ColorUtil; instead you simply call static methods such as the <code>ColorUtil.adjustBrightness()</code> method.",
  "tags": [
  {  "tagName": "playerversion",
         "values": ["Flash 10.2", "AIR 2.6"]},
      {  "tagName": "productversion",
         "values": ["Royale 0.0"]},
      {  "tagName": "langversion",
         "values": ["3.0"]}  ],
  "members": [
  { "type": "method",
        "qname": "adjustBrightness",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Performs a linear brightness adjustment of an RGB color.  <p>The same amount is added to the red, green, and blue channels of an RGB color. Each color channel is limited to the range 0 through 255.</p>   The range for this parameter is -255 to 255; -255 produces black while 255 produces white. If this parameter is 0, the RGB color returned is the same as the original color.",
        "tags": [
        {  "tagName": "param",
               "values": ["rgb Original RGB color.", "brite Amount to be added to each color channel."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Royale 1.0.0"]},
            {  "tagName": "return",
               "values": ["New RGB color."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "uint",
          "params": [{ "name": "rgb", "type": "uint"},
        { "name": "brite", "type": "Number"}]}
      ,
      { "type": "method",
        "qname": "adjustBrightness2",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Performs a scaled brightness adjustment of an RGB color.   If positive, the original color is brightened toward white by this percentage. If negative, it is darkened toward black by this percentage. The range for this parameter is -100 to 100; -100 produces black while 100 produces white. If this parameter is 0, the RGB color returned is the same as the original color.",
        "tags": [
        {  "tagName": "param",
               "values": ["rgb Original RGB color.", "brite The percentage to brighten or darken the original color."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Royale 1.0.0"]},
            {  "tagName": "return",
               "values": ["New RGB color."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "uint",
          "params": [{ "name": "rgb", "type": "uint"},
        { "name": "brite", "type": "Number"}]}
      ,
      { "type": "method",
        "qname": "rgbMultiply",
        "namespace": "public",
        "bindable": [],
        "details": ["static"],
        "deprecated": {},
          "description": "Performs an RGB multiplication of two RGB colors.  <p>This always results in a darker number than either original color unless one of them is white, in which case the other color is returned.</p>",
        "tags": [
        {  "tagName": "param",
               "values": ["rgb1 First RGB color.", "rgb2 Second RGB color."]},
            {  "tagName": "playerversion",
               "values": ["Flash 9", "AIR 1.1"]},
            {  "tagName": "productversion",
               "values": ["Royale 1.0.0"]},
            {  "tagName": "return",
               "values": ["RGB multiplication of the two colors."]},
            {  "tagName": "langversion",
               "values": ["3.0"]}  ],
          "return": "uint",
          "params": [{ "name": "rgb1", "type": "uint"},
        { "name": "rgb2", "type": "uint"}]}
      ]
  }