Skip to content

Commit

Permalink
gfx_apps doc review v3.5.4
Browse files Browse the repository at this point in the history
  • Loading branch information
automaate committed Oct 30, 2019
1 parent 38298d5 commit 069fe08
Show file tree
Hide file tree
Showing 48 changed files with 4,225 additions and 2,806 deletions.
Binary file modified doc/help_apps_gfx.chm
Binary file not shown.
18 changes: 7 additions & 11 deletions docs/00000.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<a href="contents.html" target="tocidx">Contents</a></div>
</td><td width="25%">
<div class="Element90">
<a href="00055.html" target="topic">Next</a></div>
<a href="00039.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element96">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: APP_GFX Topic Title: MPLAB Harmony Graphics Suite Applications)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
Expand All @@ -49,9 +49,7 @@
<a name="4465736372697074696F6E"></a><div class="Element11">
<div class="Element10">
<p class="Element10">
&nbsp;</p>
<p class="Element10">
MPLAB® Harmony Graphics Suite is an extension of the MPLAB® ecosystem for creating embedded graphic firmware solutions for 32-bit Microchip devices. The MPLAB® Harmony Graphics Suite applications provide helpful examples and demonstrations. Online documentation in addition to topics listed in this manual can be found at <a href="#" onclick="openExternalLink('https://github.com/Microchip-MPLAB-Harmony/gfx/wiki');">Graphics Overview</a> and <a href="#" onclick="openExternalLink('https://github.com/Microchip-MPLAB-Harmony/gfx/wiki/Creating-a-New-Graphics-Application');">Creating a New Graphics Application</a>.&nbsp;</p>
MPLAB® Harmony Graphics Suite is an extension of the MPLAB ecosystem for creating embedded graphic firmware solutions for 32-bit Microchip devices. The MPLAB Harmony Graphics Suite applications provide helpful examples and demonstrations. Online documentation in addition to topics listed in this manual can be found at <a href="#" onclick="openExternalLink('https://github.com/Microchip-MPLAB-Harmony/gfx/wiki');">MPLAB® Harmony Graphics Suite Wiki</a>.&nbsp;</p>
<p class="Element10">
&nbsp;</p><div class="Element63">
<div class="TableDiv">
Expand All @@ -61,9 +59,9 @@
<div class="Element68">
<img src="Important Star.png" border="0" alt="" title=""><br><strong>Important!</strong>&nbsp;</div></td><td class="Element67" valign="top" width="90%" style="border:none;">
<div class="Element68">
Due to distribution streamlining, the applications are split between two repositories.<br>Quickstart applications, such as <span class="Element145">aria_quickstart</span>, can be found under the <strong>apps folder</strong> in Harmony <strong>gfx </strong>repository.<br>Non-quickstart graphics applications reside under the <strong>apps folder</strong> the Harmony <strong>gfx_apps </strong>repository.<br>Although each application can run standalone from within their respective repository, the use of MPLAB® Harmony Configurator and code regeneration require the presence of other Harmony repositories.&nbsp;</div></td></tr></table></div></div>
Due to distribution streamlining, the applications are split between two repositories.<br>Quickstart and utility applications, such as <span class="Element145">aria_quickstart</span>, can be found under the <strong>apps folder</strong> in Harmony <strong>gfx </strong>repository.<br>Non-quickstart graphics applications reside under the <strong>apps folder</strong> the Harmony <strong>gfx_apps </strong>repository.<br>Although each application can run standalone from within their respective repository, the use of MPLAB® Harmony Configurator and code regeneration require the presence of other Harmony repositories.&nbsp;</div></td></tr></table></div></div>
<p class="Element10">
Prior to using these demonstrations, it is recommended to review the <strong>MPLAB® Harmony Graphics Release Notes</strong> for any known issues.</p></div>
Prior to using these demonstrations, it is recommended to review the <a href="#" onclick="openExternalLink('https://github.com/Microchip-MPLAB-Harmony/gfx/blob/master/release_notes.md');">release notes</a> for any known issues.</p></div>
</div>
<a name="546F70696373"></a><div class="Element14">
Topics</div>
Expand All @@ -80,13 +78,11 @@
Description&nbsp;</div></td></tr><tr>
<td class="Element202" valign="top" width="35%">
<div class="Element203">
<a href="00055.html" target="topic">Examples and Demonstrations</a>&nbsp;</div></td><td class="Element206" valign="top" width="65%">
<a href="00039.html" target="topic">Examples and Demonstrations</a>&nbsp;</div></td><td class="Element206" valign="top" width="65%">
<div class="Element207">
This section provides application examples and demonstrations available in the MPLAB® Harmony Graphics Suite.&nbsp;</div></td></tr></table></div></div>
This section provides example quickstart and utility applications available in the MPLAB Harmony Graphics Suite.&nbsp;</div></td></tr></table></div></div>
</div>
</div>
<div class="Element62">
Created with a commercial version of <a href="#" onclick="openExternalLink('http://www.doc-o-matic.com');">Doc-O-Matic</a>. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at <a href="#" onclick="openExternalLink('mailto:support@toolsfactory.com');">support@toolsfactory.com</a>.</div>
</div>
<!-- End Page Content -->

Expand All @@ -103,7 +99,7 @@
<a href="contents.html" target="tocidx">Contents</a></div>
</td><td width="25%">
<div class="Element91">
<a href="00055.html" target="topic">Next</a></div>
<a href="00039.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element97">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: APP_GFX Topic Title: MPLAB Harmony Graphics Suite Applications)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
Expand Down
93 changes: 9 additions & 84 deletions docs/00001.html
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<!-- Begin Page Header -->
<div class="Element710" id="areafixed">
<div class="Element94">
<a href="00000.html" target="topic">MPLAB Harmony Graphics Suite Applications</a> &gt; <a href="00055.html" target="topic">Examples and Demonstrations</a> &gt; <a href="00053.html" target="topic">Aria Applications</a> &gt; <a href="00001.html" target="topic">aria_adventure</a></div>
<a href="00000.html" target="topic">MPLAB Harmony Graphics Suite Applications</a> &gt; <a href="00039.html" target="topic">Examples and Demonstrations</a> &gt; <a href="00037.html" target="topic">Aria Applications</a> &gt; <a href="00001.html" target="topic">aria_adventure</a></div>
<div class="Element92">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="25%">
Expand All @@ -29,7 +29,7 @@
<a href="contents.html" target="tocidx">Contents</a> | <a href="00000.html" target="topic">Home</a></div>
</td><td width="25%">
<div class="Element90">
<a href="00053.html" target="topic">Previous</a> | <a href="00053.html" target="topic">Up</a> | <a href="00002.html" target="topic">Next</a></div>
<a href="00037.html" target="topic">Previous</a> | <a href="00037.html" target="topic">Up</a> | <a href="00017.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element96">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: APPS GFX Aria_adventure Topic Title: aria_adventure)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
Expand All @@ -48,7 +48,8 @@
<a name="PageContent"></a><div class="Element58">
<a name="4465736372697074696F6E"></a><div class="Element11">
<div class="Element10">
<p class="Element10">
<p class="Element10" style="text-align: center;">
<img src="APPS GFX aria_adventure demo main mode.png" border="0" alt="" title=""></p><p class="Element10">
This application showcases how parallax and sprite animation can be achieved using the aria graphics library.&nbsp;</p>
<p class="Element10">
The demonstration launches with a splash screen highlighting basic motion capability supported by the graphics library. When running the application, the user can interface with it via capacitive single-fingered touch and swiping gestures.&nbsp;</p>
Expand All @@ -57,71 +58,7 @@
<p class="Element10">
In addition, two other features demonstrated by this application includes the circular gauge widget and the ability to display updating text at a high update rate (showing the score count).&nbsp;</p>
<p class="Element10">
The lamb sprite character is animated using more than one hundred frames of animation and is blitted quickly using the GPU and the image preprocessing technique.</p><div class="Element15">
Architecture</div>
<p class="Element10">
The diagrams below show the various software and hardware components for each configuration.&nbsp;</p>
<p class="Element10">
<strong>aria_adventure_mzda_intddr_sk_meb2_wqvga</strong>&nbsp;</p>
<p class="Element10">
For this configuration, the application uses the Graphics library to render graphics to the display. The Graphics library passes draw commands into the GPU Library, which in-turn draws the widgets and images to the frame buffer that is stored in an external DDR2. Via the DDR2 Memory Controller, the GLCD display controller peripheral continuously transfers frame data from the frame buffer onto to the LCD display.&nbsp;</p>
<p class="Element10">
The application also features user touch input through the integrated touch screen on the display panel. Touch input from the touch controller goes thru the I<sup>2</sup>C port, and the Input System Service acquires the touch input information from the touch and I<sup>2</sup>C drivers. The Input System Service sends touch events to the Graphics library which processes these events and updates the frame data accordingly.&nbsp;</p>
<p class="Element10">
The core timer is used by the application and the Graphics library to manage the movement of the splash screen. </p><p class="Element10" style="text-align: center;">
<img src="APPS GFX aria_adventure pic32mz_da_sk_extddr_meb2 and pic32mz_da_sk_extddr_meb2_wvga Double Buffered, with GPU, 3 Layers, Double Buffered.png" border="0" alt="" title="">&nbsp;</p>
<p class="Element10" style="text-align: center;">
&nbsp;</p>
<p class="Element10" style="text-align: center;">
&nbsp;</p><div class="Element15">
Demonstration Features</div>

<ul class="Element630">
<li class="Element600">Integrated PCAP Touch Input</li>
<li class="Element600">Three graphics layer supported via the GLCD peripheral on the PIC32MZ DA device</li>
<li class="Element600">Preprocessed Image assets to leverage GPU peripheral supported</li>
<li class="Element600">Sprite animation achieved using Image Sequence Widget</li>
<li class="Element600">Parallax</li>
<li class="Element600">32-bit RGBA8888 color depth support (16.7 million unique colors)</li>
<li class="Element600">Per-layer frame double-buffering</li>
<li class="Element600">Image compression techniques using Run-Length Encoding, PNG, and JPEG</li>
</ul><p class="Element10">
&nbsp;</p>
<p class="Element10">
<strong>MPLAB Harmony Configurator Setup</strong>&nbsp;</p>
<p class="Element10">
The Project Graph diagram below shows the Harmony components that are included in this application. Lines between components are drawn to satisfy components that depend on a capability that another component provides.&nbsp;</p>
<p class="Element10">
&nbsp;</p><p class="Element10" style="text-align: center;">
<img src="aria_ad_mzda_sk_intddr_wqvga_pg.png" border="0" alt="" title="">&nbsp;</p><p class="Element10">
&nbsp;</p>
<p class="Element10">
Adding the “PIC32MZ DA Starter Kit BSP” and “Aria Graphics w/ PDA TM4301B Display” Graphics Template component into the project graph will automatically add the components needed for a graphics project and resolve their dependencies. It will also configure the pins needed to drive the external peripherals like the display and the touch controller.&nbsp;</p>
<p class="Element10">
The heap size is set to 204800 bytes. The heap is set in Device &amp; Project Configuration -&gt; Project Configuration -&gt; XC32 (Global Options) xc32-ld -&gt; General -&gt; Heap Size option in the “System” component. </p><p class="Element10" style="text-align: center;">
&nbsp;</p>
<p class="Element10" style="text-align: center;">
&nbsp;</p>
<p class="Element10" style="text-align: center;">
<img src="APPS GFX confdiag_e70_freertos_heap.png" border="0" alt="" title="">&nbsp;</p>
<p class="Element10" style="text-align: center;">
&nbsp;</p>
<p class="Element10" style="text-align: center;">
&nbsp;</p>
<p class="Element10" style="text-align: center;">
&nbsp;</p><p class="Element10">
The I2C Baud Rate for the I2C1 component to 1,000,000 Hz.&nbsp;</p>
<p class="Element10">
&nbsp;</p><p class="Element10" style="text-align: center;">
<img src="i2c_baud_rate.png" border="0" alt="" title="">&nbsp;</p>
<p class="Element10" style="text-align: center;">
&nbsp;</p>
<p class="Element10" style="text-align: center;">
&nbsp;</p><p class="Element10">
Enable Double Buffer Mode in GFX Core&nbsp;</p>
<p class="Element10">
&nbsp;</p><p class="Element10" style="text-align: center;">
<img src="driver_config_hints.png" border="0" alt="" title="">&nbsp;</p></div>
The lamb sprite character is animated using more than one hundred frames of animation and is blitted quickly using the GPU and the image preprocessing technique.</p></div>
</div>
<a name="546F70696373"></a><div class="Element14">
Topics</div>
Expand All @@ -138,29 +75,17 @@
Description&nbsp;</div></td></tr><tr>
<td class="Element202" valign="top" width="35%">
<div class="Element203">
<a href="00002.html" target="topic">Building the Application</a>&nbsp;</div></td><td class="Element206" valign="top" width="65%">
<div class="Element207">
This sections describes how to build the application for the demonstration.&nbsp;</div></td></tr><tr>
<td class="Element202" valign="top" width="35%">
<div class="Element203">
<a href="00003.html" target="topic">Configuring the Hardware</a>&nbsp;</div></td><td class="Element206" valign="top" width="65%">
<div class="Element207">
This section details how to configure the hardware for the demonstration.&nbsp;</div></td></tr><tr>
<td class="Element202" valign="top" width="35%">
<div class="Element203">
<a href="00004.html" target="topic">Running the Demonstration</a>&nbsp;</div></td><td class="Element206" valign="top" width="65%">
<a href="00017.html" target="topic">aria_adv_mzda_intddr_sk_meb2_tm4301b.X</a>&nbsp;</div></td><td class="Element206" valign="top" width="65%">
<div class="Element207">
This section details how to run the demonstration.&nbsp;</div></td></tr></table></div></div>
This application runs on the <a href="#" onclick="openExternalLink('https://www.microchip.com/DevelopmentTools/ProductDetails/DM320010');">PIC32MZ Embedded Graphics with Stacked DRAM (DA) Starter Kit</a> attached to the <a href="#" onclick="openExternalLink('https://www.microchip.com/DevelopmentTools/ProductDetails/PartNO/DM320005-5');">Multimedia Expansion Board II</a> using GLCD peripheral controller to drive the <a href="#" onclick="openExternalLink('https://www.microchip.com/DevelopmentTools/ProductDetails/PartNO/AC320005-4');">High-Performance 4.3&quot; WQVGA Display Module with maXTouch® Technology</a>.&nbsp;</div></td></tr></table></div></div>
</div>
</div>
<div class="Element62">
Created with a commercial version of <a href="#" onclick="openExternalLink('http://www.doc-o-matic.com');">Doc-O-Matic</a>. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at <a href="#" onclick="openExternalLink('mailto:support@toolsfactory.com');">support@toolsfactory.com</a>.</div>
</div>
<!-- End Page Content -->

<!-- Begin Page Footer -->
<div class="Element95">
<a href="00000.html" target="topic">MPLAB Harmony Graphics Suite Applications</a> &gt; <a href="00055.html" target="topic">Examples and Demonstrations</a> &gt; <a href="00053.html" target="topic">Aria Applications</a> &gt; <a href="00001.html" target="topic">aria_adventure</a></div>
<a href="00000.html" target="topic">MPLAB Harmony Graphics Suite Applications</a> &gt; <a href="00039.html" target="topic">Examples and Demonstrations</a> &gt; <a href="00037.html" target="topic">Aria Applications</a> &gt; <a href="00001.html" target="topic">aria_adventure</a></div>
<div class="Element93">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="25%">
Expand All @@ -171,7 +96,7 @@
<a href="contents.html" target="tocidx">Contents</a> | <a href="00000.html" target="topic">Home</a></div>
</td><td width="25%">
<div class="Element91">
<a href="00053.html" target="topic">Previous</a> | <a href="00053.html" target="topic">Up</a> | <a href="00002.html" target="topic">Next</a></div>
<a href="00037.html" target="topic">Previous</a> | <a href="00037.html" target="topic">Up</a> | <a href="00017.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element97">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: APPS GFX Aria_adventure Topic Title: aria_adventure)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
Expand Down
Loading

0 comments on commit 069fe08

Please sign in to comment.