This wiki is out of date, use the continuation of this wiki instead

From FenixWiki

Revision as of 13:28, 26 April 2007 (edit) Sandman (Talk | contribs) ← Previous diff		Current revision (00:25, 24 March 2008) (edit) (undo) 86.72.151.138 (Talk) (→Notes)
(3 intermediate revisions not shown.)
Line 1:		Line 1:
	[[Category:functions]]		[[Category:functions]]
-	[[Category:text]]	+	[[Category:texts]]
	==Definition==		==Definition==
	'''INT''' set_text_color ( <'''WORD''' color> )		'''INT''' set_text_color ( <'''WORD''' color> )
-	Sets the [[color]] of texts written after this [[function]] is called.	+	Sets the current text color (the color where texts will be written in). This only affects 1 bit (2 color) fonts, which can be loaded with [[load_font]]() or [[load_bdf]](). 8 bit and 16 bit fonts already contain color information themselves and thus aren't affected.
		+
	== Parameters ==		== Parameters ==
	{|		{|
-	| '''WORD''' color || - The color to use for text.	+	| '''WORD''' color || - The [[color]] to use for text.
	|}		|}
	== Returns ==		== Returns ==
	'''INT''' : [[true]] if successful and [[false]] if failed. (''Needs confirmation.'')		'''INT''' : [[true]] if successful and [[false]] if failed. (''Needs confirmation.'')
		+
		+	== Notes ==
		+	Be warned that values returned by the [[Rgb]]() function differ with the video card. So, directly filling out color numbers as color parameter in 16 bit color mode without using [[Rgb]]() is a bad idea, as RGB returns the correct color code for every video card
		+
		+	== Errors ==
		+	''<If someone knows, please edit!> ''
	== Example ==		== Example ==
Line 38:		Line 45:
	</pre>		</pre>
	Used in example: [[write]](), [[rgb]]()		Used in example: [[write]](), [[rgb]]()
		+
		+	This results in something like this: <br/>
		+	[[Image:set_text_color.png]]

---

Current revision

Contents 1 Definition 2 Parameters 3 Returns 4 Notes 5 Errors 6 Example

[edit] Definition

INT set_text_color ( <WORD color> )

Sets the current text color (the color where texts will be written in). This only affects 1 bit (2 color) fonts, which can be loaded with load_font() or load_bdf(). 8 bit and 16 bit fonts already contain color information themselves and thus aren't affected.

[edit] Parameters

WORD color

- The color to use for text.

[edit] Returns

INT : true if successful and false if failed. (Needs confirmation.)

[edit] Notes

Be warned that values returned by the Rgb() function differ with the video card. So, directly filling out color numbers as color parameter in 16 bit color mode without using Rgb() is a bad idea, as RGB returns the correct color code for every video card

[edit] Errors

<If someone knows, please edit!>

[edit] Example

Program awesome;
Global
    byte red=0;
    byte green=255;
    byte blue=0;

Begin
    
    set_text_color(rgb(red,green,blue));
    write(0,1,1,0,"Mijn potlood is bruin"); //this text will be green as an Irishman's ejecta

    set_text_color(rgb(255,0,0));
    write(0,1,11,0,"Je moeder"); //this text will be red
        
    Loop
  
        frame;
    End
End

Used in example: write(), rgb()

This results in something like this: