Difference between revisions of "API Console.SetOutputRGB"
From Flowcode Help
Jump to navigationJump to search (XML import of latest API) |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetOutputRGB''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the colour of text inserted by the component from now on | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | ||
| + | | width="90%" | ConsoleHandle | ||
| + | |- | ||
| + | | colspan="2" | A valid console windows handle | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG | ||
| + | | width="90%" | RGB | ||
| + | |- | ||
| + | | colspan="2" | The red, green, blue byte values to set the text to | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| − | + | ==Detailed description== | |
| − | + | This call sets the colour that text is displayed when inserted via any console API call: | |
| + | :[[API Console.WriteText|WriteText]] | ||
| + | :[[API Console.SetLineText|SetLineText]] | ||
| + | :[[API Console.SetLineBytes|SetLineBytes]] | ||
| − | + | 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.SetInputRGB]] which sets the colour for text typed by the user. | ||
==Examples== | ==Examples== | ||
===Calling in a calculation=== | ===Calling in a calculation=== | ||
* Add to a calculation icon: <pre class="brush:[cpp]">::Console.SetOutputRGB(consolehandle, rgb)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">::Console.SetOutputRGB(consolehandle, rgb)</pre> | ||
| − | |||
| − | |||
Latest revision as of 11:55, 16 January 2023
|
SetOutputRGB |
| Sets the colour of text inserted by the component from now on | |
 - HANDLE
|
ConsoleHandle |
| A valid console windows handle | |
 - ULONG
|
RGB |
| The red, green, blue byte values to set the text to | |
 - NONE
|
Return |
Detailed description
This call sets the colour that text is displayed when inserted via any console API call:
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.SetInputRGB which sets the colour for text typed by the user.
Examples
Calling in a calculation
- Add to a calculation icon:
::Console.SetOutputRGB(consolehandle, rgb)
