Difference between revisions of "API Console.SetInputRGB"
From Flowcode Help
Jump to navigationJump to search (XML import of latest API) |
(XML import) |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | <sidebar>API Contents</sidebar> | |
| − | |||
| − | <sidebar>API | ||
Sets the colour of text inserted by the user from now on | Sets the colour of text inserted by the user from now on | ||
| Line 12: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | [[Variable | + | [[Variable Types|HANDLE]] ''ConsoleHandle'' |
:A valid console windows handle | :A valid console windows handle | ||
| − | [[Variable | + | [[Variable Types|ULONG]] ''RGB'' |
:The red, green, blue byte values to set the text to | :The red, green, blue byte values to set the text to | ||
| Line 24: | Line 22: | ||
==Detailed description== | ==Detailed description== | ||
| − | + | This call sets the colour that text is displayed when inputted by the user. | |
| + | |||
| + | The colour specified is true 24-bit R,G,B, however, internally console text is stored as 6 bits per pixel - that is 4 grades of red, green and blue. | ||
| + | This call compliments [[API Console.SetOutputRGB]] which sets the colour for text added via the API. | ||
==Examples== | ==Examples== | ||
| Line 31: | Line 32: | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Console.SetInputRGB(consolehandle, rgb)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Console.SetInputRGB(consolehandle, rgb)</pre> | ||
| − | ''<span style="color:red;">No additional | + | ''<span style="color:red;">No additional examples</span>'' |
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Sets the colour of text inserted by the user from now on
Contents
Parameters
HANDLE ConsoleHandle
- A valid console windows handle
ULONG RGB
- The red, green, blue byte values to set the text to
Return value
This call does not return a value
Detailed description
This call sets the colour that text is displayed when inputted by the user.
The colour specified is true 24-bit R,G,B, however, internally console text is stored as 6 bits per pixel - that is 4 grades of red, green and blue.
This call compliments API Console.SetOutputRGB which sets the colour for text added via the API.
Examples
Calling in a calculation
- Add to a calculation icon:
::Console.SetInputRGB(consolehandle, rgb)
No additional examples
