Rgbscale - Revision history

Sandman: /* Notes */

Sandman — Mon, 14 Apr 2008 19:12:28 GMT

Notes

←Older revision		Revision as of 19:12, 14 April 2008
Line 44:		Line 44:
	where r,g,b are the specified r,g,b.		where r,g,b are the specified r,g,b.

-	Note that <code>[[rgbscale]](0,map,1,1,1) = [[grayscale]](0,map,0)</code>.	+	Note that <code>[[rgbscale]](0,map,1,1,1) = [[grayscale]](0,map,0)</code>, for a valid graphic (0,map).

	{{Funcbox		{{Funcbox
	\| category=Graphical effects		\| category=Graphical effects
	}}		}}

Sandman at 19:11, 14 April 2008

Sandman — Mon, 14 Apr 2008 19:11:58 GMT

←Older revision		Revision as of 19:11, 14 April 2008
Line 5:		Line 5:
	'''INT''' rgbscale ( <'''INT''' fileID> , <'''INT''' fraphID> , <'''FLOAT''' r> , <'''FLOAT''' g> , <'''FLOAT''' b> )		'''INT''' rgbscale ( <'''INT''' fileID> , <'''INT''' fraphID> , <'''FLOAT''' r> , <'''FLOAT''' g> , <'''FLOAT''' b> )

-	This will convert the specified ~~graph~~ by using the specified color as a reference. The converted ~~graph~~ will have only the specified color and lighter/darker colors; see [[#Notes\|notes]] for the details.	+	This will convert the specified [[graphic]] by using the specified color as a reference. The converted graphic will have only the specified color and lighter/darker colors; see [[#Notes\|notes]] for the details.

	== Parameters ==		== Parameters ==
Line 21:		Line 21:

	== Returns ==		== Returns ==
-	'''INT''' ~~: [[true]]~~	+	'''INT'''
		+	{\|
		+	\| -1 \|\| - Invalid graphic.
		+	\|-
		+	\| 1 \|\| - Success.
		+	\|}

	== Errors ==		== Errors ==
Line 38:		Line 43:
	</pre>		</pre>
	where r,g,b are the specified r,g,b.		where r,g,b are the specified r,g,b.
		+
		+	Note that <code>[[rgbscale]](0,map,1,1,1) = [[grayscale]](0,map,0)</code>.

	{{Funcbox		{{Funcbox
	\| category=Graphical effects		\| category=Graphical effects
	}}		}}

Sandman at 22:05, 13 April 2008

Sandman — Sun, 13 Apr 2008 22:05:03 GMT

←Older revision		Revision as of 22:05, 13 April 2008
Line 40:		Line 40:

	{{Funcbox		{{Funcbox
-	\| category=Graphical ~~Effects~~	+	\| category=Graphical effects
	}}		}}

Sandman: New page: Category:functions Category:graphical effects ==Definition== '''INT''' rgbscale ( <'''INT''' fileID> , <'''INT''' fraphID> , <'''FLOAT''' r> , <'''FLOAT''' g> , <'''FLOAT''' b> ) ...

Sandman — Sun, 13 Apr 2008 22:04:49 GMT

New page: Category:functions Category:graphical effects ==Definition== '''INT''' rgbscale ( <'''INT''' fileID> , <'''INT''' fraphID> , <'''FLOAT''' r> , <'''FLOAT''' g> , <'''FLOAT''' b> ) ...

New page

[[Category:functions]]
[[Category:graphical effects]]

==Definition==
'''INT''' rgbscale ( <'''INT''' fileID> , <'''INT''' fraphID> , <'''FLOAT''' r> , <'''FLOAT''' g> , <'''FLOAT''' b> )

This will convert the specified graph by using the specified color as a reference. The converted graph will have only the specified color and lighter/darker colors; see [[#Notes|notes]] for the details.

== Parameters ==
{|
| '''INT''' fileID || - The [[fileID]] of the [[file]] that holds the graphics.
|-
| '''INT''' graphID || - The [[graphID]] of the [[graphic]] to convert.
|-
| '''FLOAT''' r || - The red component of the color to be used for reference.
|-
| '''FLOAT''' g || - The green component of the color to be used for reference.
|-
| '''FLOAT''' b || - The blue component of the color to be used for reference.
|}

== Returns ==
'''INT''' : [[true]]

== Errors ==
{|
| Unsupported color depth || - The graphic's color depth is not 16bit.
|}

== Notes ==
The exact formula is:
<pre>
for every pixel:
c = 0.3 * oldpixel_r + 0.59 * oldpixel_g + 0.11 * oldpixel_b
newpixel_r = r * c;
newpixel_g = g * c;
newpixel_b = b * c;
</pre>
where r,g,b are the specified r,g,b.

{{Funcbox
| category=Graphical Effects
}}