QSGRenderNode::RenderState Class Reference

Provides information about the projection matrix and clipping. More...

#include <qsgrendernode.h>

Inheritance diagram for QSGRenderNode::RenderState:

Collaboration diagram for QSGRenderNode::RenderState:

Public Member Functions
virtual	~RenderState ()
virtual const QMatrix4x4 *	projectionMatrix () const =0
virtual QRect	scissorRect () const =0
virtual bool	scissorEnabled () const =0
virtual int	stencilValue () const =0
virtual bool	stencilEnabled () const =0
virtual const QRegion *	clipRegion () const =0
virtual void *	get (const char *state) const

Detailed Description

Provides information about the projection matrix and clipping.

\inmodule QtQuick

The render state contains information for the renderer when invoking commands to the scenegraph backends.

See also

QSGRenderNode::render()

Definition at line 38 of file qsgrendernode.h.

Constructor & Destructor Documentation

~RenderState()

QSGRenderNode::RenderState::~RenderState ( )

virtual

Definition at line 411 of file qsgrendernode.cpp.

Member Function Documentation

clipRegion()

virtual const QRegion * QSGRenderNode::RenderState::clipRegion ( ) const

pure virtual

Returns

the current clip region or null for backends where clipping is implemented via stencil or scissoring.

The software backend uses no projection, scissor or stencil, meaning most of the render state is not in use. However, the clip region that can be set on the QPainter still has to be communicated since reconstructing this manually in render() is not reasonable. It can therefore be queried via this function. The region is in world coordinates and can be passed to QPainter::setClipRegion() with Qt::ReplaceClip. This must be done before calling QPainter::setTransform() since the clip region is already mapped to the transform provided in QSGRenderNode::matrix().

Implemented in QSGBatchRenderer::RenderNodeState, QSGBatchRenderer::RenderNodeState, RenderNodeState, and RenderNodeState.

get()

void * QSGRenderNode::RenderState::get ( const char * state ) const

virtual

Returns

pointer to a state value.

Reserved for future use.

Definition at line 490 of file qsgrendernode.cpp.

projectionMatrix()

virtual const QMatrix4x4 * QSGRenderNode::RenderState::projectionMatrix ( ) const

pure virtual

Returns

pointer to the current projection matrix.

The model-view matrix can be retrieved with QSGRenderNode::matrix(). Typically {projection * modelview} is the matrix that is then used in the vertex shader to transform the vertices.

Implemented in QSGBatchRenderer::RenderNodeState, QSGBatchRenderer::RenderNodeState, RenderNodeState, and RenderNodeState.

scissorEnabled()

virtual bool QSGRenderNode::RenderState::scissorEnabled ( ) const

pure virtual

Returns

the current state of scissoring.

Note

Only relevant for graphics APIs that have a dedicated on/off state of scissoring.

Implemented in QSGBatchRenderer::RenderNodeState, QSGBatchRenderer::RenderNodeState, RenderNodeState, and RenderNodeState.

scissorRect()

virtual QRect QSGRenderNode::RenderState::scissorRect ( ) const

pure virtual

Returns

the current scissor rectangle when clipping is active. x and y are the bottom left coordinates.

Implemented in QSGBatchRenderer::RenderNodeState, QSGBatchRenderer::RenderNodeState, RenderNodeState, and RenderNodeState.

stencilEnabled()

virtual bool QSGRenderNode::RenderState::stencilEnabled ( ) const

pure virtual

Returns

the current state of stencil testing.

Note

With graphics APIs where stencil testing is enabled in pipeline state objects, instead of individual state-setting commands, it is up to the implementation of render() to enable stencil testing with operations KEEP, comparison function EQUAL, and a read and write mask of 0xFF.

Implemented in QSGBatchRenderer::RenderNodeState, QSGBatchRenderer::RenderNodeState, RenderNodeState, and RenderNodeState.

stencilValue()

virtual int QSGRenderNode::RenderState::stencilValue ( ) const

pure virtual

Returns

the current stencil reference value when clipping is active.

Implemented in QSGBatchRenderer::RenderNodeState, QSGBatchRenderer::RenderNodeState, RenderNodeState, and RenderNodeState.

---

The documentation for this class was generated from the following files:

• qtdeclarative/src/quick/scenegraph/coreapi/qsgrendernode.h (839716872b9d5f9300eea4d0ddc7bf0fa6168165)
• qtdeclarative/src/quick/scenegraph/coreapi/qsgrendernode.cpp (d3d045f7e9f1a2140e0d6db6c722f6a907ba2cdf)