Commit f8ce62e2 authored by Paul Lemire's avatar Paul Lemire
Browse files

Add QML doc for textures



Change-Id: I649cf174ff59c64358d13c762eeb500521f712ce
Reviewed-by: default avatarMichael Brasser <michael.brasser@live.com>
parent 62b08ac3
......@@ -102,6 +102,27 @@ void QAbstractTexturePrivate::setDataFunctor(const QTextureGeneratorPtr &generat
with data.
*/
/*!
\qmltype AbstractTexture
\instantiates Qt3DRender::QAbstractTexture
\inqmlmodule Qt3D.Render
\since 5.5
\brief A base class to be used to provide textures.
The AbstractTexture class shouldn't be used directly but rather through one
of its subclasses. Each subclass implements a given texture target (2D,
2DArray, 3D, CubeMap ...) Each subclass provides a set of functors for each
layer, cube map face and mipmap level. In turn the backend uses those
functor to properly fill a corresponding OpenGL texture with data. It is
expected the functor does as minimal processing as possible so as not to
slow down textures generation and upload. If the content of a texture is
the result of a slow procedural generation process, it is recommended not
to implement this directly in a functor.
All textures are unique. If you instantiate twice the same texture this
will create 2 identical textures on the GPU, no sharing will take place.
*/
/*!
\enum Qt3DRender::QAbstractTexture::CubeMapFace
......@@ -370,6 +391,12 @@ void QAbstractTexture::setSize(int w, int h, int d)
Holds the width of the texture provider.
*/
/*!
\qmlproperty int Qt3DRender::QAbstractTexture::width
Holds the width of the texture provider.
*/
/*!
Set the width of the texture provider to \a width.
*/
......@@ -385,6 +412,11 @@ void QAbstractTexture::setWidth(int width)
/*!
\property Qt3DRender::QAbstractTexture::height
Holds the height of the texture provider.
*/
/*!
\qmlproperty int Qt3DRender::QAbstractTexture::height
Holds the height of the texture provider.
*/
/*!
......@@ -402,6 +434,11 @@ void QAbstractTexture::setHeight(int height)
/*!
\property Qt3DRender::QAbstractTexture::depth
Holds the depth of the texture provider.
*/
/*!
\qmlproperty int Qt3DRender::QAbstractTexture::depth
Holds the depth of the texture provider.
*/
/*!
......@@ -449,6 +486,15 @@ int QAbstractTexture::depth() const
Holds the maximum layer count of the texture provider. By default, the
maximum layer count is 1.
\note this has a meaning only for texture providers that have 3D or
array target formats.
*/
/*!
\qmlproperty int Qt3DRender::QAbstractTexture::layers
Holds the maximum layer count of the texture provider. By default, the
maximum layer count is 1.
\note this has a meaning only for texture providers that have 3D or
array target formats.
*/
......@@ -482,6 +528,15 @@ int QAbstractTexture::layers() const
Holds the number of samples per texel for the texture provider.
By default, the number of samples is 1.
\note this has a meaning only for texture providers that have multisample
formats.
*/
/*!
\qmlproperty int Qt3DRender::QAbstractTexture::samples
Holds the number of samples per texel for the texture provider.
By default, the number of samples is 1.
\note this has a meaning only for texture providers that have multisample
formats.
*/
......@@ -512,6 +567,11 @@ int QAbstractTexture::samples() const
/*!
\property Qt3DRender::QAbstractTexture::format
Holds the format of the texture provider.
*/
/*!
\qmlproperty TextureFormat Qt3DRender::QAbstractTexture::format
Holds the format of the texture provider.
*/
/*!
......@@ -538,6 +598,11 @@ QAbstractTexture::TextureFormat QAbstractTexture::format() const
/*!
\property Qt3DRender::QAbstractTexture::status readonly
Holds the current status of the texture provider.
*/
/*!
\qmlproperty Status Qt3DRender::QAbstractTexture::status readonly
Holds the current status of the texture provider.
*/
......@@ -605,6 +670,13 @@ QAbstractTexture::Status QAbstractTexture::status() const
Holds the target format of the texture provider.
\note The target format can only be set once.
*/
/*!
\qmlproperty Target Qt3DRender::QAbstractTexture::target readonly
Holds the target format of the texture provider.
\note The target format can only be set once.
*/
/*!
......@@ -706,6 +778,11 @@ QVector<QAbstractTextureImage *> QAbstractTexture::textureImages() const
/*!
\property Qt3DRender::QAbstractTexture::generateMipMaps
Holds whether the texture provider should auto generate mipmaps.
*/
/*!
\qmlproperty bool Qt3DRender::QAbstractTexture::generateMipMaps
Holds whether the texture provider should auto generate mipmaps.
*/
/*!
......@@ -730,6 +807,11 @@ bool QAbstractTexture::generateMipMaps() const
/*!
\property Qt3DRender::QAbstractTexture::minificationFilter
Holds the minification filter of the texture provider.
*/
/*!
\qmlproperty Filter Qt3DRender::QAbstractTexture::minificationFilter
Holds the minification filter of the texture provider.
*/
/*!
......@@ -764,6 +846,11 @@ void QAbstractTexture::setMinificationFilter(Filter f)
/*!
\property Qt3DRender::QAbstractTexture::magnificationFilter
Holds the magnification filter of the texture provider.
*/
/*!
\qmlproperty Filter Qt3DRender::QAbstractTexture::magnificationFilter
Holds the magnification filter of the texture provider.
*/
/*!
......@@ -793,6 +880,11 @@ QAbstractTexture::Filter QAbstractTexture::magnificationFilter() const
/*!
\property Qt3DRender::QAbstractTexture::wrapMode
Holds the wrap mode of the texture provider.
*/
/*!
\qmlproperty QTextureWrapMode Qt3DRender::QAbstractTexture::wrapMode
Holds the wrap mode of the texture provider.
*/
/*!
......@@ -833,6 +925,11 @@ QTextureWrapMode *QAbstractTexture::wrapMode()
/*!
\property Qt3DRender::QAbstractTexture::maximumAnisotropy
Holds the maximum anisotropy of the texture provider.
*/
/*!
\qmlproperty bool Qt3DRender::QAbstractTexture::maximumAnisotropy
Holds the maximum anisotropy of the texture provider.
*/
/*!
......@@ -859,6 +956,11 @@ float QAbstractTexture::maximumAnisotropy() const
/*!
\property Qt3DRender::QAbstractTexture::ComparisonFunction
Holds the comparison function of the texture provider.
*/
/*!
\qmlproperty ComparisonFunction Qt3DRender::QAbstractTexture::ComparisonFunction
Holds the comparison function of the texture provider.
*/
/*!
......@@ -885,6 +987,12 @@ QAbstractTexture::ComparisonFunction QAbstractTexture::comparisonFunction() cons
/*!
\property Qt3DRender::QAbstractTexture::ComparisonMode
Holds the comparison mode of the texture provider.
*/
/*!
\qmlproperty ComparisonMode Qt3DRender::QAbstractTexture::ComparisonMode
Holds the comparison mode of the texture provider.
*/
/*!
......
......@@ -1041,6 +1041,13 @@ void TextureDownloadRequest::onCompleted()
\since 5.5
\brief A QAbstractTexture with a Target1D target format.
*/
/*!
\qmltype Texture1D
\instantiates Qt3DRender::QTexture1D
\inqmlmodule Qt3D.Render
\since 5.5
\brief An AbstractTexture with a Target1D target format.
*/
/*!
Constructs a new Qt3DRender::QTexture1D instance with \a parent as parent.
......@@ -1062,6 +1069,13 @@ QTexture1D::~QTexture1D()
\since 5.5
\brief A QAbstractTexture with a Target1DArray target format.
*/
/*!
\qmltype Texture1DArray
\instantiates Qt3DRender::QTexture1DArray
\inqmlmodule Qt3D.Render
\since 5.5
\brief An AbstractTexture with a Target1DArray target format.
*/
/*!
Constructs a new Qt3DRender::QTexture1DArray instance with \a parent as parent.
......@@ -1083,6 +1097,13 @@ QTexture1DArray::~QTexture1DArray()
\since 5.5
\brief A QAbstractTexture with a Target2D target format.
*/
/*!
\qmltype Texture2D
\instantiates Qt3DRender::QTexture2D
\inqmlmodule Qt3D.Render
\since 5.5
\brief An AbstractTexture with a Target2D target format.
*/
/*!
Constructs a new Qt3DRender::QTexture2D instance with \a parent as parent.
......@@ -1104,6 +1125,13 @@ QTexture2D::~QTexture2D()
\since 5.5
\brief A QAbstractTexture with a Target2DArray target format.
*/
/*!
\qmltype Texture2DArray
\instantiates Qt3DRender::QTexture2DArray
\inqmlmodule Qt3D.Render
\since 5.5
\brief An AbstractTexture with a Target2DArray target format.
*/
/*!
Constructs a new Qt3DRender::QTexture2DArray instance with \a parent as parent.
......@@ -1125,6 +1153,13 @@ QTexture2DArray::~QTexture2DArray()
\since 5.5
\brief A QAbstractTexture with a Target3D target format.
*/
/*!
\qmltype Texture3D
\instantiates Qt3DRender::QTexture3D
\inqmlmodule Qt3D.Render
\since 5.5
\brief An AbstractTexture with a Target3D target format.
*/
/*!
Constructs a new Qt3DRender::QTexture3D instance with \a parent as parent.
......@@ -1146,6 +1181,13 @@ QTexture3D::~QTexture3D()
\since 5.5
\brief A QAbstractTexture with a TargetCubeMap target format.
*/
/*!
\qmltype TextureCubeMap
\instantiates Qt3DRender::QTextureCubeMap
\inqmlmodule Qt3D.Render
\since 5.5
\brief An AbstractTexture with a TargetCubeMap target format.
*/
/*!
Constructs a new Qt3DRender::QTextureCubeMap instance with \a parent as parent.
......@@ -1167,6 +1209,13 @@ QTextureCubeMap::~QTextureCubeMap()
\since 5.5
\brief A QAbstractTexture with a TargetCubeMapArray target format.
*/
/*!
\qmltype TextureCubeMapArray
\instantiates Qt3DRender::QTextureCubeMapArray
\inqmlmodule Qt3D.Render
\since 5.5
\brief An AbstractTexture with a TargetCubeMapArray target format.
*/
/*!
Constructs a new Qt3DRender::QTextureCubeMapArray instance with \a parent as parent.
......@@ -1188,6 +1237,13 @@ QTextureCubeMapArray::~QTextureCubeMapArray()
\since 5.5
\brief A QAbstractTexture with a Target2DMultisample target format.
*/
/*!
\qmltype Texture2DMultisample
\instantiates Qt3DRender::QTexture2DMultisample
\inqmlmodule Qt3D.Render
\since 5.5
\brief An AbstractTexture with a Target2DMultisample target format.
*/
/*!
Constructs a new Qt3DRender::QTexture2DMultisample instance with \a parent as parent.
......@@ -1209,6 +1265,13 @@ QTexture2DMultisample::~QTexture2DMultisample()
\since 5.5
\brief A QAbstractTexture with a Target2DMultisampleArray target format.
*/
/*!
\qmltype Texture2DMultisampleArray
\instantiates Qt3DRender::QTexture2DMultisampleArray
\inqmlmodule Qt3D.Render
\since 5.5
\brief An AbstractTexture with a Target2DMultisampleArray target format.
*/
/*!
Constructs a new Qt3DRender::QTexture2DMultisampleArray instance with \a parent as parent.
......@@ -1230,6 +1293,13 @@ QTexture2DMultisampleArray::~QTexture2DMultisampleArray()
\since 5.5
\brief A QAbstractTexture with a TargetRectangle target format.
*/
/*!
\qmltype TextureRectangle
\instantiates Qt3DRender::QTextureRectangle
\inqmlmodule Qt3D.Render
\since 5.5
\brief An AbstractTexture with a TargetRectangle target format.
*/
/*!
Constructs a new Qt3DRender::QTextureRectangle instance with \a parent as parent.
......@@ -1251,6 +1321,13 @@ QTextureRectangle::~QTextureRectangle()
\since 5.5
\brief A QAbstractTexture with a TargetBuffer target format.
*/
/*!
\qmltype TextureBuffer
\instantiates Qt3DRender::QTextureBuffer
\inqmlmodule Qt3D.Render
\since 5.5
\brief An AbstractTexture with a TargetBuffer target format.
*/
/*!
Constructs a new Qt3DRender::QTextureBuffer instance with \a parent as parent.
......
Markdown is supported
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