Qt
Internal/Contributor docs for the Qt SDK. <b>Note:</b> These are NOT official API docs; those are found <a href='https://doc.qt.io/'>here</a>.
|
#include <qrhid3d11_p.h>
Public Member Functions | |
QD3D11SwapChain (QRhiImplementation *rhi) | |
~QD3D11SwapChain () | |
void | destroy () override |
Releases (or requests deferred releasing of) the underlying native graphics resources. | |
QRhiCommandBuffer * | currentFrameCommandBuffer () override |
QRhiRenderTarget * | currentFrameRenderTarget () override |
QRhiRenderTarget * | currentFrameRenderTarget (StereoTargetBuffer targetBuffer) override |
QSize | surfacePixelSize () override |
bool | isFormatSupported (Format f) override |
QRhiSwapChainHdrInfo | hdrInfo () override |
\variable QRhiSwapChainHdrInfo::limitsType | |
QRhiRenderPassDescriptor * | newCompatibleRenderPassDescriptor () override |
bool | createOrResize () override |
Creates the swapchain if not already done and resizes the swapchain buffers to match the current size of the targeted surface. | |
void | releaseBuffers () |
bool | newColorBuffer (const QSize &size, DXGI_FORMAT format, DXGI_SAMPLE_DESC sampleDesc, ID3D11Texture2D **tex, ID3D11RenderTargetView **rtv) const |
Public Member Functions inherited from QRhiSwapChain | |
QRhiResource::Type | resourceType () const override |
QWindow * | window () const |
void | setWindow (QWindow *window) |
Sets the window. | |
QRhiSwapChainProxyData | proxyData () const |
void | setProxyData (const QRhiSwapChainProxyData &d) |
Sets the proxy data d. | |
Flags | flags () const |
void | setFlags (Flags f) |
Sets the flags f. | |
Format | format () const |
void | setFormat (Format f) |
Sets the format f. | |
QRhiRenderBuffer * | depthStencil () const |
void | setDepthStencil (QRhiRenderBuffer *ds) |
Sets the renderbuffer ds for use as a depth-stencil buffer. | |
int | sampleCount () const |
void | setSampleCount (int samples) |
Sets the sample count. | |
QRhiRenderPassDescriptor * | renderPassDescriptor () const |
void | setRenderPassDescriptor (QRhiRenderPassDescriptor *desc) |
Associates with the QRhiRenderPassDescriptor desc. | |
QSize | currentPixelSize () const |
Public Member Functions inherited from QRhiResource | |
virtual | ~QRhiResource () |
Destructor. | |
void | deleteLater () |
When called without a frame being recorded, this function is equivalent to deleting the object. | |
QByteArray | name () const |
void | setName (const QByteArray &name) |
Sets a name for the object. | |
quint64 | globalResourceId () const |
QRhi * | rhi () const |
Public Attributes | |
QWindow * | window = nullptr |
QSize | pixelSize |
QD3D11SwapChainRenderTarget | rt |
QD3D11SwapChainRenderTarget | rtRight |
QD3D11CommandBuffer | cb |
DXGI_FORMAT | colorFormat |
DXGI_FORMAT | srgbAdjustedColorFormat |
IDXGISwapChain * | swapChain = nullptr |
UINT | swapChainFlags = 0 |
ID3D11Texture2D * | backBufferTex |
ID3D11RenderTargetView * | backBufferRtv |
ID3D11RenderTargetView * | backBufferRtvRight = nullptr |
ID3D11Texture2D * | msaaTex [BUFFER_COUNT] |
ID3D11RenderTargetView * | msaaRtv [BUFFER_COUNT] |
DXGI_SAMPLE_DESC | sampleDesc |
int | currentFrameSlot = 0 |
int | frameCount = 0 |
QD3D11RenderBuffer * | ds = nullptr |
UINT | swapInterval = 1 |
IDCompositionTarget * | dcompTarget = nullptr |
IDCompositionVisual * | dcompVisual = nullptr |
QD3D11SwapChainTimestamps | timestamps |
int | currentTimestampPairIndex = 0 |
Static Public Attributes | |
static const int | BUFFER_COUNT = 2 |
Definition at line 583 of file qrhid3d11_p.h.
QD3D11SwapChain::QD3D11SwapChain | ( | QRhiImplementation * | rhi | ) |
Definition at line 4888 of file qrhid3d11.cpp.
References backBufferRtv, backBufferTex, BUFFER_COUNT, i, msaaRtv, and msaaTex.
QD3D11SwapChain::~QD3D11SwapChain | ( | ) |
Definition at line 4899 of file qrhid3d11.cpp.
References destroy().
|
overridevirtual |
Creates the swapchain if not already done and resizes the swapchain buffers to match the current size of the targeted surface.
Call this whenever the size of the target surface is different than before.
true
when successful, false
when a graphics operation failed. Regardless of the return value, calling destroy() is always safe. Implements QRhiSwapChain.
Definition at line 5077 of file qrhid3d11.cpp.
References QSurfaceFormat::alphaBufferSize(), backBufferRtv, backBufferRtvRight, backBufferTex, BUFFER_COUNT, colorFormat, QRhiRenderBuffer::create(), currentFrameSlot, dcompTarget, dcompVisual, DEFAULT_FORMAT, DEFAULT_SRGB_FORMAT, destroy(), ds, QD3D11RenderBuffer::dsv, QRhi::EnableTimestamps, QRhiRenderBuffer::flags(), QWindow::format(), frameCount, QRhiSwapChain::HDR10, QRhiSwapChain::HDRExtendedSrgbLinear, QSize::height(), i, QSize::isEmpty(), QRhiSwapChain::m_currentPixelSize, QRhiSwapChain::m_depthStencil, QRhiSwapChain::m_flags, QRhiSwapChain::m_format, QRhiSwapChain::m_renderPassDesc, QRhiSwapChain::m_sampleCount, QRhiSwapChain::m_window, msaaRtv, msaaTex, newColorBuffer(), QRhiSwapChain::NoVSync, QRhiD3D::outputDesc1ForWindow(), QRhiRenderBuffer::pixelSize(), pixelSize, QD3D11SwapChainTimestamps::prepare(), qPrintable, QRHI_RES, QRHI_RES_RHI, qWarning, releaseBuffers(), rt, rtRight, QRhiRenderBuffer::sampleCount(), sampleDesc, QRhiSwapChain::SDR, QRhiRenderBuffer::setPixelSize(), QRhiRenderTarget::setRenderPassDescriptor(), QRhiSwapChain::sRGB, srgbAdjustedColorFormat, QSurfaceFormat::stereo(), QRhiSwapChain::SurfaceHasNonPreMulAlpha, QRhiSwapChain::SurfaceHasPreMulAlpha, surfacePixelSize(), swapChain, swapChainFlags, swapInterval, timestamps, QRhiRenderBuffer::UsedWithSwapChainOnly, QSize::width(), and window.
|
overridevirtual |
Implements QRhiSwapChain.
Definition at line 4961 of file qrhid3d11.cpp.
References cb.
|
overridevirtual |
Implements QRhiSwapChain.
Definition at line 4966 of file qrhid3d11.cpp.
References rt.
|
overridevirtual |
When stereoscopic rendering is not supported, the return value will be the default target. It is supported by all hardware backends except for Metal, in combination with \l QSurfaceFormat::StereoBuffers, assuming it is supported by the graphics and display driver stack at run time. Metal and Null backends are going to return the default render target from this overload.
Reimplemented from QRhiSwapChain.
Definition at line 4971 of file qrhid3d11.cpp.
References QRhiSwapChain::LeftBuffer, rt, and rtRight.
|
overridevirtual |
Releases (or requests deferred releasing of) the underlying native graphics resources.
Safe to call multiple times, subsequent invocations will be a no-op then.
Once destroy() is called, the QRhiResource instance can be reused, by calling create()
again. That will then result in creating new native graphics resources underneath.
The QRhiResource destructor also performs the same task, so calling this function is not necessary before deleting a QRhiResource.
Implements QRhiResource.
Definition at line 4930 of file qrhid3d11.cpp.
References dcompTarget, dcompVisual, QD3D11SwapChainTimestamps::destroy(), QRHI_RES_RHI, releaseBuffers(), swapChain, and timestamps.
Referenced by ~QD3D11SwapChain(), and createOrResize().
|
overridevirtual |
\variable QRhiSwapChainHdrInfo::limitsType
With Metal on macOS/iOS, there is no luminance values exposed in the platform APIs. Instead, the maximum color component value, that would be 1.0 in a non-HDR setup, is provided. This value indicates what kind of information is available in \l limits.
\variable QRhiSwapChainHdrInfo::limits
Contains the actual values queried from the graphics API or the platform. The type of data is indicated by \l limitsType. This is therefore a union. There are currently two options:
Luminance values in nits:
On Windows the minimum and maximum luminance depends on the screen brightness. While not relevant for desktops, on laptops the screen brightness may change at any time. Increasing brightness implies decreased maximum luminance. In addition, the results may also be dependent on the HDR Content Brightness set in Windows Settings' System/Display/HDR view, if there is such a setting.
Note however that the changes made to the laptop screen's brightness or in the system settings while the application is running are not necessarily reflected in the returned values, meaning calling hdrInfo() again may still return the same luminance range as before for the rest of the process' lifetime. The exact behavior is up to DXGI and Qt has no control over it.
For macOS/iOS, the current maximum and potential maximum color component values are provided:
The value may depend on the screen brightness, which on laptops means that the result may change in the next call to hdrInfo() if the brightness was changed in the meantime. The maximum screen brightness implies a maximum color value of 1.0.
\variable QRhiSwapChainHdrInfo::luminanceBehavior
Describes the platform's presumed behavior with regards to color values.
\variable QRhiSwapChainHdrInfo::sdrWhiteLevel
On Windows this is the dynamic SDR white level in nits. The value is dependent on the screen brightness (on laptops), and the SDR or HDR Content Brightness settings in the Windows settings' System/Display/HDR view.
To perform white level correction for non-HDR (SDR) content, such as 2D UI elemenents, multiply the final color with sdrWhiteLevel / 80.0 whenever \l luminanceBehavior is SceneReferred. (assuming Windows and a linear extended sRGB (scRGB) color space)
On other platforms the value is always a pre-defined value, 200. This may not match the system's actual SDR white level, but the value of this variable is not relevant in practice when the \l luminanceBehavior is DisplayReferred, because then the color component value of 1.0 refers to the SDR white by default.
Do not assume that this is a cheap operation. Depending on the platform, this function makes various platform queries which may have a performance impact.
Reimplemented from QRhiSwapChain.
Definition at line 5002 of file qrhid3d11.cpp.
References QRhiSwapChain::hdrInfo(), info, QRhiSwapChainHdrInfo::LuminanceInNits, QRhiSwapChain::m_window, QRhiD3D::outputDesc1ForWindow(), QRHI_RES_RHI, QRhiSwapChainHdrInfo::SceneReferred, and QRhiD3D::sdrWhiteLevelInNits().
|
overridevirtual |
The main use of this function is to call it before the first createOrResize() after the window is already set. This allow the QRhi backends to perform platform or windowing system specific queries to determine if the window (and the screen it is on) is capable of true HDR output with the specified format.
When the format is reported as supported, call setFormat() to set the requested format and call createOrResize(). Be aware of the consequences however: successfully requesting a HDR format will involve having to deal with a different color space, possibly doing white level correction for non-HDR-aware content, adjusting tonemapping methods, adjusting offscreen render target settings, etc.
Implements QRhiSwapChain.
Definition at line 4982 of file qrhid3d11.cpp.
References QRhiSwapChain::HDR10, QRhiSwapChain::HDRExtendedSrgbLinear, QRhiSwapChain::m_window, QRhiD3D::outputDesc1ForWindow(), QRHI_RES_RHI, qWarning, and QRhiSwapChain::SDR.
bool QD3D11SwapChain::newColorBuffer | ( | const QSize & | size, |
DXGI_FORMAT | format, | ||
DXGI_SAMPLE_DESC | sampleDesc, | ||
ID3D11Texture2D ** | tex, | ||
ID3D11RenderTargetView ** | rtv ) const |
Definition at line 5028 of file qrhid3d11.cpp.
References QRhiSwapChain::format(), qPrintable, QRHI_RES_RHI, qWarning, and sampleDesc.
Referenced by createOrResize().
|
overridevirtual |
The returned value is used in two ways: it can be passed to setRenderPassDescriptor() and QRhiGraphicsPipeline::setRenderPassDescriptor(). A render pass descriptor describes the attachments (color, depth/stencil) and the load/store behavior that can be affected by flags(). A QRhiGraphicsPipeline can only be used in combination with a swapchain that has a \l{QRhiRenderPassDescriptor::isCompatible()}{compatible} QRhiRenderPassDescriptor set.
Implements QRhiSwapChain.
Definition at line 5020 of file qrhid3d11.cpp.
References QRhiResource::m_rhi, and QRHI_RES_RHI.
void QD3D11SwapChain::releaseBuffers | ( | ) |
Definition at line 4904 of file qrhid3d11.cpp.
References backBufferRtv, backBufferRtvRight, backBufferTex, BUFFER_COUNT, i, msaaRtv, and msaaTex.
Referenced by createOrResize(), and destroy().
|
overridevirtual |
{QWindow::size() * QWindow::devicePixelRatio()}. With some graphics APIs and windowing system interfaces (for example, Vulkan) there is a theoretical possibility for a surface to assume a size different from the associated window. To support these cases, {rendering logic must always base size-derived calculations (such as, viewports) on the size reported from QRhiSwapChain, and never on the size queried from QWindow}.Implements QRhiSwapChain.
Definition at line 4976 of file qrhid3d11.cpp.
References QRhiSwapChain::m_window, Q_ASSERT, and QWindow::size().
Referenced by createOrResize().
ID3D11RenderTargetView* QD3D11SwapChain::backBufferRtv |
Definition at line 614 of file qrhid3d11_p.h.
Referenced by QD3D11SwapChain(), createOrResize(), and releaseBuffers().
ID3D11RenderTargetView* QD3D11SwapChain::backBufferRtvRight = nullptr |
Definition at line 615 of file qrhid3d11_p.h.
Referenced by createOrResize(), and releaseBuffers().
ID3D11Texture2D* QD3D11SwapChain::backBufferTex |
Definition at line 613 of file qrhid3d11_p.h.
Referenced by QD3D11SwapChain(), createOrResize(), and releaseBuffers().
|
static |
Definition at line 616 of file qrhid3d11_p.h.
Referenced by QD3D11SwapChain(), createOrResize(), QRhiD3D11::endFrame(), and releaseBuffers().
QD3D11CommandBuffer QD3D11SwapChain::cb |
Definition at line 608 of file qrhid3d11_p.h.
Referenced by currentFrameCommandBuffer().
DXGI_FORMAT QD3D11SwapChain::colorFormat |
Definition at line 609 of file qrhid3d11_p.h.
Referenced by createOrResize().
int QD3D11SwapChain::currentFrameSlot = 0 |
Definition at line 620 of file qrhid3d11_p.h.
Referenced by createOrResize().
int QD3D11SwapChain::currentTimestampPairIndex = 0 |
Definition at line 627 of file qrhid3d11_p.h.
IDCompositionTarget* QD3D11SwapChain::dcompTarget = nullptr |
Definition at line 624 of file qrhid3d11_p.h.
Referenced by createOrResize(), and destroy().
IDCompositionVisual* QD3D11SwapChain::dcompVisual = nullptr |
Definition at line 625 of file qrhid3d11_p.h.
Referenced by createOrResize(), and destroy().
QD3D11RenderBuffer* QD3D11SwapChain::ds = nullptr |
Definition at line 622 of file qrhid3d11_p.h.
Referenced by createOrResize().
int QD3D11SwapChain::frameCount = 0 |
Definition at line 621 of file qrhid3d11_p.h.
Referenced by createOrResize().
ID3D11RenderTargetView* QD3D11SwapChain::msaaRtv[BUFFER_COUNT] |
Definition at line 618 of file qrhid3d11_p.h.
Referenced by QD3D11SwapChain(), createOrResize(), and releaseBuffers().
ID3D11Texture2D* QD3D11SwapChain::msaaTex[BUFFER_COUNT] |
Definition at line 617 of file qrhid3d11_p.h.
Referenced by QD3D11SwapChain(), createOrResize(), and releaseBuffers().
QSize QD3D11SwapChain::pixelSize |
Definition at line 605 of file qrhid3d11_p.h.
Referenced by createOrResize().
QD3D11SwapChainRenderTarget QD3D11SwapChain::rt |
Definition at line 606 of file qrhid3d11_p.h.
Referenced by createOrResize(), currentFrameRenderTarget(), and currentFrameRenderTarget().
QD3D11SwapChainRenderTarget QD3D11SwapChain::rtRight |
Definition at line 607 of file qrhid3d11_p.h.
Referenced by createOrResize(), and currentFrameRenderTarget().
DXGI_SAMPLE_DESC QD3D11SwapChain::sampleDesc |
Definition at line 619 of file qrhid3d11_p.h.
Referenced by createOrResize(), and newColorBuffer().
DXGI_FORMAT QD3D11SwapChain::srgbAdjustedColorFormat |
Definition at line 610 of file qrhid3d11_p.h.
Referenced by createOrResize().
IDXGISwapChain* QD3D11SwapChain::swapChain = nullptr |
Definition at line 611 of file qrhid3d11_p.h.
Referenced by createOrResize(), and destroy().
UINT QD3D11SwapChain::swapChainFlags = 0 |
Definition at line 612 of file qrhid3d11_p.h.
Referenced by createOrResize().
UINT QD3D11SwapChain::swapInterval = 1 |
Definition at line 623 of file qrhid3d11_p.h.
Referenced by createOrResize().
QD3D11SwapChainTimestamps QD3D11SwapChain::timestamps |
Definition at line 626 of file qrhid3d11_p.h.
Referenced by createOrResize(), and destroy().
Definition at line 604 of file qrhid3d11_p.h.
Referenced by createOrResize().