blob: 88acd009f46d1ece7e96b16cbcd8cf207d2c4142 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!-- saved from url=(0014)about:internet --><html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><link rel="stylesheet" href="../../style.css" type="text/css" media="screen"><link rel="stylesheet" href="../../print.css" type="text/css" media="print"><link rel="stylesheet" href="../../override.css" type="text/css"><meta name="keywords" content="ColorUtil,mx.utils.ColorUtil,addEventListener,addEventListener,adjustBrightness,adjustBrightness2,arrayValuesMatch,arraysMatch,callProperty,callProperty,clone,compare,computeDigest,convertHSBtoRGB,convertRGBtoHSB,copy,createUID,createUID,createUniqueName,createXMLDocument,dateCompare,decode,deleteProperty,deleteProperty,dispatchEvent,dispatchEvent,displayObjectToString,drawRoundRectComplex,drawRoundRectComplex2,encode,encodeBytes,encodeUTFBytes,externalToString,find,fromByteArray,fromByteArray,getArrayValues,getAttributeByQName,getClassInfo,getClassInfo,getComplexProperty,getEnumerableProperties,getFirstItem,getFullURL,getInstance,getItemIndex,getPlatforms,getPort,getProperty,getProperty,getProtocol,getServerName,getServerNameWithPort,getUID,getUnqualifiedClassName,getValue,hasEventListener,hasEventListener,hasMetadata,hasMutualTrustBetweenParentAndChild,hasProperty,hasTokens,hasUnresolvableTokens,init,init,init,insertAfter,insertBefore,isDynamicObject,isHttpURL,isHttpsURL,isSimple,isUID,isUID,isWhitespace,isWhitespace,nextName,nextNameIndex,nextValue,normalizeURL,numericCompare,objectToString,pop,propertyChangeHandler,push,qnameToString,qnamesEqual,readExternal,registerClassAliases,remove,removeEventListener,removeEventListener,repeat,replacePort,replaceProtocol,replaceTokens,reset,reset,restrict,rgbMultiply,setProperty,setProperty,setToStringExcludes,setValue,setupPropertyList,shift,stringCompare,stringToObject,substitute,substitute,toArray,toArrayInt,toArrayObject,toByteArray,toByteArray,toByteArray,toString,toString,toString,trim,trim,trimArrayElements,trimArrayElements,unshift,unwatchXML,urisEqual,valuesAreSubsetOfObject,walkDisplayObjects,watchXML,willTrigger,willTrigger,writeExternal"><title>mx.utils.ColorUtil</title></head><body><script language="javascript" type="text/javascript" src="../../asdoc.js"></script><script language="javascript" type="text/javascript" src="../../help.js"></script><script language="javascript" type="text/javascript" src="../../cookies.js"></script><script language="javascript" type="text/javascript"><!--
asdocTitle = 'ColorUtil - ApacheFlex API Reference';
var baseRef = '../../';
window.onload = configPage;
--></script>
<script type="text/javascript">
scrollToNameAnchor();
</script><table class="titleTable" cellpadding="0" cellspacing="0" id="titleTable" style="display:none"><tr><td class="titleTableTitle" align="left">Apache Flex 4.16.1 API Reference </td><td class="titleTableTopNav" align="right"><a href="../../package-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Packages</a>&nbsp;|&nbsp;<a href="../../class-summary.html" onclick="loadClassListFrame('../../all-classes.html')">All Classes</a>&nbsp;|&nbsp;<a href="../../all-index-A.html" onclick="loadClassListFrame('../../index-list.html')">Index</a>&nbsp;|&nbsp;<a id="framesLink1" href="../../index.html?mx/utils/ColorUtil.html&amp;mx/utils/class-list.html">Frames</a><a id="noFramesLink1" style="display:none" href="" onclick="parent.location=document.location"> No Frames </a></td><td class="titleTableLogo" align="right" rowspan="3"><img src="../../images/logo.jpg" class="logoImage" alt="AdobeLogo" title="AdobeLogo"></td></tr><tr class="titleTableRow2"><td class="titleTableSubTitle" id="subTitle" align="left">ColorUtil</td><td class="titleTableSubNav" id="subNav" align="right"><a href="#methodSummary">Methods</a></td></tr><tr class="titleTableRow3"><td colspan="3">&nbsp;</td></tr></table><script language="javascript" type="text/javascript" xml:space="preserve">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("ColorUtil"); titleBar_setSubNav(false,false,false,false,false,false,false,false,true,false,false ,false,false,false,false,false);}
-->
</script><div xmlns:fn="http://www.w3.org/2005/xpath-functions" class="MainContent"><table class="classHeaderTable" cellpadding="0" cellspacing="0"><tr><td class="classHeaderTableLabel">Package</td><td><a href="package-detail.html" onclick="javascript:loadClassListFrame('class-list.html')">mx.utils</a></td></tr><tr><td class="classHeaderTableLabel">Class</td><td class="classSignature">public class ColorUtil</td></tr><tr><td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">ColorUtil <img src="../../images/inherit-arrow.gif" title="Inheritance" alt="Inheritance" class="inheritArrow"> Object</td></tr></table><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p></p><p></p>
The ColorUtil class is an all-static class
with methods for working with RGB colors within Flex.
You do not create instances of ColorUtil;
instead you simply call static methods such as
the <code>ColorUtil.adjustBrightness()</code> method.
<p></p><br/><hr></div><a name="methodSummary"></a><div class="summarySection"><div class="summaryTableTitle">Public Methods </div><table cellspacing="0" cellpadding="3" class="summaryTable " id="summaryTableMethod"><tr><th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined By</th></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#adjustBrightness()" class="signatureLink">adjustBrightness</a>(rgb:uint, brite:Number):uint</div><div class="summaryTableDescription">[static]
Performs a linear brightness adjustment of an RGB color.</div></td><td class="summaryTableOwnerCol">ColorUtil</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#adjustBrightness2()" class="signatureLink">adjustBrightness2</a>(rgb:uint, brite:Number):uint</div><div class="summaryTableDescription">[static]
Performs a scaled brightness adjustment of an RGB color.</div></td><td class="summaryTableOwnerCol">ColorUtil</td></tr><tr class=""><td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><div class="summarySignature"><a href="#rgbMultiply()" class="signatureLink">rgbMultiply</a>(rgb1:uint, rgb2:uint):uint</div><div class="summaryTableDescription">[static]
Performs an RGB multiplication of two RGB colors.</div></td><td class="summaryTableOwnerCol">ColorUtil</td></tr></table></div><script language="javascript" type="text/javascript"><!--
showHideInherited();
--></script><div class="MainContent"><a name="methodDetail"></a><div class="detailSectionHeader">Method Detail</div><a name="adjustBrightness()"></a><a name="adjustBrightness(uint,Number)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">adjustBrightness</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td></tr></table><div class="detailBody"><code> public static function adjustBrightness(rgb:uint, brite:Number):uint</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
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>
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">rgb</span>:uint</code> &mdash; Original RGB color.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">brite</span>:Number</code> &mdash; Amount to be added to each color channel.
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.
</td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>uint</code> &mdash; New RGB color.
</td></tr></table></div><a name="adjustBrightness2()"></a><a name="adjustBrightness2(uint,Number)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">adjustBrightness2</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public static function adjustBrightness2(rgb:uint, brite:Number):uint</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
Performs a scaled brightness adjustment of an RGB color.
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">rgb</span>:uint</code> &mdash; Original RGB color.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">brite</span>:Number</code> &mdash; The percentage to brighten or darken the original 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.
</td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>uint</code> &mdash; New RGB color.
</td></tr></table></div><a name="rgbMultiply()"></a><a name="rgbMultiply(uint,uint)"></a><table class="detailHeader" cellpadding="0" cellspacing="0"><tr><td class="detailHeaderName">rgbMultiply</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td></tr></table><div class="detailBody"><code> public static function rgbMultiply(rgb1:uint, rgb2:uint):uint</code><p></p><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Language Version :&nbsp;</b></td><td>ActionScript 3.0</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Product Version :&nbsp;</b></td><td>Flex 3</td></tr></table><table cellpadding="0" cellspacing="0" border="0"><tr><td style="white-space:nowrap" valign="top"><b> Runtime Versions :&nbsp;</b></td><td>Flash Player 9, AIR 1.1</td></tr></table><p></p><p></p><p>
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>
</p><p><span class="label"> Parameters </span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20px"></td><td><code><span class="label">rgb1</span>:uint</code> &mdash; First RGB color.
</td></tr><tr><td class="paramSpacer">&nbsp;</td></tr><tr><td width="20px"></td><td><code><span class="label">rgb2</span>:uint</code> &mdash; Second RGB color.
</td></tr></table></p><p></p><span class="label">Returns</span><table cellpadding="0" cellspacing="0" border="0"><tr><td width="20"></td><td><code>uint</code> &mdash; RGB multiplication of the two colors.
</td></tr></table></div><br/><br/><hr><br/><p></p><center class="copyright"><footer>The Apache Software Foundation</footer><br/>Wed Nov 15 2017, 09:50 AM +01:00 </center></div></body></html><!--The Apache Software Foundation<br/>Wed Nov 15 2017, 09:50 AM +01:00 -->