Difference between revisions of "Unit Console"

From Ultibo.org
Jump to: navigation, search
(Created page with "Return to Unit Reference === Description === ---- ''To be documented'' === Constants === ---- ''To be documented'' === Type definitions === ---- ''To...")
 
Line 25: Line 25:
 
----
 
----
  
−
''To be documented''
+
'''Initialization Functions'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">procedure ConsoleInit;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
 
 +
'''Console Functions'''
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceOpen(Console:PConsoleDevice):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceClose(Console:PConsoleDevice):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceClear(Console:PConsoleDevice;Color:LongWord):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceClose(Console:PConsoleDevice):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceScroll(Console:PConsoleDevice;X1,Y1,X2,Y2,Count,Direction:LongWord):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceDrawBox(Console:PConsoleDevice;X1,Y1,X2,Y2,Color,Width:LongWord):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceDrawLine(Console:PConsoleDevice;X1,Y1,X2,Y2,Color,Width:LongWord):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceDrawChar(Console:PConsoleDevice;Handle:TFontHandle;Ch:Char;X,Y,Forecolor,Backcolor:LongWord):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceDrawText(Console:PConsoleDevice;Handle:TFontHandle;const Text:String;X,Y,Forecolor,Backcolor,Len:LongWord):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceDrawPixel(Console:PConsoleDevice;X,Y,Color:LongWord):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceDrawBlock(Console:PConsoleDevice;X1,Y1,X2,Y2,Color:LongWord):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceDrawImage(Console:PConsoleDevice;X,Y:LongWord;Buffer:Pointer;Width,Height,Format,Skip:LongWord):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceDrawWindow(Console:PConsoleDevice;Handle:TWindowHandle):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceGetPixel(Console:PConsoleDevice;X,Y:LongWord;var Color:LongWord):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceGetImage(Console:PConsoleDevice;X,Y:LongWord;Buffer:Pointer;Width,Height,Format,Skip:LongWord):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceCopyImage(Console:PConsoleDevice;const Source,Dest:TConsolePoint;Width,Height:LongWord):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceGetPosition(Console:PConsoleDevice;Position:LongWord;var X1,Y1,X2,Y2:LongWord):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceGetProperties(Console:PConsoleDevice;Properties:PConsoleProperties):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceCheckFlag(Console:PConsoleDevice;Flag:LongWord):Boolean;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceGetMode(Console:PConsoleDevice):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceGetState(Console:PConsoleDevice):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceCreate:PConsoleDevice;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| Create a new Console entry
 +
|-
 +
! '''Return'''
 +
| Pointer to new Console entry or nil if Console could not be created
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceCreateEx(Size:LongWord):PConsoleDevice;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| Create a new Console entry
 +
|-
 +
! '''Size'''
 +
| Size in bytes to allocate for new Console (Including the Console entry)
 +
|-
 +
! '''Return'''
 +
| Pointer to new Console entry or nil if Console could not be created
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceDestroy(Console:PConsoleDevice):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| Destroy an existing Console entry
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceRegister(Console:PConsoleDevice):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| Register a new Console in the Console table
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceDeregister(Console:PConsoleDevice):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| Deregister a Console from the Console table
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceFind(ConsoleId:LongWord):PConsoleDevice;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceFindByDevice(Device:PDevice):PConsoleDevice;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceFindByName(const Name:String):PConsoleDevice; inline;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceFindByDescription(const Description:String):PConsoleDevice; inline;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceEnumerate(Callback:TConsoleEnumerate;Data:Pointer):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
 +
<div class="toccolours mw-collapsible mw-collapsed" style="border: 1; font-family: arial;">
 +
<code style="padding:10px;">function ConsoleDeviceNotification(Console:PConsoleDevice;Callback:TConsoleNotification;Data:Pointer;Notification,Flags:LongWord):LongWord;</code>
 +
<div class="mw-collapsible-content" style="text-align: left; margin:0px;">
 +
{| class="wikitable" style="font-size: 14px; background:white;"
 +
|-
 +
! '''Description'''
 +
| To be documented
 +
|-
 +
|}
 +
</div></div>
 +
<br />
  
  
 
Return to [[Unit_Reference|Unit Reference]]
 
Return to [[Unit_Reference|Unit Reference]]

Revision as of 06:03, 26 July 2016

Return to Unit Reference


Description

To be documented

Constants

To be documented

Type definitions

To be documented

Public variables

To be documented

Function declarations

Initialization Functions

[Expand]

procedure ConsoleInit;


Console Functions

[Expand]

function ConsoleDeviceOpen(Console:PConsoleDevice):LongWord;


[Expand]

function ConsoleDeviceClose(Console:PConsoleDevice):LongWord;


[Expand]

function ConsoleDeviceClear(Console:PConsoleDevice;Color:LongWord):LongWord;


[Expand]

function ConsoleDeviceClose(Console:PConsoleDevice):LongWord;


[Expand]

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


[Expand]

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


[Expand]

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


[Expand]

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


[Expand]

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


[Expand]

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


[Expand]

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


[Expand]

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


[Expand]

function ConsoleDeviceDrawWindow(Console:PConsoleDevice;Handle:TWindowHandle):LongWord;


[Expand]

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


[Expand]

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


[Expand]

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


[Expand]

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


[Expand]

function ConsoleDeviceGetProperties(Console:PConsoleDevice;Properties:PConsoleProperties):LongWord;


[Expand]

function ConsoleDeviceCheckFlag(Console:PConsoleDevice;Flag:LongWord):Boolean;


[Expand]

function ConsoleDeviceGetMode(Console:PConsoleDevice):LongWord;


[Expand]

function ConsoleDeviceGetState(Console:PConsoleDevice):LongWord;


[Expand]

function ConsoleDeviceCreate:PConsoleDevice;


[Expand]

function ConsoleDeviceCreateEx(Size:LongWord):PConsoleDevice;


[Expand]

function ConsoleDeviceDestroy(Console:PConsoleDevice):LongWord;


[Expand]

function ConsoleDeviceRegister(Console:PConsoleDevice):LongWord;


[Expand]

function ConsoleDeviceDeregister(Console:PConsoleDevice):LongWord;


[Expand]

function ConsoleDeviceFind(ConsoleId:LongWord):PConsoleDevice;


[Expand]

function ConsoleDeviceFindByDevice(Device:PDevice):PConsoleDevice;


[Expand]

function ConsoleDeviceFindByName(const Name:String):PConsoleDevice; inline;


[Expand]

function ConsoleDeviceFindByDescription(const Description:String):PConsoleDevice; inline;


[Expand]

function ConsoleDeviceEnumerate(Callback:TConsoleEnumerate;Data:Pointer):LongWord;


[Expand]

function ConsoleDeviceNotification(Console:PConsoleDevice;Callback:TConsoleNotification;Data:Pointer;Notification,Flags:LongWord):LongWord;



Return to Unit Reference

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