Difference between revisions of "Unit Console"

From Ultibo.org
Jump to: navigation, search
Line 243: Line 243:
 
----
 
----
  
−
''To be documented''
+
 
 +
'''Console specific types'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TCursorState = (CURSORON,CURSOROFF);</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console char types'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PConsoleChar = ^TConsoleChar;</code>
 +
 
 +
<code>TConsoleChar = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>Ch:Char;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>Forecolor:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>Backcolor:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''Console point types'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TConsolePoint = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>X:LongWord;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>Y:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''Console rect types'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
 
 +
<code>TConsoleRect = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>X1:LongWord;</code>
 +
| style="width: 50%;"|&nbsp;
 +
|-
 +
| <code>Y1:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>X2:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>Y2:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
|}
 +
</div></div> 
 +
 
 +
'''Console properties''' 
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PConsoleProperties = ^TConsoleProperties;</code>
 +
 
 +
<code>TConsoleProperties = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>Flags:LongWord;</code>
 +
| Console device flags (eg CONSOLE_FLAG_FULLSCREEN)
 +
|-
 +
| <code>Mode:LongWord;</code>
 +
| Console device mode (eg CONSOLE_MODE_PIXEL)
 +
|-
 +
| <code>Width:LongWord;</code>
 +
| Console Width (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER)
 +
|-
 +
| <code>Height:LongWord;</code>
 +
| Console Height (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER)
 +
|-
 +
| <code>Format:LongWord;</code>
 +
| Color Format (eg COLOR_FORMAT_ARGB32)(Only applicable if CONSOLE_MODE_PIXEL)
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''Console enumeration callback'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleEnumerate = function(Console:PConsoleDevice; Data:Pointer):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console notification callback'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleNotification = function(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device open'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDeviceOpen = function(Console:PConsoleDevice):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device close'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDeviceClose = function(Console:PConsoleDevice):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device clear'''
 +
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDeviceClear = function(Console:PConsoleDevice; Color:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device scroll"
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDeviceScroll = function(Console:PConsoleDevice; X1,Y1,X2,Y2,Count,Direction:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device draw box'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDeviceDrawBox = function(Console:PConsoleDevice; X1,Y1,X2,Y2,Color,Width:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device draw line'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDeviceDrawLine = function(Console:PConsoleDevice; X1,Y1,X2,Y2,Color,Width:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device draw char'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDeviceDrawChar = function(Console:PConsoleDevice; Handle:TFontHandle; Ch:Char;X,Y,Forecolor,Backcolor:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device draw text'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDeviceDrawText = function(Console:PConsoleDevice; Handle:TFontHandle; const Text:String;X,Y,Forecolor,Backcolor,Len:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device draw pixel'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDeviceDrawPixel = function(Console:PConsoleDevice; X,Y,Color:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device draw block'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDeviceDrawBlock = function(Console:PConsoleDevice; X1,Y1,X2,Y2,Color:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device draw image'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDeviceDrawImage = function(Console:PConsoleDevice; X,Y:LongWord; Buffer:Pointer; Width,Height,Format,Skip:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device draw window'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDeviceDrawWindow = function(Console:PConsoleDevice; Handle:TWindowHandle):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device get pixel'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDeviceGetPixel = function(Console:PConsoleDevice; X,Y:LongWord; var Color:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device get image'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDeviceGetImage = function(Console:PConsoleDevice; X,Y:LongWord; Buffer:Pointer; Width,Height,Format,Skip:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device put text'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDevicePutText = function(Console:PConsoleDevice; Handle:TFontHandle; const Source,Dest:TConsolePoint; Buffer:PConsoleChar; Width,Height,Skip:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device copy image'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDeviceCopyImage = function(Console:PConsoleDevice; const Source,Dest:TConsolePoint; Width,Height:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device get position'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDeviceGetPosition = function(Console:PConsoleDevice; Position:LongWord; var X1,Y1,X2,Y2:LongWord):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device get properties'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleDeviceGetProperties = function(Console:PConsoleDevice; Properties:PConsoleProperties):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console device types'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PConsoleDevice = ^TConsoleDevice;</code>
 +
 
 +
<code>TConsoleDevice = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|''Device Properties''
 +
|-
 +
| <code>Device:TDevice;</code>
 +
| The Device entry for this Console device
 +
|-
 +
|colspan="2"|''Console Properties''
 +
|-
 +
| <code>ConsoleId:LongWord;</code>
 +
| Unique Id of this Console device in the Console device table
 +
|-
 +
| <code>ConsoleState:LongWord;</code>
 +
| Console device state (eg CONSOLE_STATE_OPEN)
 +
|-
 +
| <code>ConsoleMode:LongWord;</code>
 +
| Console device mode (eg CONSOLE_MODE_PIXEL)
 +
|-
 +
| <code>DeviceOpen:TConsoleDeviceOpen;</code>
 +
| A device specific DeviceOpen method implementing a standard console device interface (Mandatory)
 +
|-
 +
| <code>DeviceClose:TConsoleDeviceClose;</code>
 +
| A device specific DeviceClose method implementing a standard console device interface (Mandatory)
 +
|-
 +
| <code>DeviceClear:TConsoleDeviceClear;</code>
 +
| A device specific DeviceClear method implementing a standard console device interface (Mandatory)
 +
|-
 +
| <code>DeviceScroll:TConsoleDeviceScroll;</code>
 +
| A device specific DeviceScroll method implementing a standard console device interface (Mandatory)
 +
|-
 +
| <code>DeviceDrawBox:TConsoleDeviceDrawBox;</code>
 +
| A device specific DeviceDrawBox method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL)
 +
|-
 +
| <code>DeviceDrawLine:TConsoleDeviceDrawLine;</code>
 +
| A device specific DeviceDrawLine method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL)
 +
|-
 +
| <code>DeviceDrawChar:TConsoleDeviceDrawChar;</code>
 +
| A device specific DeviceDrawChar method implementing a standard console device interface (Mandatory)
 +
|-
 +
| <code>DeviceDrawText:TConsoleDeviceDrawText;</code>
 +
| A device specific DeviceDrawText method implementing a standard console device interface (Mandatory)
 +
|-
 +
| <code>DeviceDrawPixel:TConsoleDeviceDrawPixel;</code>
 +
| A device specific DeviceDrawPixel method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL)
 +
|-
 +
| <code>DeviceDrawBlock:TConsoleDeviceDrawBlock;</code>
 +
| A device specific DeviceDrawBlock method implementing a standard console device interface (Mandatory)
 +
|-
 +
| <code>DeviceDrawImage:TConsoleDeviceDrawImage;</code>
 +
| A device specific DeviceDrawImage method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL)
 +
|-
 +
| <code>DeviceDrawWindow:TConsoleDeviceDrawWindow;</code>
 +
| A device specific DeviceDrawWindow method implementing a standard console device interface (Mandatory)
 +
|-
 +
| <code>DeviceGetPixel:TConsoleDeviceGetPixel;</code>
 +
| A device specific DeviceGetPixel method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL)
 +
|-
 +
| <code>DeviceGetImage:TConsoleDeviceGetImage;</code>
 +
| A device specific DeviceGetImage method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL)
 +
|-
 +
| <code>DevicePutText:TConsoleDevicePutText;</code>
 +
| A device specific DevicePutText method implementing a standard console device interface (Mandatory)
 +
|-
 +
| <code>DeviceCopyImage:TConsoleDeviceCopyImage;</code>
 +
| A device specific DeviceCopyImage method implementing a standard console device interface (Mandatory for CONSOLE_MODE_PIXEL)
 +
|-
 +
| <code>DeviceGetPosition:TConsoleDeviceGetPosition;</code>
 +
| A device specific DeviceGetPosition method implementing a standard console device interface (Mandatory)
 +
|-
 +
| <code>DeviceGetProperties:TConsoleDeviceGetProperties;</code>
 +
| A device specific DeviceGetProperties method implementing a standard console device interface (Or nil if the default method is suitable)
 +
|-
 +
|colspan="2"|''Statistics Properties''
 +
|-
 +
| <code>OpenCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>CloseCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>ClearCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>ScrollCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>DrawCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>GetCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>PutCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>CopyCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|''Driver Properties''
 +
|-
 +
| <code>Lock:TMutexHandle;</code>
 +
| Device lock
 +
|-
 +
| <code>Width:LongWord;</code>
 +
| Console Width (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER)
 +
|-
 +
| <code>Height:LongWord;</code>
 +
| Console Height (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER)
 +
|-
 +
| <code>Format:LongWord;</code>
 +
| Color Format (eg COLOR_FORMAT_ARGB32)(Only applicable if CONSOLE_MODE_PIXEL)
 +
|-
 +
| <code>Forecolor:LongWord;</code>
 +
| Foreground Color
 +
|-
 +
| <code>Backcolor:LongWord;</code>
 +
| Background Color
 +
|-
 +
| <code>Borderwidth:LongWord;</code>
 +
| Border Width (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER)
 +
|-
 +
| <code>Bordercolor:LongWord;</code>
 +
| Border Color
 +
|-
 +
|colspan="2"|''Font Properties''
 +
|-
 +
| <code>Font:TFontHandle;</code>
 +
| Console Font
 +
|-
 +
| <code>FontRatio:LongWord;</code>
 +
| Font Characters to Pixels Ratio (Normally 1 for Pixel Console / 0 for Character Console)
 +
|-
 +
|colspan="2"|''Window Properties''
 +
|-
 +
| <code>WindowFirst:PConsoleWindow;</code>
 +
| &nbsp;
 +
|-
 +
| <code>WindowLock:TCriticalSectionHandle;</code>
 +
| &nbsp;
 +
|-
 +
| <code>WindowCount:LongWord;</code>
 +
| &nbsp;
 +
|-
 +
| <code>WindowDefault:TWindowHandle;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|''Internal Properties''
 +
|-
 +
| <code>Prev:PConsoleDevice;</code>
 +
| Previous entry in Console device table
 +
|-
 +
| <code>Next:PConsoleDevice;</code>
 +
| Next entry in Console device table
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''Window properties'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PWindowProperties = ^TWindowProperties;</code>
 +
 
 +
<code>TWindowProperties = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
| <code>Position:LongWord;</code>
 +
| Console Window Position (eg CONSOLE_POSITION_TOP)
 +
|-
 +
| <code>State:LongWord;</code>
 +
| Console Window State (eg WINDOW_STATE_VISIBLE)
 +
|-
 +
| <code>Mode:LongWord;</code>
 +
| Console Window Mode (eg WINDOW_MODE_TEXT)
 +
|-
 +
| <code>Flags:LongWord;</code>
 +
| Console Window Flags (eg WINDOW_FLAG_LINE_WRAP)
 +
|-
 +
| <code>X1:LongWord;</code>
 +
| (Window X1) Console Relative (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER)
 +
|-
 +
| <code>Y1:LongWord;</code>
 +
| (Window Y1) Console Relative (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER)
 +
|-
 +
| <code>X2:LongWord;</code>
 +
| (Window X2)Console Relative (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER)
 +
|-
 +
| <code>Y2:LongWord;</code>
 +
| (Window Y2) Console Relative (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER)
 +
|-
 +
| <code>Width:LongWord;</code>
 +
| Window Width in Columns (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS)
 +
|-
 +
| <code>Height:LongWord;</code>
 +
| Window Height in Rows (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS)
 +
|-
 +
| <code>OffsetX:LongWord;</code>
 +
| Window X Offset (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER)
 +
|-
 +
| <code>OffsetY:LongWord;</code>
 +
| Window Y Offset (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER)
 +
|-
 +
| <code>FontWidth:LongWord;</code>
 +
| Font Width (Pixels)
 +
|-
 +
| <code>FontHeight:LongWord;</code>
 +
| Font Height (Pixels)
 +
|-
 +
| <code>Borderwidth:LongWord;</code>
 +
| Current Border Width
 +
|-
 +
| <code>Font:TFontHandle;</code>
 +
| Window Font
 +
|-
 +
| <code>Console:PConsoleDevice;</code>
 +
| Window console
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''Console window enumeration callback'''
 +
 
 +
{| class="wikitable" style="font-size: 14px; text-align: left; width: 100%; height: 50px;"
 +
|-
 +
| <code>TConsoleWindowEnumerate = function(Console:PConsoleDevice; Handle:TWindowHandle; Data:Pointer):LongWord;</code>
 +
| style="width: 40%;"|
 +
|-
 +
|}
 +
 
 +
'''Console window'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PConsoleWindow = ^TConsoleWindow;</code>
 +
 
 +
<code>TConsoleWindow = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|''Window Properties''
 +
|-
 +
| <code>Signature:LongWord;</code>
 +
| Signature for entry validation
 +
|-
 +
| <code>Position:LongWord;</code>
 +
| Console Window Position (eg CONSOLE_POSITION_TOP)
 +
|-
 +
| <code>WindowState:LongWord;</code>
 +
| Console Window State (eg WINDOW_STATE_VISIBLE)
 +
|-
 +
| <code>WindowMode:LongWord;</code>
 +
| Console Window Mode (eg WINDOW_MODE_TEXT)
 +
|-
 +
| <code>WindowFlags:LongWord;</code>
 +
| Console Window Flags (eg WINDOW_FLAG_LINE_WRAP)
 +
|-
 +
| <code>X1:LongWord;</code>
 +
| (Window X1) Console Relative (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER)
 +
|-
 +
| <code>Y1:LongWord;</code>
 +
| (Window Y1) Console Relative (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER)
 +
|-
 +
| <code>X2:LongWord;</code>
 +
| (Window X2) Console Relative (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER)
 +
|-
 +
| <code>Y2:LongWord;</code>
 +
| Window Y2) Console Relative (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER)
 +
|-
 +
| <code>Width:LongWord;</code>
 +
| Window Width in Columns (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS)
 +
|-
 +
| <code>Height:LongWord;</code>
 +
| Window Height in Rows (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS)
 +
|-
 +
| <code>OffsetX:LongWord;</code>
 +
| Window X Offset (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER)
 +
|-
 +
| <code>OffsetY:LongWord;</code>
 +
| Window Y Offset (Pixels for CONSOLE_MODE_PIXEL / Characters for CONSOLE_MODE_CHARACTER)
 +
|-
 +
| <code>MinX:LongWord;</code>
 +
| (Viewport X1) Window Relative (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS)
 +
|-
 +
| <code>MinY:LongWord;</code>
 +
| (Viewport Y1) Window Relative (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS)
 +
|-
 +
| <code>MaxX:LongWord;</code>
 +
| (Viewport X2) Window Relative (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS)
 +
|-
 +
| <code>MaxY:LongWord;</code>
 +
| (Viewport Y2) Window Relative (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS)
 +
|-
 +
| <code>X:LongWord;</code>
 +
| (Current X) Window Relative (Characters for WINDOW_MODE_TEXT / Not used for WINDOW_MODE_GRAPHICS)
 +
|-
 +
| <code>Y:LongWord;</code>
 +
| (Current Y) Window Relative (Characters for WINDOW_MODE_TEXT / Not used for WINDOW_MODE_GRAPHICS)
 +
|-
 +
| <code>Cols:LongWord;</code>
 +
| Viewport Columns (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS)
 +
|-
 +
| <code>Rows:LongWord;</code>
 +
| Viewport Rows (Characters for WINDOW_MODE_TEXT / Pixels for WINDOW_MODE_GRAPHICS)
 +
|-
 +
| <code>Format:LongWord;</code>
 +
| Color Format (eg COLOR_FORMAT_ARGB32)(Only applicable if CONSOLE_MODE_PIXEL)
 +
|-
 +
| <code>Forecolor:LongWord;</code>
 +
| Current Foreground Color
 +
|-
 +
| <code>Backcolor:LongWord;</code>
 +
| Current Background Color
 +
|-
 +
| <code>Borderwidth:LongWord;</code>
 +
| Current Border Width
 +
|-
 +
| <code>Bordercolor:LongWord;</code>
 +
| Current Border Color
 +
|-
 +
|colspan="2"|''Font Properties''
 +
|-
 +
| <code>Font:TFontHandle;</code>
 +
| Window Font
 +
|-
 +
| <code>FontWidth:LongWord;</code>
 +
| Font Width (Pixels)
 +
|-
 +
| <code>FontHeight:LongWord;</code>
 +
| Font Height (Pixels)
 +
|-
 +
|colspan="2"|''Cursor Properties''
 +
|-
 +
| <code>CursorX:LongWord;</code>
 +
| (Cursor X) Window Relative (Characters for WINDOW_MODE_TEXT / Not used for WINDOW_MODE_GRAPHICS)
 +
|-
 +
| <code>CursorY:LongWord;</code>
 +
| (Cursor Y) Window Relative (Characters for WINDOW_MODE_TEXT / Not used for WINDOW_MODE_GRAPHICS)
 +
|-
 +
| <code>CursorMode:LongWord;</code>
 +
| Cursor Mode (eg CURSOR_MODE_INSERT)
 +
|-
 +
| <code>CursorBlink:Boolean;</code>
 +
| Cursor Blink On/Off
 +
|-
 +
| <code>CursorState:TCursorState;</code>
 +
| Cursor State On/Off
 +
|-
 +
| <code>CursorTimer:TTimerHandle;</code>
 +
| Cursor Timer (or INVALID_HANDLE_VALUE)
 +
|-
 +
|colspan="2"|''Driver Properties''
 +
|-
 +
| <code>Lock:TMutexHandle;</code>
 +
| Window lock
 +
|-
 +
| <code>Console:PConsoleDevice;</code>
 +
| Window console
 +
|-
 +
|colspan="2"|''Internal Properties''
 +
|-
 +
| <code>Prev:PConsoleWindow;</code>
 +
| Previous entry in Console Window table
 +
|-
 +
| <code>Next:PConsoleWindow;</code>
 +
| Next entry in Console Window table
 +
|-
 +
|}
 +
</div></div>
 +
 
 +
'''Framebuffer console specific types'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code>PFramebufferConsole = ^TFramebufferConsole;</code>
 +
 
 +
<code>TFramebufferConsole = record</code>
 +
<div class="mw-collapsible-content" style="text-align: left; padding-left: 5px;">
 +
{| class="wikitable" style="font-size: 14px; background: white;"
 +
|-
 +
|colspan="2"|''Console Properties''
 +
|-
 +
| <code>Console:TConsoleDevice;</code>
 +
| &nbsp;
 +
|-
 +
|colspan="2"|''Framebuffer Properties''
 +
|-
 +
| <code>Framebuffer:PFramebufferDevice;</code>
 +
| &nbsp;
 +
|-
 +
| <code>DesktopX:LongWord;</code>
 +
| Desktop X (Left) Console Relative (Pixels)
 +
|-
 +
| <code>DesktopY:LongWord;</code>
 +
| Desktop Y (Right) Console Relative (Pixels)
 +
|-
 +
| <code>DesktopWidth:LongWord;</code>
 +
| Desktop (Width) Console Relative (Pixels)
 +
|-
 +
| <code>DesktopHeight:LongWord;</code>
 +
| Desktop (Height) Console Relative (Pixels)
 +
|-
 +
| <code>DesktopOffset:LongWord;</code>
 +
| Desktop (Offset)
 +
|-
 +
| <code>DesktopColor:LongWord;</code>
 +
| Desktop (Color)
 +
|-
 +
|colspan="2"|''Buffer Properties''
 +
|-
 +
| <code>LineBuffer:Pointer;</code>
 +
| Buffer for device reads and writes (Size of one line)
 +
|-
 +
|}
 +
</div></div>
 +
<br />
  
 
=== Public variables ===
 
=== Public variables ===

Revision as of 05:55, 16 January 2017

Return to Unit Reference


Description

Ultibo Console interface unit

To be documented

Constants


[Expand]
Console specific constants CONSOLE_*


[Expand]
Console device type constants CONSOLE_TYPE_*


[Expand]
Console device state constants CONSOLE_STATE_*


[Expand]
Console device flag constants CONSOLE_FLAG_*


[Expand]
Console device mode constants CONSOLE_MODE_*


[Expand]
Console window ignature constants WINDOW_SIGNATURE_*


[Expand]
Console window state constants WINDOW_STATE_*


[Expand]
Console window mode constants WINDOW_MODE_*


[Expand]
Console window flag constants WINDOW_FLAG_*


[Expand]
Console cursor mode constants CURSOR_MODE_*


[Expand]
Framebuffer console specific constants FRAMEBUFFER_CONSOLE_*


Type definitions


Console specific types

TCursorState = (CURSORON,CURSOROFF);

Console char types

[Expand]

PConsoleChar = ^TConsoleChar;

TConsoleChar = record

Console point types

[Expand]

TConsolePoint = record

Console rect types

[Expand]

TConsoleRect = record

Console properties

[Expand]

PConsoleProperties = ^TConsoleProperties;

TConsoleProperties = record

Console enumeration callback

TConsoleEnumerate = function(Console:PConsoleDevice; Data:Pointer):LongWord;

Console notification callback

TConsoleNotification = function(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;

Console device open

TConsoleDeviceOpen = function(Console:PConsoleDevice):LongWord;

Console device close

TConsoleDeviceClose = function(Console:PConsoleDevice):LongWord;

Console device clear

TConsoleDeviceClear = function(Console:PConsoleDevice; Color:LongWord):LongWord;

Console device scroll"

TConsoleDeviceScroll = function(Console:PConsoleDevice; X1,Y1,X2,Y2,Count,Direction:LongWord):LongWord;

Console device draw box

TConsoleDeviceDrawBox = function(Console:PConsoleDevice; X1,Y1,X2,Y2,Color,Width:LongWord):LongWord;

Console device draw line

TConsoleDeviceDrawLine = function(Console:PConsoleDevice; X1,Y1,X2,Y2,Color,Width:LongWord):LongWord;

Console device draw char

TConsoleDeviceDrawChar = function(Console:PConsoleDevice; Handle:TFontHandle; Ch:Char;X,Y,Forecolor,Backcolor:LongWord):LongWord;

Console device draw text

TConsoleDeviceDrawText = function(Console:PConsoleDevice; Handle:TFontHandle; const Text:String;X,Y,Forecolor,Backcolor,Len:LongWord):LongWord;

Console device draw pixel

TConsoleDeviceDrawPixel = function(Console:PConsoleDevice; X,Y,Color:LongWord):LongWord;

Console device draw block

TConsoleDeviceDrawBlock = function(Console:PConsoleDevice; X1,Y1,X2,Y2,Color:LongWord):LongWord;

Console device draw image

TConsoleDeviceDrawImage = function(Console:PConsoleDevice; X,Y:LongWord; Buffer:Pointer; Width,Height,Format,Skip:LongWord):LongWord;

Console device draw window

TConsoleDeviceDrawWindow = function(Console:PConsoleDevice; Handle:TWindowHandle):LongWord;

Console device get pixel

TConsoleDeviceGetPixel = function(Console:PConsoleDevice; X,Y:LongWord; var Color:LongWord):LongWord;

Console device get image

TConsoleDeviceGetImage = function(Console:PConsoleDevice; X,Y:LongWord; Buffer:Pointer; Width,Height,Format,Skip:LongWord):LongWord;

Console device put text

TConsoleDevicePutText = function(Console:PConsoleDevice; Handle:TFontHandle; const Source,Dest:TConsolePoint; Buffer:PConsoleChar; Width,Height,Skip:LongWord):LongWord;

Console device copy image

TConsoleDeviceCopyImage = function(Console:PConsoleDevice; const Source,Dest:TConsolePoint; Width,Height:LongWord):LongWord;

Console device get position

TConsoleDeviceGetPosition = function(Console:PConsoleDevice; Position:LongWord; var X1,Y1,X2,Y2:LongWord):LongWord;

Console device get properties

TConsoleDeviceGetProperties = function(Console:PConsoleDevice; Properties:PConsoleProperties):LongWord;

Console device types

[Expand]

PConsoleDevice = ^TConsoleDevice;

TConsoleDevice = record

Window properties

[Expand]

PWindowProperties = ^TWindowProperties;

TWindowProperties = record

Console window enumeration callback

TConsoleWindowEnumerate = function(Console:PConsoleDevice; Handle:TWindowHandle; Data:Pointer):LongWord;

Console window

[Expand]

PConsoleWindow = ^TConsoleWindow;

TConsoleWindow = record

Framebuffer console specific types

[Expand]

PFramebufferConsole = ^TFramebufferConsole;

TFramebufferConsole = record


Public variables

None defined

Function declarations


Initialization functions

[Expand] 
procedure ConsoleInit;
Description: To be documented


Console functions

[Expand] 
function ConsoleDeviceOpen(Console:PConsoleDevice):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceClose(Console:PConsoleDevice):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceClear(Console:PConsoleDevice; Color:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceClose(Console:PConsoleDevice):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceScroll(Console:PConsoleDevice; X1,Y1,X2,Y2,Count,Direction:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceDrawBox(Console:PConsoleDevice; X1,Y1,X2,Y2,Color,Width:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceDrawLine(Console:PConsoleDevice; X1,Y1,X2,Y2,Color,Width:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceDrawChar(Console:PConsoleDevice; Handle:TFontHandle; Ch:Char; X,Y,Forecolor,Backcolor:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceDrawText(Console:PConsoleDevice; Handle:TFontHandle; const Text:String; X,Y,Forecolor,Backcolor,Len:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceDrawPixel(Console:PConsoleDevice; X,Y,Color:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceDrawBlock(Console:PConsoleDevice; X1,Y1,X2,Y2,Color:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceDrawImage(Console:PConsoleDevice; X,Y:LongWord; Buffer:Pointer; Width,Height,Format,Skip:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceDrawWindow(Console:PConsoleDevice; Handle:TWindowHandle):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceGetPixel(Console:PConsoleDevice; X,Y:LongWord; var Color:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceGetImage(Console:PConsoleDevice; X,Y:LongWord; Buffer:Pointer; Width,Height,Format,Skip:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleDevicePutText(Console:PConsoleDevice; Handle:TFontHandle; const Source,Dest:TConsolePoint; Buffer:PConsoleChar; Width,Height,Skip:LongWord):LongWord;
Description: Output a rectangular area of text to a console device


[Expand] 
function ConsoleDeviceCopyImage(Console:PConsoleDevice; const Source,Dest:TConsolePoint; Width,Height:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceGetPosition(Console:PConsoleDevice; Position:LongWord; var X1,Y1,X2,Y2:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceGetProperties(Console:PConsoleDevice; Properties:PConsoleProperties):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceCheckFlag(Console:PConsoleDevice; Flag:LongWord):Boolean;
Description: To be documented


[Expand] 
function ConsoleDeviceGetMode(Console:PConsoleDevice):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceGetState(Console:PConsoleDevice):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceCreate:PConsoleDevice;
Description: Create a new Console entry


[Expand] 
function ConsoleDeviceCreateEx(Size:LongWord):PConsoleDevice;
Description: Create a new Console entry


[Expand] 
function ConsoleDeviceDestroy(Console:PConsoleDevice):LongWord;
Description: Destroy an existing Console entry


[Expand] 
function ConsoleDeviceRegister(Console:PConsoleDevice):LongWord;
Description: Register a new Console in the Console table


[Expand] 
function ConsoleDeviceDeregister(Console:PConsoleDevice):LongWord;
Description: Deregister a Console from the Console table


[Expand] 
function ConsoleDeviceFind(ConsoleId:LongWord):PConsoleDevice;
Description: To be documented


[Expand] 
function ConsoleDeviceFindByDevice(Device:PDevice):PConsoleDevice;
Description: To be documented


[Expand] 
function ConsoleDeviceFindByName(const Name:String):PConsoleDevice; inline;
Description: To be documented


[Expand] 
function ConsoleDeviceFindByDescription(const Description:String):PConsoleDevice; inline;
Description: To be documented


[Expand] 
function ConsoleDeviceEnumerate(Callback:TConsoleEnumerate; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function ConsoleDeviceNotification(Console:PConsoleDevice; Callback:TConsoleNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented


Text console functions

[Expand] 
function ConsoleWindowCreate(Console:PConsoleDevice; Position:LongWord; Default:Boolean):TWindowHandle;
Description: Create a new Console window


[Expand] 
function ConsoleWindowCreateEx(Console:PConsoleDevice; Font:TFontHandle; Size,State,Mode,Position:LongWord; Default:Boolean):TWindowHandle;
Description: Create a new Console window


[Expand] 
function ConsoleWindowDestroy(Handle:TWindowHandle):LongWord;
Description: Close and Destroy an existing console window


[Expand] 
function ConsoleWindowShow(Handle:TWindowHandle):LongWord;
Description: Make an existing console window visible and show it on screen


[Expand] 
function ConsoleWindowHide(Handle:TWindowHandle):LongWord;
Description: Make an existing console window invisible and hide it on screen


[Expand] 
function ConsoleWindowFind(Console:PConsoleDevice; Position:LongWord):TWindowHandle;
Description: Find an existing console window in the position specified


[Expand] 
function ConsoleWindowEnumerate(Console:PConsoleDevice; Callback:TConsoleWindowEnumerate; Data:Pointer):LongWord;
Description: Enumerate existing console windows on the specified console device


[Expand] 
function ConsoleWindowCheckFlag(Handle:TWindowHandle; Flag:LongWord):Boolean;
Description: Check an existing console window to determine if a flag is set or not


[Expand] 
function ConsoleWindowGetMode(Handle:TWindowHandle):LongWord;
Description: Get the window mode of an existing console window


function ConsoleWindowGetState(Handle:TWindowHandle):LongWord;

[Expand] 
function ConsoleWindowCreate(Console:PConsoleDevice; Position:LongWord; Default:Boolean):TWindowHandle;
Description: Get the window state of an existing console window


[Expand] 
function ConsoleWindowGetPosition(Handle:TWindowHandle):LongWord;
Description: Get the position of an existing console window


[Expand] 
function ConsoleWindowSetPosition(Handle:TWindowHandle; Position:LongWord):LongWord;
Description: Set the position of an existing console window


[Expand] 
function ConsoleWindowGetProperties(Handle:TWindowHandle; Properties:PWindowProperties):LongWord;
Description: Get the properties for the specified console window


[Expand] 
function ConsoleWindowGetMinX(Handle:TWindowHandle):LongWord;
Description: Get the current minimum X of the window viewport for an existing console window


[Expand] 
function ConsoleWindowGetMinY(Handle:TWindowHandle):LongWord;
Description: Get the current minimum Y of the window viewport for an existing console window


[Expand] 
function ConsoleWindowGetMaxX(Handle:TWindowHandle):LongWord;
Description: Get the current maximum X of the window viewport for an existing console window


[Expand] 
function ConsoleWindowGetMaxY(Handle:TWindowHandle):LongWord;
Description: Get the current maximum Y of the window viewport for an existing console window


[Expand] 
function ConsoleWindowGetRect(Handle:TWindowHandle):TConsoleRect; inline;
Description: Get the rectangle X1,Y1,X2,Y2 of the window viewport for an existing console window


[Expand] 
function ConsoleWindowSetRect(Handle:TWindowHandle; const ARect:TConsoleRect):LongWord; inline;
Description: Set the rectangle X1,Y1,X2,Y2 of the window viewport for an existing console window


[Expand] 
function ConsoleWindowResetRect(Handle:TWindowHandle):LongWord; inline;
Description: Reset the window viewport for an existing console window to the maximum size


[Expand] 
function ConsoleWindowGetViewport(Handle:TWindowHandle; var X1,Y1,X2,Y2:LongWord):LongWord;
Description: Get the X1,Y1,X2,Y2 of the window viewport for an existing console window


[Expand] 
function ConsoleWindowSetViewport(Handle:TWindowHandle; X1,Y1,X2,Y2:LongWord):LongWord;
Description: Set the X1,Y1,X2,Y2 of the window viewport for an existing console window


[Expand] 
function ConsoleWindowResetViewport(Handle:TWindowHandle):LongWord;
Description: Reset the window viewport for an existing console window to the maximum size


[Expand] 
function ConsoleWindowGetX(Handle:TWindowHandle):LongWord;
Description: Get the current X (Column) position of an existing console window


[Expand] 
function ConsoleWindowSetX(Handle:TWindowHandle; X:LongWord):LongWord;
Description: Set the current X (Column) position of an existing console window


[Expand] 
function ConsoleWindowGetY(Handle:TWindowHandle):LongWord;
Description: Get the current Y (Row) position of an existing console window


[Expand] 
function ConsoleWindowSetY(Handle:TWindowHandle; Y:LongWord):LongWord;
Description: Set the current Y (Row) position of an existing console window


[Expand] 
function ConsoleWindowGetXY(Handle:TWindowHandle; var X,Y:LongWord):LongWord;
Description: Get the current X and Y positions of an existing console window


[Expand] 
function ConsoleWindowSetXY(Handle:TWindowHandle; X,Y:LongWord):LongWord;
Description: Set the current X and Y positions of an existing console window


[Expand] 
function ConsoleWindowGetPoint(Handle:TWindowHandle):TConsolePoint;
Description: Get the point X,Y of an existing console window


[Expand] 
function ConsoleWindowSetPoint(Handle:TWindowHandle; const APoint:TConsolePoint):LongWord;
Description: Set the point X,Y of an existing console window


[Expand] 
function ConsoleWindowGetCols(Handle:TWindowHandle):LongWord;
Description: Get the current columns of the window viewport for an existing console window


[Expand] 
function ConsoleWindowGetRows(Handle:TWindowHandle):LongWord;
Description: Get the current rows of the window viewport for an existing console window


[Expand] 
function ConsoleWindowGetWidth(Handle:TWindowHandle):LongWord;
Description: Get the absolute width of an existing console window


[Expand] 
function ConsoleWindowGetHeight(Handle:TWindowHandle):LongWord;
Description: Get the absolute height of an existing console window


[Expand] 
function ConsoleWindowGetFormat(Handle:TWindowHandle):LongWord;
Description: Get the color format of an existing console window


[Expand] 
function ConsoleWindowGetForecolor(Handle:TWindowHandle):LongWord;
Description: Get the current foreground color of an existing console window


[Expand] 
function ConsoleWindowSetForecolor(Handle:TWindowHandle; Color:LongWord):LongWord;
Description: Set the current foreground color of an existing console window


[Expand] 
function ConsoleWindowGetBackcolor(Handle:TWindowHandle):LongWord;
Description: Get the current background color of an existing console window


[Expand] 
function ConsoleWindowSetBackcolor(Handle:TWindowHandle; Color:LongWord):LongWord;
Description: Set the current background color of an existing console window


[Expand] 
function ConsoleWindowGetFont(Handle:TWindowHandle):TFontHandle;
Description: Get the default font of an existing console window


[Expand] 
function ConsoleWindowSetFont(Handle:TWindowHandle; Font:TFontHandle):LongWord;
Description: Set the default font of an existing console window


[Expand] 
function ConsoleWindowGetCursorXY(Handle:TWindowHandle; var X,Y:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowSetCursorXY(Handle:TWindowHandle; X,Y:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowGetCursorBlink(Handle:TWindowHandle):Boolean;
Description: To be documented


[Expand] 
function ConsoleWindowSetCursorBlink(Handle:TWindowHandle; CursorBlink:Boolean):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowGetCursorState(Handle:TWindowHandle):TCursorState;
Description: To be documented


[Expand] 
function ConsoleWindowSetCursorState(Handle:TWindowHandle; CursorState:TCursorState):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowCursorOn(Handle:TWindowHandle):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowCursorOff(Handle:TWindowHandle):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowCursorMove(Handle:TWindowHandle; X,Y:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowCursorBlink(Handle:TWindowHandle; Enabled:Boolean):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowScrollUp(Handle:TWindowHandle; Row,Lines:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowScrollDown(Handle:TWindowHandle; Row,Lines:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowScrollLeft(Handle:TWindowHandle; Row,Col,Lines,Chars:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowScrollRight(Handle:TWindowHandle; Row,Col,Lines,Chars:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowClear(Handle:TWindowHandle):LongWord;
Description: Clear the current viewport of an existing console window


[Expand] 
function ConsoleWindowClearEx(Handle:TWindowHandle; X1,Y1,X2,Y2:LongWord; Cursor:Boolean):LongWord;
Description: Clear part of the the current viewport of an existing console window


[Expand] 
function ConsoleWindowWrite(Handle:TWindowHandle; const AText:String):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowWriteEx(Handle:TWindowHandle; const AText:String; X,Y:LongWord; Forecolor,Backcolor:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowWriteLn(Handle:TWindowHandle; const AText:String):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowWriteLnEx(Handle:TWindowHandle; const AText:String; X,Y:LongWord; Forecolor,Backcolor:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowWriteChr(Handle:TWindowHandle; AChr:Char):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowWriteChrEx(Handle:TWindowHandle; AChr:Char; X,Y:LongWord; Forecolor,Backcolor:LongWord):LongWord;
Description: To be documented


[Expand] 
function ConsoleWindowOutput(Handle:TWindowHandle; const Source,Dest:TConsolePoint; Buffer:PConsoleChar; Width,Height,Skip:LongWord):LongWord;
Description: Output a rectangular area of text to a console window


CRT console functions

[Expand] 
procedure ConsoleAssignCrt(var F:Text);
Description: Compatible with RTL Crt unit function AssignCrt


[Expand] 
procedure ConsoleClrEol;
Description: Compatible with RTL Crt unit function ClrEol


[Expand] 
procedure ConsoleClrScr;
Description: Compatible with RTL Crt unit function ClrScr


[Expand] 
procedure ConsoleDelay(MS:Word);
Description: Compatible with RTL Crt unit function Delay


[Expand] 
procedure ConsoleDelLine;
Description: Compatible with RTL Crt unit function DelLine


[Expand] 
procedure ConsoleGotoXY(X,Y:Integer);
Description: Compatible with RTL Crt unit function GotoXY


[Expand] 
procedure ConsoleHighVideo;
Description: Compatible with RTL Crt unit function HighVideo


[Expand] 
procedure ConsoleInsLine;
Description: Compatible with RTL Crt unit function InsLine


[Expand] 
function ConsoleKeypressed:Boolean;
Description: Compatible with RTL Crt unit function KeyPressed


[Expand] 
procedure ConsoleLowVideo;
Description: Compatible with RTL Crt unit function LowVideo


[Expand] 
procedure ConsoleNormVideo;
Description: Compatible with RTL Crt unit function NormVideo


[Expand] 
procedure ConsoleNoSound;
Description: Compatible with RTL Crt unit function NoSound


[Expand] 
function ConsoleReadKey:Char;
Description: Compatible with RTL Crt unit function ReadKey


[Expand] 
procedure ConsoleSound(Hz:Word);
Description: Compatible with RTL Crt unit function Sound


[Expand] 
procedure ConsoleTextBackground(Color:LongWord);
Description: Compatible with RTL Crt unit function TextBackground


[Expand] 
procedure ConsoleTextColor(Color:LongWord);
Description: Compatible with RTL Crt unit function TextColor


[Expand] 
procedure ConsoleTextMode(Mode:Integer);
Description: Compatible with RTL Crt unit function TextMode


[Expand] 
function ConsoleWhereX:Integer;
Description: Compatible with RTL Crt unit function WhereX


[Expand] 
function ConsoleWhereY:Integer;
Description: Compatible with RTL Crt unit function WhereY


[Expand] 
procedure ConsoleWindow(X1,Y1,X2,Y2:Integer);
Description: Compatible with RTL Crt unit function Window


[Expand] 
procedure ConsoleScrollUp(Row,Lines:Integer);
Description: To be documented


[Expand] 
procedure ConsoleScrollDown(Row,Lines:Integer);
Description: To be documented


[Expand] 
procedure ConsoleWrite(const AText:String);
Description: To be documented


[Expand] 
procedure ConsoleWriteLn(const AText:String);
Description: To be documented


[Expand] 
procedure ConsoleWriteChr(AChr:Char);
Description: To be documented


[Expand] 
procedure ConsoleRead(var AText:String);
Description: Read text from console input and echo to screen


[Expand] 
procedure ConsoleReadLn(var AText:String);
Description: Read text from console input and echo to screen


[Expand] 
procedure ConsoleReadChr(var AChr:Char);
Description: Read characters from console input and echo to screen


RTL console functions

[Expand] 
function SysConsoleWriteChar(ACh:Char; AUserData:Pointer):Boolean;
Description: To be documented


Framebuffer console functions

[Expand] 
function FramebufferConsoleOpen(Console:PConsoleDevice):LongWord;
Description: Implementation of ConsoleDeviceOpen API for FramebufferConsole


[Expand] 
function FramebufferConsoleClose(Console:PConsoleDevice):LongWord;
Description: Implementation of ConsoleDeviceClose API for FramebufferConsole


[Expand] 
function FramebufferConsoleClear(Console:PConsoleDevice; Color:LongWord):LongWord;
Description: Implementation of ConsoleDeviceClear API for FramebufferConsole


[Expand] 
function FramebufferConsoleScroll(Console:PConsoleDevice; X1,Y1,X2,Y2,Count,Direction:LongWord):LongWord;
Description: Implementation of ConsoleDeviceScroll API for FramebufferConsole


[Expand] 
function FramebufferConsoleDrawBox(Console:PConsoleDevice; X1,Y1,X2,Y2,Color,Width:LongWord):LongWord;
Description: Implementation of ConsoleDeviceDrawBox API for FramebufferConsole


[Expand] 
function FramebufferConsoleDrawLine(Console:PConsoleDevice; X1,Y1,X2,Y2,Color,Width:LongWord):LongWord;
Description: Implementation of ConsoleDeviceDrawLine API for FramebufferConsole


[Expand] 
function FramebufferConsoleDrawChar(Console:PConsoleDevice; Handle:TFontHandle;Ch:Char; X,Y,Forecolor,Backcolor:LongWord):LongWord;
Description: Implementation of ConsoleDeviceDrawChar API for FramebufferConsole


[Expand] 
function FramebufferConsoleDrawText(Console:PConsoleDevice; Handle:TFontHandle; const Text:String; X,Y,Forecolor,Backcolor,Len:LongWord):LongWord;
Description: Implementation of ConsoleDeviceDrawText API for FramebufferConsole


[Expand] 
function FramebufferConsoleDrawPixel(Console:PConsoleDevice; X,Y,Color:LongWord):LongWord;
Description: Implementation of ConsoleDeviceDrawPixel API for FramebufferConsole


[Expand] 
function FramebufferConsoleDrawBlock(Console:PConsoleDevice; X1,Y1,X2,Y2,Color:LongWord):LongWord;
Description: Implementation of ConsoleDeviceDrawBlock API for FramebufferConsole


[Expand] 
function FramebufferConsoleDrawImage(Console:PConsoleDevice; X,Y:LongWord; Buffer:Pointer; Width,Height,Format,Skip:LongWord):LongWord;
Description: Implementation of ConsoleDeviceDrawImage API for FramebufferConsole


[Expand] 
function FramebufferConsoleDrawWindow(Console:PConsoleDevice; Handle:TWindowHandle):LongWord;
Description: Implementation of ConsoleDeviceDrawWindow API for FramebufferConsole


[Expand] 
function FramebufferConsoleDrawDesktop(Console:PConsoleDevice):LongWord;
Description: Internal function used by FramebufferConsole to draw the console desktop


[Expand] 
function FramebufferConsoleGetPixel(Console:PConsoleDevice; X,Y:LongWord; var Color:LongWord):LongWord;
Description: Implementation of ConsoleDeviceGetPixel API for FramebufferConsole


[Expand] 
function FramebufferConsoleGetImage(Console:PConsoleDevice; X,Y:LongWord; Buffer:Pointer; Width,Height,Format,Skip:LongWord):LongWord;
Description: Implementation of ConsoleDeviceGetImage API for FramebufferConsole


[Expand] 
function FramebufferConsolePutText(Console:PConsoleDevice; Handle:TFontHandle; const Source,Dest:TConsolePoint; Buffer:PConsoleChar; Width,Height,Skip:LongWord):LongWord;
Description: Implementation of ConsoleDevicePutText API for FramebufferConsole


[Expand] 
function FramebufferConsoleCopyImage(Console:PConsoleDevice; const Source,Dest:TConsolePoint; Width,Height:LongWord):LongWord;
Description: Implementation of ConsoleDeviceCopyImage API for FramebufferConsole


[Expand] 
function FramebufferConsoleGetPosition(Console:PConsoleDevice; Position:LongWord; var X1,Y1,X2,Y2:LongWord):LongWord;
Description: Implementation of ConsoleDeviceGetPosition API for FramebufferConsole


Console helper functions

[Expand] 
function ConsoleDeviceGetCount:LongWord; inline;
Description: Get the current console device count


[Expand] 
function ConsoleDeviceGetDefault:PConsoleDevice; inline;
Description: Get the current default console device


[Expand] 
function ConsoleDeviceSetDefault(Console:PConsoleDevice):LongWord;
Description: Set the current default console device


[Expand] 
function ConsoleDeviceCheck(Console:PConsoleDevice):PConsoleDevice;
Description: Check if the supplied Console device is in the Console table


[Expand] 
function ConsoleFramebufferDeviceAdd(Framebuffer:PFramebufferDevice):LongWord;
Description: To be documented


[Expand] 
function ConsoleFramebufferDeviceRemove(Framebuffer:PFramebufferDevice):LongWord;
Description: To be documented


[Expand] 
function ConsoleFramebufferDeviceEnum(Framebuffer:PFramebufferDevice; Data:Pointer):LongWord;
Description: To be documented


[Expand] 
function ConsoleFramebufferDeviceNotify(Device:PDevice; Data:Pointer; Notification:LongWord):LongWord;
Description: To be documented


Text console helper functions

[Expand] 
function ConsoleWindowGetCount(Console:PConsoleDevice):LongWord; inline;
Description: Get the current console window count


[Expand] 
function ConsoleWindowGetDefault(Console:PConsoleDevice):TWindowHandle; inline;
Description: Get the current console default window


[Expand] 
function ConsoleWindowSetDefault(Console:PConsoleDevice; Handle:TWindowHandle):LongWord;
Description: Set the current console default window


[Expand] 
function ConsoleWindowCheck(Console:PConsoleDevice; Window:PConsoleWindow):PConsoleWindow;
Description: To be documented


Return to Unit Reference

Retrieved from "https://ultibo.org/mediawiki_ultibo_org/index.php?title=Unit_Console&oldid=2457"