QImageWriter Class

Dokumentation der Mitgliedsfunktionen

QImageWriter::QImageWriter()

Konstruiert ein leeres QImageWriter-Objekt. Vor dem Schreiben müssen Sie setFormat() aufrufen, um ein Bildformat festzulegen, dann setDevice() oder setFileName().

[explicit] QImageWriter::QImageWriter(QIODevice *device, const QByteArray &format)

Konstruiert ein QImageWriter-Objekt unter Verwendung des Geräts device und des Bildformats format.

[explicit] QImageWriter::QImageWriter(const QString &fileName, const QByteArray &format = QByteArray())

Konstruiert ein QImageWriter-Objekt, das in eine Datei mit dem Namen fileName schreibt, wobei das Bildformat format verwendet wird. Wenn format nicht angegeben wird, erkennt QImageWriter das Bildformat anhand der Erweiterung von fileName.

[noexcept] QImageWriter::~QImageWriter()

Zerstört das Objekt QImageWriter.

bool QImageWriter::canWrite() const

Gibt true zurück, wenn QImageWriter das Bild schreiben kann, d. h., das Bildformat wird unterstützt und das zugewiesene Gerät ist zum Lesen geöffnet.

Siehe auch write(), setDevice(), und setFormat().

int QImageWriter::compression() const

Gibt die Komprimierung des Bildes zurück.

Siehe auch setCompression().

QIODevice *QImageWriter::device() const

Gibt das Gerät zurück, das derzeit QImageWriter zugewiesen ist, oder nullptr, wenn kein Gerät zugewiesen wurde.

Siehe auch setDevice().

QImageWriter::ImageWriterError QImageWriter::error() const

Gibt den Typ des zuletzt aufgetretenen Fehlers zurück.

Siehe auch ImageWriterError und errorString().

QString QImageWriter::errorString() const

Gibt eine menschenlesbare Beschreibung des letzten aufgetretenen Fehlers zurück.

Siehe auch error().

QString QImageWriter::fileName() const

Wenn das aktuell zugewiesene Gerät eine Datei ist oder wenn setFileName() aufgerufen wurde, gibt diese Funktion den Namen der Datei zurück, in die QImageWriter schreibt. Andernfalls (d.h., wenn kein Gerät zugewiesen wurde oder das Gerät keine Datei ist), wird ein leeres QString zurückgegeben.

Siehe auch setFileName() und setDevice().

QByteArray QImageWriter::format() const

Gibt das Format zurück, das QImageWriter zum Schreiben von Bildern verwendet.

Siehe auch setFormat().

[static] QList<QByteArray> QImageWriter::imageFormatsForMimeType(const QByteArray &mimeType)

Gibt die Liste der Bildformate zurück, die mimeType entsprechen.

Beachten Sie, dass die Instanz QGuiApplication erstellt werden muss, bevor diese Funktion aufgerufen wird.

Siehe auch supportedImageFormats() und supportedMimeTypes().

bool QImageWriter::optimizedWrite() const

Gibt zurück, ob die Optimierung für das Schreiben des Bildes eingeschaltet wurde.

Siehe auch setOptimizedWrite().

bool QImageWriter::progressiveScanWrite() const

Gibt zurück, ob das Bild als progressives Bild geschrieben werden soll.

Siehe auch setProgressiveScanWrite().

int QImageWriter::quality() const

Gibt die Qualitätseinstellung des Bildformats zurück.

Siehe auch setQuality().

void QImageWriter::setCompression(int compression)

Dies ist eine bildformatspezifische Funktion, die die Komprimierung eines Bildes festlegt. Bei Bildformaten, die die Einstellung der Komprimierung nicht unterstützen, wird dieser Wert ignoriert.

Der Wertebereich von compression hängt vom jeweiligen Bildformat ab. Das "tiff"-Format unterstützt zum Beispiel zwei Werte, 0 (keine Kompression) und 1 (LZW-Kompression).

Siehe auch compression().

void QImageWriter::setDevice(QIODevice *device)

Setzt das Gerät von QImageWriter auf device. Wenn bereits ein Gerät gesetzt wurde, wird das alte Gerät aus QImageWriter entfernt und ansonsten unverändert belassen.

Wenn das Gerät noch nicht geöffnet ist, versucht QImageWriter, das Gerät im Modus QIODeviceBase::WriteOnly durch Aufruf von open() zu öffnen. Beachten Sie, dass dies bei bestimmten Geräten nicht funktioniert, wie z. B. QProcess, QTcpSocket und QUdpSocket, bei denen mehr Logik zum Öffnen des Geräts erforderlich ist.

Siehe auch device() und setFileName().

void QImageWriter::setFileName(const QString &fileName)

Setzt den Dateinamen von QImageWriter auf fileName. Intern erstellt QImageWriter eine Datei QFile, öffnet diese im Modus QIODevice::WriteOnly und verwendet diese Datei beim Schreiben von Bildern.

Siehe auch fileName() und setDevice().

void QImageWriter::setFormat(const QByteArray &format)

Legt das Format, das QImageWriter beim Schreiben von Bildern verwendet, auf format fest. format ist eine von der Groß- und Kleinschreibung unabhängige Textzeichenfolge. Beispiel:

QImageWriter writer;
writer.setFormat("png"); // same as writer.setFormat("PNG");

Sie können supportedImageFormats() aufrufen, um die vollständige Liste der Formate zu erhalten, die QImageWriter unterstützt.

Siehe auch format().

void QImageWriter::setOptimizedWrite(bool optimize)

Dies ist eine bildformatspezifische Funktion, die die optimize -Flags beim Schreiben von Bildern setzt. Bei Bildformaten, die das Setzen eines optimize -Flags nicht unterstützen, wird dieser Wert ignoriert.

Der Standardwert ist false.

Siehe auch optimizedWrite().

void QImageWriter::setProgressiveScanWrite(bool progressive)

Dies ist eine bildformatspezifische Funktion, die das Scannen von progressive beim Schreiben von Bildern aktiviert. Bei Bildformaten, die das Setzen eines progressive Scan-Flags nicht unterstützen, wird dieser Wert ignoriert.

Der Standardwert ist false.

Siehe auch progressiveScanWrite().

void QImageWriter::setQuality(int quality)

Setzt die Qualitätseinstellung des Bildformats auf quality.

Einige Bildformate, insbesondere verlustbehaftete Formate, bringen einen Kompromiss zwischen a) der visuellen Qualität des resultierenden Bildes und b) der Kodierungsausführungszeit und dem Komprimierungsgrad mit sich. Diese Funktion legt den Grad dieses Kompromisses für Bildformate fest, die ihn unterstützen. Für andere Formate wird dieser Wert ignoriert.

Der Wertebereich von quality hängt vom Bildformat ab. Das "jpeg"-Format unterstützt beispielsweise einen Qualitätsbereich von 0 (niedrige visuelle Qualität, hohe Kompression) bis 100 (hohe visuelle Qualität, niedrige Kompression).

Siehe auch quality().

void QImageWriter::setSubType(const QByteArray &type)

Dies ist eine bildformatspezifische Funktion, die den Subtyp des Bildes auf type setzt. Subtyp kann von einem Handler verwendet werden, um zu bestimmen, welches Format er beim Speichern des Bildes verwenden soll.

Beispiel: Speichern eines Bildes im DDS-Format mit dem Subtyp A8R8G8R8:

QImageWriter writer("some/image.dds");
if (writer.supportsOption(QImageIOHandler::SubType))
    writer.setSubType("A8R8G8B8");
writer.write(image);

Siehe auch subType().

void QImageWriter::setText(const QString &key, const QString &text)

Setzt den Bildtext, der mit dem Schlüssel key verknüpft ist, auf text. Dies ist nützlich, um Copyright-Informationen oder andere Informationen über das Bild zu speichern. Beispiel:

QImage image("some/image.jpeg");
QImageWriter writer("images/outimage.png", "png");
writer.setText("Author", "John Smith");
writer.write(image);

Wenn Sie einen einzelnen Datenblock (z. B. einen Kommentar) speichern möchten, können Sie einen leeren Schlüssel übergeben oder einen generischen Schlüssel wie "Beschreibung" verwenden.

Der Schlüssel und der Text werden nach dem Aufruf von write() in die Bilddaten eingebettet.

Die Unterstützung für diese Option wird durch QImageIOHandler::Description implementiert.

Siehe auch QImage::setText() und QImageReader::text().

void QImageWriter::setTransformation(QImageIOHandler::Transformations transform)

Setzt die Metadaten für die Bildtransformation einschließlich der Ausrichtung auf transform.

Wenn Transformations-Metadaten vom Bildformat nicht unterstützt werden, wird die Transformation vor dem Schreiben angewendet.

Siehe auch transformation() und write().

QByteArray QImageWriter::subType() const

Gibt den Subtyp des Bildes zurück.

Siehe auch setSubType().

[static] QList<QByteArray> QImageWriter::supportedImageFormats()

Gibt die Liste der von QImageWriter unterstützten Bildformate zurück.

Standardmäßig kann Qt die folgenden Formate schreiben:

Das Lesen und Schreiben von SVG-Dateien wird durch das Qt SVG Modul unterstützt. Das Modul Qt Image Formats Modul bietet Unterstützung für weitere Bildformate.

Beachten Sie, dass die Instanz QApplication erstellt werden muss, bevor diese Funktion aufgerufen wird.

Siehe auch setFormat(), QImageReader::supportedImageFormats(), und QImageIOPlugin.

[static] QList<QByteArray> QImageWriter::supportedMimeTypes()

Gibt die Liste der von QImageWriter unterstützten MIME-Typen zurück.

Beachten Sie, dass die Instanz QApplication erstellt werden muss, bevor diese Funktion aufgerufen wird.

Siehe auch supportedImageFormats() und QImageReader::supportedMimeTypes().

QList<QByteArray> QImageWriter::supportedSubTypes() const

Gibt die Liste der von einem Bild unterstützten Subtypen zurück.

bool QImageWriter::supportsOption(QImageIOHandler::ImageOption option) const

Gibt true zurück, wenn der Writer option unterstützt; andernfalls wird false zurückgegeben.

Verschiedene Bildformate unterstützen verschiedene Optionen. Rufen Sie diese Funktion auf, um festzustellen, ob eine bestimmte Option vom aktuellen Format unterstützt wird. Das PNG-Format erlaubt es zum Beispiel, Text in die Metadaten des Bildes einzubetten (siehe text()).

QImageWriter writer(fileName);
if (writer.supportsOption(QImageIOHandler::Description))
    writer.setText("Author", "John Smith");

Optionen können getestet werden, nachdem der Writer mit einem Format verknüpft wurde.

Siehe auch QImageReader::supportsOption() und setFormat().

QImageIOHandler::Transformations QImageWriter::transformation() const

Gibt die Transformation und Ausrichtung zurück, mit der das Bild geschrieben wurde.

Siehe auch setTransformation().

bool QImageWriter::write(const QImage &image)

Schreibt das Bild image auf das zugewiesene Gerät oder den Dateinamen. Gibt bei Erfolg true zurück, andernfalls false. Wenn der Vorgang fehlschlägt, können Sie error() aufrufen, um die Art des aufgetretenen Fehlers zu ermitteln, oder errorString(), um eine von Menschen lesbare Beschreibung des Fehlers zu erhalten.

Siehe auch canWrite(), error(), und errorString().