Difference between revisions of "API Console.SetOutputRGB"

Revision as of 11:41, 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

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.

Add to a calculation icon:

::Console.SetOutputRGB(consolehandle, rgb)

No additional examples

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Sets the colour of text inserted by the component from now on
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetOutputRGB'''
-====Class hierarchy====
+|-
-[[API Console|Console]]
+| colspan="2" | Sets the colour of text inserted by the component from now on&nbsp;
-:[[API Console|SetOutputRGB]]
+|-
-</div>
+|-
-__TOC__
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | ConsoleHandle
-==Parameters==
+|-
-[[Variable Types|HANDLE]] ''ConsoleHandle''
+| colspan="2" | A valid console windows handle&nbsp;
-:A valid console windows handle
+|-
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-[[Variable Types|ULONG]] ''RGB''
+| width="90%" | RGB
-:The red, green, blue byte values to set the text to
+|-
+| colspan="2" | The red, green, blue byte values to set the text to&nbsp;
+|-
-==Return value==
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - NONE
-''This call does not return a value''
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}