CVB++ 15.0
Loading...
Searching...
No Matches

Configuration class for QR codes. More...

#include <cvb/config.hpp>

Inherits ConfigBase< QR >.

Inherited by MicroQR.

Public Member Functions

QRSetPolarity (Polarity value)
 Sets polarity mode for decoding.
 
Config::Polarity Polarity () const
 Gets the currently configured polarity mode.
 
QRSetMirroringEnabled (bool value)
 Enables or disables mirroring based on the given value.
 
bool IsMirroringEnabled () const
 Check whether mirroring is enabled.
 
QRSetPreciseCornersEnabled (bool value)
 Enables or disables the calculation of more precise corner coordinates.
 
bool IsPreciseCornersEnabled () const
 Check whether the calculation of more precise corner coordinates is enabled.
 
- Public Member Functions inherited from ConfigBase< QR >
bool Enabled () const
 Checks if decoding for the code type represented by the derived class is enabled.
 
QREnable ()
 Enables decoding for the code type represented by the derived class.
 
QRDisable ()
 Disables decoding for the code type represented by the derived class.
 

Friends

class Cvb::CodeReader::Decoder
 

Detailed Description

Configuration class for QR codes.

Use this class to configure decoding options for QR codes. To access the configuration and enable decoding QR codes, use the following example. For additional details on configuration, refer to the documentation for Decoder::Config().

QR & Enable()
Definition detail_config_base.hpp:16
static std::unique_ptr< Decoder > Create()
Creates and returns a new Decoder instance.
Definition detail_decoder.hpp:22
@ QR
QR code.
Definition decl_config_base.hpp:47
Note
A more comprehensive code example demonstrating configuration in a broader context, as well as the decoding process, can be found here.

Member Function Documentation

◆ IsMirroringEnabled()

bool IsMirroringEnabled ( ) const
inline

Check whether mirroring is enabled.

Returns
true if mirroring is enabled, false otherwise.

◆ IsPreciseCornersEnabled()

bool IsPreciseCornersEnabled ( ) const
inline

Check whether the calculation of more precise corner coordinates is enabled.

Returns
true if the calculation of more precise corner coordinates is enabled, false otherwise.

◆ Polarity()

Polarity Polarity ( ) const
inline

Gets the currently configured polarity mode.

Returns
The polarity mode.

◆ SetMirroringEnabled()

QR & SetMirroringEnabled ( bool value)
inline

Enables or disables mirroring based on the given value.

Parameters
valueSet to true to enable mirroring, or false to disable it.
Returns
A reference to the current QR object for method chaining.

◆ SetPolarity()

QR & SetPolarity ( Config::Polarity value)
inline

Sets polarity mode for decoding.

Parameters
valueThe desired polarity mode.
Returns
A reference to the current QR object for method chaining.

◆ SetPreciseCornersEnabled()

QR & SetPreciseCornersEnabled ( bool value)
inline

Enables or disables the calculation of more precise corner coordinates.

When a QR Code is decoded, the detected corners used for decoding may not be very precise. Use this setting to get more precise corner coordinates.

Parameters
valueSet to true to enable the calculation of more precise corner coordinates, or false to disable it.
Returns
A reference to the current QR object for method chaining.