QImageIOHandler Class

メンバ関数のドキュメント

QImageIOHandler::QImageIOHandler()

QImageIOHandler オブジェクトを生成します。

[virtual noexcept] QImageIOHandler::~QImageIOHandler()

QImageIOHandler オブジェクトを破棄します。

[static, since 6.0] bool QImageIOHandler::allocateImage(QSize size, QImage::Format format, QImage *image)

これは、サブクラスにおける読み込み関数用の便利なメソッドです。画像フォーマットハンドラは、必要なメモリ割り当てが現在の割り当て制限を超える場合、画像の読み込みを拒否しなければなりません。この関数はパラメータと制限を確認し、有効かつ必要であればメモリ割り当てを行います。正常に返された場合、image は、指定されたsize およびformat に対する、有効なデタッチされたQImage となります。

この関数は Qt 6.0 で導入されました。

QImageReader::allocationLimit()も参照してください 。

[pure virtual] bool QImageIOHandler::canRead() const

デバイスから画像を読み込める場合（つまり、画像形式がサポートされており、デバイスから読み込みが可能で、初期のヘッダー情報から画像が読み込めることが示唆されている場合）、true を返します。それ以外の場合は、false を返します。

canRead() を再実装する際は、I/O デバイス (device()) が元の状態のまま保たれるようにしてください（例：read() ではなく peek() を使用するなど）。

read() およびQIODevice::peek()も参照してください 。

[virtual] int QImageIOHandler::currentImageNumber() const

アニメーションをサポートする画像形式の場合、この関数はアニメーション内の現在の画像のシーケンス番号を返します。read() が呼び出される前にこの関数が呼び出された場合、-1 が返されます。シーケンスの最初の画像の番号は 0 です。

画像形式がアニメーションに対応していない場合は、0が返されます。

read()も参照してください 。

[virtual] QRect QImageIOHandler::currentImageRect() const

現在の画像の矩形を返します。画像に矩形が定義されていない場合は、空の QRect() が返されます。

この関数は、フレームの一部のみを一度に更新するアニメーションなどで役立ちます。

QIODevice *QImageIOHandler::device() const

QImageIOHandler に現在割り当てられているデバイスを返します。デバイスが割り当てられていない場合は、nullptr が返されます。

「setDevice()」も参照してください 。

QByteArray QImageIOHandler::format() const

QImageIOHandler に現在割り当てられているフォーマットを返します。フォーマットが割り当てられていない場合は、空の文字列が返されます。

setFormat()も参照してください 。

[virtual] int QImageIOHandler::imageCount() const

アニメーションに対応している画像形式の場合、この関数はアニメーションに含まれる画像の数を返します。画像形式がアニメーションに対応していない場合、または画像の数を特定できない場合は、0が返されます。

デフォルトの実装では、canRead()がtrue を返す場合、1を返し、それ以外の場合は0を返します。

[virtual] bool QImageIOHandler::jumpToImage(int imageNumber)

アニメーションをサポートする画像形式の場合、この関数はシーケンス番号がimageNumber である画像にジャンプします。次にread()が呼び出されると、この画像の読み込みが試みられます。

デフォルトの実装では何も行わず、false を返します。

[virtual] bool QImageIOHandler::jumpToNextImage()

アニメーションに対応している画像形式の場合、この関数は次の画像にジャンプします。

デフォルトの実装では何も行わず、false を返します。

[virtual] int QImageIOHandler::loopCount() const

アニメーションに対応している画像形式の場合、この関数はアニメーションのループ回数を返します。画像形式がアニメーションに対応していない場合は、0が返されます。

[virtual] int QImageIOHandler::nextImageDelay() const

アニメーションに対応している画像形式の場合、この関数は次の画像を読み込むまでの待機時間をミリ秒単位で返します。画像形式がアニメーションに対応していない場合は、0 が返されます。

[virtual] QVariant QImageIOHandler::option(QImageIOHandler::ImageOption option) const

option に割り当てられた値をQVariant として返します。値の型はオプションによって異なります。たとえば、option(Size)はQSize のバリアントを返します。

setOption() およびsupportsOption()も参照してください 。

[pure virtual] bool QImageIOHandler::read(QImage *image)

デバイスから画像を読み込み、image に格納します。画像の読み込みに成功した場合はtrue を返し、失敗した場合はfalseを返します。

インクリメンタル読み込みをサポートする画像形式やアニメーション形式の場合、画像ハンドラは `image ` が前のフレームを指していると見なすことができます。

canRead()も参照してください 。

void QImageIOHandler::setDevice(QIODevice *device)

QImageIOHandler のデバイスをdevice に設定します。画像ハンドラは、画像の読み取りおよび書き込み時にこのデバイスを使用します。

デバイスの設定は一度のみ可能であり、canRead()、read()、write() などを呼び出す前に設定する必要があります。複数のファイルを読み込む必要がある場合は、適切なQImageIOHandler のサブクラスのインスタンスを複数作成してください。

device()も参照してください 。

void QImageIOHandler::setFormat(const QByteArray &format)

QImageIOHandler のフォーマットをformat に設定します。このフォーマットは、複数の画像形式をサポートするハンドラで特に役立ちます。

format()も参照してください 。

void QImageIOHandler::setFormat(const QByteArray &format) const

QImageIOHandler のフォーマットをformat に設定します。このフォーマットは、複数の画像フォーマットをサポートするハンドラで特に有用です。

この関数は、canRead() から呼び出せるように、const として宣言されています。

format()も参照してください 。

[virtual] void QImageIOHandler::setOption(QImageIOHandler::ImageOption option, const QVariant &value)

オプション `option ` の値を `value` に設定します。

option() およびImageOptionも参照してください 。

[virtual] bool QImageIOHandler::supportsOption(QImageIOHandler::ImageOption option) const

QImageIOHandler がoption オプションをサポートしている場合はtrue を返し、そうでない場合はfalse を返します。たとえば、QImageIOHandler がSize オプションをサポートしている場合、supportsOption(Size)はtrueを返さなければなりません。

setOption() およびoption()も参照してください 。

[virtual] bool QImageIOHandler::write(const QImage &image)

指定されたデバイスに画像 `image ` を書き込みます。成功した場合は `true ` を返し、失敗した場合は `false` を返します。

デフォルトの実装では何も行わず、単にfalse を返します。