1
0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00

Document the DMD demo

This commit is contained in:
Rhys Weatherley 2012-05-30 13:39:46 +10:00
parent c7d87fd98c
commit 08dc249ecb
2 changed files with 43 additions and 0 deletions

42
doc/dmd-demo.dox Normal file
View File

@ -0,0 +1,42 @@
/*
* Copyright (C) 2012 Southern Storm Software, Pty Ltd.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*/
/**
\file dmd-demo.dox
\page dmd_demo Dot Matrix Display Demo
This demo shows off various features of drawing with the Bitmap class
to a DMD display:
\li Drawing circles, lines, and rectangles.
\li Filling the screen with a bitmap-based brick pattern.
\li Drawing bitmaps directly from program memory.
\li Drawing text in various fonts.
\li Scrolling text in a "marquee".
\ref dmd_running_figure "RunningFigure" provides another example of
drawing and animating bitmaps.
The full source code for the demo follows:
\include DMD/examples/Demo/Demo.pde
*/

View File

@ -46,6 +46,7 @@ LCD shield.
\li DMD class to manage the initialize of the display.
\li Bitmap class to manage drawing to in-memory bitmaps and the DMD display.
\li \ref dmd_demo "Demo" that shows off various bitmap drawing features.
\li \ref dmd_running_figure "RunningFigure" example that demonstrates how
to draw and animate bitmaps.