Difference between revisions of "API Console.SetOutputRGB"

From Flowcode Help
Jump to navigationJump to search
Line 24: Line 24:
  
 
==Detailed description==
 
==Detailed description==
This call sets the colour that text is displayed when inserted via any console API call.
+
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.
 
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.

Revision as of 14:00, 29 May 2013


<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 information