<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qbitmap.cpp -->
<title>Qt 4.8: QBitmap Class Reference</title>
<link rel="stylesheet" type="text/css" href="style/style.css" />
<script src="scripts/jquery.js" type="text/javascript"></script>
<script src="scripts/functions.js" type="text/javascript"></script>
<link rel="stylesheet" type="text/css" href="style/superfish.css" />
<link rel="stylesheet" type="text/css" href="style/narrow.css" />
<!--[if IE]>
<meta name="MSSmartTagsPreventParsing" content="true">
<meta http-equiv="imagetoolbar" content="no">
<![endif]-->
<!--[if lt IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie6.css">
<![endif]-->
<!--[if IE 7]>
<link rel="stylesheet" type="text/css" href="style/style_ie7.css">
<![endif]-->
<!--[if IE 8]>
<link rel="stylesheet" type="text/css" href="style/style_ie8.css">
<![endif]-->
<script src="scripts/superfish.js" type="text/javascript"></script>
<script src="scripts/narrow.js" type="text/javascript"></script>
</head>
<body class="" onload="CheckEmptyAndLoadList();">
<div class="header" id="qtdocheader">
<div class="content">
<div id="nav-logo">
<a href="index.html">Home</a></div>
<a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
<div id="narrowsearch"></div>
<div id="nav-topright">
<ul>
<li class="nav-topright-home"><a href="http://qt.digia.com/">Qt HOME</a></li>
<li class="nav-topright-dev"><a href="http://qt-project.org/">DEV</a></li>
<li class="nav-topright-doc nav-topright-doc-active"><a href="http://qt-project.org/doc/">
DOC</a></li>
<li class="nav-topright-blog"><a href="http://blog.qt.digia.com/">BLOG</a></li>
</ul>
</div>
<div id="shortCut">
<ul>
<li class="shortCut-topleft-inactive"><span><a href="index.html">Qt 4.8</a></span></li>
<li class="shortCut-topleft-active"><a href="http://qt-project.org/doc/">ALL VERSIONS </a></li>
</ul>
</div>
<ul class="sf-menu" id="narrowmenu">
<li><a href="#">API Lookup</a>
<ul>
<li><a href="classes.html">Class index</a></li>
<li><a href="functions.html">Function index</a></li>
<li><a href="modules.html">Modules</a></li>
<li><a href="namespaces.html">Namespaces</a></li>
<li><a href="qtglobal.html">Global Declarations</a></li>
<li><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</li>
<li><a href="#">Qt Topics</a>
<ul>
<li><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li><a href="supported-platforms.html">Supported Platforms</a></li>
<li><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</li>
<li><a href="#">Examples</a>
<ul>
<li><a href="all-examples.html">Examples</a></li>
<li><a href="tutorials.html">Tutorials</a></li>
<li><a href="demos.html">Demos</a></li>
<li><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="wrapper">
<div class="hd">
<span></span>
</div>
<div class="bd group">
<div class="sidebar">
<div class="searchlabel">
Search index:</div>
<div class="search" id="sidebarsearch">
<form id="qtdocsearch" action="" onsubmit="return false;">
<fieldset>
<input type="text" name="searchstring" id="pageType" value="" />
<div id="resultdialog">
<a href="#" id="resultclose">Close</a>
<p id="resultlinks" class="all"><a href="#" id="showallresults">All</a> | <a href="#" id="showapiresults">API</a> | <a href="#" id="showarticleresults">Articles</a> | <a href="#" id="showexampleresults">Examples</a></p>
<p id="searchcount" class="all"><span id="resultcount"></span><span id="apicount"></span><span id="articlecount"></span><span id="examplecount"></span> results:</p>
<ul id="resultlist" class="all">
</ul>
</div>
</fieldset>
</form>
</div>
<div class="box first bottombar" id="lookup">
<h2 title="API Lookup"><span></span>
API Lookup</h2>
<div id="list001" class="list">
<ul id="ul001" >
<li class="defaultLink"><a href="classes.html">Class index</a></li>
<li class="defaultLink"><a href="functions.html">Function index</a></li>
<li class="defaultLink"><a href="modules.html">Modules</a></li>
<li class="defaultLink"><a href="namespaces.html">Namespaces</a></li>
<li class="defaultLink"><a href="qtglobal.html">Global Declarations</a></li>
<li class="defaultLink"><a href="qdeclarativeelements.html">QML elements</a></li>
</ul>
</div>
</div>
<div class="box bottombar" id="topics">
<h2 title="Qt Topics"><span></span>
Qt Topics</h2>
<div id="list002" class="list">
<ul id="ul002" >
<li class="defaultLink"><a href="qt-basic-concepts.html">Programming with Qt</a></li>
<li class="defaultLink"><a href="qtquick.html">Device UIs & Qt Quick</a></li>
<li class="defaultLink"><a href="qt-gui-concepts.html">UI Design with Qt</a></li>
<li class="defaultLink"><a href="supported-platforms.html">Supported Platforms</a></li>
<li class="defaultLink"><a href="technology-apis.html">Qt and Key Technologies</a></li>
<li class="defaultLink"><a href="best-practices.html">How-To's and Best Practices</a></li>
</ul>
</div>
</div>
<div class="box" id="examples">
<h2 title="Examples"><span></span>
Examples</h2>
<div id="list003" class="list">
<ul id="ul003">
<li class="defaultLink"><a href="all-examples.html">Examples</a></li>
<li class="defaultLink"><a href="tutorials.html">Tutorials</a></li>
<li class="defaultLink"><a href="demos.html">Demos</a></li>
<li class="defaultLink"><a href="qdeclarativeexamples.html">QML Examples</a></li>
</ul>
</div>
</div>
</div>
<div class="wrap">
<div class="toolbar">
<div class="breadcrumb toolblock">
<ul>
<li class="first"><a href="index.html">Home</a></li>
<!-- Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtgui.html">QtGui</a></li>
<li>QBitmap</li>
</ul>
</div>
<div class="toolbuttons toolblock">
<ul>
<li id="smallA" class="t_button">A</li>
<li id="medA" class="t_button active">A</li>
<li id="bigA" class="t_button">A</li>
<li id="print" class="t_button"><a href="javascript:this.print();">
<span>Print</span></a></li>
</ul>
</div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#static-public-members">Static Public Members</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QBitmap Class Reference</h1>
<!-- $$$QBitmap-brief -->
<p>The QBitmap class provides monochrome (1-bit depth) pixmaps. <a href="#details">More...</a></p>
<!-- @@@QBitmap -->
<pre class="cpp"> <span class="preprocessor">#include <QBitmap></span></pre><p><b>Inherits: </b><a href="qpixmap.html">QPixmap</a>.</p>
<ul>
<li><a href="qbitmap-members.html">List of all members, including inherited members</a></li>
<li><a href="qbitmap-obsolete.html">Obsolete members</a></li>
<li><a href="qbitmap-qt3.html">Qt 3 support members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qbitmap.html#QBitmap">QBitmap</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qbitmap.html#QBitmap-2">QBitmap</a></b> ( const QPixmap & <i>pixmap</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qbitmap.html#QBitmap-3">QBitmap</a></b> ( int <i>width</i>, int <i>height</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qbitmap.html#QBitmap-4">QBitmap</a></b> ( const QSize & <i>size</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qbitmap.html#QBitmap-5">QBitmap</a></b> ( const QString & <i>fileName</i>, const char * <i>format</i> = 0 )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qbitmap.html#dtor.QBitmap">~QBitmap</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qbitmap.html#clear">clear</a></b> ()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> void </td><td class="memItemRight bottomAlign"><b><a href="qbitmap.html#swap">swap</a></b> ( QBitmap & <i>other</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBitmap </td><td class="memItemRight bottomAlign"><b><a href="qbitmap.html#transformed">transformed</a></b> ( const QTransform & <i>matrix</i> ) const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qbitmap.html#operator-QVariant">operator QVariant</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBitmap & </td><td class="memItemRight bottomAlign"><b><a href="qbitmap.html#operator-eq">operator=</a></b> ( const QPixmap & <i>pixmap</i> )</td></tr>
</table>
<ul>
<li class="fn">48 public functions inherited from <a href="qpixmap.html#public-functions">QPixmap</a></li>
<li class="fn">13 public functions inherited from <a href="qpaintdevice.html#public-functions">QPaintDevice</a></li>
</ul>
<a name="static-public-members"></a>
<h2>Static Public Members</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> QBitmap </td><td class="memItemRight bottomAlign"><b><a href="qbitmap.html#fromData">fromData</a></b> ( const QSize & <i>size</i>, const uchar * <i>bits</i>, QImage::Format <i>monoFormat</i> = QImage::Format_MonoLSB )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> QBitmap </td><td class="memItemRight bottomAlign"><b><a href="qbitmap.html#fromImage">fromImage</a></b> ( const QImage & <i>image</i>, Qt::ImageConversionFlags <i>flags</i> = Qt::AutoColor )</td></tr>
</table>
<ul>
<li class="fn">14 static public members inherited from <a href="qpixmap.html#static-public-members">QPixmap</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 protected function inherited from <a href="qpaintdevice.html#protected-functions">QPaintDevice</a></li>
</ul>
<a name="details"></a>
<!-- $$$QBitmap-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QBitmap class provides monochrome (1-bit depth) pixmaps.</p>
<p>The QBitmap class is a monochrome off-screen paint device used mainly for creating custom <a href="qcursor.html">QCursor</a> and <a href="qbrush.html">QBrush</a> objects, constructing <a href="qregion.html">QRegion</a> objects, and for setting masks for pixmaps and widgets.</p>
<p>QBitmap is a <a href="qpixmap.html">QPixmap</a> subclass ensuring a depth of 1, except for null objects which have a depth of 0. If a pixmap with a depth greater than 1 is assigned to a bitmap, the bitmap will be dithered automatically.</p>
<p>Use the <a href="qcolor.html">QColor</a> objects <a href="qt.html#GlobalColor-enum">Qt::color0</a> and <a href="qt.html#GlobalColor-enum">Qt::color1</a> when drawing on a QBitmap object (or a <a href="qpixmap.html">QPixmap</a> object with depth 1).</p>
<p>Painting with <a href="qt.html#GlobalColor-enum">Qt::color0</a> sets the bitmap bits to 0, and painting with <a href="qt.html#GlobalColor-enum">Qt::color1</a> sets the bits to 1. For a bitmap, 0-bits indicate background (or transparent pixels) and 1-bits indicate foreground (or opaque pixels). Use the <a href="qbitmap.html#clear">clear</a>() function to set all the bits to <a href="qt.html#GlobalColor-enum">Qt::color0</a>. Note that using the <a href="qt.html#GlobalColor-enum">Qt::black</a> and <a href="qt.html#GlobalColor-enum">Qt::white</a> colors make no sense because the <a href="qcolor-qt3.html#pixel" class="compat">QColor::pixel</a>() value is not necessarily 0 for black and 1 for white.</p>
<p>The QBitmap class provides the <a href="qbitmap.html#transformed">transformed</a>() function returning a transformed copy of the bitmap; use the <a href="qtransform.html">QTransform</a> argument to translate, scale, shear, and rotate the bitmap. In addition, QBitmap provides the static <a href="qbitmap.html#fromData">fromData</a>() function which returns a bitmap constructed from the given <tt>uchar</tt> data, and the static <a href="qbitmap.html#fromImage">fromImage</a>() function returning a converted copy of a <a href="qimage.html">QImage</a> object.</p>
<p>Just like the <a href="qpixmap.html">QPixmap</a> class, QBitmap is optimized by the use of implicit data sharing. For more information, see the <a href="implicit-sharing.html#implicit-data-sharing">Implicit Data Sharing</a> documentation.</p>
</div>
<p><b>See also </b><a href="qpixmap.html">QPixmap</a>, <a href="qimage.html">QImage</a>, <a href="qimagereader.html">QImageReader</a>, and <a href="qimagewriter.html">QImageWriter</a>.</p>
<!-- @@@QBitmap -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QBitmap[overload1]$$$QBitmap -->
<h3 class="fn"><a name="QBitmap"></a>QBitmap::<span class="name">QBitmap</span> ()</h3>
<p>Constructs a null bitmap.</p>
<p><b>See also </b><a href="qpixmap.html#isNull">QPixmap::isNull</a>().</p>
<!-- @@@QBitmap -->
<!-- $$$QBitmap$$$QBitmapconstQPixmap& -->
<h3 class="fn"><a name="QBitmap-2"></a>QBitmap::<span class="name">QBitmap</span> ( const <span class="type"><a href="qpixmap.html">QPixmap</a></span> & <i>pixmap</i> )</h3>
<p>Constructs a bitmap that is a copy of the given <i>pixmap</i>.</p>
<p>If the pixmap has a depth greater than 1, the resulting bitmap will be dithered automatically.</p>
<p><b>See also </b><a href="qpixmap.html#depth">QPixmap::depth</a>(), <a href="qbitmap.html#fromImage">fromImage</a>(), and <a href="qbitmap.html#fromData">fromData</a>().</p>
<!-- @@@QBitmap -->
<!-- $$$QBitmap$$$QBitmapintint -->
<h3 class="fn"><a name="QBitmap-3"></a>QBitmap::<span class="name">QBitmap</span> ( <span class="type">int</span> <i>width</i>, <span class="type">int</span> <i>height</i> )</h3>
<p>Constructs a bitmap with the given <i>width</i> and <i>height</i>. The pixels inside are uninitialized.</p>
<p><b>See also </b><a href="qbitmap.html#clear">clear</a>().</p>
<!-- @@@QBitmap -->
<!-- $$$QBitmap$$$QBitmapconstQSize& -->
<h3 class="fn"><a name="QBitmap-4"></a>QBitmap::<span class="name">QBitmap</span> ( const <span class="type"><a href="qsize.html">QSize</a></span> & <i>size</i> )</h3>
<p>Constructs a bitmap with the given <i>size</i>. The pixels in the bitmap are uninitialized.</p>
<p><b>See also </b><a href="qbitmap.html#clear">clear</a>().</p>
<!-- @@@QBitmap -->
<!-- $$$QBitmap$$$QBitmapconstQString&constchar* -->
<h3 class="fn"><a name="QBitmap-5"></a>QBitmap::<span class="name">QBitmap</span> ( const <span class="type"><a href="qstring.html">QString</a></span> & <i>fileName</i>, const <span class="type">char</span> * <i>format</i> = 0 )</h3>
<p>Constructs a bitmap from the file specified by the given <i>fileName</i>. If the file does not exist, or has an unknown format, the bitmap becomes a null bitmap.</p>
<p>The <i>fileName</i> and <i>format</i> parameters are passed on to the <a href="qpixmap.html#load">QPixmap::load</a>() function. If the file format uses more than 1 bit per pixel, the resulting bitmap will be dithered automatically.</p>
<p><b>See also </b><a href="qpixmap.html#isNull">QPixmap::isNull</a>() and <a href="qimagereader.html#imageFormat">QImageReader::imageFormat</a>().</p>
<!-- @@@QBitmap -->
<!-- $$$~QBitmap[overload1]$$$~QBitmap -->
<h3 class="fn"><a name="dtor.QBitmap"></a>QBitmap::<span class="name">~QBitmap</span> ()</h3>
<p>Destroys the bitmap.</p>
<!-- @@@~QBitmap -->
<!-- $$$clear[overload1]$$$clear -->
<h3 class="fn"><a name="clear"></a><span class="type">void</span> QBitmap::<span class="name">clear</span> ()</h3>
<p>Clears the bitmap, setting all its bits to <a href="qt.html#GlobalColor-enum">Qt::color0</a>.</p>
<!-- @@@clear -->
<!-- $$$fromData[overload1]$$$fromDataconstQSize&constuchar*QImage::Format -->
<h3 class="fn"><a name="fromData"></a><span class="type">QBitmap</span> QBitmap::<span class="name">fromData</span> ( const <span class="type"><a href="qsize.html">QSize</a></span> & <i>size</i>, const <span class="type"><a href="qtglobal.html#uchar-typedef">uchar</a></span> * <i>bits</i>, <span class="type"><a href="qimage.html#Format-enum">QImage::Format</a></span> <i>monoFormat</i> = QImage::Format_MonoLSB )<tt> [static]</tt></h3>
<p>Constructs a bitmap with the given <i>size</i>, and sets the contents to the <i>bits</i> supplied.</p>
<p>The bitmap data has to be byte aligned and provided in in the bit order specified by <i>monoFormat</i>. The mono format must be either <a href="qimage.html#Format-enum">QImage::Format_Mono</a> or <a href="qimage.html#Format-enum">QImage::Format_MonoLSB</a>. Use <a href="qimage.html#Format-enum">QImage::Format_Mono</a> to specify data on the XBM format.</p>
<p><b>See also </b><a href="qbitmap.html#fromImage">fromImage</a>().</p>
<!-- @@@fromData -->
<!-- $$$fromImage[overload1]$$$fromImageconstQImage&Qt::ImageConversionFlags -->
<h3 class="fn"><a name="fromImage"></a><span class="type">QBitmap</span> QBitmap::<span class="name">fromImage</span> ( const <span class="type"><a href="qimage.html">QImage</a></span> & <i>image</i>, <span class="type"><a href="qt.html#ImageConversionFlag-enum">Qt::ImageConversionFlags</a></span> <i>flags</i> = Qt::AutoColor )<tt> [static]</tt></h3>
<p>Returns a copy of the given <i>image</i> converted to a bitmap using the specified image conversion <i>flags</i>.</p>
<p><b>See also </b><a href="qbitmap.html#fromData">fromData</a>().</p>
<!-- @@@fromImage -->
<!-- $$$swap[overload1]$$$swapQBitmap& -->
<h3 class="fn"><a name="swap"></a><span class="type">void</span> QBitmap::<span class="name">swap</span> ( <span class="type">QBitmap</span> & <i>other</i> )</h3>
<p>Swaps bitmap <i>other</i> with this bitmap. This operation is very fast and never fails.</p>
<p>This function was introduced in Qt 4.8.</p>
<!-- @@@swap -->
<!-- $$$transformed[overload1]$$$transformedconstQTransform& -->
<h3 class="fn"><a name="transformed"></a><span class="type">QBitmap</span> QBitmap::<span class="name">transformed</span> ( const <span class="type"><a href="qtransform.html">QTransform</a></span> & <i>matrix</i> ) const</h3>
<p>Returns a copy of this bitmap, transformed according to the given <i>matrix</i>.</p>
<p><b>See also </b><a href="qpixmap.html#transformed">QPixmap::transformed</a>().</p>
<!-- @@@transformed -->
<!-- $$$operator QVariant[overload1]$$$operator QVariant -->
<h3 class="fn"><a name="operator-QVariant"></a>QBitmap::<span class="name">operator QVariant</span> () const</h3>
<p>Returns the bitmap as a <a href="qvariant.html">QVariant</a>.</p>
<!-- @@@operator QVariant -->
<!-- $$$operator=[overload1]$$$operator=constQPixmap& -->
<h3 class="fn"><a name="operator-eq"></a><span class="type">QBitmap</span> & QBitmap::<span class="name">operator=</span> ( const <span class="type"><a href="qpixmap.html">QPixmap</a></span> & <i>pixmap</i> )</h3>
<p>This is an overloaded function.</p>
<p>Assigns the given <i>pixmap</i> to this bitmap and returns a reference to this bitmap.</p>
<p>If the pixmap has a depth greater than 1, the resulting bitmap will be dithered automatically.</p>
<p><b>See also </b><a href="qpixmap.html#depth">QPixmap::depth</a>().</p>
<!-- @@@operator= -->
</div>
</div>
</div>
</div>
<div class="ft">
<span></span>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2015 The Qt Company Ltd.
Documentation contributions included herein are the copyrights of
their respective owners.</p>
<br />
<p>
The documentation provided herein is licensed under the terms of the
<a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
License version 1.3</a> as published by the Free Software Foundation.</p>
<p>
Documentation sources may be obtained from <a href="http://www.qt-project.org">
www.qt-project.org</a>.</p>
<br />
<p>
Qt and respective logos are trademarks of The Qt Company Ltd
in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. <a title="Privacy Policy"
href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
<script src="scripts/functions.js" type="text/javascript"></script>
</body>
</html>
