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>.
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 ()
 
QVideoFrame::MapMode mapMode () const override
 
MapData map (QVideoFrame::MapMode mode) override
 Independently 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) const override
 Returns a texture handle to the data buffer.
 
QImageVideoBufferensureImageBuffer ()
 
- Public Member Functions inherited from QAbstractVideoBuffer
 QAbstractVideoBuffer (QVideoFrame::HandleType type, QRhi *rhi=nullptr)
 Constructs an abstract video buffer of the given type.
 
virtual ~QAbstractVideoBuffer ()
 Destroys an abstract video buffer.
 
QVideoFrame::HandleType handleType () const
 Returns the type of a video buffer's handle.
 
QRhirhi () const
 Returns the QRhi instance.
 
virtual std::unique_ptr< QVideoFrameTexturesmapTextures (QRhi *)
 
virtual QMatrix4x4 externalTextureMatrix () const
 
virtual QByteArray underlyingByteArray (int) const
 

Additional Inherited Members

- Protected Attributes inherited from QAbstractVideoBuffer
QVideoFrame::HandleType m_type
 
QRhim_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 57 of file qopenglvideobuffer.cpp.

References Q_ASSERT.

◆ ~QOpenGLVideoBuffer()

QOpenGLVideoBuffer::~QOpenGLVideoBuffer ( )

Definition at line 63 of file qopenglvideobuffer.cpp.

Member Function Documentation

◆ ensureImageBuffer()

QImageVideoBuffer & QOpenGLVideoBuffer::ensureImageBuffer ( )

Definition at line 87 of file qopenglvideobuffer.cpp.

References qWarning, and 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

Independently maps the planes of a video buffer to memory.

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 be sure to call the unmap() function to release the mapped memory and possibly update the buffer contents.

Returns the number of planes in the mapped video data. For each plane the line stride of that plane will be returned in bytesPerLine, and a pointer to the plane data will be returned in data. The accumulative size of the mapped data is returned in numBytes.

Not all buffer implementations will map more than the first plane, if this returns a single plane for a planar format the additional planes will have to be calculated from the line stride of the first plane and the frame height. Mapping a buffer with QVideoFrame will do this for you.

To implement this function create a derivative of QAbstractPlanarVideoBuffer and implement its map function instance instead.

Since
5.4

Implements QAbstractVideoBuffer.

Definition at line 70 of file qopenglvideobuffer.cpp.

References ensureImageBuffer(), and QImageVideoBuffer::map().

+ Here is the call graph for this function:

◆ mapMode()

QVideoFrame::MapMode QOpenGLVideoBuffer::mapMode ( ) const
overridevirtual

Implements QAbstractVideoBuffer.

Definition at line 65 of file qopenglvideobuffer.cpp.

References QVideoFrame::NotMapped.

◆ textureHandle()

quint64 QOpenGLVideoBuffer::textureHandle ( QRhi * rhi,
int plane ) const
overridevirtual

Returns a texture handle to the data buffer.

See also
handleType()

Reimplemented from QAbstractVideoBuffer.

Definition at line 81 of file qopenglvideobuffer.cpp.

References Q_UNUSED.

◆ 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.

See also
map()

Implements QAbstractVideoBuffer.

Definition at line 75 of file qopenglvideobuffer.cpp.


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