stable/c_api/_sc_aruco_dictionary_8h_source.html

#ifndef SC_ARUCO_DICTIONARY_H_

#define SC_ARUCO_DICTIONARY_H_


#include <Scandit/ScConfig.h>


SC_EXTERN_C_BEGIN


typedef enum {

    SC_ARUCO_DICTIONARY_PRESET_4X4_250 = 2,

    SC_ARUCO_DICTIONARY_PRESET_5X5_50 = 4,

    SC_ARUCO_DICTIONARY_PRESET_5X5_100 = 5,

    SC_ARUCO_DICTIONARY_PRESET_5X5_250 = 6,

    SC_ARUCO_DICTIONARY_PRESET_5X5_1000 = 7,

    SC_ARUCO_DICTIONARY_PRESET_5X5_1023 = 16, // From original ArUco paper

    SC_ARUCO_DICTIONARY_PRESET_6X6_250 = 10,

} ScArucoDictionaryPreset;


typedef struct ScOpaqueArucoDictionary ScArucoDictionary;


SC_EXPORT

ScArucoDictionary *sc_aruco_dictionary_from_preset(ScArucoDictionaryPreset preset);


SC_EXPORT

void sc_aruco_dictionary_retain(ScArucoDictionary const *dictionary);


SC_EXPORT

void sc_aruco_dictionary_release(ScArucoDictionary const *dictionary);


SC_EXPORT

ScArucoDictionary *sc_aruco_dictionary_new(uint32_t marker_size);


SC_EXPORT

ScBool sc_aruco_dictionary_add_marker(ScArucoDictionary *dictionary,

                                      uint8_t *marker_bits,

                                      uint32_t marker_size);


SC_EXTERN_C_END


#endif // SC_ARUCO_DICTIONARY_H_

ScArucoDictionaryPreset
ScArucoDictionaryPreset
Predefined dictionaries compatible with OpenCV.
Definition: ScArucoDictionary.h:20

ScConfig.h
Common definitions used throughout the ScanditSDK API.

SC_EXTERN_C_BEGIN
#define SC_EXTERN_C_BEGIN
Start of external C code.
Definition: ScConfig.h:19

SC_EXTERN_C_END
#define SC_EXTERN_C_END
End of external C code.
Definition: ScConfig.h:28

ScBool
int32_t ScBool
Boolean value, can be SC_TRUE or SC_FALSE.
Definition: ScConfig.h:167

ScArucoDictionary
ArUco Symbology Dictionary.

ScArucoDictionary::sc_aruco_dictionary_from_preset
ScArucoDictionary * sc_aruco_dictionary_from_preset(ScArucoDictionaryPreset preset)
creates a constant prefilled dictionary

ScArucoDictionary::sc_aruco_dictionary_retain
void sc_aruco_dictionary_retain(ScArucoDictionary const *dictionary)
Increase reference count of an Aruco dictionary by one.

ScArucoDictionary::sc_aruco_dictionary_add_marker
ScBool sc_aruco_dictionary_add_marker(ScArucoDictionary *dictionary, uint8_t *marker_bits, uint32_t marker_size)
adds an aruco marker to a dictionary. Serialization of dictionaries created or modified using this fu...

ScArucoDictionary::sc_aruco_dictionary_new
ScArucoDictionary * sc_aruco_dictionary_new(uint32_t marker_size)
creates a new aruco dictionary with the specified marker size

ScArucoDictionary::sc_aruco_dictionary_release
void sc_aruco_dictionary_release(ScArucoDictionary const *dictionary)
Decrease reference count of an Aruco dictionary by one.