Commit ce5392c3 authored by Pasi Keranen's avatar Pasi Keranen Committed by Pasi Keränen
Browse files

Add README and up versions to 1.0.0 for Tech Preview.


Change-Id: If7a832e6be688dba021b8ee801df5e2e67f591d1
Reviewed-by: default avatarSami Makkonen <sami.makkonen@digia.com>
Reviewed-by: default avatarTomi Korpipää <tomi.korpipaa@digia.com>
Reviewed-by: default avatarPasi Keränen <pasi.keranen@digia.com>
Showing with 87 additions and 7 deletions
load(qt_build_config)
CONFIG += qt_example_installs
MODULE_VERSION=0.8.0
MODULE_VERSION=1.0.0
CMAKE_MODULE_TESTS=-
README 0 → 100644
---------------------------------------
Qt Canvas 3D 1.0.0 Technology Preview 1
---------------------------------------
Qt Canvas 3D 1.0 module provides a QtQuick canvas component that can be used to render
with WebGL-like API from QtQuick JavaScript environment
System Requirements
===================
- Qt 5.3 or newer
- OpenGL 2.1 (or newer) or OpenGL ES2
Building
========
Configure the project with qmake:
qmake
After running qmake, build the project with make:
(Linux) make
(Windows with MinGw) mingw32-make
(Windows with Visual Studio) nmake
(OSX) make
The above generates the default makefiles for your configuration, which is typically
the release build if you are using precompiled binary Qt distribution. To build both
debug and release, or one specifically, use one of the following qmake lines instead.
For debug builds:
qmake CONFIG+=debug
make
or
qmake CONFIG+=debug_and_release
make debug
For release builds:
qmake CONFIG+=release
make
or
qmake CONFIG+=debug_and_release
make release
For both builds (Windows/Mac only):
qmake CONFIG+="debug_and_release build_all"
make
After building, install the module to your Qt directory:
make install
If you want to uninstall the module:
make uninstall
Building as a statically linked library
=======================================
The same as above applies, you will just have to add static to the CONFIG:
qmake CONFIG+=static
Documentation
=============
The documentation can be generated with:
make docs
The documentation is generated into the doc folder under the build folder.
Both Qt Assistant (qtcanvas3d.qch) and in HTML format
(qtcanvas3d subfolder) documentation is generated.
Please refer to the generated documentation for more information:
doc/qtcanvas3d/index.html
Known Issues
============
- QObject based TypedArray implementation is a temporary stop gap solution
and will be removed from QtCanvas3D later on.
- Texturing does not work perfectly in all of the examples.
- Using Qt Quick Enterprise Controls buttons cause a crash on application exit
on Windows in certain circumstances (try JSON Models Example for reference).
- Resizing window works incorrectly if viewport is updated during rendering to match
the window size (try Framebuffer Example for reference).
......@@ -6,7 +6,7 @@ include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf)
project = QtCanvas3D
description = QML 3D Canvas Reference Documentation
version = 0.8.0
version = 1.0.0
exampledirs = ../../examples/canvas3d \
snippets
......@@ -26,14 +26,14 @@ indexes += $QT_INSTALL_DOCS/qtcore/qtcore.index \
qhp.projects = QtCanvas3D
qhp.QtCanvas3D.file = qtcanvas3d.qhp
qhp.QtCanvas3D.namespace = com.digia.qtcanvas3d.080
qhp.QtCanvas3D.namespace = com.digia.qtcanvas3d.100
qhp.QtCanvas3D.virtualFolder = qtcanvas3d
qhp.QtCanvas3D.indexTitle = QML 3D Canvas
qhp.QtCanvas3D.indexRoot =
qhp.QtCanvas3D.filterAttributes = qtcanvas3d 0.8.0 qtrefdoc
qhp.QtCanvas3D.customFilters.Qt.name = QtCanvas3D 0.8.0
qhp.QtCanvas3D.customFilters.Qt.filterAttributes = qtcanvas3d 0.8.0
qhp.QtCanvas3D.filterAttributes = qtcanvas3d 1.0.0 qtrefdoc
qhp.QtCanvas3D.customFilters.Qt.name = QtCanvas3D 1.0.0
qhp.QtCanvas3D.customFilters.Qt.filterAttributes = qtcanvas3d 1.0.0
qhp.QtCanvas3D.subprojects = gettingstarted examples types
qhp.QtCanvas3D.subprojects.gettingstarted.title = Getting Started
qhp.QtCanvas3D.subprojects.gettingstarted.indexTitle = QtCanvas3D Getting Started
......
......@@ -170,7 +170,6 @@
\list
\li QObject based TypedArray implementation is a temporary stop gap solution and will be removed from QtCanvas3D later on.
\li Texturing does not work perfectly in all of the examples.
\li \l{Interaction Example} and \l{JSON Models Example} crash on some Macs on startup.
\li Using Qt Quick Enterprise Controls buttons cause a crash on application exit
on Windows in certain circumstances (try \l{JSON Models Example} for reference).
\li Resizing window works incorrectly if viewport is updated during rendering to match
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment