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
QOpenGLVideoBuffer Class Reference

#include <qopenglvideobuffer_p.h>

Inheritance diagram for QOpenGLVideoBuffer:
Collaboration diagram for QOpenGLVideoBuffer:

Public Member Functions

 QOpenGLVideoBuffer (std::unique_ptr< QOpenGLFramebufferObject > fbo)
 ~QOpenGLVideoBuffer () override
MapData map (QVideoFrame::MapMode mode) override
 Maps the planes of a video buffer to memory.
void unmap () override
 Releases the memory mapped by the map() function.
quint64 textureHandle (QRhi &, int plane) override
QImageVideoBuffer & ensureImageBuffer ()
Public Member Functions inherited from QHwVideoBuffer
 QHwVideoBuffer (QVideoFrame::HandleType type, QRhi *rhi=nullptr)
 ~QHwVideoBuffer () override
QVideoFrame::HandleType handleType () const
virtual QRhi * rhi () const
QVideoFrameFormat format () const override
 Gets \l QVideoFrameFormat of the underlying video buffer.
virtual QMatrix4x4 externalTextureMatrix () const
virtual QVideoFrameTexturesUPtr mapTextures (QRhi &, QVideoFrameTexturesUPtr &)
virtual void initTextureConverter (QRhi &)
virtual bool isDmaBuf () const
Public Member Functions inherited from QAbstractVideoBuffer
virtual ~QAbstractVideoBuffer ()
 \variable QAbstractVideoBuffer::MapData::planeCount
Public Member Functions inherited from QVideoFrameTexturesHandles
virtual ~QVideoFrameTexturesHandles ()

Additional Inherited Members

Protected Attributes inherited from QHwVideoBuffer
QVideoFrame::HandleType m_type
QRhi * m_rhi = nullptr

Detailed Description

Definition at line 25 of file qopenglvideobuffer_p.h.

Constructor & Destructor Documentation

◆ QOpenGLVideoBuffer()

QOpenGLVideoBuffer::QOpenGLVideoBuffer ( std::unique_ptr< QOpenGLFramebufferObject > fbo)

Definition at line 56 of file qopenglvideobuffer.cpp.

References QOpenGLVideoBuffer().

Referenced by QOpenGLVideoBuffer().

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

◆ ~QOpenGLVideoBuffer()

QOpenGLVideoBuffer::~QOpenGLVideoBuffer ( )
overridedefault

Member Function Documentation

◆ ensureImageBuffer()

QImageVideoBuffer & QOpenGLVideoBuffer::ensureImageBuffer ( )

Definition at line 81 of file qopenglvideobuffer.cpp.

References setCurrentOpenGLContext().

Referenced by map().

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

◆ map()

QAbstractVideoBuffer::MapData QOpenGLVideoBuffer::map ( QVideoFrame::MapMode mode)
overridevirtual

Maps the planes of a video buffer to memory.

Returns a \l MapData structure that contains information about the plane layout of the mapped current video data. If the mapping fails, the method returns the default structure. For CPU memory buffers, the data is considered as already mapped, so the function just returns the plane layout of the preallocated underlying data.

The map mode indicates whether the contents of the mapped memory should be read from and/or written to the buffer. If the map mode includes the QVideoFrame::ReadOnly flag the mapped memory will be populated with the content of the buffer when initially mapped. If the map mode includes the QVideoFrame::WriteOnly flag the content of the possibly modified mapped memory will be written back to the buffer when unmapped.

When access to the data is no longer needed, the \l unmap function is called to release the mapped memory and possibly update the buffer contents.

If the format of the video data is multiplanar, the method may map the whole pixel data as a single plane. In this case, mapping a buffer with \l QVideoFrame will calculate additional planes from the specified line stride of the first plane, the frame height, and the data size.

Implements QAbstractVideoBuffer.

Definition at line 64 of file qopenglvideobuffer.cpp.

References ensureImageBuffer().

Here is the call graph for this function:

◆ textureHandle()

quint64 QOpenGLVideoBuffer::textureHandle ( QRhi & ,
int plane )
overridevirtual

Reimplemented from QVideoFrameTexturesHandles.

Definition at line 75 of file qopenglvideobuffer.cpp.

◆ unmap()

void QOpenGLVideoBuffer::unmap ( )
overridevirtual

Releases the memory mapped by the map() function.

If the \l {QVideoFrame::MapMode}{MapMode} included the QVideoFrame::WriteOnly flag this will write the current content of the mapped memory back to the video frame.

For CPU video buffers, the function may be not overridden. The default implementation of unmap does nothing.

See also
map()

Reimplemented from QAbstractVideoBuffer.

Definition at line 69 of file qopenglvideobuffer.cpp.

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