Skip to content
This repository has been archived by the owner on Dec 17, 2023. It is now read-only.

Commit

Permalink
[feat] english engine doc improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
yuxiaolejs committed Dec 8, 2023
1 parent 3ae6ca6 commit ff997e4
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ As a user, you don't need to know how OpenGL runs, you just need to interact wit

### Detailed explaination
#### std::map<int, game::RES::Layer> game::layers
This is a global object used to store all layers displayed on the screen. Each layer contains a vector used to carry all elements in the layer. The smallest unit is Shape, please refer to the detailed explanation of class definition. This object is extremely important and will be read frequently. Please **be sure to comply with the locking specifications of game::layersMutex**.
This is a global object used to store all layers displayed on the screen. Each layer contains a vector used to carry all elements in the layer. The smallest unit is Shape, please refer to the detailed explanation of class definition. In this object, the `int` key is used to determine display order (overlapping of the layers), and `Layer` key is the Layer object to display. This object is extremely important and will be read frequently. Please **be sure to comply with the locking specifications of game::layersMutex**.

Use case: Create an element that displays as a texture for res/logo.png
```
Expand Down

0 comments on commit ff997e4

Please sign in to comment.