QCGImageVideoBuffer Class Reference

Inheritance diagram for QCGImageVideoBuffer:

Collaboration diagram for QCGImageVideoBuffer:

Public Member Functions
	QCGImageVideoBuffer (CGImageRef image)
	~QCGImageVideoBuffer () override
MapData	map (QVideoFrame::MapMode) override
	Maps the planes of a video buffer to memory.
QVideoFrameFormat	format () const override
	Gets \l QVideoFrameFormat of the underlying video buffer.
	QCGImageVideoBuffer (CGImageRef image)
	~QCGImageVideoBuffer () override
MapData	map (QVideoFrame::MapMode) override
	Maps the planes of a video buffer to memory.
QVideoFrameFormat	format () const override
	Gets \l QVideoFrameFormat of the underlying video buffer.
Public Member Functions inherited from QAbstractVideoBuffer
virtual	~QAbstractVideoBuffer ()
	\variable QAbstractVideoBuffer::MapData::planeCount
virtual void	unmap ()
	Releases the memory mapped by the map() function.

Detailed Description

Definition at line 44 of file qcgwindowcapture.mm.

Constructor & Destructor Documentation

QCGImageVideoBuffer() [1/2]

QCGImageVideoBuffer::QCGImageVideoBuffer ( CGImageRef image )

inline

Definition at line 47 of file qcgwindowcapture.mm.

~QCGImageVideoBuffer() [1/2]

QCGImageVideoBuffer::~QCGImageVideoBuffer ( )

inlineoverride

Definition at line 54 of file qcgwindowcapture.mm.

QCGImageVideoBuffer() [2/2]

QCGImageVideoBuffer::QCGImageVideoBuffer ( CGImageRef image )

inline

Definition at line 47 of file qcgwindowcapture.mm.

~QCGImageVideoBuffer() [2/2]

QCGImageVideoBuffer::~QCGImageVideoBuffer ( )

inlineoverride

Definition at line 54 of file qcgwindowcapture.mm.

Member Function Documentation

format() [1/2]

QVideoFrameFormat QCGImageVideoBuffer::format ( ) const

inlineoverridevirtual

Gets \l QVideoFrameFormat of the underlying video buffer.

The format must be available upon construction of \l QVideoFrame. QVideoFrame will contain won instance of the given format, that can be detached and modified.

Implements QAbstractVideoBuffer.

Definition at line 68 of file qcgwindowcapture.mm.

format() [2/2]

QVideoFrameFormat QCGImageVideoBuffer::format ( ) const

inlineoverridevirtual

Gets \l QVideoFrameFormat of the underlying video buffer.

The format must be available upon construction of \l QVideoFrame. QVideoFrame will contain won instance of the given format, that can be detached and modified.

Implements QAbstractVideoBuffer.

Definition at line 68 of file qcgwindowcapture.mm.

map() [1/2]

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

inlineoverridevirtual

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

map() [2/2]

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

inlineoverridevirtual

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

---

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

• qtmultimedia/src/plugins/multimedia/ffmpeg/darwin/qcgwindowcapture.mm (4fd6b1777aa723a0ef472bb01e185509df8452e7)