flightgear/utils/fgqcanvas/README.md

46 lines
1.2 KiB
Markdown
Raw Normal View History

2022-10-20 20:29:11 +08:00
# FGQCanvas
A Qt-based remote canvas application for FlightGear. This app can connect to
a FlightGear instance which has the built-in HTTPD server enabled and display
any canvas in real-time.
## Usage
Start FlightGear with the '--httpd' option, passing a port number. This can be
done in the 'additional options' box if using the launcher.
* `--httpd=8080`
Start FGQCanvas and enter the WebSocket url, with a suitable host-name and port.
Provide the path to the Canvas you want to display (this part will become
smarter in the future!)
Examples URLs:
* `ws://localhost:8080/PropertyTreeMirror`
* `ws://mycomputer.local:8001/PropertyTreeMirror`
Example Canvas path:
* `/canvas/by-index/texture[0]/`
## Limitations
* Clipping is still being worked on
* Fonts are not loaded from the host instance yet
* Image loading is still being worked on, no support for remote image loading
yet.
* Performance is mediocre due to proof-of-concept implementation
* No input event support yet
## Future plans
* Finish image, clip and font loading
* Switch to OpenGL rendering
* Support event-input to the Canvas
* Rewrite to use [Skia](http://skia.org)
## Questions / support
Ask on the developer mailing list!