CVB++ 15.0
Public Member Functions | Static Public Member Functions | List of all members
FormatConverter Class Referencefinal

A format converter for video frames. More...

#include <cvb/codec_bridge/format_converter.hpp>

Public Member Functions

void Execute (const Frame &srcFrame, const Frame &dstFrame)
 Convert an from one frame to another. More...
 

Static Public Member Functions

static std::unique_ptr< FormatConverter > Create (Size2D< int > srcSize, PixelFormat srcFormat, Size2D< int > dstSize, PixelFormat dstFormat, Interpolation method)
 Creates a format converter. More...
 

Detailed Description

A format converter for video frames.

Member Function Documentation

◆ Create()

static std::unique_ptr< FormatConverter > Create ( Size2D< int >  srcSize,
PixelFormat  srcFormat,
Size2D< int >  dstSize,
PixelFormat  dstFormat,
Interpolation  method 
)
inlinestatic

Creates a format converter.

Parameters
[in]srcSizeThe size of the source frame.
[in]srcFormatThe pixel format of the source frame.
[in]dstSizeThe size of the destination frame.
[in]dstFormatThe pixel format of the destination frame.
[in]methodThe method to interpolate if scaling is done.
Returns
A pointer to a converter object.
Exceptions
Anyexception derived from std::exception including CvbException.

◆ Execute()

void Execute ( const Frame &  srcFrame,
const Frame &  dstFrame 
)
inline

Convert an from one frame to another.

Parameters
[in]srcFrameThe source frame.
[in]dstFrameThe destination frame.
Exceptions
Anyexception derived from std::exception including CvbException.

The frames properties must match those used when the converter was created.