QScreen Class Reference
[QtGui module]

Properties

See also QScreenDriverPlugin, QScreenDriverFactory, and Qt for Embedded Linux Display Management.

Member Type Documentation

enum QScreen::ClassId

This enum defines the class identifiers for the known screen subclasses.

See also classId().

enum QScreen::PixelType

This enum describes the pixel storage format of the screen, i.e. the order of the red (R), green (G) and blue (B) components of a pixel.

See also pixelType().

Member Function Documentation

QScreen::QScreen ( int display_id, ClassId classId )

Constructs a new screen driver.

The display_id identifies the Qt for Embedded Linux server to connect to. The classId specifies the class identifier.

This function was introduced in Qt 4.4.

QScreen::QScreen ( int displayId )

Constructs a new screen driver.

The displayId identifies the Qt for Embedded Linux server to connect to.

QScreen::~QScreen ()   [virtual]

Destroys this screen driver.

int QScreen::alloc ( unsigned int red, unsigned int green, unsigned int blue )   [virtual]

Returns the index in the screen's palette which is the closest match to the given RGB value (red, green, blue).

Note that this function only apply in paletted modes like 8-bit, i.e. in modes where only the palette indexes (and not the actual color values) are stored in memory.

See also clut() and numCols().

uchar * QScreen::base () const

Returns a pointer to the beginning of the framebuffer.

See also onCard(), region(), and totalSize().

void QScreen::blank ( bool on )   [virtual]

Prevents the screen driver form displaying any content on the screen.

Note that the default implementation does nothing.

Reimplement this function to prevent the screen driver from displaying any contents on the screen if on is true; otherwise the contents is expected to be shown.

See also blit().

void QScreen::blit ( const QImage & image, const QPoint & topLeft, const QRegion & region )   [virtual]

Copies the given region in the given image to the point specified by topLeft using device coordinates.

This function is called from the exposeRegion() function; it is not intended to be called explicitly.

Reimplement this function to make use of accelerated hardware. Note that this function must be reimplemented if the framebuffer format is not supported by Qt for Embedded Linux (See the Display Management documentation for more details).

See also exposeRegion(), solidFill(), and blank().

ClassId QScreen::classId () const

Returns the class identifier for the screen object.

This function was introduced in Qt 4.4.

QRgb * QScreen::clut ()

Returns a pointer to the screen's color lookup table (i.e. its color palette).

Note that this function only apply in paletted modes like 8-bit, i.e. in modes where only the palette indexes (and not the actual color values) are stored in memory.

See also alloc(), depth(), and numCols().

bool QScreen::connect ( const QString & displaySpec )   [pure virtual]

This function is called by every Qt for Embedded Linux application on startup, and must be implemented to map in the framebuffer and the accelerated drivers that the graphics card control registers. Note that coonnect must be called before the initDevice() function.

Ensure that true is returned if a connection to the screen device is made. Otherwise, return false. Upon making the connection, the function should read out the parameters of the framebuffer and use them as required to set this class's protected variables.

The displaySpec argument is passed by the QWS_DISPLAY environment variable or the -display command line parameter, and has the following syntax:

 [screen driver][:driver specific options][:display number]

For example, to use the mach64 driver on fb1 as display 2:

 Mach64:/dev/fb1:2

See Qt for Embedded Linux Display Management for more details.

See also disconnect(), initDevice(), and Running Qt for Embedded Linux Applications.

QWSWindowSurface * QScreen::createSurface ( const QString & key ) const   [virtual]

Creates and returns a new window surface matching the given key.

The server application will call this function whenever it needs to create a server side representation of a window, e.g. when copying the content of memory to the screen using the screen driver.

Note that this function must be reimplemented when adding an accelerated graphics driver. See the Adding an Accelerated Graphics Driver documentation for details.

This function was introduced in Qt 4.2.

See also Qt for Embedded Linux Architecture.

QWSWindowSurface * QScreen::createSurface ( QWidget * widget ) const   [virtual]

This is an overloaded member function, provided for convenience.

Creates and returns a new window surface for the given widget.

int QScreen::depth () const

Returns the depth of the framebuffer, in bits per pixel.

Note that the returned depth is the number of bits each pixel fills rather than the number of significant bits, so 24bpp and 32bpp express the same range of colors (8 bits of red, green and blue).

See also clut() and pixmapDepth().

int QScreen::deviceHeight () const

Returns the full height of the framebuffer device in pixels.

Note that the returned height can differ from the height which Qt for Embedded Linux will actually use, that is if the display is centered within the framebuffer.

See also height(), physicalHeight(), and deviceWidth().

int QScreen::deviceWidth () const

Returns the physical width of the framebuffer device in pixels.

Note that the returned width can differ from the width which Qt for Embedded Linux will actually use, that is if the display is centered within the framebuffer.

See also width(), physicalWidth(), and deviceHeight().

void QScreen::disconnect ()   [pure virtual]

This function is called by every Qt for Embedded Linux application before exiting, and must be implemented to unmap the framebuffer. Note that a server application will call the shutdownDevice() function prior to this function.

See also connect(), shutdownDevice(), and Running Qt for Embedded Linux Applications.

void QScreen::exposeRegion ( QRegion region, int windowIndex )   [virtual]

This function is called by the Qt for Embedded Linux server whenever a screen update is required. region is the area on the screen that must be updated, and windowIndex is the index into QWSServer::clientWindows() of the window that required the update. QWSWindow::state() gives more information about the cause.

The default implementation composes the affected windows and paints the given region on screen by calling the blit() and solidFill() functions

This function can be reimplemented to perform composition in hardware, or to perform transition effects. For simpler hardware acceleration, or to interface with this is typically done by reimplementing the blit() and solidFill() functions instead.

Note that there is no need to call this function explicitly.

See also blit(), solidFill(), and blank().

int QScreen::height () const

Returns the logical height of the framebuffer in pixels.

See also deviceHeight(), physicalHeight(), and width().

bool QScreen::initDevice ()   [pure virtual]

This function is called by the Qt for Embedded Linux server to initialize the framebuffer. Note that a server application will call the connect() function prior to this function.

Implement this function to make accelerated drivers set up the graphics card. Return true to indicate success and false to indicate failure.

See also shutdownDevice() and connect().

QScreen * QScreen::instance ()   [static]

Returns a pointer to the application's QScreen instance.

If this screen consists of several subscreens, operations to the returned instance will affect all its subscreens. Use the subscreens() function to retrieve access to a particular subscreen.

See also subScreens() and subScreenIndexAt().

bool QScreen::isInterlaced () const   [virtual]

Returns true if the display is interlaced (i.e. is displaying images progressively like a television screen); otherwise returns false.

If the display is interlaced, the drawing is altered to look better.

See also isTransformed() and linestep().

bool QScreen::isTransformed () const   [virtual]

Returns true if the screen is transformed (for instance, rotated 90 degrees); otherwise returns false.

See also transformOrientation() and isInterlaced().

int QScreen::linestep () const

Returns the length of each scanline of the framebuffer in bytes.

See also isInterlaced().

QSize QScreen::mapFromDevice ( const QSize & size ) const   [virtual]

Maps the given size from the framebuffer coordinate system to the coordinate space used by the application. Note that the default implementation simply returns the given size as it is.

Reimplement this function to use the given device's coordinate system when mapping.

See also mapToDevice().

QPoint QScreen::mapFromDevice ( const QPoint & point, const QSize & screenSize ) const   [virtual]

This is an overloaded member function, provided for convenience.

Maps the given point from the framebuffer coordinate system to the coordinate space used by the application, passing the device's screenSize as argument. Note that the default implementation simply returns the given point as it is.

QRect QScreen::mapFromDevice ( const QRect & rectangle, const QSize & screenSize ) const   [virtual]

This is an overloaded member function, provided for convenience.

Maps the given rectangle from the framebuffer coordinate system to the coordinate space used by the application, passing the device's screenSize as argument. Note that the default implementation simply returns the given rectangle as it is.

QImage QScreen::mapFromDevice ( const QImage & image ) const   [virtual]

This is an overloaded member function, provided for convenience.

Maps the given image from the framebuffer coordinate system to the coordinate space used by the application. Note that the default implementation simply returns the given image as it is.

QRegion QScreen::mapFromDevice ( const QRegion & region, const QSize & screenSize ) const   [virtual]

This is an overloaded member function, provided for convenience.

Maps the given region from the framebuffer coordinate system to the coordinate space used by the application, passing the device's screenSize as argument. Note that the default implementation simply returns the given region as it is.

QSize QScreen::mapToDevice ( const QSize & size ) const   [virtual]

Maps the given size from the coordinate space used by the application to the framebuffer coordinate system. Note that the default implementation simply returns the given size as it is.

Reimplement this function to use the given device's coordinate system when mapping.

See also mapFromDevice().

QPoint QScreen::mapToDevice ( const QPoint & point, const QSize & screenSize ) const   [virtual]

This is an overloaded member function, provided for convenience.

Maps the given point from the coordinate space used by the application to the framebuffer coordinate system, passing the device's screenSize as argument. Note that the default implementation returns the given point as it is.

QRect QScreen::mapToDevice ( const QRect & rectangle, const QSize & screenSize ) const   [virtual]

This is an overloaded member function, provided for convenience.

Maps the given rectangle from the coordinate space used by the application to the framebuffer coordinate system, passing the device's screenSize as argument. Note that the default implementation returns the given rectangle as it is.

QImage QScreen::mapToDevice ( const QImage & image ) const   [virtual]

This is an overloaded member function, provided for convenience.

Maps the given image from the coordinate space used by the application to the framebuffer coordinate system. Note that the default implementation returns the given image as it is.

QRegion QScreen::mapToDevice ( const QRegion & region, const QSize & screenSize ) const   [virtual]

This is an overloaded member function, provided for convenience.

Maps the given region from the coordinate space used by the application to the framebuffer coordinate system, passing the device's screenSize as argument. Note that the default implementation returns the given region as it is.

int QScreen::numCols ()

Returns the number of entries in the screen's color lookup table (i.e. its color palette). A pointer to the color table can be retrieved using the clut() function.

See also clut() and alloc().

QPoint QScreen::offset () const

Returns the logical offset of the screen, i.e., the offset between (0,0) in screen coordinates and the application coordinate system.

This function was introduced in Qt 4.2.

bool QScreen::onCard ( const unsigned char * buffer ) const   [virtual]

Returns true if the specified buffer is within the graphics card's memory; otherwise returns false (i.e. if it's in main RAM).

See also base() and totalSize().

bool QScreen::onCard ( const unsigned char * buffer, ulong & offset ) const   [virtual]

This is an overloaded member function, provided for convenience.

If the specified buffer is within the graphics card's memory, this function stores the offset from the start of graphics card memory (in bytes), in the location specified by the offset parameter.

int QScreen::physicalHeight () const

Returns the physical height of the screen in millimeters.

This function was introduced in Qt 4.2.

See also height(), deviceHeight(), and physicalWidth().

int QScreen::physicalWidth () const

Returns the physical width of the screen in millimeters.

This function was introduced in Qt 4.2.

See also width(), deviceWidth(), and physicalHeight().

QImage::Format QScreen::pixelFormat () const

Returns the pixel format of the screen, or QImage::Format_Invalid if the pixel format is not a supported image format.

See also setPixelFormat().

PixelType QScreen::pixelType () const

Returns the pixel storage format of the screen.

int QScreen::pixmapDepth () const   [virtual]

Returns the preferred depth for pixmaps, in bits per pixel.

See also depth().

int QScreen::pixmapLinestepAlignment ()   [virtual]

Returns the value (in bits) to which individual scanlines of pixmaps held in the graphics card's memory, should be aligned.

Note that the default implementation returns 64; reimplement this function to override the return value, e.g., when implementing an accelerated driver (see the Adding an Accelerated Graphics Driver documentation for details).

See also pixmapOffsetAlignment().

int QScreen::pixmapOffsetAlignment ()   [virtual]

Returns the value (in bits) to which the start address of pixmaps held in the graphics card's memory, should be aligned.

Note that the default implementation returns 64; reimplement this function to override the return value, e.g., when implementing an accelerated driver (see the Adding an Accelerated Graphics Driver documentation for details).

See also pixmapLinestepAlignment().

QRegion QScreen::region () const   [virtual]

Returns the region covered by this screen driver.

This function was introduced in Qt 4.2.

See also base() and screenSize().

void QScreen::restore ()   [virtual]

Restores the previously saved state of the graphics card.

For example, hardware screen drivers should reimplement the save() and restore() functions to save and restore its registers, enabling swintching between virtual consoles.

Note that the default implementation does nothing.

See also save().

void QScreen::save ()   [virtual]

Saves the current state of the graphics card.

For example, hardware screen drivers should reimplement the save() and restore() functions to save and restore its registers, enabling swintching between virtual consoles.

Note that the default implementation does nothing.

See also restore().

int QScreen::screenSize () const

Returns the size of the screen in bytes.

The screen size is always located at the beginning of framebuffer memory, i.e. it can also be retrieved using the base() function.

See also base() and region().

void QScreen::setDirty ( const QRect & rectangle )   [virtual]

Marks the given rectangle as dirty.

Note that the default implementation does nothing; reimplement this function to indicate that the given rectangle has been altered.

void QScreen::setMode ( int width, int height, int depth )   [pure virtual]

Implement this function to reset the framebuffer's resolution (width and height) and bit depth.

After the resolution has been set, existing paint engines will be invalid and the framebuffer should be completely redrawn. In a multiple-process situation, all other applications must be notified to reset their mode and update themselves accordingly.

void QScreen::setPixelFormat ( QImage::Format format )   [protected]

Sets the screen's pixel format to format.

See also pixelFormat().

void QScreen::shutdownDevice ()   [virtual]

This function is called by the Qt for Embedded Linux server before it calls the disconnect() function when exiting.

Note that the default implementation only hides the mouse cursor; reimplement this function to do the necessary graphics card specific cleanup.

See also initDevice() and disconnect().

void QScreen::solidFill ( const QColor & color, const QRegion & region )   [virtual]

Fills the given region of the screen with the specified color.

This function is called from the exposeRegion() function; it is not intended to be called explicitly.

Reimplement this function to make use of accelerated hardware. Note that this function must be reimplemented if the framebuffer format is not supported by Qt for Embedded Linux (See the Display Management documentation for more details).

See also exposeRegion(), blit(), and blank().

int QScreen::subScreenIndexAt ( const QPoint & position ) const

Returns the index of the subscreen at the given position; returns -1 if no screen is found.

The index identifies the subscreen in the list of pointers returned by the subScreens() function.

This function was introduced in Qt 4.2.

See also instance() and subScreens().

QList<QScreen *> QScreen::subScreens () const   [virtual]

Returns a list of this screen's subscreens. Use the subScreenIndexAt() function to retrieve the index of a screen at a given position.

Note that if this screen consists of several subscreens, operations to this instance will affect all subscreens by default.

This function was introduced in Qt 4.2.

See also instance() and subScreenIndexAt().

bool QScreen::supportsDepth ( int depth ) const   [virtual]

Returns true if the screen supports the specified color depth; otherwise returns false.

See also clut().

int QScreen::totalSize () const

Returns the size of the available graphics card memory (including the screen) in bytes.

See also onCard().

int QScreen::transformOrientation () const   [virtual]

Returns the current rotation as an integer value.

Note that the default implementation returns 0; reimplement this function to override this value.

See also isTransformed().

int QScreen::width () const

Returns the logical width of the framebuffer in pixels.

See also deviceWidth(), physicalWidth(), and height().

Member Variable Documentation

int QScreen::d

This variable holds the pixel depth.

This is the number of significant bits used to set a pixel color. This variable must be initialized by a subclass.

uchar * QScreen::data

This variable holds points to the first visible pixel in the frame buffer.

You must initialize this variable if you are using the default implementation of non-buffered painting Qt::WA_PaintOnScreen, QPixmap::grabWindow() or QDirectPainter::frameBuffer(). If you initialize this variable, you must also initialize QScreen::size and QScreen::mapsize.

See also QScreen::size and QScreen::mapsize.

int QScreen::dh

This variable holds the device height.

This is the number of pixels in a column of the physical screen. It must be initialized by a subclass. Normally, it should be set to the logical height QScreen::h, but it might be different, e.g., if you are doing rotations in software.

See also QScreen::h.

int QScreen::dw

This variable holds the device width.

This is the number of pixels in a row of the physical screen. It must be initialized by a subclass. Normally, it should be set to the logical width QScreen::w, but it might be different, e.g., if you are doing rotations in software.

See also QScreen::w.

bool QScreen::grayscale

This variable holds the gray scale screen mode flag.

Set this variable to true in a subclass, if you are using a grayscale screen mode. e.g., in an 8-bit mode where you don't want to use the palette, but you want to use the grayscales.

int QScreen::h

This variable holds the logical height of the screen.

This variable must be initialized by a subclass.

int QScreen::lstep

This variable holds the number of bytes representing a line in the frame buffer.

i.e., line step. data[lstep * 2] is the address of the first visible pixel in the third line of the frame buffer.

See also data.

int QScreen::mapsize

This variable holds the total number of bytes in the frame buffer.

This is the total number of bytes in the block pointed to by the QScreen::data pointer. You must initialize this variable if you initialize the QScreen::data pointer.

See also QScreen::data and QScreen::size.

int QScreen::physHeight

This variable holds the physical height of the screen in millimeters.

Currently, this variable is used when calculating the screen DPI, which in turn is used when deciding the actual font size Qt is using.

int QScreen::physWidth

This variable holds the physical width of the screen in millimeters.

Currently, this variable is used when calculating the screen DPI, which in turn is used when deciding the actual font size Qt is using.

PixelType QScreen::pixeltype

This variable holds set to BGRPixel.

Set this variable to BGRPixel in a subclass, if the screen pixel format is a BGR type and you have used setPixelFormat() to set the pixel format to the corresponding RGB format. e.g., you have set the pixel format to QImage::Format_RGB555, but your screen really uses BGR, not RGB.

QRgb QScreen::screenclut[256]

This variable holds the color table.

Initialize this variable in a subclass using a paletted screen mode, and initialize its partner, QScreen::screencols.

See also screencols.

int QScreen::screencols

This variable holds the number of entries in the color table.

Initialize this variable in a subclass using a paletted screen mode, and initialize its partner, QScreen::screenclut.

See also screenclut.

int QScreen::size

This variable holds the number of bytes in the visible region of the frame buffer.

This is the number of bytes in the visible part of the block pointed to by the QScreen::data pointer. You must initialize this variable if you initialize the QScreen::data pointer.

See also QScreen::data and QScreen::mapsize.

int QScreen::w

This variable holds the logical width of the screen.

This variable must be initialized by a subclass.