diff options
author | Nico Vertriest <nico.vertriest@qt.io> | 2017-01-24 16:20:11 +0100 |
---|---|---|
committer | Nico Vertriest <nico.vertriest@qt.io> | 2017-02-15 11:02:57 +0000 |
commit | c668bde4982ff7340de4e882aa45cf1db93bea98 (patch) | |
tree | b9213f276845b550c6296ad890ace570fa340dfa | |
parent | e29f8cf68e2f1ed22244f84099589e9444eaf5ba (diff) |
Doc: added doc for parameters QPaintedTextureImage
Undocumented parameter h,size,w,rect in Qt3DRender::QPaintedTextureImage::setHeight()
Change-Id: I7108b71ac84928b37db4f01218b83e908860e200
Reviewed-by: Venugopal Shivashankar <Venugopal.Shivashankar@qt.io>
-rw-r--r-- | src/render/texture/qpaintedtextureimage.cpp | 38 |
1 files changed, 13 insertions, 25 deletions
diff --git a/src/render/texture/qpaintedtextureimage.cpp b/src/render/texture/qpaintedtextureimage.cpp index 9ae43378a..52c5706d8 100644 --- a/src/render/texture/qpaintedtextureimage.cpp +++ b/src/render/texture/qpaintedtextureimage.cpp @@ -104,14 +104,9 @@ QPaintedTextureImage::~QPaintedTextureImage() /*! \property QPaintedTextureImage::width - Holds the width of the texture image - */ - -/*! - \property QPaintedTextureImage::width - - \return the width of the texture image. - */ + This property holds the width of the texture image. + The width must be greater than or equal to 1. +*/ int QPaintedTextureImage::width() const { Q_D(const QPaintedTextureImage); @@ -121,14 +116,9 @@ int QPaintedTextureImage::width() const /*! \property QPaintedTextureImage::height - Holds the height of the texture image - */ - -/*! - \property QPaintedTextureImage::height - - \return the height of the texture image. - */ + This property holds the height of the texture image. + The height must be greater than or equal to 1. +*/ int QPaintedTextureImage::height() const { Q_D(const QPaintedTextureImage); @@ -138,14 +128,11 @@ int QPaintedTextureImage::height() const /*! \property QPaintedTextureImage::size - Holds the width and height of the texture image - */ + This property holds the size of the texture image. -/*! - \property QPaintedTextureImage::size + \sa height, width - \return the size of the texture image. - */ +*/ QSize QPaintedTextureImage::size() const { Q_D(const QPaintedTextureImage); @@ -206,9 +193,10 @@ void QPaintedTextureImage::setSize(QSize size) } /*! - Will trigger an update of the texture image, meaning the paint() method will - be invoked. - */ + Schedules the painted texture's paint() function to be called, + which in turn uploads the new image to the GPU. + Parameter \a rect is currently unused. +*/ void QPaintedTextureImage::update(const QRect &rect) { Q_UNUSED(rect) |