Qt 4.8
Public Functions | Protected Functions | Friends | List of all members
QGraphicsShaderEffect Class Reference

#include <qgraphicsshadereffect_p.h>

Inheritance diagram for QGraphicsShaderEffect:
QGraphicsEffect QObject

Public Functions

QByteArray pixelShaderFragment () const
 
 QGraphicsShaderEffect (QObject *parent=0)
 
void setPixelShaderFragment (const QByteArray &code)
 
virtual ~QGraphicsShaderEffect ()
 
- Public Functions inherited from QGraphicsEffect
QRectF boundingRect () const
 Returns the effective bounding rectangle for this effect, i.e., the bounding rectangle of the source in device coordinates, adjusted by any margins applied by the effect itself. More...
 
virtual QRectF boundingRectFor (const QRectF &sourceRect) const
 Returns the effective bounding rectangle for this effect, given the provided rect in the device coordinates. More...
 
bool isEnabled () const
 
 QGraphicsEffect (QObject *parent=0)
 Constructs a new QGraphicsEffect instance having the specified parent. More...
 
QGraphicsEffectSourcesource () const
 Returns a pointer to the source, which provides extra context information that can be useful for the effect. More...
 
virtual ~QGraphicsEffect ()
 Removes the effect from the source, and destroys the graphics effect. More...
 
- Public Functions inherited from QObject
bool blockSignals (bool b)
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More...
 
const QObjectListchildren () const
 Returns a list of child objects. More...
 
bool connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
 
bool disconnect (const QObject *receiver, const char *member=0)
 
void dumpObjectInfo ()
 Dumps information about signal connections, etc. More...
 
void dumpObjectTree ()
 Dumps a tree of children to the debug output. More...
 
QList< QByteArraydynamicPropertyNames () const
 Returns the names of all properties that were dynamically added to the object using setProperty(). More...
 
virtual bool event (QEvent *)
 This virtual function receives events to an object and should return true if the event e was recognized and processed. More...
 
virtual bool eventFilter (QObject *, QEvent *)
 Filters events if this object has been installed as an event filter for the watched object. More...
 
template<typename T >
findChild (const QString &aName=QString()) const
 Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More...
 
template<typename T >
QList< T > findChildren (const QString &aName=QString()) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. More...
 
template<typename T >
QList< T > findChildren (const QRegExp &re) const
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. More...
 
void installEventFilter (QObject *)
 Installs an event filter filterObj on this object. More...
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false. More...
 
void killTimer (int id)
 Kills the timer with timer identifier, id. More...
 
virtual const QMetaObjectmetaObject () const
 Returns a pointer to the meta-object of this object. More...
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children. More...
 
QString objectName () const
 
QObjectparent () const
 Returns a pointer to the parent object. More...
 
QVariant property (const char *name) const
 Returns the value of the object's name property. More...
 
Q_INVOKABLE QObject (QObject *parent=0)
 Constructs an object with parent object parent. More...
 
void removeEventFilter (QObject *)
 Removes an event filter object obj from this object. More...
 
void setObjectName (const QString &name)
 
void setParent (QObject *)
 Makes the object a child of parent. More...
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value. More...
 
void setUserData (uint id, QObjectUserData *data)
 
bool signalsBlocked () const
 Returns true if signals are blocked; otherwise returns false. More...
 
int startTimer (int interval)
 Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...
 
QThreadthread () const
 Returns the thread in which the object lives. More...
 
QObjectUserDatauserData (uint id) const
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects. More...
 

Protected Functions

void draw (QPainter *painter)
 This pure virtual function draws the effect and is called whenever the source needs to be drawn. More...
 
virtual void setUniforms (QGLShaderProgram *program)
 
void setUniformsDirty ()
 
- Protected Functions inherited from QGraphicsEffect
void drawSource (QPainter *painter)
 Draws the source directly using the given painter. More...
 
 QGraphicsEffect (QGraphicsEffectPrivate &d, QObject *parent=0)
 
QRectF sourceBoundingRect (Qt::CoordinateSystem system=Qt::LogicalCoordinates) const
 Returns the bounding rectangle of the source mapped to the given system. More...
 
virtual void sourceChanged (ChangeFlags flags)
 This virtual function is called by QGraphicsEffect to notify the effect that the source has changed. More...
 
bool sourceIsPixmap () const
 Returns true if the source effectively is a pixmap, e.g., a QGraphicsPixmapItem. More...
 
QPixmap sourcePixmap (Qt::CoordinateSystem system=Qt::LogicalCoordinates, QPoint *offset=0, PixmapPadMode mode=PadToEffectiveBoundingRect) const
 Returns a pixmap with the source painted into it. More...
 
void updateBoundingRect ()
 This function notifies the effect framework when the effect's bounding rectangle has changed. More...
 
- Protected Functions inherited from QObject
virtual void childEvent (QChildEvent *)
 This event handler can be reimplemented in a subclass to receive child events. More...
 
virtual void connectNotify (const char *signal)
 This virtual function is called when something has been connected to signal in this object. More...
 
virtual void customEvent (QEvent *)
 This event handler can be reimplemented in a subclass to receive custom events. More...
 
virtual void disconnectNotify (const char *signal)
 This virtual function is called when something has been disconnected from signal in this object. More...
 
 QObject (QObjectPrivate &dd, QObject *parent=0)
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal. More...
 
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More...
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *)
 This event handler can be reimplemented in a subclass to receive timer events for the object. More...
 

Friends

class QGLCustomShaderEffectStage
 

Additional Inherited Members

- Public Types inherited from QGraphicsEffect
enum  ChangeFlag { SourceAttached = 0x1, SourceDetached = 0x2, SourceBoundingRectChanged = 0x4, SourceInvalidated = 0x8 }
 This enum describes what has changed in QGraphicsEffectSource. More...
 
enum  PixmapPadMode { NoPad, PadToTransparentBorder, PadToEffectiveBoundingRect }
 This enum describes how the pixmap returned from sourcePixmap should be padded. More...
 
- Public Slots inherited from QGraphicsEffect
void setEnabled (bool enable)
 
void update ()
 Schedules a redraw of the effect. More...
 
- Public Slots inherited from QObject
void deleteLater ()
 Schedules this object for deletion. More...
 
- Signals inherited from QGraphicsEffect
void enabledChanged (bool enabled)
 This signal is emitted whenever the effect is enabled or disabled. More...
 
- Signals inherited from QObject
void destroyed (QObject *=0)
 This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...
 
- Static Public Functions inherited from QObject
static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...
 
static bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 Disconnects signal in object sender from method in object receiver. More...
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static uint registerUserData ()
 
static QString tr (const char *sourceText, const char *comment=0, int n=-1)
 
static QString trUtf8 (const char *sourceText, const char *comment=0, int n=-1)
 
- Static Public Variables inherited from QObject
static const QMetaObject staticMetaObject
 This variable stores the meta-object for the class. More...
 
- Protected Variables inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Static Protected Variables inherited from QObject
static const QMetaObject staticQtMetaObject
 

Detailed Description

Definition at line 68 of file qgraphicsshadereffect_p.h.

Constructors and Destructors

◆ QGraphicsShaderEffect()

QGraphicsShaderEffect::QGraphicsShaderEffect ( QObject parent = 0)

Definition at line 181 of file qgraphicsshadereffect.cpp.

183 {
184 }
QGraphicsEffect(QObject *parent=0)
Constructs a new QGraphicsEffect instance having the specified parent.

◆ ~QGraphicsShaderEffect()

QGraphicsShaderEffect::~QGraphicsShaderEffect ( )
virtual

Definition at line 189 of file qgraphicsshadereffect.cpp.

190 {
191 #ifdef QGL_HAVE_CUSTOM_SHADERS
193  delete d->customShaderStage;
194 #endif
195 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482

Functions

◆ draw()

void QGraphicsShaderEffect::draw ( QPainter painter)
protectedvirtual

This pure virtual function draws the effect and is called whenever the source needs to be drawn.

Reimplement this function in a QGraphicsEffect subclass to provide the effect's drawing implementation, using painter.

For example:

MyGraphicsEffect::draw(QPainter *painter)
{
...
QPoint offset;
if (sourceIsPixmap()) {
// No point in drawing in device coordinates (pixmap will be scaled anyways).
const QPixmap pixmap = sourcePixmap(Qt::LogicalCoordinates, &offset);
...
painter->drawPixmap(offset, pixmap);
} else {
// Draw pixmap in device coordinates to avoid pixmap scaling;
const QPixmap pixmap = sourcePixmap(Qt::DeviceCoordinates, &offset);
...
painter->drawPixmap(offset, pixmap);
}
...
}

This function should not be called explicitly by the user, since it is meant for reimplementation purposes only.

Implements QGraphicsEffect.

Definition at line 244 of file qgraphicsshadereffect.cpp.

245 {
247 
248 #ifdef QGL_HAVE_CUSTOM_SHADERS
249  // Set the custom shader on the paint engine. The setOnPainter()
250  // call may fail if the paint engine is not GL2. In that case,
251  // we fall through to drawing the pixmap normally.
252  if (!d->customShaderStage) {
253  d->customShaderStage = new QGLCustomShaderEffectStage
254  (this, d->pixelShaderFragment);
255  }
256  bool usingShader = d->customShaderStage->setOnPainter(painter);
257 
258  QPoint offset;
259  if (sourceIsPixmap()) {
260  // No point in drawing in device coordinates (pixmap will be scaled anyways).
261  const QPixmap pixmap = sourcePixmap(Qt::LogicalCoordinates, &offset);
262  painter->drawPixmap(offset, pixmap);
263  } else {
264  // Draw pixmap in device coordinates to avoid pixmap scaling.
265  const QPixmap pixmap = sourcePixmap(Qt::DeviceCoordinates, &offset);
266  QTransform restoreTransform = painter->worldTransform();
267  painter->setWorldTransform(QTransform());
268  painter->drawPixmap(offset, pixmap);
269  painter->setWorldTransform(restoreTransform);
270  }
271 
272  // Remove the custom shader to return to normal painting operations.
273  if (usingShader)
274  d->customShaderStage->removeFromPainter(painter);
275 #else
276  drawSource(painter);
277 #endif
278 }
double d
Definition: qnumeric_p.h:62
bool sourceIsPixmap() const
Returns true if the source effectively is a pixmap, e.g., a QGraphicsPixmapItem.
QPixmap sourcePixmap(Qt::CoordinateSystem system=Qt::LogicalCoordinates, QPoint *offset=0, PixmapPadMode mode=PadToEffectiveBoundingRect) const
Returns a pixmap with the source painted into it.
void drawSource(QPainter *painter)
Draws the source directly using the given painter.
#define Q_D(Class)
Definition: qglobal.h:2482
const QTransform & worldTransform() const
Returns the world transformation matrix.
Definition: qpainter.cpp:9652
The QPoint class defines a point in the plane using integer precision.
Definition: qpoint.h:53
void setWorldTransform(const QTransform &matrix, bool combine=false)
Sets the world transformation matrix.
Definition: qpainter.cpp:9630
The QPixmap class is an off-screen image representation that can be used as a paint device...
Definition: qpixmap.h:71
void drawPixmap(const QRectF &targetRect, const QPixmap &pixmap, const QRectF &sourceRect)
Draws the rectangular portion source of the given pixmap into the given target in the paint device...
Definition: qpainter.cpp:5619
The QTransform class specifies 2D transformations of a coordinate system.
Definition: qtransform.h:65

◆ pixelShaderFragment()

QByteArray QGraphicsShaderEffect::pixelShaderFragment ( ) const

Definition at line 205 of file qgraphicsshadereffect.cpp.

206 {
207  Q_D(const QGraphicsShaderEffect);
208  return d->pixelShaderFragment;
209 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482

◆ setPixelShaderFragment()

void QGraphicsShaderEffect::setPixelShaderFragment ( const QByteArray code)

Definition at line 229 of file qgraphicsshadereffect.cpp.

230 {
232  if (d->pixelShaderFragment != code) {
233  d->pixelShaderFragment = code;
234 #ifdef QGL_HAVE_CUSTOM_SHADERS
235  delete d->customShaderStage;
236  d->customShaderStage = 0;
237 #endif
238  }
239 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482

◆ setUniforms()

void QGraphicsShaderEffect::setUniforms ( QGLShaderProgram program)
protectedvirtual

Definition at line 309 of file qgraphicsshadereffect.cpp.

Referenced by QGLCustomShaderEffectStage::setUniforms().

310 {
311  Q_UNUSED(program);
312 }
#define Q_UNUSED(x)
Indicates to the compiler that the parameter with the specified name is not used in the body of a fun...
Definition: qglobal.h:1729

◆ setUniformsDirty()

void QGraphicsShaderEffect::setUniformsDirty ( )
protected

Definition at line 290 of file qgraphicsshadereffect.cpp.

291 {
292 #ifdef QGL_HAVE_CUSTOM_SHADERS
294  if (d->customShaderStage)
295  d->customShaderStage->setUniformsDirty();
296 #endif
297 }
double d
Definition: qnumeric_p.h:62
#define Q_D(Class)
Definition: qglobal.h:2482

Friends and Related Functions

◆ QGLCustomShaderEffectStage

Definition at line 87 of file qgraphicsshadereffect_p.h.

Referenced by draw().


The documentation for this class was generated from the following files: