diff options
author | Mitch Curtis <mitch.curtis@theqtcompany.com> | 2015-09-23 10:03:21 +0200 |
---|---|---|
committer | Mitch Curtis <mitch.curtis@theqtcompany.com> | 2015-09-23 11:07:02 +0000 |
commit | 9794e7d66c30f012a19ec9530d719293b7c5bc7c (patch) | |
tree | 52ffaf46c3cb06b6ce24dd1586d103a6845f5d46 /src/quick/items | |
parent | 2cc7621c4b22d7356b60a06038e7bc6b7b13718e (diff) |
Link to Item Layers documentation from each property of layer
The layer properties desperately lack code snippets, but the Item
Layers section has some, so link to that.
Change-Id: I3172102b5a1f95bfc495242a16141f030db0dd3c
Reviewed-by: Gunnar Sletta <gunnar@sletta.org>
Diffstat (limited to 'src/quick/items')
-rw-r--r-- | src/quick/items/qquickitem.cpp | 17 |
1 files changed, 15 insertions, 2 deletions
diff --git a/src/quick/items/qquickitem.cpp b/src/quick/items/qquickitem.cpp index ac3f8b2433..1b728584b4 100644 --- a/src/quick/items/qquickitem.cpp +++ b/src/quick/items/qquickitem.cpp @@ -7426,6 +7426,8 @@ QQuickItemLayer::~QQuickItemLayer() None of the other layer properties have any effect when the layer is disabled. + + \sa {Item Layers} */ void QQuickItemLayer::setEnabled(bool e) { @@ -7549,7 +7551,7 @@ void QQuickItemLayer::deactivateEffect() The effect is typically a \l ShaderEffect component, although any \l Item component can be assigned. The effect should have a source texture property with a name matching \l layer.samplerName. - \sa layer.samplerName + \sa layer.samplerName, {Item Layers} */ void QQuickItemLayer::setEffect(QQmlComponent *component) @@ -7589,6 +7591,8 @@ void QQuickItemLayer::setEffect(QQmlComponent *component) \note Some OpenGL ES 2 implementations do not support mipmapping of non-power-of-two textures. + + \sa {Item Layers} */ void QQuickItemLayer::setMipmap(bool mipmap) @@ -7622,6 +7626,7 @@ void QQuickItemLayer::setMipmap(bool mipmap) be used with caution, as support for these formats in the underlying hardare and driver is often not present. + \sa {Item Layers} */ void QQuickItemLayer::setFormat(QQuickShaderEffectSource::Format f) @@ -7644,6 +7649,8 @@ void QQuickItemLayer::setFormat(QQuickShaderEffectSource::Format f) rendered into the texture. The source rectangle can be larger than the item itself. If the rectangle is null, which is the default, then the whole item is rendered to the texture. + + \sa {Item Layers} */ void QQuickItemLayer::setSourceRect(const QRectF &sourceRect) @@ -7662,6 +7669,8 @@ void QQuickItemLayer::setSourceRect(const QRectF &sourceRect) \qmlproperty bool QtQuick::Item::layer.smooth Holds whether the layer is smoothly transformed. + + \sa {Item Layers} */ void QQuickItemLayer::setSmooth(bool s) @@ -7685,6 +7694,8 @@ void QQuickItemLayer::setSmooth(bool s) \note Some platforms have a limit on how small framebuffer objects can be, which means the actual texture size might be larger than the requested size. + + \sa {Item Layers} */ void QQuickItemLayer::setSize(const QSize &size) @@ -7715,6 +7726,8 @@ void QQuickItemLayer::setSize(const QSize &size) \note Some OpenGL ES 2 implementations do not support the GL_REPEAT wrap mode with non-power-of-two textures. + + \sa {Item Layers} */ void QQuickItemLayer::setWrapMode(QQuickShaderEffectSource::WrapMode mode) @@ -7737,7 +7750,7 @@ void QQuickItemLayer::setWrapMode(QQuickShaderEffectSource::WrapMode mode) This value must match the name of the effect's source texture property so that the Item can pass the layer's offscreen surface to the effect correctly. - \sa layer.effect, ShaderEffect + \sa layer.effect, ShaderEffect, {Item Layers} */ void QQuickItemLayer::setName(const QByteArray &name) { |