pub struct FrameParams {
pub triggered: Option<i32>,
pub current_image: Option<i32>,
pub post_count: Option<i32>,
pub actual_trigger_count: Option<i32>,
pub soft_trigger: Option<i32>,
pub control: Option<i32>,
pub status: Option<&'static str>,
}Expand description
The parameter-library assignments C NDPluginCircularBuff::processCallbacks
makes while handling one frame (NDPluginCircularBuff.cpp:120-203).
A field is Some exactly when C calls setIntegerParam/setStringParam for
it on this frame, and None when C leaves the parameter untouched — which is
how C freezes NDCircBuffCurrentImage at the pre-buffer size for the whole
flush (it is assigned only on the pre-trigger branch, :151).
Later assignments in the same frame overwrite earlier ones, exactly as
repeated setIntegerParam calls do before C’s single trailing
callParamCallbacks(): on a frame that both flushes and completes, clients
see only the final NDCircBuffPostCount = 0, never the intermediate count.
CircularBuffer::push — the state machine that decides the transitions —
is the single owner of these values; the processor only maps them onto
parameter indices. Reconstructing them from the post-push buffer state is
what produced the divergences this type removes.
Fields§
§triggered: Option<i32>NDCircBuffTriggered — C :127/:133 (every frame that evaluates the
trigger) and :192/:194 (cleared when the sequence ends).
current_image: Option<i32>NDCircBuffCurrentImage — C :151, the pre-buffer size, assigned ONLY
on a pre-trigger frame.
post_count: Option<i32>NDCircBuffPostCount — C :168-169 per forwarded post-trigger frame,
and :193 (reset to 0) when the sequence re-arms.
actual_trigger_count: Option<i32>NDCircBuffActualTriggerCount — C :179-180, incremented when the
post-trigger count is reached, not when the trigger fires.
soft_trigger: Option<i32>NDCircBuffSoftTrigger — C :191, the soft-trigger latch cleared on
re-arm.
control: Option<i32>NDCircBuffControl — C :190 (re-arm, still 1) and :197 (the preset
trigger count was reached: C turns acquisition off).
status: Option<&'static str>NDCircBuffStatus — C’s setStringParam calls (:152-153, :157,
:194-195, :198).
Trait Implementations§
Source§impl Clone for FrameParams
impl Clone for FrameParams
Source§fn clone(&self) -> FrameParams
fn clone(&self) -> FrameParams
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for FrameParams
impl Debug for FrameParams
Source§impl Default for FrameParams
impl Default for FrameParams
Source§fn default() -> FrameParams
fn default() -> FrameParams
impl Eq for FrameParams
Source§impl PartialEq for FrameParams
impl PartialEq for FrameParams
impl StructuralPartialEq for FrameParams
Auto Trait Implementations§
impl Freeze for FrameParams
impl RefUnwindSafe for FrameParams
impl Send for FrameParams
impl Sync for FrameParams
impl Unpin for FrameParams
impl UnsafeUnpin for FrameParams
impl UnwindSafe for FrameParams
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more