Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QSGVideoMaterial Class Reference
Inheritance diagram for QSGVideoMaterial:
Collaboration diagram for QSGVideoMaterial:

Public Member Functions

 QSGVideoMaterial (const QVideoFrameFormat &videoFormat, QRhi *rhi)
QSGMaterialTypetype () const override
 This function is called by the scene graph to query an identifier that is unique to the QSGMaterialShader instantiated by createShader().
QSGMaterialShadercreateShader (QSGRendererInterface::RenderMode) const override
 This function returns a new instance of a the QSGMaterialShader implementation used to render geometry for a specific implementation of QSGMaterial.
int compare (const QSGMaterial *other) const override
 Compares this material to other and returns 0 if they are equal; -1 if this material should sort before other and 1 if other should sort before.
void updateBlending ()
void setSurfaceFormat (const QRhiSwapChain::Format surfaceFormat)
void setHdrInfo (const QRhiSwapChainHdrInfo &hdrInfo)
void updateTextures (QRhi *rhi, QRhiResourceUpdateBatch *resourceUpdates)
 QSGVideoMaterial (const QVideoFrameFormat &videoFormat, QRhi *rhi)
QSGMaterialTypetype () const override
 This function is called by the scene graph to query an identifier that is unique to the QSGMaterialShader instantiated by createShader().
QSGMaterialShadercreateShader (QSGRendererInterface::RenderMode) const override
 This function returns a new instance of a the QSGMaterialShader implementation used to render geometry for a specific implementation of QSGMaterial.
int compare (const QSGMaterial *other) const override
 Compares this material to other and returns 0 if they are equal; -1 if this material should sort before other and 1 if other should sort before.
void updateBlending ()
void setSurfaceFormat (const QRhiSwapChain::Format surfaceFormat)
void setHdrInfo (const QRhiSwapChainHdrInfo &hdrInfo)
void updateTextures (QRhi *rhi, QRhiResourceUpdateBatch *resourceUpdates)
Public Member Functions inherited from QSGMaterial
 QSGMaterial ()
virtual ~QSGMaterial ()
QSGMaterial::Flags flags () const
 Returns the material's flags.
void setFlag (Flags flags, bool on=true)
 Sets the flags flags on this material if on is true; otherwise clears the attribute.
int viewCount () const

Public Attributes

QVideoFrameFormat m_videoFormat
QRhiSwapChain::Format m_surfaceFormat = QRhiSwapChain::SDR
float m_opacity = 1.0f
QRhiSwapChainHdrInfo m_hdrInfo
QVideoFrameTexturePoolPtr m_texturePool = std::make_shared<QVideoFrameTexturePool>()
std::array< QSGVideoTexture, 3 > m_textures
QRhim_rhi

Additional Inherited Members

Public Types inherited from QSGMaterial
enum  Flag {
  Blending = 0x0001 , RequiresDeterminant = 0x0002 , RequiresFullMatrixExceptTranslate = 0x0004 | RequiresDeterminant , RequiresFullMatrix = 0x0008 | RequiresFullMatrixExceptTranslate ,
  NoBatching = 0x0010 , MultiView2 = 0x10000 , MultiView3 = 0x20000 , MultiView4 = 0x40000
}
 \value Blending Set this flag to true if the material requires blending to be enabled during rendering. More...

Detailed Description

Definition at line 130 of file qsgvideonode_p.cpp.

Constructor & Destructor Documentation

◆ QSGVideoMaterial() [1/2]

QSGVideoMaterial::QSGVideoMaterial ( const QVideoFrameFormat & videoFormat,
QRhi * rhi )

Definition at line 246 of file qsgvideonode_p.cpp.

References QSGVideoMaterial().

Referenced by QSGVideoMaterial().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ QSGVideoMaterial() [2/2]

QSGVideoMaterial::QSGVideoMaterial ( const QVideoFrameFormat & videoFormat,
QRhi * rhi )

Member Function Documentation

◆ compare() [1/2]

int QSGVideoMaterial::compare ( const QSGMaterial * other) const
inlineoverridevirtual

Compares this material to other and returns 0 if they are equal; -1 if this material should sort before other and 1 if other should sort before.

The scene graph can reorder geometry nodes to minimize state changes. The compare function is called during the sorting process so that the materials can be sorted to minimize state changes in each call to QSGMaterialShader::updateState().

The this pointer and other is guaranteed to have the same type().

Reimplemented from QSGMaterial.

Definition at line 145 of file qsgvideonode_p.cpp.

◆ compare() [2/2]

int QSGVideoMaterial::compare ( const QSGMaterial * other) const
inlineoverridevirtual

Compares this material to other and returns 0 if they are equal; -1 if this material should sort before other and 1 if other should sort before.

The scene graph can reorder geometry nodes to minimize state changes. The compare function is called during the sorting process so that the materials can be sorted to minimize state changes in each call to QSGMaterialShader::updateState().

The this pointer and other is guaranteed to have the same type().

Reimplemented from QSGMaterial.

Definition at line 145 of file qsgvideonode_p.cpp.

◆ createShader() [1/2]

QSGMaterialShader * QSGVideoMaterial::createShader ( QSGRendererInterface::RenderMode renderMode) const
inlinenodiscardoverridevirtual

This function returns a new instance of a the QSGMaterialShader implementation used to render geometry for a specific implementation of QSGMaterial.

The function will be called only once for each combination of material type and renderMode and will be cached internally.

For most materials, the renderMode can be ignored. A few materials may need custom handling for specific render modes. For instance if the material implements antialiasing in a way that needs to account for perspective transformations when RenderMode3D is in use.

Implements QSGMaterial.

Definition at line 141 of file qsgvideonode_p.cpp.

◆ createShader() [2/2]

QSGMaterialShader * QSGVideoMaterial::createShader ( QSGRendererInterface::RenderMode renderMode) const
inlinenodiscardoverridevirtual

This function returns a new instance of a the QSGMaterialShader implementation used to render geometry for a specific implementation of QSGMaterial.

The function will be called only once for each combination of material type and renderMode and will be cached internally.

For most materials, the renderMode can be ignored. A few materials may need custom handling for specific render modes. For instance if the material implements antialiasing in a way that needs to account for perspective transformations when RenderMode3D is in use.

Implements QSGMaterial.

Definition at line 141 of file qsgvideonode_p.cpp.

◆ setHdrInfo() [1/2]

void QSGVideoMaterial::setHdrInfo ( const QRhiSwapChainHdrInfo & hdrInfo)
inline

Definition at line 167 of file qsgvideonode_p.cpp.

◆ setHdrInfo() [2/2]

void QSGVideoMaterial::setHdrInfo ( const QRhiSwapChainHdrInfo & hdrInfo)
inline

Definition at line 167 of file qsgvideonode_p.cpp.

◆ setSurfaceFormat() [1/2]

void QSGVideoMaterial::setSurfaceFormat ( const QRhiSwapChain::Format surfaceFormat)
inline

Definition at line 162 of file qsgvideonode_p.cpp.

◆ setSurfaceFormat() [2/2]

void QSGVideoMaterial::setSurfaceFormat ( const QRhiSwapChain::Format surfaceFormat)
inline

Definition at line 162 of file qsgvideonode_p.cpp.

◆ type() [1/2]

QSGMaterialType * QSGVideoMaterial::type ( ) const
inlinenodiscardoverridevirtual

This function is called by the scene graph to query an identifier that is unique to the QSGMaterialShader instantiated by createShader().

For many materials, the typical approach will be to return a pointer to a static, and so globally available, QSGMaterialType instance. The QSGMaterialType is an opaque object. Its purpose is only to serve as a type-safe, simple way to generate unique material identifiers.

QSGMaterialType *type() const override
{
return &type;
}
QSGMaterialType * type() const override
This function is called by the scene graph to query an identifier that is unique to the QSGMaterialSh...
GLenum type
The QSGMaterialType class is used as a unique type token in combination with QSGMaterial.

Implements QSGMaterial.

Definition at line 135 of file qsgvideonode_p.cpp.

◆ type() [2/2]

QSGMaterialType * QSGVideoMaterial::type ( ) const
inlinenodiscardoverridevirtual

This function is called by the scene graph to query an identifier that is unique to the QSGMaterialShader instantiated by createShader().

For many materials, the typical approach will be to return a pointer to a static, and so globally available, QSGMaterialType instance. The QSGMaterialType is an opaque object. Its purpose is only to serve as a type-safe, simple way to generate unique material identifiers.

QSGMaterialType *type() const override
{
return &type;
}

Implements QSGMaterial.

Definition at line 135 of file qsgvideonode_p.cpp.

◆ updateBlending() [1/2]

void QSGVideoMaterial::updateBlending ( )
inline

Definition at line 157 of file qsgvideonode_p.cpp.

◆ updateBlending() [2/2]

void QSGVideoMaterial::updateBlending ( )
inline

Definition at line 157 of file qsgvideonode_p.cpp.

◆ updateTextures() [1/2]

void QSGVideoMaterial::updateTextures ( QRhi * rhi,
QRhiResourceUpdateBatch * resourceUpdates )

Definition at line 185 of file qsgvideonode_p.cpp.

◆ updateTextures() [2/2]

void QSGVideoMaterial::updateTextures ( QRhi * rhi,
QRhiResourceUpdateBatch * resourceUpdates )

Member Data Documentation

◆ m_hdrInfo

QRhiSwapChainHdrInfo QSGVideoMaterial::m_hdrInfo

Definition at line 177 of file qsgvideonode_p.cpp.

◆ m_opacity

float QSGVideoMaterial::m_opacity = 1.0f

Definition at line 176 of file qsgvideonode_p.cpp.

◆ m_rhi

QRhi * QSGVideoMaterial::m_rhi

Definition at line 182 of file qsgvideonode_p.cpp.

◆ m_surfaceFormat

QRhiSwapChain::Format QSGVideoMaterial::m_surfaceFormat = QRhiSwapChain::SDR

Definition at line 175 of file qsgvideonode_p.cpp.

◆ m_texturePool

QVideoFrameTexturePoolPtr QSGVideoMaterial::m_texturePool = std::make_shared<QVideoFrameTexturePool>()

Definition at line 179 of file qsgvideonode_p.cpp.

◆ m_textures

std::array< QSGVideoTexture, 3 > QSGVideoMaterial::m_textures

Definition at line 180 of file qsgvideonode_p.cpp.

◆ m_videoFormat

QVideoFrameFormat QSGVideoMaterial::m_videoFormat

Definition at line 174 of file qsgvideonode_p.cpp.


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