QCGImageVideoBuffer Class Reference

Inheritance diagram for QCGImageVideoBuffer:

Collaboration diagram for QCGImageVideoBuffer:

Public Member Functions
	QCGImageVideoBuffer (CGImageRef image)
	~QCGImageVideoBuffer () override
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.
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.
QRhi *	rhi () const
	Returns the QRhi instance.
virtual QVideoFrame::MapMode	mapMode () const =0
virtual MapData	map (QVideoFrame::MapMode mode)=0
	Independently maps the planes of a video buffer to memory.
virtual void	unmap ()=0
	Releases the memory mapped by the map() function.
virtual std::unique_ptr< QVideoFrameTextures >	mapTextures (QRhi *)
virtual quint64	textureHandle (int) const
	Returns a texture handle to the data buffer.
virtual QMatrix4x4	externalTextureMatrix () const

Additional Inherited Members
Protected Attributes inherited from QAbstractVideoBuffer
QVideoFrame::HandleType	m_type
QRhi *	m_rhi = nullptr

Detailed Description

Definition at line 39 of file qcgwindowcapture.mm.

Constructor & Destructor Documentation

QCGImageVideoBuffer()

QCGImageVideoBuffer::QCGImageVideoBuffer ( CGImageRef  image )

inline

Definition at line 42 of file qcgwindowcapture.mm.

~QCGImageVideoBuffer()

QCGImageVideoBuffer::~QCGImageVideoBuffer ( )

inlineoverride

Definition at line 49 of file qcgwindowcapture.mm.

Member Function Documentation

map()

MapData QCGImageVideoBuffer::map ( QVideoFrame::MapMode  mode )

inlineoverridevirtual

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 53 of file qcgwindowcapture.mm.

References QAbstractVideoBuffer::MapData::bytesPerLine, QAbstractVideoBuffer::MapData::data, mapData(), QVideoFrame::NotMapped, QAbstractVideoBuffer::MapData::nPlanes, and QAbstractVideoBuffer::MapData::size.

Here is the call graph for this function:

mapMode()

QVideoFrame::MapMode QCGImageVideoBuffer::mapMode ( ) const

inlineoverridevirtual

Implements QAbstractVideoBuffer.

Definition at line 51 of file qcgwindowcapture.mm.

unmap()

void QCGImageVideoBuffer::unmap ( )

inlineoverridevirtual

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 68 of file qcgwindowcapture.mm.

References QVideoFrame::NotMapped.

---

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

• qtmultimedia/src/plugins/multimedia/ffmpeg/qcgwindowcapture.mm