QRhiSwapChain Class

void init()
{
    sc = rhi->newSwapChain();
    ds = rhi->newRenderBuffer(QRhiRenderBuffer::DepthStencil,
                              QSize(), // no need to set the size here due to UsedWithSwapChainOnly
                              1,
                              QRhiRenderBuffer::UsedWithSwapChainOnly);
    sc->setWindow(window);
    sc->setDepthStencil(ds);
    rp = sc->newCompatibleRenderPassDescriptor();
    sc->setRenderPassDescriptor(rp);
    resizeSwapChain();
}

void resizeSwapChain()
{
    hasSwapChain = sc->createOrResize();
}

void render()
{
    if (!hasSwapChain || notExposed)
        return;

    if (sc->currentPixelSize() != sc->surfacePixelSize() || newlyExposed) {
        resizeSwapChain();
        if (!hasSwapChain)
            return;
        newlyExposed = false;
    }

    rhi->beginFrame(sc);
    // ...
    rhi->endFrame(sc);
}

void releaseSwapChain()
{
    if (hasSwapChain) {
        sc->destroy();
        hasSwapChain = false;
    }
}

// assuming Window is our QWindow subclass
bool Window::event(QEvent *e)
{
    switch (e->type()) {
    case QEvent::UpdateRequest: // for QWindow::requestUpdate()
        render();
        break;
    case QEvent::PlatformSurface:
        if (static_cast<QPlatformSurfaceEvent *>(e)->surfaceEventType() == QPlatformSurfaceEvent::SurfaceAboutToBeDestroyed)
            releaseSwapChain();
        break;
    default:
        break;
    }
    return QWindow::event(e);
}

void Window::exposeEvent(QExposeEvent *)
{
    // initialize and start rendering when the window becomes usable for graphics purposes
    if (isExposed() && !running) {
        running = true;
        init();
    }

    // stop pushing frames when not exposed or size becomes 0
    if ((!isExposed() || (hasSwapChain && sc->surfacePixelSize().isEmpty())) && running)
        notExposed = true;

    // continue when exposed again and the surface has a valid size
    if (isExposed() && running && notExposed && !sc->surfacePixelSize().isEmpty()) {
        notExposed = false;
        newlyExposed = true;
    }

    if (isExposed() && !sc->surfacePixelSize().isEmpty())
        render();
}

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

[pure virtual] bool QRhiSwapChain::createOrResize()

まだ作成されていない場合はスワップチェーンを作成し、ターゲットとなるサーフェスの現在のサイズに合わせてスワップチェーンのバッファサイズを変更します。ターゲットとなるサーフェスのサイズが以前と異なる場合は、いつでもこの関数を呼び出してください。

成功した場合はtrue を、グラフィックス操作が失敗した場合はfalse を返します。戻り値にかかわらず、destroy()の呼び出しは常に安全です。

[pure virtual] QRhiCommandBuffer *QRhiSwapChain::currentFrameCommandBuffer()

このスワップチェーンを使用して beginFrame() が呼び出されたことを前提として、beginFrame -endFrame ブロック内でレンダリングコマンドやリソースの更新を記録できるコマンドバッファを返します。

[pure virtual] QRhiRenderTarget *QRhiSwapChain::currentFrameRenderTarget()

スワップチェーンの現在のバックバッファをレンダリングするために、`beginPass()` で使用できるレンダリングターゲットを返します。このスワップチェーンで `beginFrame()` が呼び出された `QRhi::beginFrame()` - `QRhi::endFrame()` ブロック内でのみ有効です。

[virtual] QRhiRenderTarget *QRhiSwapChain::currentFrameRenderTarget(QRhiSwapChain::StereoTargetBuffer targetBuffer)

スワップチェーンの左または右のバックバッファにレンダリングするために、`beginPass()` で使用できるレンダリングターゲットを返します。このオーバーロードは、ステレオレンダリングの場合、つまり、関連付けられた `QWindow ` が単一のカラーバッファではなく、各眼用に1つずつ計2つのカラーバッファによって裏付けられている場合にのみ使用してください。

ステレオレンダリングがサポートされていない場合、戻り値はデフォルトのターゲットになります。Metalを除くすべてのハードウェアバックエンドで、QSurfaceFormat::StereoBuffers と組み合わせてサポートされています（実行時にグラフィックスおよびディスプレイドライバースタックによってサポートされていることを前提とします）。MetalおよびNullバックエンドは、このオーバーロードからデフォルトのレンダリングターゲットを返します。

QSize QRhiSwapChain::currentPixelSize() const

スワップチェーンが最後に正常に構築された際のサイズを返します。これを使用して、createOrResize() を再度呼び出す必要があるかどうかを判断します。currentPixelSize() != surfacePixelSize() の場合、スワップチェーンのサイズ変更が必要です。

多くの場合、その値は `QWindow::size() * QWindow::devicePixelRatio()` と同じですが、`QWindow` が報告するサイズを信頼しても、すべてのプラットフォームやグラフィックス API の実装において正確であるとは限りません。したがって、出力レイヤーまたはサーフェスの寸法（ピクセル単位）を特定する必要がある場合は、この関数の使用を強く推奨します。

また、専用のレンダリングスレッド上でQRhi を使用する際に発生しうるデータ競合を回避できるという利点もあります。これは、メインスレッド上で更新されたデータにアクセスする可能性のあるQWindow 関数を呼び出す必要がなくなるためです。

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

QRhiRenderBuffer *QRhiSwapChain::depthStencil() const

深度・ステンシル用に現在関連付けられているレンダリングバッファを返します。

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

QRhiSwapChain::Flags QRhiSwapChain::flags() const

現在設定されているフラグを返します。

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

QRhiSwapChain::Format QRhiSwapChain::format() const

現在設定されているフォーマットを返します。

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

[virtual] QRhiSwapChainHdrInfo QRhiSwapChain::hdrInfo()

関連付けられたディスプレイのHDR情報を返します。

この操作が低コストであると想定しないでください。プラットフォームによっては、この関数がさまざまなプラットフォームクエリを実行し、パフォーマンスに影響を与える可能性があります。

QRhiSwapChainHdrInfoも参照してください 。

[pure virtual] bool QRhiSwapChain::isFormatSupported(QRhiSwapChain::Format f)

指定されたスワップチェーン形式 `f ` がサポートされている場合、`true` を返します。SDR は常にサポートされています。

この関数の主な用途は、ウィンドウがすでに設定された後、最初の `createOrResize()` を呼び出す前にこれを呼び出すことです。これにより、QRhi バックエンドは、プラットフォームやウィンドウシステムに固有のクエリを実行して、そのウィンドウ（およびそれが表示されている画面）が、指定されたフォーマットで真の HDR 出力が可能かどうかを判断できるようになります。

フォーマットがサポートされていると報告された場合は、setFormat() を呼び出して要求されたフォーマットを設定し、createOrResize() を呼び出してください。ただし、その影響には注意が必要です。HDR フォーマットを正常に要求すると、異なる色空間への対応、HDR 非対応のコンテンツに対するホワイトレベル補正、トーンマッピング方法の調整、オフスクリーン・レンダリングターゲット設定の調整などが必要になる場合があります。

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

[pure virtual] QRhiRenderPassDescriptor *QRhiSwapChain::newCompatibleRenderPassDescriptor()

このスワップチェーンと互換性のある新しいQRhiRenderPassDescriptor を返します。

返り値は 2 つの方法で使用されます。setRenderPassDescriptor() およびQRhiGraphicsPipeline::setRenderPassDescriptor() に渡すことができます。レンダリングパス記述子は、アタッチメント（色、深度／ステンシル）およびflags() によって影響を受ける可能性のあるロード／ストアの挙動を記述します。QRhiGraphicsPipeline は、compatible QRhiRenderPassDescriptor が設定されているスワップチェーンと組み合わせてのみ使用できます。

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

QRhiSwapChainProxyData QRhiSwapChain::proxyData() const

現在設定されているプロキシデータを返します。

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

QRhiRenderPassDescriptor *QRhiSwapChain::renderPassDescriptor() const

現在関連付けられているQRhiRenderPassDescriptor オブジェクトを返します。

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

[override virtual] QRhiResource::Type QRhiSwapChain::resourceType() const

QRhiResource::resourceType() const を再実装します。

リソースの型を返します。

int QRhiSwapChain::sampleCount() const

現在設定されているサンプル数を返します。1 は、マルチサンプルアンチエイリアシングが有効でないことを意味します。

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

void QRhiSwapChain::setDepthStencil(QRhiRenderBuffer *ds)

レンダリングバッファ `ds ` を、深度・ステンシルバッファとして使用するように設定します。

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

void QRhiSwapChain::setFlags(QRhiSwapChain::Flags f)

フラグ「f 」を設定します。

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

void QRhiSwapChain::setFormat(QRhiSwapChain::Format f)

f のフォーマットを設定します。

isFormatSupported() によってサポートされていないと報告されるフォーマットの設定は避けてください。特定のフォーマットのサポートは、スワップチェーンに関連付けられたウィンドウが開かれている画面によって異なる場合があることに注意してください。Windows や macOS などの一部のプラットフォームでは、HDR 出力を機能させるには、ディスプレイ設定で HDR 出力が有効になっている必要があります。

ハイダイナミックレンジ出力に関する詳細については、isFormatSupported()、QRhiSwapChainHdrInfo 、およびFormat を参照してください。

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

void QRhiSwapChain::setProxyData(const QRhiSwapChainProxyData &d)

プロキシデータ `d` を設定します。

proxyData() およびQRhi::updateSwapChainProxyData()も参照してください 。

void QRhiSwapChain::setRenderPassDescriptor(QRhiRenderPassDescriptor *desc)

QRhiRenderPassDescriptor （desc ）に関連しています。

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

void QRhiSwapChain::setSampleCount(int samples)

サンプル数を設定します。samples の一般的な値は、1（MSAA なし）、4（4倍 MSAA）、または 8（8倍 MSAA）です。

sampleCount() およびQRhi::supportedSampleCounts()も参照してください 。

[since 6.9] void QRhiSwapChain::setShadingRateMap(QRhiShadingRateMap *map)

指定されたQRhiShadingRateMap map に関連付けられます。これは、QRhi::VariableRateShadingMap 機能がサポートされていると報告されている場合にのみ機能します。

QRhiCommandBuffer::setShadingRate() も呼び出された場合、各タイルに対して 2 つのシェーディングレートのうち高い方が使用されます。現在、コンバイナの動作を制御する手段は提供されていません。

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

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

void QRhiSwapChain::setWindow(QWindow *window)

window を設定します。

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

[since 6.9] QRhiShadingRateMap *QRhiSwapChain::shadingRateMap() const

現在設定されているQRhiShadingRateMap を返します。デフォルトでは、nullptr となります。

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

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

[pure virtual] QSize QRhiSwapChain::surfacePixelSize()

戻り値：ウィンドウに関連付けられたサーフェスまたはレイヤーのサイズ。

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

QWindow *QRhiSwapChain::window() const

現在設定されているウィンドウを返します。

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