Clean-up and document NX configuration settings

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@1420 42af7a65-404d-4744-a932-0658087f49c3
This commit is contained in:
patacongo 2008-12-05 14:04:37 +00:00
parent b81cd8ca20
commit cb141d8bb2
2 changed files with 45 additions and 17 deletions

View File

@ -547,7 +547,7 @@
<b>Look at all those files and features... How can it be a tiny OS?</b>. <b>Look at all those files and features... How can it be a tiny OS?</b>.
The NuttX feature list (above) is fairly long and if you look at the NuttX The NuttX feature list (above) is fairly long and if you look at the NuttX
source tree, you will see that there are hundreds of source files comprising source tree, you will see that there are hundreds of source files comprising
NuttX. How can NuttX be a tiny OS will all of that? NuttX. How can NuttX be a tiny OS with all of that?
</p> </p>
<center><table width="90%"> <center><table width="90%">

View File

@ -16,7 +16,7 @@
</b></big></h1> </b></big></h1>
<p><small>by</small></p> <p><small>by</small></p>
<p>Gregory Nutt</p> <p>Gregory Nutt</p>
<p><small>Last Update: November 28, 2008</small></p> <p><small>Last Update: December 5, 2008</small></p>
</center> </center>
<center><h1>Table of Contents</h1></center> <center><h1>Table of Contents</h1></center>
@ -1857,7 +1857,7 @@ The system can be re-made subsequently by just typing <code>make</code>.
<h2>Graphics related configuration settings</h3> <h2>Graphics related configuration settings</h3>
<ul> <ul>
<li> <li>
<code>CONFIG_NXGRAPHICS</code> <code>CONFIG_NX</code>
Enables overall support for graphics library and NX Enables overall support for graphics library and NX
</li> </li>
</ul> </ul>
@ -1865,35 +1865,63 @@ The system can be re-made subsequently by just typing <code>make</code>.
<h3>NX configuration setting</h3> <h3>NX configuration setting</h3>
<ul> <ul>
<li> <li>
<code>CONFIG_NX_MULTIUSER</code> <code>CONFIG_NX_MULTIUSER</code>:
Configures NX in multi-user mode Configures NX in multi-user mode.
</li> </li>
<li> <li>
<code>CONFIG_NX_NPLANES</code> <code>CONFIG_NX_NPLANES</code>:
Some YUV color formats requires support for multiple planes, Some YUV color formats requires support for multiple planes,
one for each color component. Unless you have such special one for each color component. Unless you have such special
hardware, this value should be undefined or set to 1 hardware, this value should be undefined or set to 1.
</li> </li>
<li> <li>
<code>CONFIG_NXGLIB_DISABLE_1BPP</code>, <code>CONFIG_NXGLIB_DISABLE_2BPP</code>, <code>CONFIG_NX_DISABLE_1BPP</code>, <code>CONFIG_NX_DISABLE_2BPP</code>,
<code>CONFIG_NXGLIB_DISABLE_4BPP</code>, <code>CONFIG_NXGLIB_DISABLE_8BPP</code> <code>CONFIG_NX_DISABLE_4BPP</code>, <code>CONFIG_NX_DISABLE_8BPP</code>
<code>CONFIG_NXGLIB_DISABLE_16BPP</code>, <code>CONFIG_NXGLIB_DISABLE_24BPP</code>, and <code>CONFIG_NX_DISABLE_16BPP</code>, <code>CONFIG_NX_DISABLE_24BPP</code>, and
<code>CONFIG_NXGLIB_DISABLE_32BPP <code>CONFIG_NX_DISABLE_32BPP</code>:
NX supports a variety of pixel depths. You can save some NX supports a variety of pixel depths. You can save some
memory by disabling support for unused color depths. memory by disabling support for unused color depths.
</li> </li>
<li> <li>
<code>CONFIG_NXGL_PACKEDMSFIRST</code> <code>CONFIG_NX_PACKEDMSFIRST</code>:
If a pixel depth of less than 8-bits is used, then NX needs If a pixel depth of less than 8-bits is used, then NX needs
to know if the pixels pack from the MS to LS or from LS to MS to know if the pixels pack from the MS to LS or from LS to MS
</li> </li>
<li> <li>
<code>CONFIG_NX_MOUSE</code> <code>CONFIG_NX_MOUSE</code>:
Build in support for mouse input Build in support for mouse input.
</li> </li>
<li> <li>
<code>CONFIG_NX_KBD</code> <code>CONFIG_NX_KBD</code>:
Build in support of keypad/keyboard input Build in support of keypad/keyboard input.
</li>
<li>
<code>CONFIG_NXTK_BORDERWIDTH</code>:
Specifies with with of the border (in pixels) used with
framed windows. The default is 4.
</li>
<li>
<code>CONFIG_NXTK_BORDERCOLOR1</code> and <code>CONFIG_NXTK_BORDERCOLOR2</code>:
Specify the colors of the border used with framed windows.
<code>CONFIG_NXTK_BORDERCOLOR2</code> is the shadow side color and so
is normally darker. The default is medium and dark grey,
respectively
</li>
<li>
<code>CONFIG_NXTK_AUTORAISE</code>:
If set, a window will be raised to the top if the mouse position
is over a visible portion of the window. Default: A mouse
button must be clicked over a visible portion of the window.
</li>
<li>
<code>CONFIG_NXFONTS_CHARBITS</code>:
The number of bits in the character set. Current options are
only 7 and 8. The default is 7.
</li>
<li>
<code>CONFIG_NXFONT_SANS</code>:
At present, there is only one font. But if there were were more,
then this option would select the sans serif font.
</li> </li>
</ul> </ul>
@ -1902,7 +1930,7 @@ The system can be re-made subsequently by just typing <code>make</code>.
<li> <li>
<code>CONFIG_NX_BLOCKING</code> <code>CONFIG_NX_BLOCKING</code>
Open the client message queues in blocking mode. In this case, Open the client message queues in blocking mode. In this case,
<code>nx_eventhandler()</code> will never return. <code>nx_eventhandler()</code> will not return until a message is received and processed.
</li> </li>
<li> <li>
<code>CONFIG_NX_MXSERVERMSGS</code> and <code>CONFIG_NX_MXCLIENTMSGS</code> <code>CONFIG_NX_MXSERVERMSGS</code> and <code>CONFIG_NX_MXCLIENTMSGS</code>