src/quick/scenegraph/util/qsgtexture.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QSGTEXTURE_H
  43 #define QSGTEXTURE_H
  44
  45 #include <QtQuick/qtquickglobal.h>
  46 #include <QObject>
  47 #include <QImage>
  48
  49 QT_BEGIN_HEADER
  50
  51 QT_BEGIN_NAMESPACE
  52
  53 class QSGTexturePrivate;
  54 class Q_QUICK_EXPORT QSGTexture : public QObject
  55 {
  56     Q_OBJECT
  57     Q_DECLARE_PRIVATE(QSGTexture)
  58
  59 public:
  60     QSGTexture();
  61     ~QSGTexture();
  62
  63     enum WrapMode {
  64         Repeat,
  65         ClampToEdge
  66     };
  67
  68     enum Filtering {
  69         None,
  70         Nearest,
  71         Linear
  72     };
  73
  74     virtual int textureId() const = 0;
  75     virtual QSize textureSize() const = 0;
  76     virtual bool hasAlphaChannel() const = 0;
  77     virtual bool hasMipmaps() const = 0;
  78
  79     virtual QRectF normalizedTextureSubRect() const;
  80
  81     virtual bool isAtlasTexture() const;
  82
  83     virtual QSGTexture *removedFromAtlas() const;
  84
  85     virtual void bind() = 0;
  86     void updateBindOptions(bool force = false);
  87
  88     void setMipmapFiltering(Filtering filter);
  89     QSGTexture::Filtering mipmapFiltering() const;
  90
  91     void setFiltering(Filtering filter);
  92     QSGTexture::Filtering filtering() const;
  93
  94     void setHorizontalWrapMode(WrapMode hwrap);
  95     QSGTexture::WrapMode horizontalWrapMode() const;
  96
  97     void setVerticalWrapMode(WrapMode vwrap);
  98     QSGTexture::WrapMode verticalWrapMode() const;
  99
 100     inline QRectF convertToNormalizedSourceRect(const QRectF &rect) const;
 101
 102 protected:
 103     QSGTexture(QSGTexturePrivate &dd);
 104 };
 105
 106 QRectF QSGTexture::convertToNormalizedSourceRect(const QRectF &rect) const
 107 {
 108     QSize s = textureSize();
 109     QRectF r = normalizedTextureSubRect();
 110
 111     qreal sx = r.width() / s.width();
 112     qreal sy = r.height() / s.height();
 113
 114     return QRectF(r.x() + rect.x() * sx,
 115                   r.y() + rect.y() * sy,
 116                   rect.width() * sx,
 117                   rect.height() * sy);
 118 }
 119
 120
 121 class Q_QUICK_EXPORT QSGDynamicTexture : public QSGTexture
 122 {
 123     Q_OBJECT
 124 public:
 125     virtual bool updateTexture() = 0;
 126 };
 127
 128 QT_END_NAMESPACE
 129
 130 QT_END_HEADER
 131
 132 #endif