---
name: "qcanvaspixmap"
section: "3qt"
platform: "linux"
package: "qt3-doc"
version: "3:3.3.8b-7"
release: "Debian 6.0 (Squeeze)"
platforms: ["linux"]
url: "https://new.carta.tech/qcanvaspixmap"
---

# qcanvaspixmap(3qt)

Pixmaps for QCanvasSprites

## NAME

QCanvasPixmap - Pixmaps for QCanvasSprites

## SYNOPSIS

`#include <qcanvas.h>`

Inherits QPixmap.

### Public Members

**QCanvasPixmap ( const QString & datafilename )**\
 **QCanvasPixmap ( const QImage & image )**\
 **QCanvasPixmap ( const QPixmap & pm, const QPoint & offset )**\
 **~QCanvasPixmap ()**\
 **int offsetX () const**\
 **int offsetY () const**\
 **void setOffset ( int x, int y )**\

## DESCRIPTION

The QCanvasPixmap class provides pixmaps for QCanvasSprites.

If you want to show a single pixmap on a QCanvas use a QCanvasSprite with just one pixmap.

When pixmaps are inserted into a QCanvasPixmapArray they are held as QCanvasPixmaps. QCanvasSprites are used to show pixmaps on QCanvases and hold their pixmaps in a QCanvasPixmapArray. If you retrieve a frame (pixmap) from a QCanvasSprite it will be returned as a QCanvasPixmap.

The pixmap is a QPixmap and can only be set in the constructor. There are three different constructors, one taking a QPixmap, one a QImage and one a file name that refers to a file in any supported file format (see QImageIO).

QCanvasPixmap can have a hotspot which is defined in terms of an (x, y) offset. When you create a QCanvasPixmap from a PNG file or from a QImage that has a QImage::offset(), the offset() is initialized appropriately, otherwise the constructor leaves it at (0, 0). You can set it later using setOffset(). When the QCanvasPixmap is used in a QCanvasSprite, the offset position is the point at QCanvasItem::x() and QCanvasItem::y(), not the top-left corner of the pixmap.

Note that for QCanvasPixmap objects created by a QCanvasSprite, the position of each QCanvasPixmap object is set so that the hotspot stays in the same position.

See also QCanvasPixmapArray, QCanvasItem, QCanvasSprite, Graphics Classes, and Image Processing Classes.

## MEMBER FUNCTION DOCUMENTATION

## QCanvasPixmap::QCanvasPixmap ( const QString & datafilename )

Constructs a QCanvasPixmap that uses the image stored in *datafilename*.

## QCanvasPixmap::QCanvasPixmap ( const QImage & image )

Constructs a QCanvasPixmap from the image *image*.

## QCanvasPixmap::QCanvasPixmap ( const QPixmap & pm, const QPoint & offset )

Constructs a QCanvasPixmap from the pixmap *pm* using the offset *offset*.

## QCanvasPixmap::~QCanvasPixmap ()

Destroys the pixmap.

## int QCanvasPixmap::offsetX () const

Returns the x-offset of the pixmap's hotspot.

See also setOffset().

## int QCanvasPixmap::offsetY () const

Returns the y-offset of the pixmap's hotspot.

See also setOffset().

## void QCanvasPixmap::setOffset ( int x, int y )

Sets the offset of the pixmap's hotspot to (*x*, *y*).

**Warning:** Do not call this function if any QCanvasSprites are currently showing this pixmap.

## SEE ALSO

**http://doc.trolltech.com/qcanvaspixmap.html** **http://www.trolltech.com/faq/tech.html**

## COPYRIGHT

Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the license file included in the distribution for a complete license statement.

## AUTHOR

Generated automatically from the source code.

## BUGS

If you find a bug in Qt, please report it as described in **http://doc.trolltech.com/bughowto.html**. Good bug reports help us to help you. Thank you.

The definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt Assistant or with a web browser. This man page is provided as a convenience for those users who prefer man pages, although this format is not officially supported by Trolltech.

If you find errors in this manual page, please report them to **qt-bugs@trolltech.com**. Please include the name of the manual page (qcanvaspixmap.3qt) and the Qt version (3.3.8).