From 0e7db308d7b059b4c59bbb3881f78b512ba10bce Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hauke=20Kr=C3=BCger?= Date: Mon, 8 Jul 2024 16:25:25 +0200 Subject: [PATCH] Added comments --- .../include/interfaces/IjvxConnector.h | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/sources/jvxLibraries/jvx-system-base/include/interfaces/IjvxConnector.h b/sources/jvxLibraries/jvx-system-base/include/interfaces/IjvxConnector.h index 60c783e9..21120292 100644 --- a/sources/jvxLibraries/jvx-system-base/include/interfaces/IjvxConnector.h +++ b/sources/jvxLibraries/jvx-system-base/include/interfaces/IjvxConnector.h @@ -72,6 +72,13 @@ JVX_INTERFACE IjvxInputConnector : public IjvxInputConnectorSelect virtual jvxErrorType JVX_CALLINGCONVENTION prepare_connect_icon(JVX_CONNECTION_FEEDBACK_TYPE(fdb)) = 0; virtual jvxErrorType JVX_CALLINGCONVENTION start_connect_icon(JVX_CONNECTION_FEEDBACK_TYPE(fdb)) = 0; + + //! Start processing a single frame. We may use the parameters to influence behavior: + //! 1) idx_stage: Stage id for releasing. If JVX_SIZE_UNSELECTED, use the id as given by link data struct + //! 2) operate_first_call: Bool to forward buffer index increment + //! 3) tobeAccessedByStage: holds the process step Id related to the stage + //! 4) callback_process_stop_in_lock: safe passing lock function + //! 5) priv_data for 4) virtual jvxErrorType JVX_CALLINGCONVENTION process_start_icon( jvxSize pipeline_offset = 0, jvxSize* idx_stage = NULL, @@ -80,6 +87,13 @@ JVX_INTERFACE IjvxInputConnector : public IjvxInputConnectorSelect jvxHandle* priv_ptr = NULL) = 0; virtual jvxErrorType JVX_CALLINGCONVENTION process_buffers_icon(jvxSize mt_mask = JVX_SIZE_UNSELECTED, jvxSize idx_stage = JVX_SIZE_UNSELECTED) = 0; + + //! Stop processing a single frame. We may use the parameters to influence behavior: + //! 1) idx_stage: Stage id for releasing. If JVX_SIZE_UNSELECTED, use the id as given by link data struct + //! 2) operate_first_call: Bool to forward buffer index increment + //! 3) tobeAccessedByStage: holds the process step Id related to the stage + //! 4) callback_process_stop_in_lock: safe passing lock function + //! 5) priv_data for 4) virtual jvxErrorType JVX_CALLINGCONVENTION process_stop_icon(jvxSize idx_stage = JVX_SIZE_UNSELECTED, jvxBool operate_first_call = true, jvxSize tobeAccessedByStage = 0,