QCanvasRhiPaintDriver Class

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

void QCanvasRhiPaintDriver::beginPaint(QCanvasOffscreenCanvas &canvas, QRhiCommandBuffer *cb, QCanvasRhiPaintDriver::BeginPaintFlags flags = {})

指定されたオフスクリーンcanvas への描画を開始し、レンダリングコマンドをコマンドバッファcb に記録します。

QCanvasOffscreenCanvas::Flag::PreserveContents フラグが設定されていない限り、fill color set on the canvas によってクリアが行われます。フラグが設定されている場合は、クリアは行われず、キャンバスの内容が保持されます（基盤となるGPUアーキテクチャによっては、パフォーマンスに影響が出る可能性があります）。

flags は、レンダリングを制御するオプションのフラグを指定します。

void QCanvasRhiPaintDriver::beginPaint(QRhiCommandBuffer *cb, QRhiRenderTarget *rt, const QMatrix4x4 &matrix, QCanvasRhiPaintDriver::BeginPaintFlags flags = {})

レンダリングターゲット `rt` への描画を開始し、レンダリングコマンドをコマンドバッファ `cb` に記録します。

このオーバーロードは、頂点の変換に使用されるカスタムmatrix を受け取ります。この行列は、座標がピクセル単位で指定された頂点を処理できるものでなければなりません。一般的な使用例としては、QSGRenderNode のサブクラス内でQCanvasPainter ベースのレンダリングを実装する際に、Qt Quick のモデルビュー投影行列を渡すことが挙げられます。

ビューポートのサイズとデバイスピクセル比は、レンダリングターゲットから取得されます。

このオーバーロードは、実際にはフラグ `EndPaintFlag::DoNotRecordRenderPass ` が設定された `endPaint()` が後に続くことが想定されているため、塗りつぶし色を受け取りません。

flags レンダリングを制御するオプションのフラグを指定します。

void QCanvasRhiPaintDriver::beginPaint(QRhiCommandBuffer *cb, QRhiRenderTarget *rt, QColor fillColor = Qt::black, QSize logicalSize = QSize(), qreal dpr = 1.0, QCanvasRhiPaintDriver::BeginPaintFlags flags = {})

レンダリングターゲット `rt` への描画を開始し、レンダリングコマンドをコマンドバッファ `cb` に記録します。

fillColor カラーバッファのクリアに使用する色を指定します。endPaint() のフラグにEndPaintFlag::DoNotRecordRenderPass が含まれている場合、この値は無視されます。

logicalSize はオプションです。空でない場合、ビューポートのサイズを論理単位で指定します。その場合、`dpr ` は、`logicalSize ` が内部でピクセルに変換されるように、スケール係数（デバイスピクセル比）を指定する必要があります。実際には、デフォルトでレンダリングターゲットのサイズが自動的に使用されるため、これが必要になることはほとんどありません。

flags は、レンダリングを制御するオプションのフラグを指定します。

void QCanvasRhiPaintDriver::endPaint(QCanvasRhiPaintDriver::EndPaintFlags flags = {})

QCanvasPainter 描画コマンドによって生成されたすべてのQRhi レンダリングをフラッシュして記録します。

デフォルトでは、この関数はレンダリングパス全体を記録します。つまり、内部でQRhiCommandBuffer::beginPass()およびQRhiCommandBuffer::endPass()を呼び出します。クリアカラーは、beginPaint()のfillColor引数、またはオフスクリーンキャンバスの塗りつぶし色によって指定されます。

flags endPaint() が beginPass() から endPass() までのシーケンス全体を実行することを望まない場合もあるため、この関数を使用してレンダリングパスの記録を制御できます。

以下の 2 つのコードスニペットは結果としては同一ですが、アプリケーションが同じレンダリングパス内でさらに処理を行いたい場合、2 つ目のスニペットの方が柔軟性が高くなります。

pd->beginPaint(cb, rt, Qt::black);
// painter->...
pd->endPaint();

pd->beginPaint(cb, rt);
// painter->...
pd->endPaint(QCanvasRhiPaintDriver::EndPaintFlag::DoNotRecordRenderPass);

cb->beginPass(rt, Qt::black, { 1.0f, 0 });
pd->renderPaint();
cb->endPass();

beginPaint() およびrenderPaint()も参照してください 。

template <typename Functor> void QCanvasRhiPaintDriver::grabCanvas(const QCanvasOffscreenCanvas &canvas, const QObject *context, Functor &&callback)

canvas に対してテクスチャの読み出し要求を発行し、それをcontext と関連付けます。

callback この関数は、関数が戻る前、あるいはそれ以降に呼び出されます。これは、基盤となるQRhi および3D APIの実装によって異なります。テクスチャ内容の読み出しには、GPUアーキテクチャによってはGPU→CPU間のコピーが含まれる場合があります。この関数はconst QImage & 引数を1つ受け取り、move専用を含む任意のファンクタを指定できます。

読み込みが完了する前にcontext が破棄された場合、グラブはキャンセルされ、callback は呼び出されません。これにより、コールバック関数内で、保留中の読み込みが完了する前に存在しなくなる可能性のあるオブジェクトを参照しても安全です。

この関数は、beginPaint() -endPaint() ブロック内でも、その外でも呼び出すことができます。外から呼び出された場合、内部でQRhi::beginOffscreenFrame() などが呼び出されるため、いつでもグラブを実行することが可能です。

たとえば、以下のコードは、画面外にあるキャンバスの内容を PNG ファイルに保存します：

grabCanvas(offscreenCanvas, qGuiApp, [](const QImage &image) {
    image.save("result.png");
});

void QCanvasRhiPaintDriver::renderPaint()

QCanvasPainter 描画コマンドによって生成されたすべてのQRhi レンダリングを記録します。この関数は、endPaint()がDoNotRecordRenderPass で呼び出された場合にのみ呼び出してください。それ以外の場合は、決して呼び出してはなりません。

この関数が呼び出される際、関連するQRhi はレンダリングパスを記録中である必要があります。

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

void QCanvasRhiPaintDriver::resetForNewFrame()

ペインターエンジンの状態をリセットします。この関数は、新しいフレーム全体を開始する際に一度呼び出されることが想定されています。通常は、QRhi::beginFrame() またはQRhi::beginOffscreenFrame() の後に呼び出されます。