API Console.SetOutputRGB: Difference between revisions

Latest revision as of 14:11, 13 July 2026

	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:

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)

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
-<sidebar>API contents</sidebar>
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-Sets the colour of text inserted by the component from now on
+| width="90%" class="mtx-class-macrohead" | '''SetOutputRGB'''
+|-
-<div style="width:25%; float:right" class="toc">
+| colspan="2" | Sets the colour of text inserted by the component from now on&nbsp;
-====Class hierarchy====
+|-
-[[API Console|Console]]
+|-
-:[[API Console|SetOutputRGB]]
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-</div>
+| width="90%" | ConsoleHandle
-__TOC__
+|-
+| colspan="2" | A valid console windows handle&nbsp;
-==Parameters==
+|-
-[[Variable types|HANDLE]] ''ConsoleHandle''
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-:A valid console windows handle
+| width="90%" | RGB
+|-
-[[Variable types|ULONG]] ''RGB''
+| colspan="2" | The red, green, blue byte values to set the text to&nbsp;
-: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''
-==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.
+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.
@@ Line 33: / Line 35: @@
 ===Calling in a calculation===
 * Add to a calculation icon: <pre class="brush:[cpp]">::Console.SetOutputRGB(consolehandle, rgb)</pre>
-''<span style="color:red;">No additional information</span>''

SteveT (talk | contribs)

Latest revision as of 14:11, 13 July 2026

Detailed description

Examples

Calling in a calculation