Difference between revisions of "API Console.SetOutputRGB"

From Flowcode Help
Jump to navigationJump to search
(XML Import to change Variable types into Variable Types)
(XML import)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
+
<sidebar>API Contents</sidebar>
 
Sets the colour of text inserted by the component from now on
 
Sets the colour of text inserted by the component from now on
  
Line 35: Line 35:
 
* 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>
  
''<span style="color:red;">No additional information</span>''
+
''<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 component from now on

Class hierarchy

Console

SetOutputRGB

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 inserted via any console API call:

WriteText
SetLineText
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

Calling in a calculation

  • Add to a calculation icon:
    ::Console.SetOutputRGB(consolehandle, rgb)

No additional examples