Skip to content

Commit

Permalink
Regenerate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@twistedfall
twistedfall committed Jan 9, 2025
1 parent cdff759 commit 1c511d4
Show file tree
Hide file tree
Showing 10 changed files with 5,099 additions and 5,951 deletions.
273 changes: 151 additions & 122 deletions docs/core.rs
View file

Large diffs are not rendered by default.

1,235 changes: 1,235 additions & 0 deletions docs/cudalegacy.rs
View file

Large diffs are not rendered by default.

12 changes: 12 additions & 0 deletions docs/dnn.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7420,6 +7420,9 @@ pub mod dnn {
Ok(ret)
}

/// ## Note
/// This alternative version of [DictValueTraitConst::get_str] function uses the following default values for its arguments:
/// * idx: -1
#[inline]
fn get_str_def(&self) -> Result<String> {
return_send!(via ocvrs_return);
Expand All @@ -7441,6 +7444,9 @@ pub mod dnn {
Ok(ret)
}

/// ## Note
/// This alternative version of [DictValueTraitConst::get_f64] function uses the following default values for its arguments:
/// * idx: -1
#[inline]
fn get_f64_def(&self) -> Result<f64> {
return_send!(via ocvrs_return);
Expand All @@ -7461,6 +7467,9 @@ pub mod dnn {
Ok(ret)
}

/// ## Note
/// This alternative version of [DictValueTraitConst::get_i32] function uses the following default values for its arguments:
/// * idx: -1
#[inline]
fn get_i32_def(&self) -> Result<i32> {
return_send!(via ocvrs_return);
Expand All @@ -7481,6 +7490,9 @@ pub mod dnn {
Ok(ret)
}

/// ## Note
/// This alternative version of [DictValueTraitConst::get_i64] function uses the following default values for its arguments:
/// * idx: -1
#[inline]
fn get_i64_def(&self) -> Result<i64> {
return_send!(via ocvrs_return);
Expand Down
3 changes: 0 additions & 3 deletions docs/face.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3664,9 +3664,6 @@ pub mod face {
///
///
/// TODO Lifetime of detector parameters is uncontrolled. Rework interface design to "Ptr<FaceDetector>".
///
/// ## C++ default parameters
/// * user_data: 0
#[inline]
fn set_face_detector(&mut self, detector: crate::face::FN_FaceDetector) -> Result<bool> {
callback_arg!(detector_trampoline(unnamed: *const c_void, unnamed_1: *const c_void, user_data: *mut c_void) -> bool => user_data in detector(unnamed: *const c_void, unnamed_1: *const c_void) -> bool);
Expand Down
15 changes: 0 additions & 15 deletions docs/highgui.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -571,12 +571,8 @@ pub mod highgui {
///
/// ## Note
/// This alternative version of [create_button] function uses the following default values for its arguments:
/// * userdata: 0
/// * typ: QT_PUSH_BUTTON
/// * initial_button_state: false
///
/// ## C++ default parameters
/// * userdata: 0
#[inline]
pub fn create_button_def(bar_name: &str, on_change: crate::highgui::ButtonCallback) -> Result<i32> {
extern_container_arg!(bar_name);
Expand Down Expand Up @@ -618,7 +614,6 @@ pub mod highgui {
/// value could be 0 or 1. (__Optional__)
///
/// ## C++ default parameters
/// * userdata: 0
/// * typ: QT_PUSH_BUTTON
/// * initial_button_state: false
#[inline]
Expand Down Expand Up @@ -664,10 +659,6 @@ pub mod highgui {
/// Call the callback function manually with the desired initial value to avoid runtime warnings.
/// ## See also
/// \ref tutorial_trackbar
///
/// ## C++ default parameters
/// * on_change: 0
/// * userdata: 0
#[inline]
pub fn create_trackbar(trackbarname: &str, winname: &str, value: Option<&mut i32>, count: i32, on_change: crate::highgui::TrackbarCallback) -> Result<i32> {
extern_container_arg!(trackbarname);
Expand Down Expand Up @@ -1447,9 +1438,6 @@ pub mod highgui {
/// * winname: Name of the window.
/// * onMouse: Callback function for mouse events. See OpenCV samples on how to specify and use the callback.
/// * userdata: The optional parameter passed to the callback.
///
/// ## C++ default parameters
/// * userdata: 0
#[inline]
pub fn set_mouse_callback(winname: &str, on_mouse: crate::highgui::MouseCallback) -> Result<()> {
extern_container_arg!(winname);
Expand Down Expand Up @@ -1517,9 +1505,6 @@ pub mod highgui {
/// * onOpenGlDraw: Pointer to the function to be called every frame. This function should be
/// prototyped as void Foo(void\*) .
/// * userdata: Pointer passed to the callback function.(__Optional__)
///
/// ## C++ default parameters
/// * userdata: 0
#[inline]
pub fn set_opengl_draw_callback(winname: &str, on_opengl_draw: crate::highgui::OpenGlDrawCallback) -> Result<()> {
extern_container_arg!(winname);
Expand Down
134 changes: 2 additions & 132 deletions docs/hub.rs
View file
Original file line number Diff line number Diff line change
@@ -1,134 +1,69 @@
#[cfg(ocvrs_has_module_alphamat)]
include!(concat!(env!("OUT_DIR"), "/opencv/alphamat.rs"));
#[cfg(ocvrs_has_module_aruco)]
include!(concat!(env!("OUT_DIR"), "/opencv/aruco.rs"));
#[cfg(ocvrs_has_module_bgsegm)]
include!(concat!(env!("OUT_DIR"), "/opencv/bgsegm.rs"));
#[cfg(ocvrs_has_module_bioinspired)]
include!(concat!(env!("OUT_DIR"), "/opencv/bioinspired.rs"));
#[cfg(ocvrs_has_module_calib3d)]
include!(concat!(env!("OUT_DIR"), "/opencv/calib3d.rs"));
#[cfg(ocvrs_has_module_ccalib)]
include!(concat!(env!("OUT_DIR"), "/opencv/ccalib.rs"));
#[cfg(ocvrs_has_module_core)]
include!(concat!(env!("OUT_DIR"), "/opencv/core.rs"));
#[cfg(ocvrs_has_module_cudaarithm)]
include!(concat!(env!("OUT_DIR"), "/opencv/cudaarithm.rs"));
#[cfg(ocvrs_has_module_cudabgsegm)]
include!(concat!(env!("OUT_DIR"), "/opencv/cudabgsegm.rs"));
#[cfg(ocvrs_has_module_cudacodec)]
include!(concat!(env!("OUT_DIR"), "/opencv/cudacodec.rs"));
#[cfg(ocvrs_has_module_cudafeatures2d)]
include!(concat!(env!("OUT_DIR"), "/opencv/cudafeatures2d.rs"));
#[cfg(ocvrs_has_module_cudafilters)]
include!(concat!(env!("OUT_DIR"), "/opencv/cudafilters.rs"));
#[cfg(ocvrs_has_module_cudaimgproc)]
include!(concat!(env!("OUT_DIR"), "/opencv/cudaimgproc.rs"));
#[cfg(ocvrs_has_module_cudaobjdetect)]
include!(concat!(env!("OUT_DIR"), "/opencv/cudalegacy.rs"));
include!(concat!(env!("OUT_DIR"), "/opencv/cudaobjdetect.rs"));
#[cfg(ocvrs_has_module_cudaoptflow)]
include!(concat!(env!("OUT_DIR"), "/opencv/cudaoptflow.rs"));
#[cfg(ocvrs_has_module_cudastereo)]
include!(concat!(env!("OUT_DIR"), "/opencv/cudastereo.rs"));
#[cfg(ocvrs_has_module_cudawarping)]
include!(concat!(env!("OUT_DIR"), "/opencv/cudawarping.rs"));
#[cfg(ocvrs_has_module_cvv)]
include!(concat!(env!("OUT_DIR"), "/opencv/cvv.rs"));
#[cfg(ocvrs_has_module_dnn)]
include!(concat!(env!("OUT_DIR"), "/opencv/dnn.rs"));
#[cfg(ocvrs_has_module_dnn_superres)]
include!(concat!(env!("OUT_DIR"), "/opencv/dnn_superres.rs"));
#[cfg(ocvrs_has_module_dpm)]
include!(concat!(env!("OUT_DIR"), "/opencv/dpm.rs"));
#[cfg(ocvrs_has_module_face)]
include!(concat!(env!("OUT_DIR"), "/opencv/face.rs"));
#[cfg(ocvrs_has_module_features2d)]
include!(concat!(env!("OUT_DIR"), "/opencv/features2d.rs"));
#[cfg(ocvrs_has_module_flann)]
include!(concat!(env!("OUT_DIR"), "/opencv/flann.rs"));
#[cfg(ocvrs_has_module_freetype)]
include!(concat!(env!("OUT_DIR"), "/opencv/freetype.rs"));
#[cfg(ocvrs_has_module_fuzzy)]
include!(concat!(env!("OUT_DIR"), "/opencv/fuzzy.rs"));
#[cfg(ocvrs_has_module_gapi)]
include!(concat!(env!("OUT_DIR"), "/opencv/gapi.rs"));
#[cfg(ocvrs_has_module_hdf)]
include!(concat!(env!("OUT_DIR"), "/opencv/hdf.rs"));
#[cfg(ocvrs_has_module_hfs)]
include!(concat!(env!("OUT_DIR"), "/opencv/hfs.rs"));
#[cfg(ocvrs_has_module_highgui)]
include!(concat!(env!("OUT_DIR"), "/opencv/highgui.rs"));
#[cfg(ocvrs_has_module_img_hash)]
include!(concat!(env!("OUT_DIR"), "/opencv/img_hash.rs"));
#[cfg(ocvrs_has_module_imgcodecs)]
include!(concat!(env!("OUT_DIR"), "/opencv/imgcodecs.rs"));
#[cfg(ocvrs_has_module_imgproc)]
include!(concat!(env!("OUT_DIR"), "/opencv/imgproc.rs"));
#[cfg(ocvrs_has_module_intensity_transform)]
include!(concat!(env!("OUT_DIR"), "/opencv/intensity_transform.rs"));
#[cfg(ocvrs_has_module_line_descriptor)]
include!(concat!(env!("OUT_DIR"), "/opencv/line_descriptor.rs"));
#[cfg(ocvrs_has_module_mcc)]
include!(concat!(env!("OUT_DIR"), "/opencv/mcc.rs"));
#[cfg(ocvrs_has_module_ml)]
include!(concat!(env!("OUT_DIR"), "/opencv/ml.rs"));
#[cfg(ocvrs_has_module_objdetect)]
include!(concat!(env!("OUT_DIR"), "/opencv/objdetect.rs"));
#[cfg(ocvrs_has_module_optflow)]
include!(concat!(env!("OUT_DIR"), "/opencv/optflow.rs"));
#[cfg(ocvrs_has_module_ovis)]
include!(concat!(env!("OUT_DIR"), "/opencv/ovis.rs"));
#[cfg(ocvrs_has_module_phase_unwrapping)]
include!(concat!(env!("OUT_DIR"), "/opencv/phase_unwrapping.rs"));
#[cfg(ocvrs_has_module_photo)]
include!(concat!(env!("OUT_DIR"), "/opencv/photo.rs"));
#[cfg(ocvrs_has_module_plot)]
include!(concat!(env!("OUT_DIR"), "/opencv/plot.rs"));
#[cfg(ocvrs_has_module_quality)]
include!(concat!(env!("OUT_DIR"), "/opencv/quality.rs"));
#[cfg(ocvrs_has_module_rapid)]
include!(concat!(env!("OUT_DIR"), "/opencv/rapid.rs"));
#[cfg(ocvrs_has_module_rgbd)]
include!(concat!(env!("OUT_DIR"), "/opencv/rgbd.rs"));
#[cfg(ocvrs_has_module_saliency)]
include!(concat!(env!("OUT_DIR"), "/opencv/saliency.rs"));
#[cfg(ocvrs_has_module_sfm)]
include!(concat!(env!("OUT_DIR"), "/opencv/sfm.rs"));
#[cfg(ocvrs_has_module_shape)]
include!(concat!(env!("OUT_DIR"), "/opencv/shape.rs"));
#[cfg(ocvrs_has_module_signal)]
include!(concat!(env!("OUT_DIR"), "/opencv/signal.rs"));
#[cfg(ocvrs_has_module_stereo)]
include!(concat!(env!("OUT_DIR"), "/opencv/stereo.rs"));
#[cfg(ocvrs_has_module_stitching)]
include!(concat!(env!("OUT_DIR"), "/opencv/stitching.rs"));
#[cfg(ocvrs_has_module_structured_light)]
include!(concat!(env!("OUT_DIR"), "/opencv/structured_light.rs"));
#[cfg(ocvrs_has_module_superres)]
include!(concat!(env!("OUT_DIR"), "/opencv/superres.rs"));
#[cfg(ocvrs_has_module_surface_matching)]
include!(concat!(env!("OUT_DIR"), "/opencv/surface_matching.rs"));
#[cfg(ocvrs_has_module_text)]
include!(concat!(env!("OUT_DIR"), "/opencv/text.rs"));
#[cfg(ocvrs_has_module_tracking)]
include!(concat!(env!("OUT_DIR"), "/opencv/tracking.rs"));
#[cfg(ocvrs_has_module_video)]
include!(concat!(env!("OUT_DIR"), "/opencv/video.rs"));
#[cfg(ocvrs_has_module_videoio)]
include!(concat!(env!("OUT_DIR"), "/opencv/videoio.rs"));
#[cfg(ocvrs_has_module_videostab)]
include!(concat!(env!("OUT_DIR"), "/opencv/videostab.rs"));
#[cfg(ocvrs_has_module_viz)]
include!(concat!(env!("OUT_DIR"), "/opencv/viz.rs"));
#[cfg(ocvrs_has_module_wechat_qrcode)]
include!(concat!(env!("OUT_DIR"), "/opencv/wechat_qrcode.rs"));
#[cfg(ocvrs_has_module_xfeatures2d)]
include!(concat!(env!("OUT_DIR"), "/opencv/xfeatures2d.rs"));
#[cfg(ocvrs_has_module_ximgproc)]
include!(concat!(env!("OUT_DIR"), "/opencv/ximgproc.rs"));
#[cfg(ocvrs_has_module_xobjdetect)]
include!(concat!(env!("OUT_DIR"), "/opencv/xobjdetect.rs"));
#[cfg(ocvrs_has_module_xphoto)]
include!(concat!(env!("OUT_DIR"), "/opencv/xphoto.rs"));
pub mod types {
include!(concat!(env!("OUT_DIR"), "/opencv/types.rs"));
Expand All @@ -138,137 +73,72 @@ pub mod sys {
include!(concat!(env!("OUT_DIR"), "/opencv/sys.rs"));
}
pub mod hub_prelude {
#[cfg(ocvrs_has_module_alphamat)]
pub use super::alphamat::prelude::*;
#[cfg(ocvrs_has_module_aruco)]
pub use super::aruco::prelude::*;
#[cfg(ocvrs_has_module_bgsegm)]
pub use super::bgsegm::prelude::*;
#[cfg(ocvrs_has_module_bioinspired)]
pub use super::bioinspired::prelude::*;
#[cfg(ocvrs_has_module_calib3d)]
pub use super::calib3d::prelude::*;
#[cfg(ocvrs_has_module_ccalib)]
pub use super::ccalib::prelude::*;
#[cfg(ocvrs_has_module_core)]
pub use super::core::prelude::*;
#[cfg(ocvrs_has_module_cudaarithm)]
pub use super::cudaarithm::prelude::*;
#[cfg(ocvrs_has_module_cudabgsegm)]
pub use super::cudabgsegm::prelude::*;
#[cfg(ocvrs_has_module_cudacodec)]
pub use super::cudacodec::prelude::*;
#[cfg(ocvrs_has_module_cudafeatures2d)]
pub use super::cudafeatures2d::prelude::*;
#[cfg(ocvrs_has_module_cudafilters)]
pub use super::cudafilters::prelude::*;
#[cfg(ocvrs_has_module_cudaimgproc)]
pub use super::cudaimgproc::prelude::*;
#[cfg(ocvrs_has_module_cudaobjdetect)]
pub use super::cudalegacy::prelude::*;
pub use super::cudaobjdetect::prelude::*;
#[cfg(ocvrs_has_module_cudaoptflow)]
pub use super::cudaoptflow::prelude::*;
#[cfg(ocvrs_has_module_cudastereo)]
pub use super::cudastereo::prelude::*;
#[cfg(ocvrs_has_module_cudawarping)]
pub use super::cudawarping::prelude::*;
#[cfg(ocvrs_has_module_cvv)]
pub use super::cvv::prelude::*;
#[cfg(ocvrs_has_module_dnn)]
pub use super::dnn::prelude::*;
#[cfg(ocvrs_has_module_dnn_superres)]
pub use super::dnn_superres::prelude::*;
#[cfg(ocvrs_has_module_dpm)]
pub use super::dpm::prelude::*;
#[cfg(ocvrs_has_module_face)]
pub use super::face::prelude::*;
#[cfg(ocvrs_has_module_features2d)]
pub use super::features2d::prelude::*;
#[cfg(ocvrs_has_module_flann)]
pub use super::flann::prelude::*;
#[cfg(ocvrs_has_module_freetype)]
pub use super::freetype::prelude::*;
#[cfg(ocvrs_has_module_fuzzy)]
pub use super::fuzzy::prelude::*;
#[cfg(ocvrs_has_module_gapi)]
pub use super::gapi::prelude::*;
#[cfg(ocvrs_has_module_hdf)]
pub use super::hdf::prelude::*;
#[cfg(ocvrs_has_module_hfs)]
pub use super::hfs::prelude::*;
#[cfg(ocvrs_has_module_highgui)]
pub use super::highgui::prelude::*;
#[cfg(ocvrs_has_module_img_hash)]
pub use super::img_hash::prelude::*;
#[cfg(ocvrs_has_module_imgcodecs)]
pub use super::imgcodecs::prelude::*;
#[cfg(ocvrs_has_module_imgproc)]
pub use super::imgproc::prelude::*;
#[cfg(ocvrs_has_module_intensity_transform)]
pub use super::intensity_transform::prelude::*;
#[cfg(ocvrs_has_module_line_descriptor)]
pub use super::line_descriptor::prelude::*;
#[cfg(ocvrs_has_module_mcc)]
pub use super::mcc::prelude::*;
#[cfg(ocvrs_has_module_ml)]
pub use super::ml::prelude::*;
#[cfg(ocvrs_has_module_objdetect)]
pub use super::objdetect::prelude::*;
#[cfg(ocvrs_has_module_optflow)]
pub use super::optflow::prelude::*;
#[cfg(ocvrs_has_module_ovis)]
pub use super::ovis::prelude::*;
#[cfg(ocvrs_has_module_phase_unwrapping)]
pub use super::phase_unwrapping::prelude::*;
#[cfg(ocvrs_has_module_photo)]
pub use super::photo::prelude::*;
#[cfg(ocvrs_has_module_plot)]
pub use super::plot::prelude::*;
#[cfg(ocvrs_has_module_quality)]
pub use super::quality::prelude::*;
#[cfg(ocvrs_has_module_rapid)]
pub use super::rapid::prelude::*;
#[cfg(ocvrs_has_module_rgbd)]
pub use super::rgbd::prelude::*;
#[cfg(ocvrs_has_module_saliency)]
pub use super::saliency::prelude::*;
#[cfg(ocvrs_has_module_sfm)]
pub use super::sfm::prelude::*;
#[cfg(ocvrs_has_module_shape)]
pub use super::shape::prelude::*;
#[cfg(ocvrs_has_module_signal)]
pub use super::signal::prelude::*;
#[cfg(ocvrs_has_module_stereo)]
pub use super::stereo::prelude::*;
#[cfg(ocvrs_has_module_stitching)]
pub use super::stitching::prelude::*;
#[cfg(ocvrs_has_module_structured_light)]
pub use super::structured_light::prelude::*;
#[cfg(ocvrs_has_module_superres)]
pub use super::superres::prelude::*;
#[cfg(ocvrs_has_module_surface_matching)]
pub use super::surface_matching::prelude::*;
#[cfg(ocvrs_has_module_text)]
pub use super::text::prelude::*;
#[cfg(ocvrs_has_module_tracking)]
pub use super::tracking::prelude::*;
#[cfg(ocvrs_has_module_video)]
pub use super::video::prelude::*;
#[cfg(ocvrs_has_module_videoio)]
pub use super::videoio::prelude::*;
#[cfg(ocvrs_has_module_videostab)]
pub use super::videostab::prelude::*;
#[cfg(ocvrs_has_module_viz)]
pub use super::viz::prelude::*;
#[cfg(ocvrs_has_module_wechat_qrcode)]
pub use super::wechat_qrcode::prelude::*;
#[cfg(ocvrs_has_module_xfeatures2d)]
pub use super::xfeatures2d::prelude::*;
#[cfg(ocvrs_has_module_ximgproc)]
pub use super::ximgproc::prelude::*;
#[cfg(ocvrs_has_module_xobjdetect)]
pub use super::xobjdetect::prelude::*;
#[cfg(ocvrs_has_module_xphoto)]
pub use super::xphoto::prelude::*;
}

Expand Down
4 changes: 2 additions & 2 deletions docs/objdetect.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3750,7 +3750,7 @@ pub mod objdetect {

/// coefficients for the linear SVM classifier.
#[inline]
fn set_svm_detector_vec(&mut self, val: core::Vector<f32>) {
fn set_svm_detector(&mut self, val: core::Vector<f32>) {
let ret = unsafe { sys::cv_HOGDescriptor_propSvmDetector_const_vectorLfloatG(self.as_raw_mut_HOGDescriptor(), val.as_raw_VectorOff32()) };
ret
}
Expand Down Expand Up @@ -3789,7 +3789,7 @@ pub mod objdetect {
/// ## Parameters
/// * svmdetector: coefficients for the linear SVM classifier.
#[inline]
fn set_svm_detector(&mut self, svmdetector: &impl ToInputArray) -> Result<()> {
fn set_svm_detector_input_array(&mut self, svmdetector: &impl ToInputArray) -> Result<()> {
input_array_arg!(svmdetector);
return_send!(via ocvrs_return);
unsafe { sys::cv_HOGDescriptor_setSVMDetector_const__InputArrayR(self.as_raw_mut_HOGDescriptor(), svmdetector.as_raw__InputArray(), ocvrs_return.as_mut_ptr()) };
Expand Down
Loading

0 comments on commit 1c511d4

Please sign in to comment.