QQuickImageProvider Class

Description détaillée

QQuickImageProvider est utilisé pour fournir des fonctionnalités avancées de chargement d’images dans les applications QML. Il permet aux images dans QML d’être :

• Chargées à l’aide de QPixmaps plutôt que de fichiers image réels
• soient chargées de manière asynchrone dans un thread séparé

Pour spécifier qu'une image doit être chargée par un fournisseur d'images, utilisez le schéma « image: » pour la source URL de l'image, suivi des identifiants du fournisseur d'images et de l'image demandée. Par exemple :

Image { source: "image://myimageprovider/image.png" }

Cela spécifie que l'image doit être chargée par le fournisseur d'images nommé « myimageprovider », et que l'image à charger s'appelle « image.png ». Le moteur QML invoque le fournisseur d'images approprié en fonction des fournisseurs qui ont été enregistrés via QQmlEngine::addImageProvider().

Notez que les identifiants ne sont pas sensibles à la casse, mais que le reste de l’URL sera transmis en conservant la casse d’origine. Par exemple, l’extrait de code ci-dessous spécifierait toujours que l’image doit être chargée par le fournisseur d’images nommé « myimageprovider », mais il demanderait une image différente de celle de l’extrait de code ci-dessus (« Image.png » au lieu de « image.png »).

Image { source: "image://MyImageProvider/Image.png" }

Si vous souhaitez que le reste de l’URL ne soit pas sensible à la casse, vous devrez vous en charger vous-même au sein de votre fournisseur d’images.

Un exemple

Voici deux images. Leurs valeurs source indiquent qu’elles doivent être chargées par un fournisseur d’images nommé « colors », et les images à charger sont respectivement « yellow » et « red » :

Column {
    Image { source: "image://colors/yellow" }
    Image { source: "image://colors/red" }
}

Lorsque ces images sont chargées par QML, celui-ci recherche un fournisseur d’images correspondant et appelle sa méthode ` requestImage()` ou ` requestPixmap()` (en fonction de sa méthode ` imageType()`) pour charger l’image. La méthode est appelée avec le paramètre ` id ` défini sur « yellow » pour la première image et sur « red » pour la seconde.

Voici une implémentation de fournisseur d’images capable de charger les images demandées par le code QML ci-dessus. Cette implémentation génère dynamiquement des images QPixmap remplies de la couleur demandée :

class ColorImageProvider : public QQuickImageProvider
{
public:
    ColorImageProvider()
               : QQuickImageProvider(QQuickImageProvider::Pixmap)
    {
    }

    QPixmap requestPixmap(const QString &id, QSize *size, const QSize &requestedSize) override
    {
       int width = 100;
       int height = 50;

       if (size)
          *size = QSize(width, height);
       QPixmap pixmap(requestedSize.width() > 0 ? requestedSize.width() : width,
                      requestedSize.height() > 0 ? requestedSize.height() : height);
       pixmap.fill(QColor(id).rgba());
       return pixmap;
    }
};

Pour rendre ce fournisseur accessible à QML, il est enregistré auprès du moteur QML avec l’identifiant « colors » :

int main(int argc, char *argv[])
{

    QQuickView view;
    QQmlEngine *engine = view.engine();
    engine->addImageProvider(QLatin1String("colors"), new ColorImageProvider);
    view.setSource(QUrl::fromLocalFile(QStringLiteral("imageprovider-example.qml")));
    view.show();
    return app.exec();
}

Les images peuvent désormais être chargées avec succès dans le code QML :

Consultez l’exemple de fournisseur d’images pour l’implémentation complète. Notez que l’exemple enregistre le fournisseur via une plugin au lieu de l’enregistrer dans la fonction d’ main() ation de l’application comme indiqué ci-dessus.

Il est possible de fournir une "@nx" high DPI syntax.

Chargement asynchrone des images

Les fournisseurs d’images prenant en charge l’ QImage ou le chargement de textures incluent automatiquement la prise en charge du chargement asynchrone des images. Pour activer le chargement asynchrone d’une source d’image, définissez la propriété ` asynchronous ` sur ` true ` pour l’objet ` Image ` ou ` BorderImage ` concerné. Lorsque cette option est activée, la requête d’image adressée au fournisseur s’exécute dans un thread à faible priorité, ce qui permet d’effectuer le chargement de l’image en arrière-plan et de réduire l’impact sur les performances de l’interface utilisateur.

Pour forcer le chargement asynchrone des images, même pour les sources d’images dont la propriété ` asynchronous ` n’est pas définie sur ` true`, vous pouvez transmettre le drapeau ` QQmlImageProviderBase::ForceAsynchronousImageLoading ` au constructeur du fournisseur d’images. Cela garantit que toutes les requêtes d’images adressées au fournisseur sont traitées dans un thread distinct.

Le chargement asynchrone pour les fournisseurs d’images proposant la propriété ` QPixmap ` n’est pris en charge que sur les plateformes dotées de la fonctionnalité `ThreadedPixmaps`. Sur les plateformes où les pixmaps ne peuvent être créés que dans le thread principal (c’est-à-dire où `ThreadedPixmaps` n’est pas pris en charge), si ` asynchronous ` est défini sur ` true`, cette valeur est ignorée et l’image est chargée de manière synchrone.

Le chargement asynchrone des images pour les fournisseurs d’un type autre que `ImageResponse` s’effectue sur un seul thread par moteur. Cela signifie qu’un fournisseur d’images lent bloquera le chargement de toute autre requête. Pour éviter cela, nous vous recommandons d’utiliser ` QQuickAsyncImageProvider ` et de mettre en œuvre le multithreading côté fournisseur via une propriété ` QThreadPool ` ou similaire. Consultez l’exemple de fournisseur de réponses d’images pour une implémentation complète.

Mise en cache des images

Les images renvoyées par un QQuickImageProvider sont automatiquement mises en cache, à l’instar de toute image chargée par le moteur QML. Lorsqu’une image préfixée par « image:// » est chargée à partir du cache, les méthodes requestImage() et requestPixmap() ne seront pas appelées pour le fournisseur d’images concerné. Si une image doit toujours être récupérée auprès du fournisseur d’images et ne doit en aucun cas être mise en cache, définissez la propriété cache sur false pour l’objet Image ou BorderImage concerné.