Emdee
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
Public Types | Public Member Functions | List of all members
QGLMaskedSurface Class Reference

The QGLMaskedSurface class represents a masked copy of another OpenGL drawing surface. More...

#include <qglmaskedsurface_p.h>

Inheritance diagram for QGLMaskedSurface:
Inheritance graph
[legend]
Collaboration diagram for QGLMaskedSurface:
Collaboration graph
[legend]

Public Types

enum  BufferMaskBit { RedMask = 0x0001, GreenMask = 0x0002, BlueMask = 0x0004, AlphaMask = 0x0008 }
 

Public Member Functions

 QGLMaskedSurface ()
 
 QGLMaskedSurface (QGLAbstractSurface *surface, QGLMaskedSurface::BufferMask mask)
 
 ~QGLMaskedSurface ()
 
QGLAbstractSurface * surface () const
 
void setSurface (QGLAbstractSurface *surface)
 
QGLMaskedSurface::BufferMask mask () const
 
void setMask (QGLMaskedSurface::BufferMask mask)
 
bool activate (QGLAbstractSurface *prevSurface=0)
 
void deactivate (QGLAbstractSurface *nextSurface=0)
 
QRect viewportGL () const
 
bool isValid () const
 

Detailed Description

The QGLMaskedSurface class represents a masked copy of another OpenGL drawing surface.

Since
4.8

::

Member Enumeration Documentation

This enum defines the channels to mask with QGLMaskedSurface.

RedMask Allow the red channel to be written to the color buffer. GreenMask Allow the green channel to be written to the color buffer. BlueMask Allow the blue channel to be written to the color buffer. AlphaMask Allow the alpha channel to be written to the color buffer.

Enumerator
RedMask 
GreenMask 
BlueMask 
AlphaMask 

Constructor & Destructor Documentation

QGLMaskedSurface::QGLMaskedSurface ( )

Constructs a masked OpenGL drawing surface with surface() initially set to null and mask() initially set to allow all channels to be written to the color buffer.

QGLMaskedSurface::QGLMaskedSurface ( QGLAbstractSurface *  surface,
QGLMaskedSurface::BufferMask  mask 
)

Constructs a masked OpenGL drawing surface that applies mask to surface when activate() is called.

QGLMaskedSurface::~QGLMaskedSurface ( )

Destroys this masked OpenGL drawing surface.

Member Function Documentation

bool QGLMaskedSurface::activate ( QGLAbstractSurface *  prevSurface = 0)
void QGLMaskedSurface::deactivate ( QGLAbstractSurface *  nextSurface = 0)
bool QGLMaskedSurface::isValid ( ) const
QGLMaskedSurface::BufferMask QGLMaskedSurface::mask ( ) const

Returns the color mask to apply to surface() when activate() is called.

See Also
setMask(), surface()
void QGLMaskedSurface::setMask ( QGLMaskedSurface::BufferMask  mask)

Sets the color mask to apply to surface() when activate() is called.

See Also
mask(), setSurface()
void QGLMaskedSurface::setSurface ( QGLAbstractSurface *  surface)

Sets the underlying surface that mask() will be applied to when activate() is called.

See Also
surface(), setMask()
QGLAbstractSurface * QGLMaskedSurface::surface ( ) const

Returns the underlying surface that mask() will be applied to when activate() is called.

See Also
setSurface(), mask()
QRect QGLMaskedSurface::viewportGL ( ) const

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