Skip to content

Commit e6b60f2

Browse files
committed
document canvas, cairo, and dom renderer flags
1 parent 8159a23 commit e6b60f2

4 files changed

Lines changed: 40 additions & 0 deletions

File tree

_docs/advanced-setup/html5.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,22 @@ Some Haxe externs support Lime out of the box, like [haxe-simple-peer](https://g
8080

8181
The `<config:html5 />` element in your [_project.xml_](../../project-files/xml-format/) file is used to specify advanced configuration options for HTML/JS. For a complete list of these advanced option, see [Config Values: HTML5](../../project-files/xml-format/config/#html5).
8282

83+
### Canvas rendering
84+
85+
To force software rendering with HTML Canvas instead of WebGL, add the `-Dcanvas` option to your build command.
86+
87+
```sh
88+
lime build html5 -Dcanvas
89+
```
90+
91+
### DOM rendering
92+
93+
To force rendering with the HTML DOM instead of WebGL, add the `-Ddom` option to your build command.
94+
95+
```sh
96+
lime build html5 -Ddom
97+
```
98+
8399
## Help & Forums
84100

85101
If you encounter any problems when setting up Lime for HTML5, please visit the [community forums](http://community.openfl.org/c/help) or our [Discord server](https://discord.gg/tDgq8EE).

_docs/advanced-setup/linux.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,14 @@ To compile and launch a Linux executable with one command, run `lime test linux`
3030

3131
The `<config:cpp />` element in your [_project.xml_](../../project-files/xml-format/) file is used to specify advanced configuration options for C++. For a complete list of these advanced option, see [Config Values: C++](../../project-files/xml-format/config/#c).
3232

33+
### Cairo rendering
34+
35+
To force software rendering with Cairo instead of OpenGL, add the `-Dcairo` option to your build command.
36+
37+
```sh
38+
lime build linux -Dcairo
39+
```
40+
3341
## Help & Forums
3442

3543
If you encounter problems setting up Lime to compile on Linux, please visit the [community forums](http://community.openfl.org/c/help) or our [Discord server](https://discord.gg/tDgq8EE).

_docs/advanced-setup/macos.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ To compile and launch a macOS _.app_ file with one command, run `lime test mac`.
2828

2929
The `<config:cpp />` element in your [_project.xml_](../../project-files/xml-format/) file is used to specify advanced configuration options for C++. For a complete list of these advanced option, see [Config Values: C++](../../project-files/xml-format/config/#c).
3030

31+
### Cairo rendering
32+
33+
To force software rendering with Cairo instead of OpenGL, add the `-Dcairo` option to your build command.
34+
35+
```sh
36+
lime build mac -Dcairo
37+
```
38+
3139
## Help & Forums
3240

3341
You should not need to install the Xcode command-line tools. If this is not the case, or if you encounter other problems when setting up Lime for macOS, please visit the [community forums](http://community.openfl.org/c/help) or our [Discord server](https://discord.gg/tDgq8EE).

_docs/advanced-setup/windows.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ To compile and launch a Windows _.exe_ file with one command, run `lime test win
2828

2929
The `<config:cpp />` element in your [_project.xml_](../../project-files/xml-format/) file is used to specify advanced configuration options for C++. For a complete list of these advanced option, see [Config Values: C++](../../project-files/xml-format/config/#c).
3030

31+
### Cairo rendering
32+
33+
To force software rendering with Cairo instead of OpenGL, add the `-Dcairo` option to your build command.
34+
35+
```sh
36+
lime build windows -Dcairo
37+
```
38+
3139
## Help & Forums
3240

3341
If you encounter any problems when setting up Lime for targeting Windows, please visit the [community forums](http://community.openfl.org/c/help) or our [Discord server](https://discord.gg/tDgq8EE).

0 commit comments

Comments
 (0)