Mirrors/overte-JulianGro
3
0
Fork 0
mirror of https://github.com/JulianGro/overte.git synced 2025-08-18 08:38:41 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add Color and Rect API types JSDoc

Browse source
This commit is contained in:
David Rowe 2017-11-25 16:18:40 +13:00
parent 4b5aa9bdec
commit 06012d9dfc
1 changed files with 15 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
libraries/shared/src/RegisteredMetaTypes.cpp
View file

@ -563,6 +563,14 @@ QScriptValue xColorToScriptValue(QScriptEngine *engine, const xColor& color) {
return obj;
}
/**jsdoc
* Defines a rectangular portion of an image or screen.
* @typedef {object} Rect
* @property {number} x - Integer left, x-coordinate value.
* @property {number} y - Integer top, y-coordinate value.
* @property {number} width - Integer width of the rectangle.
* @property {number} height - Integer height of the rectangle.
*/
QVariant qRectToVariant(const QRect& rect) {
QVariantMap obj;
obj["x"] = rect.x();
@ -615,7 +623,13 @@ void xColorFromScriptValue(const QScriptValue &object, xColor& color) {
}
}
/**jsdoc
* An RGB color value.
* @typedef {object} Color
* @property {number} red - Red component value. Integer in the range <code>0</code> - <code>255</code>.
* @property {number} green - Green component value. Integer in the range <code>0</code> - <code>255</code>.
* @property {number} blue - Blue component value. Integer in the range <code>0</code> - <code>255</code>.
*/
QVariant xColorToVariant(const xColor& color) {
QVariantMap obj;
obj["red"] = color.red;