Browse Source

Document Extras/ColorUtils

sole 13 years ago
parent
commit
e37fe7114e
1 changed files with 18 additions and 13 deletions
  1. 18 13
      docs/api/extras/ColorUtils.html

+ 18 - 13
docs/api/extras/ColorUtils.html

@@ -9,24 +9,29 @@
 	<body>
 		<h1>[name]</h1>
 
-		<div class="desc">todo</div>
-
-
-		<h2>Constructor</h2>
-
-		<h3>[name]()</h3>
-
-
-		<h2>Properties</h2>
-
-		<h3>.[page:Vector3 todo]</h3>
+		<div class="desc">This is a utility class to handle values in <a href="https://en.wikipedia.org/wiki/RGB_color_model">RGB</a> and <a href="https://en.wikipedia.org/wiki/HSL_and_HSV">HSV</a> color spaces.</div>
 
 
 		<h2>Methods</h2>
 
-		<h3>.todo( [page:Vector3 todo] )</h3>
+		<h3>.adjustHSV( [page:Color color], [page:Number h], [page:Number s], [page:Number v] )</h3>
+		
+		<div class="desc">Taking a color as input, converts it to HSV, adds the h, s, v parameters and returns the modified color back.</div>
+		
+		<div>
+		[page:Color color] — source color to be adjusted<br />
+		[page:Number h] — hue change amount<br />
+		[page:Number s] — saturation change amount<br />
+		[page:Number v] — value change amount
+		</div>
+		
+		<h3>.rgbToHsv( [page:Color color], [page:Object hsv] )</h3>
+		
+		<div class="desc">Converts an RGB color into an HSV triplet and returns the converted color.</div>
+		
 		<div>
-		todo — todo<br />
+		[page:Color color] — source color to be converted<br />
+		[page:Object hsv] — object in which the return value will be stored, if not null
 		</div>