QSGRenderNode Class

See also Scene Graph - Custom QSGRenderNode

flags QSGRenderNode::RenderingFlags

Possible values for the bitmask returned from flags().

The RenderingFlags type is a typedef for QFlags<RenderingFlag>. It stores an OR combination of RenderingFlag values.

See Also▲

flags QSGRenderNode::StateFlags

This enum is a bit mask identifying several states.

The StateFlags type is a typedef for QFlags<StateFlag>. It stores an OR combination of StateFlag values.

Destructs the render node. Derived classes are expected to perform cleanup similar to releaseResources() in here.

When a low-level graphics API is in use, the scenegraph will make sure there is a CPU-side wait for the GPU to complete all work submitted to the scenegraph's graphics command queue before the scenegraph's nodes are deleted. Therefore there is no need to issue additional waits here, unless the render() implementation is using additional command queues.

With QRhi and resources such as QRhiBuffer, QRhiTexture, QRhiGraphicsPipeline, etc., it is often good practice to use smart pointers, such as std::unique_ptr, which can often avoid the need to implement a destructor, and lead to more compact source code. Keep in mind however that implementing releaseResources(), most likely issuing a number of reset() calls on the unique_ptrs, is still important.

See Also▲

When the underlying rendering API is OpenGL, this function should return a mask where each bit represents graphics states changed by the render() function:

With APIs other than OpenGL, the only relevant values are the ones that correspond to dynamic state changes recorded on the command list/buffer. For example, RSSetViewports, RSSetScissorRects, OMSetBlendState, OMSetDepthStencilState in case of D3D11, or vkCmdSetViewport, vkCmdSetScissor, vkCmdSetBlendConstants, vkCmdSetStencilRef in case of Vulkan, and only when such commands were added to the scenegraph's command list queried via the QSGRendererInterface::CommandList resource enum. States set in pipeline state objects do not need to be reported here. Similarly, draw call related settings (pipeline states, descriptor sets, vertex or index buffer bindings, root signature, descriptor heaps, etc.) are always set again by the scenegraph so render() can freely change them.

RenderTargetState is no longer supported with APIs like Vulkan. This is by nature. render() is invoked while the Qt Quick scenegraph's main command buffer is recording a renderpass, so there is no possibility of changing the target and starting another renderpass (on that command buffer at least). Therefore returning a value with RenderTargetState set is not sensible.

The function is called by the renderer so it can reset the states after rendering this node. This makes the implementation of render() simpler since it does not have to query and restore these states.

The default implementation returns 0, meaning no relevant state was changed in render().

Returns the current clip list.

Returns the current command buffer.

This function was introduced in Qt 6.6.

See Also▲

Returns flags describing the behavior of this render node.

The default implementation returns 0.

See Also▲

Returns the current effective opacity.

Returns pointer to the current model-view matrix.

Called from the frame preparation phase. There is a call to this function before each invocation of render().

Unlike render(), this function is called before the scenegraph starts recording the render pass for the current frame on the underlying command buffer. This is useful when doing rendering with graphics APIs, such as Vulkan, where copy type of operations will need to be recorded before the render pass.

The default implementation is empty.

When implementing a QSGRenderNode that uses QRhi to render, query the QRhi object from the QQuickWindow via QQuickWindow::rhi(). To get a QRhiCommandBuffer for submitting work to, call commandBuffer(). To query information about the active render target, call renderTarget(). See the {Scene Graph - Custom QSGRenderNode} example for details.

This function was introduced in Qt 6.0.

Returns pointer to the current projection matrix.

In render() this is the same matrix that is returned from RenderState::projectionMatrix(). This getter exists so that prepare() also has a way to query the projection matrix.

When working with a modern graphics API, or Qt's own graphics abstraction layer, it is more than likely that one will want to load *projectionMatrix() * *matrix() into a uniform buffer. That is however something that needs to be done in prepare(), so outside the recording of a render pass. That is why both matrices are queriable directly from the QSGRenderNode, both in prepare() and render().

This function was introduced in Qt 6.5.

Returns the bounding rectangle in item coordinates for the area render() touches. The value is only in use when flags() includes BoundedRectRendering, ignored otherwise.

Reporting the rectangle in combination with BoundedRectRendering is particularly important with the software backend because otherwise having a rendernode in the scene would trigger fullscreen updates, skipping all partial update optimizations.

For rendernodes covering the entire area of a corresponding QQuickItem the return value will be (0, 0, item->width(), item->height()).

See Also▲

This function is called when all custom graphics resources allocated by this node have to be freed immediately. In case the node does not directly allocate graphics resources (buffers, textures, render targets, fences, etc.) through the graphics API that is in use, there is nothing to do here.

Failing to release all custom resources can lead to incorrect behavior in graphics device loss scenarios on some systems since subsequent reinitialization of the graphics system may fail.

Unlike with the destructor, it is expected that render() can reinitialize all resources it needs when called after a call to releaseResources().

With OpenGL, the scenegraph's OpenGL context will be current both when calling the destructor and this function.

This function is called by the renderer and should paint this node with directly invoking commands in the graphics API (OpenGL, Direct3D, etc.) currently in use.

The effective opacity can be retrieved with inheritedOpacity().

The projection matrix is available through state, while the model-view matrix can be fetched with matrix(). The combined matrix is then the projection matrix times the model-view matrix. The correct stacking of the items in the scene is ensured by the projection matrix.

When using the provided matrices, the coordinate system for vertex data follows the usual QQuickItem conventions: top-left is (0, 0), bottom-right is the corresponding QQuickItem's width() and height() minus one. For example, assuming a two float (x-y) per vertex coordinate layout, a triangle covering half of the item