Skip to content

Commit db8ef06

Browse files
committed
Correct name of "Arduino_TinyGL" library
The library was incorrectly referred to as "TinyGL". This would make it difficult for the user to follow the tutorial, including finding the library in Library Manager and the example sketches once the library was installed.
1 parent d643606 commit db8ef06

File tree

1 file changed

+8
-8
lines changed
  • content/hardware/10.mega/shields/giga-display-shield/tutorials/09.3d-engine-tutorial

1 file changed

+8
-8
lines changed

content/hardware/10.mega/shields/giga-display-shield/tutorials/09.3d-engine-tutorial/content.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ tags: [Display, 3D, TinyGL]
77

88
## Introduction
99

10-
Using a 3D engine to construct and render objects can be a hardware heavy process. Now with the GIGA R1 WiFi, GIGA Display Shield and the [TinyGL](https://github.com/arduino-libraries/TinyGL) library this can be an easy process! The powerful GIGA R1 WiFi board can run the 3D engine while rendering it on the display shield, utilizing the touch interface of the display to move and interact with the rendered objects.
10+
Using a 3D engine to construct and render objects can be a hardware heavy process. Now with the GIGA R1 WiFi, GIGA Display Shield and the [Arduino_TinyGL](https://github.com/arduino-libraries/Arduino_GigaDisplay_TinyGL) library this can be an easy process! The powerful GIGA R1 WiFi board can run the 3D engine while rendering it on the display shield, utilizing the touch interface of the display to move and interact with the rendered objects.
1111

1212
In this tutorial, we will show you how to make use of these features!
1313

1414
<video width="100%" loop autoplay>
1515
<source src="assets/3d-engine-example.mp4" type="video/mp4" />
1616
</video>
1717

18-
***Please note that the development status of the [TinyGL](https://github.com/arduino-libraries/TinyGL) library is in an experimental phase.***
18+
***Please note that the development status of the [Arduino_TinyGL](https://github.com/arduino-libraries/Arduino_GigaDisplay_TinyGL) library is in an experimental phase.***
1919

2020
## Hardware & Software Needed
2121

@@ -27,17 +27,17 @@ In this tutorial, we will show you how to make use of these features!
2727

2828
The Arduino Mbed OS Giga Boards Board Package contains most of the libraries you need to work with the shield's camera connector. To install the Board Package for GIGA boards, navigate to **Tools > Board > Boards Manager** or click the Boards Manager icon in the left tab of the IDE. In the Boards Manager tab, search for giga and install the latest Arduino Mbed OS Giga Boards version, the [Arduino_H7_Video library](https://github.com/arduino/ArduinoCore-mbed/tree/main/libraries/Arduino_H7_Video) library is included in the Board Package.
2929

30-
To install the required libraries for this tutorail, search for **TinyGL**, **LVGL** and **Arduino_GigaDisplayTouch**. Install these libraries as they are needed for the TinyGL example to work.
30+
To install the required libraries for this tutorail, search for **Arduino_TinyGL**, **LVGL** and **Arduino_GigaDisplayTouch**. Install these libraries as they are needed for the Arduino_TinyGL example to work.
3131

32-
## TinyGL Library
32+
## Arduino_TinyGL Library
3333

34-
The TinyGL library will enable us to run an engine that can render 3D objects on the GIGA Display Shield. TinyGL is based on OpenGL, meaning the objects that we want to be rendered are defined in a `.c` file. Let's take a closer look at these files!
34+
The Arduino_TinyGL library will enable us to run an engine that can render 3D objects on the GIGA Display Shield. Arduino_TinyGL is based on OpenGL, meaning the objects that we want to be rendered are defined in a `.c` file. Let's take a closer look at these files!
3535

36-
- The source code for this library is available [here](https://github.com/arduino-libraries/TinyGL)
36+
- The source code for this library is available [here](https://github.com/arduino-libraries/Arduino_GigaDisplay_TinyGL)
3737

3838
## Rotating Gears Example
3939
This example will render a set of rotating gears on your GIGA Display Shield's display, which you can move around and inspect using your fingers.
40-
Open the example by going to **Files > Examples > TinyGL > Gears** in the Arduino IDE, this will open both the required files in the IDE. You should see a `Gears.ino` and a `gears.c` file as tabs in the IDE. Let's first have a look at the `gears.c` file!
40+
Open the example by going to **Files > Examples > Arduino_TinyGL > Gears** in the Arduino IDE, this will open both the required files in the IDE. You should see a `Gears.ino` and a `gears.c` file as tabs in the IDE. Let's first have a look at the `gears.c` file!
4141

4242
### Gears.c
4343

@@ -91,7 +91,7 @@ For more information about how to use the touch functions on the display shield,
9191

9292
## Running the Sketch
9393

94-
Since the sketch requires the `gears.c` file to compile correctly we recommend opening the example directly in the Arduino IDE from the **TinyGL** library. After downloading the library the example can be found in **Files > Examples > TinyGL > Gears**.
94+
Since the sketch requires the `gears.c` file to compile correctly we recommend opening the example directly in the Arduino IDE from the **Arduino_TinyGL** library. After downloading the library the example can be found in **Files > Examples > Arduino_TinyGL > Gears**.
9595

9696
After uploading the sketch you should see the same result as shown in the gif below:
9797

0 commit comments

Comments
 (0)