mirror of
https://github.com/xomboverlord/xomb-docs.git
synced 2026-01-12 02:43:16 +01:00
133 lines
4.0 KiB
HTML
133 lines
4.0 KiB
HTML
<html><head>
|
|
<META http-equiv="content-type" content="text/html; charset=utf-8">
|
|
<title>kernel.dev.console</title>
|
|
</head><body>
|
|
<h1>kernel.dev.console</h1>
|
|
<!-- Generated by Ddoc from ../kernel/dev/console.d -->
|
|
<br><br>
|
|
<dl><dt><big>class <u>Console</u>;
|
|
</big></dt>
|
|
<dd>This is the <b>true</b> interface to the console driver.<br><br>
|
|
|
|
<dl><dt><big>static const uint <u>COLUMNS</u>;
|
|
</big></dt>
|
|
<dd>The number of columns and lines on the screen.<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static const ubyte <u>DEFAULTCOLORS</u>;
|
|
</big></dt>
|
|
<dd>The default color.<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static const int <u>TABSTOP</u>;
|
|
</big></dt>
|
|
<dd>The width of a tab<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static void <u>switchToHigherHalfVirtualAddress</u>();
|
|
</big></dt>
|
|
<dd>Notifies the driver that the kernel moved to high memory, and it should
|
|
also move its own references to refer to higher memory.<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static ubyte[] <u>segment</u>();
|
|
</big></dt>
|
|
<dd>This will yield a reference to the video memory.<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static ErrorVal <u>initialize</u>();
|
|
</big></dt>
|
|
<dd>This will <u>initialize</u> the console driver.<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static long <u>getGlobalY</u>();
|
|
</big></dt>
|
|
<dd>Returns the current y coordinate of the cursor.<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static void <u>getPosition</u>(out int <i>x</i>, out int <i>y</i>);
|
|
</big></dt>
|
|
<dd>This method will return the current location of the cursor.<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static synchronized void <u>setPosition</u>(int <i>x</i>, int <i>y</i>);
|
|
</big></dt>
|
|
<dd>This method will set the current location of the cursor to the <i>x</i> and <i>y</i> given.<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static synchronized void <u>putChar</u>(char <i>c</i>);
|
|
</big></dt>
|
|
<dd>This method will post the character to the screen at the current location.<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static synchronized void <u>putString</u>(char[] <i>s</i>);
|
|
</big></dt>
|
|
<dd>This mehtod will post a string to the screen at the current location.<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static void <u>resetColors</u>();
|
|
</big></dt>
|
|
<dd>This function sets the console colors back to their defaults.<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static void <u>setForeColor</u>(Color <i>newColor</i>);
|
|
</big></dt>
|
|
<dd>This function will set the text foreground to a new color.<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static void <u>setBackColor</u>(Color <i>newColor</i>);
|
|
</big></dt>
|
|
<dd>This function will set the text background to a new color.<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static void <u>setColors</u>(Color <i>foreColor</i>, Color <i>backColor</i>);
|
|
</big></dt>
|
|
<dd>This function will set both the foreground and background colors.<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static synchronized void <u>scrollDisplay</u>(uint <i>numLines</i>);
|
|
</big></dt>
|
|
<dd>This function will scroll the display the given number of lines.
|
|
<br><br>
|
|
<b>Params:</b><br>
|
|
<table><tr><td>uint <i>numLines</i></td>
|
|
<td>The number of lines to scroll the display up.</td></tr>
|
|
</table><br>
|
|
|
|
</dd>
|
|
<dt><big>static uint <u>width</u>();
|
|
</big></dt>
|
|
<dd>This function will return the <u>width</u> of the console in characters.
|
|
<br><br>
|
|
<b>Returns:</b><br>
|
|
The number of columns the console can display.<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static uint <u>height</u>();
|
|
</big></dt>
|
|
<dd>This function will return the <u>height</u> of the console in characters.
|
|
<br><br>
|
|
<b>Returns:</b><br>
|
|
The number of rows the console can display.<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static void <u>putCharUnsafe</u>(char <i>foo</i>);
|
|
</big></dt>
|
|
<dd>This function will print a character at the current location without
|
|
locking. It may not print in order.<br><br>
|
|
|
|
</dd>
|
|
<dt><big>static void <u>putStringUnsafe</u>(char[] <i>foo</i>);
|
|
</big></dt>
|
|
<dd>This function will print a string at the current location without
|
|
locking. It may not print in order or even interleave characters
|
|
with other strings.<br><br>
|
|
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
</dl>
|
|
|
|
<hr><small>Page generated by <a href="http://www.digitalmars.com/d/1.0/ddoc.html">Ddoc</a>. </small>
|
|
</body></html>
|