A factory class for creating filters. More...

#include <Filter.hpp>

Static Public Member Functions
static std::shared_ptr< Filter >	createFilter (const std::string &name)
	Create a filter by name.

static std::shared_ptr< Filter >	createPrivateFilter (const std::string &name, const std::string &activationKey)
	Create a private filter by name and activation key.

static std::string	getFilterVendorSpecificCode (const std::string &name)
	Get the vendor specific code of a filter by filter name.

Detailed Description

A factory class for creating filters.

Definition at line 297 of file Filter.hpp.

Member Function Documentation

static std::shared_ptr< Filter > ob::FilterFactory::createFilter ( const std::string & name )

inlinestatic

Create a filter by name.

Definition at line 302 of file Filter.hpp.

static std::shared_ptr< Filter > ob::FilterFactory::createPrivateFilter	(	const std::string &	name,
		const std::string &	activationKey )

inlinestatic

Create a private filter by name and activation key.

Some private filters require an activation key to be activated, its depends on the vendor of the filter.

Parameters

name	The name of the filter.
activation_key	The activation key of the filter.

Definition at line 316 of file Filter.hpp.

static std::string ob::FilterFactory::getFilterVendorSpecificCode ( const std::string & name )

inlinestatic

Get the vendor specific code of a filter by filter name.

A private filter can define its own vendor specific code for specific purposes.

Parameters

name	The name of the filter.

Definition at line 330 of file Filter.hpp.

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

D:/program/gitlab_repository/package/openorbbecsdkgroup/OpenOrbbecSDK/include/libobsensor/hpp/Filter.hpp