Add a NuttX logo image example

git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@3804 42af7a65-404d-4744-a932-0658087f49c3

1 files changed, 38 insertions, 0 deletions

diff --git a/apps/examples/README.txt b/apps/examples/README.txt
index b08f79d4b..fb91d914f 100644
--- a/apps/examples/README.txt
+++ b/apps/examples/README.txt
@@ -339,6 +339,44 @@ examplex/nxhello
       FAR struct fb_vtable_s *up_nxdrvinit(unsigned int devno);
       #endif
 
+examples/nximage
+^^^^^^^^^^^^^^^^
+
+  This is a simple example that just puts the NuttX logo image in the center
+  of the display.  This only works for RGB23 (888), RGB16 (656), and RGB8 (332
+  for now.
+
+    CONFIG_EXAMPLES_NXIMAGE_BUILTIN -- Build the NXIMAGE example as a "built-in"
+      that can be executed from the NSH command line    
+    CONFIG_EXAMPLES_NXIMAGE_VPLANE -- The plane to select from the frame-
+      buffer driver for use in the test.  Default: 0
+    CONFIG_EXAMPLES_NXIMAGE_DEVNO - The LCD device to select from the LCD
+      driver for use in the test: Default: 0
+    CONFIG_EXAMPLES_NXIMAGE_BPP -- Pixels per pixel to use.  Valid options
+      include 8, 16, and 24.  Default is 16.
+    CONFIG_EXAMPLES_NXIMAGE_XSCALEp5, CONFIG_EXAMPLES_NXIMAGE_XSCALE1p5,
+    CONFIG_EXAMPLES_NXIMAGE_XSCALE2p0 -- The logo image width is 160 columns.
+      One of these may be defined to rescale the image horizontally by .5, 1.5,
+      or 2.0.
+    CONFIG_EXAMPLES_NXIMAGE_YSCALEp5, CONFIG_EXAMPLES_NXIMAGE_YSCALE1p5,
+    CONFIG_EXAMPLES_NXIMAGE_YSCALE2p0 -- The logo image height is 160 rows.
+      One of these may be defined to rescale the image vertically by .5, 1.5,
+      or 2.0.
+    CONFIG_EXAMPLES_NXIMAGE_EXTERNINIT - The driver for the graphics device on
+      this platform requires some unusual initialization.  This is the
+      for, for example, SPI LCD/OLED devices.  If this configuration is
+      selected, then the platform code must provide an LCD initialization
+      function with a prototype like:
+
+      #ifdef CONFIG_NX_LCDDRIVER
+      FAR struct lcd_dev_s *up_nxdrvinit(unsigned int devno);
+      #else
+      FAR struct fb_vtable_s *up_nxdrvinit(unsigned int devno);
+      #endif
+
+    NOTE: As of this writing, not all of the scaling options and combinations
+    have been tested.
+
 examples/nxtext
 ^^^^^^^^^^^^^^^