0. Introduction - matt-s-clark/godot-gdextension-opencv GitHub Wiki

The long term objective of this extension is to make most of OpenCV accessible in GDScript. This documentation will hopefully guide you trough the decisions made to adapt the c++ library to Godot. It is useful to refer to the official OpenCV documentation here for more information on image processing and more detailed descriptions of the available algorithms.

General design decisions

  • We added CV to the beginning of all classes to better separate from Godot's and your own functionality Methods that have OutputArrays are changed to return said arrays, similar to the python API
  • CV's Points and size objects were substituted for Godot's vector2 for simplicity. Any method that receives or returns one of these types will receive or return a vector2 instead.
  • The extension use a dictionary to enable the use of optional parameters and some overriding of functionality. The keys of this dictionary should be the same as the name of the inputs on the c++ reference rewritten to snake case. This reference will include them case by case.
  • All constants will be accessible with the CVConsts class, enumerables should have the same name they have in the c++ reference. They are currently not separated by module.