Jump to content

API Console.SetInputRGB: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML Import to change Variable types into Variable Types
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead""
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
<sidebar>API contents</sidebar>
{| class="mtx-class-macrotable wikitable"
Sets the colour of text inserted by the user from now on
|-
 
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
<div style="width:25%; float:right" class="toc">
| width="90%" class="mtx-class-macrohead" | '''SetInputRGB'''
====Class hierarchy====
|-
[[API Console|Console]]
| colspan="2" | Sets the colour of text inserted by the user from now on&nbsp;
:[[API Console|SetInputRGB]]
|-
</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''
|}




Line 31: Line 32:
===Calling in a calculation===
===Calling in a calculation===
* Add to a calculation icon: <pre class="brush:[cpp]">::Console.SetInputRGB(consolehandle, rgb)</pre>
* Add to a calculation icon: <pre class="brush:[cpp]">::Console.SetInputRGB(consolehandle, rgb)</pre>
''<span style="color:red;">No additional information</span>''

Latest revision as of 14:11, 13 July 2026

SetInputRGB
Sets the colour of text inserted by the user 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 inputted by the user.

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.SetOutputRGB which sets the colour for text added via the API.

Examples

Calling in a calculation

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