ScArucoDictionary.h
Go to the documentation of this file.
1 
10 #ifndef SC_ARUCO_DICTIONARY_H
11 #define SC_ARUCO_DICTIONARY_H
12 
13 #include <Scandit/ScConfig.h>
14 
15 #if defined(__cplusplus)
16 extern "C" {
17 #endif
18 
22 typedef enum {
23  SC_ARUCO_DICTIONARY_PRESET_4X4_250 = 2,
24  SC_ARUCO_DICTIONARY_PRESET_5X5_50 = 4,
25  SC_ARUCO_DICTIONARY_PRESET_5X5_100 = 5,
26  SC_ARUCO_DICTIONARY_PRESET_5X5_250 = 6,
27  SC_ARUCO_DICTIONARY_PRESET_5X5_1000 = 7,
28  SC_ARUCO_DICTIONARY_PRESET_5X5_1023 = 16, // From original ArUco paper
29  SC_ARUCO_DICTIONARY_PRESET_6X6_250 = 10,
30 } ScArucoDictionaryPreset;
31 
39 typedef struct ScOpaqueArucoDictionary ScArucoDictionary;
42 
52 SC_EXPORT
53 ScArucoDictionary *sc_aruco_dictionary_from_preset(ScArucoDictionaryPreset preset);
54 
63 SC_EXPORT
64 void sc_aruco_dictionary_retain(ScArucoDictionary *dictionary);
65 
76 SC_EXPORT
77 void sc_aruco_dictionary_release(ScArucoDictionary *dictionary);
78 
88 SC_EXPORT
89 ScArucoDictionary *sc_aruco_dictionary_new(uint32_t marker_size);
90 
107 SC_EXPORT
108 ScBool sc_aruco_dictionary_add_marker(ScArucoDictionary *dictionary,
109  uint8_t *marker_bits,
110  uint32_t marker_size);
111 
112 #if defined(__cplusplus)
113 }
114 #endif
115 #endif
ScArucoDictionary
ArUco Symbology Dictionary.
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 *dictionary)
Decrease reference count of an Aruco dictionary by one.
ScArucoDictionaryPreset
ScArucoDictionaryPreset
Predefined dictionaries compatible with OpenCV.
Definition: ScArucoDictionary.h:22
ScArucoDictionary::sc_aruco_dictionary_retain
void sc_aruco_dictionary_retain(ScArucoDictionary *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...
ScConfig.h
Common definitions used throughout the ScanditSDK API.
ScArucoDictionary::sc_aruco_dictionary_from_preset
ScArucoDictionary * sc_aruco_dictionary_from_preset(ScArucoDictionaryPreset preset)
creates a constant prefilled dictionary
ScBool
int32_t ScBool
Boolean value, can be SC_TRUE or SC_FALSE.
Definition: ScConfig.h:127
Copyright (C) 2024 Scandit AG