QImageReader Class

Documentación de las funciones miembro

QImageReader::QImageReader()

Construye un objeto QImageReader vacío. Antes de leer una imagen, llame a setDevice() o setFileName().

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

Construye un objeto QImageReader con el dispositivo device y el formato de imagen format.

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

Construye un objeto QImageReader con el nombre de archivo fileName y el formato de imagen format.

Véase también setFileName().

[noexcept] QImageReader::~QImageReader()

Destruye el objeto QImageReader.

[static, since 6.0] int QImageReader::allocationLimit()

Devuelve el límite de asignación actual, en megabytes.

Esta función se introdujo en Qt 6.0.

Véase también setAllocationLimit().

bool QImageReader::autoDetectImageFormat() const

Devuelve true si la autodetección del formato de imagen está activada en este lector de imágenes; en caso contrario, devuelve false. Por defecto, la autodetección está activada.

Véase también setAutoDetectImageFormat().

bool QImageReader::autoTransform() const

Devuelve true si el gestor de imágenes aplicará metadatos de transformación en read().

Véase también setAutoTransform(), transformation() y read().

QColor QImageReader::backgroundColor() const

Devuelve el color de fondo que se utiliza al leer una imagen. Si el formato de la imagen no permite establecer el color de fondo, se devuelve un color no válido.

Véase también setBackgroundColor() y read().

bool QImageReader::canRead() const

Devuelve true si se puede leer una imagen para el dispositivo (es decir, el formato de imagen es compatible y el dispositivo parece contener datos válidos); de lo contrario devuelve false.

canRead() es una función ligera que sólo hace una prueba rápida para ver si los datos de la imagen son válidos. read() puede devolver false después de que canRead() devuelva true, si los datos de la imagen están corruptos.

Para las imágenes que admiten animación, canRead() devuelve false cuando se han leído todos los fotogramas.

Véase también read(), supportedImageFormats(), y QMimeDatabase.

QRect QImageReader::clipRect() const

Devuelve el rectángulo de recorte (también conocido como ROI o región de interés) de la imagen. Si no se ha establecido ningún rectángulo de recorte, se devuelve un QRect no válido.

Véase también setClipRect().

int QImageReader::currentImageNumber() const

Para formatos de imagen que soportan animación, esta función devuelve el número de secuencia del fotograma actual. Si el formato de imagen no soporta animación, devuelve 0.

Esta función devuelve -1 si se ha producido un error.

Véase también supportsAnimation(), QImageIOHandler::currentImageNumber() y canRead().

QRect QImageReader::currentImageRect() const

En los formatos de imagen que admiten animación, esta función devuelve el rectángulo del fotograma actual. En caso contrario, devuelve un rect nulo.

Véase también supportsAnimation() y QImageIOHandler::currentImageRect().

bool QImageReader::decideFormatFromContent() const

Devuelve si el lector de imágenes debe decidir qué complemento utilizar basándose únicamente en el contenido del flujo de datos y no en la extensión del archivo.

Véase también setDecideFormatFromContent().

QIODevice *QImageReader::device() const

Devuelve el dispositivo actualmente asignado a QImageReader, o nullptr si no se ha asignado ningún dispositivo.

Véase también setDevice().

QImageReader::ImageReaderError QImageReader::error() const

Devuelve el tipo de error que se ha producido en último lugar.

Véase también ImageReaderError y errorString().

QString QImageReader::errorString() const

Devuelve una descripción legible por humanos del último error que se ha producido.

Véase también error().

QString QImageReader::fileName() const

Si el dispositivo actualmente asignado es un QFile, o si se ha llamado a setFileName(), esta función devuelve el nombre del archivo del que QImageReader lee. En caso contrario (es decir, si no se ha asignado ningún dispositivo o el dispositivo no es un QFile), se devuelve un QString vacío.

Véase también setFileName() y setDevice().

QByteArray QImageReader::format() const

Devuelve el formato que utiliza QImageReader para leer imágenes.

Puede llamar a esta función después de asignar un dispositivo al lector para determinar el formato del dispositivo. Por ejemplo:

QImageReader reader("image.png");
// reader.format() == "png"

Si el lector no puede leer ninguna imagen del dispositivo (por ejemplo, no hay ninguna imagen allí, o la imagen ya ha sido leída), o si el formato no es compatible, esta función devuelve un QByteArray() vacío.

Véase también setFormat() y supportedImageFormats().

int QImageReader::imageCount() const

Para los formatos de imagen que admiten animación, esta función devuelve el número total de imágenes de la animación. Si el formato no soporta animación, devuelve 0.

Esta función devuelve -1 si se ha producido un error.

Véase también supportsAnimation(), QImageIOHandler::imageCount() y canRead().

QImage::Format QImageReader::imageFormat() const

Devuelve el formato de la imagen, sin leer realmente el contenido de la imagen. El formato describe el formato de imagen que devuelve QImageReader::read(), no el formato de la imagen real.

Si el formato de la imagen no soporta esta característica, esta función devuelve un formato inválido.

Véase también QImageIOHandler::ImageOption, QImageIOHandler::option(), y QImageIOHandler::supportsOption().

[static] QByteArray QImageReader::imageFormat(QIODevice *device)

Si es compatible, esta función devuelve el formato de imagen del dispositivo device. En caso contrario, devuelve una cadena vacía.

Véase también QImageReader::autoDetectImageFormat().

[static] QByteArray QImageReader::imageFormat(const QString &fileName)

Si es compatible, esta función devuelve el formato de imagen del archivo fileName. En caso contrario, devuelve una cadena vacía.

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

Devuelve la lista de formatos de imagen correspondientes a mimeType.

Tenga en cuenta que la instancia QGuiApplication debe crearse antes de llamar a esta función.

Véase también supportedImageFormats() y supportedMimeTypes().

bool QImageReader::jumpToImage(int imageNumber)

Para los formatos de imagen que admiten animación, esta función salta a la imagen cuyo número de secuencia es imageNumber, devolviendo true si tiene éxito o false si no se puede encontrar la imagen correspondiente.

La siguiente llamada a read() intentará leer esta imagen.

Véase también jumpToNextImage() y QImageIOHandler::jumpToImage().

bool QImageReader::jumpToNextImage()

Para formatos de imagen que soportan animación, esta función pasa por encima de la imagen actual, devolviendo true si tiene éxito o false si no hay ninguna imagen siguiente en la animación.

La implementación por defecto llama a read(), y luego descarta la imagen resultante, pero el manejador de la imagen puede tener una forma más eficiente de implementar esta operación.

Véase también jumpToImage() y QImageIOHandler::jumpToNextImage().

int QImageReader::loopCount() const

Para formatos de imagen que soportan animación, esta función devuelve el número de veces que la animación debe repetirse. Si esta función devuelve -1, puede significar que la animación debe repetirse para siempre o que se ha producido un error. Si se ha producido un error, canRead() devolverá false.

Véase también supportsAnimation(), QImageIOHandler::loopCount(), y canRead().

int QImageReader::nextImageDelay() const

Para formatos de imagen que soportan animación, esta función devuelve el número de milisegundos a esperar hasta mostrar el siguiente fotograma de la animación. Si el formato de imagen no soporta animación, devuelve 0.

Esta función devuelve -1 si se ha producido un error.

Véase también supportsAnimation(), QImageIOHandler::nextImageDelay() y canRead().

int QImageReader::quality() const

Devuelve la configuración de calidad del formato de imagen.

Véase también setQuality().

QImage QImageReader::read()

Lee una imagen del dispositivo. En caso de éxito, se devuelve la imagen leída; en caso contrario, se devuelve un valor nulo QImage. A continuación, puede llamar a error() para averiguar el tipo de error que se ha producido, o a errorString() para obtener una descripción legible del error.

En los formatos de imagen que admiten animación, si se llama repetidamente a read() se devolverá el siguiente fotograma. Cuando se hayan leído todos los fotogramas, se devolverá una imagen nula.

Véase también canRead(), supportedImageFormats(), supportsAnimation(), y QMovie.

bool QImageReader::read(QImage *image)

Lee una imagen del dispositivo en image, que debe apuntar a QImage. Devuelve true en caso de éxito; en caso contrario, devuelve false.

Si image tiene el mismo formato y tamaño que los datos de la imagen que se va a leer, puede que esta función no necesite asignar una nueva imagen antes de la lectura. Debido a esto, puede ser más rápida que la otra sobrecarga de read(), que siempre construye una nueva imagen; especialmente cuando se leen varias imágenes con el mismo formato y tamaño.

QImage icon(64, 64, QImage::Format_RGB32);
QImageReader reader("icon_64x64.bmp");
if (reader.read(&icon)) {
    // Display icon
}

Para formatos de imagen que soportan animación, llamar a read() repetidamente devolverá el siguiente fotograma. Cuando se hayan leído todos los fotogramas, se devolverá una imagen nula.

Véase también canRead(), supportedImageFormats(), supportsAnimation(), y QMovie.

QRect QImageReader::scaledClipRect() const

Devuelve el rectángulo de recorte escalado de la imagen.

Véase también setScaledClipRect().

QSize QImageReader::scaledSize() const

Devuelve el tamaño escalado de la imagen.

Véase también setScaledSize().

[static, since 6.0] void QImageReader::setAllocationLimit(int mbLimit)

Establece el límite de asignación en mbLimit megabytes. Las imágenes que requieran una asignación de memoria de QImage por encima de este límite serán rechazadas. Si mbLimit es 0, se desactivará la comprobación del tamaño de la asignación.

Este límite ayuda a las aplicaciones a evitar el uso inesperado de mucha memoria al cargar archivos de imagen corruptos. Normalmente no es necesario cambiarlo. El límite por defecto es lo suficientemente grande para todos los tamaños de imagen de uso común.

En tiempo de ejecución, este valor puede anularse mediante la variable de entorno QT_IMAGEIO_MAXALLOC.

Esta función se introdujo en Qt 6.0.

Véase también allocationLimit().

void QImageReader::setAutoDetectImageFormat(bool enabled)

Si enabled es verdadero, se activa la autodetección del formato de imagen; en caso contrario, se desactiva. Por defecto, la autodetección está activada.

QImageReader utiliza un método extenso para detectar el formato de imagen; en primer lugar, si pasa un nombre de archivo a QImageReader, intentará detectar la extensión del archivo si el nombre de archivo dado no apunta a un archivo existente, añadiendo extensiones por defecto compatibles al nombre de archivo dado, de una en una. A continuación, utiliza el siguiente método para detectar el formato de imagen:

• Los plugins de imagen se consultan primero, basándose en la cadena de formato opcional o en el sufijo del nombre de archivo (si el dispositivo de origen es un archivo). En esta fase no se realiza ninguna detección del contenido. QImageReader elegirá el primer plugin que admita la lectura de este formato.
• Si ningún plugin soporta el formato de imagen, se comprueban los manejadores integrados de Qt basándose en la cadena de formato opcional o en el sufijo del nombre del archivo.
• Si no se encuentran plugins capaces o manejadores incorporados, cada plugin se comprueba inspeccionando el contenido del flujo de datos.
• Si ningún plugin puede detectar el formato de la imagen basándose en el contenido de los datos, se comprueba cada gestor de imágenes integrado inspeccionando el contenido.
• Por último, si todos los métodos anteriores fallan, QImageReader informará de un error al intentar leer la imagen.

Al desactivar la autodetección del formato de imagen, QImageReader sólo consultará los plugins y los gestores integrados basándose en la cadena de formato (es decir, no se comprueban las extensiones de los nombres de archivo).

Véase también autoDetectImageFormat(), QImageIOHandler::canRead() y QImageIOPlugin::capabilities().

void QImageReader::setAutoTransform(bool enabled)

Determina que las imágenes devueltas por read() deben tener metadatos de transformación aplicados automáticamente si enabled es true.

Véase también autoTransform(), transformation() y read().

void QImageReader::setBackgroundColor(const QColor &color)

Establece el color de fondo a color. Se espera que los formatos de imagen que soportan esta operación inicialicen el fondo a color antes de leer una imagen.

Véase también backgroundColor() y read().

void QImageReader::setClipRect(const QRect &rect)

Establece el rectángulo de recorte de la imagen (también conocido como ROI, o región de interés) en rect. Las coordenadas de rect son relativas al tamaño de la imagen sin transformar, tal y como devuelve size().

Véase también clipRect(), setScaledSize() y setScaledClipRect().

void QImageReader::setDecideFormatFromContent(bool ignored)

Si ignored es verdadero, el lector de imágenes ignorará los formatos o extensiones de archivo especificados y decidirá qué complemento utilizar basándose únicamente en el contenido del flujo de datos.

Si se activa esta opción, se cargarán todos los complementos de imagen. Cada plugin leerá los primeros bytes de los datos de la imagen y decidirá si el plugin es compatible o no.

Esto también desactiva la detección automática del formato de imagen.

Véase también decideFormatFromContent().

void QImageReader::setDevice(QIODevice *device)

Establece el dispositivo de QImageReader en device. Si ya se ha establecido un dispositivo, el dispositivo antiguo se elimina de QImageReader y, de lo contrario, se deja sin cambios.

Si el dispositivo aún no está abierto, QImageReader intentará abrir el dispositivo en modo ReadOnly llamando a open(). Tenga en cuenta que esto no funciona para ciertos dispositivos, como QProcess, QTcpSocket y QUdpSocket, donde se requiere más lógica para abrir el dispositivo.

Véase también device() y setFileName().

void QImageReader::setFileName(const QString &fileName)

Establece el nombre de archivo de QImageReader en fileName. Internamente, QImageReader creará un objeto QFile y lo abrirá en modo ReadOnly, y lo utilizará cuando lea imágenes.

Si fileName no incluye una extensión de archivo (por ejemplo, .png o .bmp), QImageReader recorrerá todas las extensiones admitidas hasta que encuentre un archivo que coincida.

Véase también fileName(), setDevice(), y supportedImageFormats().

void QImageReader::setFormat(const QByteArray &format)

Establece el formato que utilizará QImageReader al leer imágenes, en format. format es una cadena de texto que no distingue mayúsculas de minúsculas. Ejemplo:

QImageReader reader;
reader.setFormat("png"); // same as reader.setFormat("PNG");

Puede llamar a supportedImageFormats() para obtener la lista completa de formatos que admite QImageReader.

Véase también format().

void QImageReader::setQuality(int quality)

Establece la configuración de calidad del formato de imagen en quality.

Algunos formatos de imagen, en particular los que tienen pérdidas, implican un compromiso entre a) la calidad visual de la imagen resultante y b) el tiempo de ejecución de la descodificación. Esta función establece el nivel de ese compromiso para los formatos de imagen que lo admiten.

En el caso de la lectura de imágenes escaladas, la configuración de la calidad también puede influir en el nivel de compensación entre la calidad visual y la velocidad de ejecución del algoritmo de escalado.

El rango de valores de quality depende del formato de imagen. Por ejemplo, el formato "jpeg" admite un rango de calidad de 0 (baja calidad visual) a 100 (alta calidad visual).

Véase también quality() y setScaledSize().

void QImageReader::setScaledClipRect(const QRect &rect)

Establece el rectángulo de recorte escalado en rect. El rectángulo de recorte escalado es el rectángulo de recorte (también conocido como ROI, o Región de Interés) que se aplica después de escalar la imagen.

Véase también scaledClipRect() y setScaledSize().

void QImageReader::setScaledSize(const QSize &size)

Establece el tamaño escalado de la imagen en size. El escalado se realiza después del rectángulo de recorte inicial, pero antes de que se aplique el rectángulo de recorte escalado. El algoritmo utilizado para el escalado depende del formato de la imagen. Por defecto (es decir, si el formato de imagen no soporta escalado), QImageReader utilizará QImage::scale() con Qt::SmoothScaling.

Si sólo se establece una dimensión en size, la otra se calculará a partir de la natural size de la imagen para mantener la relación de aspecto.

Véase también scaledSize(), setClipRect(), y setScaledClipRect().

QSize QImageReader::size() const

Devuelve el tamaño de la imagen sin leer su contenido.

Si el formato de imagen no soporta esta característica, esta función devuelve un tamaño inválido. Todos los manejadores de imagen incorporados en Qt soportan esta característica, pero los plugins de formato de imagen personalizados no están obligados a hacerlo.

Véase también QImageIOHandler::ImageOption, QImageIOHandler::option(), y QImageIOHandler::supportsOption().

QByteArray QImageReader::subType() const

Devuelve el subtipo de la imagen.

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

Devuelve la lista de formatos de imagen soportados por QImageReader.

Por defecto, Qt puede leer los siguientes formatos:

La lectura y escritura de archivos SVG se realiza a través del módulo Qt SVG módulo. El módulo Qt Image Formats ofrece soporte para otros formatos de imagen.

Tenga en cuenta que la instancia QCoreApplication debe crearse antes de llamar a esta función.

Véase también setFormat(), QImageWriter::supportedImageFormats(), y QImageIOPlugin.

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

Devuelve la lista de tipos MIME soportados por QImageReader.

Tenga en cuenta que la instancia QApplication debe crearse antes de llamar a esta función.

Véase también supportedImageFormats() y QImageWriter::supportedMimeTypes().

QList<QByteArray> QImageReader::supportedSubTypes() const

Devuelve la lista de subtipos admitidos por una imagen.

bool QImageReader::supportsAnimation() const

Devuelve true si el formato de imagen admite animación; en caso contrario, devuelve false.

Véase también QMovie::supportedFormats().

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

Devuelve true si el lector soporta option; en caso contrario devuelve false.

Diferentes formatos de imagen soportan diferentes opciones. Llame a esta función para determinar si una determinada opción es compatible con el formato actual. Por ejemplo, el formato PNG permite incrustar texto en los metadatos de la imagen (véase text()), y el formato BMP permite determinar el tamaño de la imagen sin cargar toda la imagen en memoria (véase size()).

QImageReader reader(":/image.png");if (reader.supportsOption(QImageIOHandler::Tamaño))    qDebug() << "Size:" << reader.size();

Véase también QImageWriter::supportsOption().

QString QImageReader::text(const QString &key) const

Devuelve el texto de la imagen asociada a key.

El soporte para esta opción se implementa a través de QImageIOHandler::Description.

Véase también textKeys() y QImageWriter::setText().

QStringList QImageReader::textKeys() const

Devuelve las claves de texto de esta imagen. Puede utilizar estas claves con text() para listar el texto de la imagen para una clave determinada.

El soporte para esta opción se implementa a través de QImageIOHandler::Description.

Véase también text(), QImageWriter::setText() y QImage::textKeys().

QImageIOHandler::Transformations QImageReader::transformation() const

Devuelve los metadatos de transformación de la imagen, incluida la orientación de la imagen. Si el formato no admite metadatos de transformación, se devuelve QImageIOHandler::TransformationNone.

Véase también setAutoTransform() y autoTransform().