Struct opencv::gapi::GScalar

source ·
pub struct GScalar { /* private fields */ }
Expand description

\addtogroup gapi_data_objects /

GScalar class represents cv::Scalar data in the graph.

GScalar may be associated with a cv::Scalar value, which becomes its constant value bound in graph compile time. cv::GScalar describes a functional relationship between operations consuming and producing GScalar objects.

GScalar is a virtual counterpart of cv::Scalar, which is usually used to represent the GScalar data in G-API during the execution.

§See also

Scalar

Implementations§

source§

impl GScalar

source

pub fn default() -> Result<GScalar>

Constructs an empty GScalar

Normally, empty G-API data objects denote a starting point of the graph. When an empty GScalar is assigned to a result of some operation, it obtains a functional link to this operation (and is not empty anymore).

source

pub fn new(s: Scalar) -> Result<GScalar>

Constructs a value-initialized GScalar

In contrast with GMat (which can be either an explicit graph input or a result of some operation), GScalars may have their values be associated at graph construction time. It is useful when some operation has a GScalar input which doesn’t change during the program execution, and is set only once. In this case, there is no need to declare such GScalar as a graph input.

Note: The value of GScalar may be overwritten by assigning some other GScalar to the object using operator= – on the assignment, the old GScalar value is discarded.

§Parameters
  • s: a cv::Scalar value to associate with this GScalar object.
source

pub fn new_1(s: Scalar) -> Result<GScalar>

Constructs a value-initialized GScalar

In contrast with GMat (which can be either an explicit graph input or a result of some operation), GScalars may have their values be associated at graph construction time. It is useful when some operation has a GScalar input which doesn’t change during the program execution, and is set only once. In this case, there is no need to declare such GScalar as a graph input.

Note: The value of GScalar may be overwritten by assigning some other GScalar to the object using operator= – on the assignment, the old GScalar value is discarded.

§Parameters
  • s: a cv::Scalar value to associate with this GScalar object.
§Overloaded parameters

Constructs a value-initialized GScalar

  • s: a cv::Scalar value to associate with this GScalar object.
source

pub fn new_2(v0: f64) -> Result<GScalar>

Constructs a value-initialized GScalar

In contrast with GMat (which can be either an explicit graph input or a result of some operation), GScalars may have their values be associated at graph construction time. It is useful when some operation has a GScalar input which doesn’t change during the program execution, and is set only once. In this case, there is no need to declare such GScalar as a graph input.

Note: The value of GScalar may be overwritten by assigning some other GScalar to the object using operator= – on the assignment, the old GScalar value is discarded.

§Parameters
  • s: a cv::Scalar value to associate with this GScalar object.
§Overloaded parameters

Constructs a value-initialized GScalar

  • v0: A double value to associate with this GScalar. Note that only the first component of a four-component cv::Scalar is set to this value, with others remain zeros.

This constructor overload is not marked explicit and can be used in G-API expression code like this:

gscalar_implicit

Here operator+(GMat,GScalar) is used to wrap cv::gapi::addC() and a value-initialized GScalar is created on the fly.

@overload

Trait Implementations§

source§

impl Boxed for GScalar

source§

unsafe fn from_raw(ptr: <GScalar as OpenCVFromExtern>::ExternReceive) -> Self

Wrap the specified raw pointer Read more
source§

fn into_raw(self) -> <GScalar as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying raw pointer while consuming this wrapper. Read more
source§

fn as_raw(&self) -> <GScalar as OpenCVTypeExternContainer>::ExternSend

Return the underlying raw pointer. Read more
source§

fn as_raw_mut( &mut self ) -> <GScalar as OpenCVTypeExternContainer>::ExternSendMut

Return the underlying mutable raw pointer Read more
source§

impl Clone for GScalar

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for GScalar

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Drop for GScalar

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl GScalarTrait for GScalar

source§

impl GScalarTraitConst for GScalar

source§

impl Send for GScalar

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<Mat> ModifyInplace for Mat
where Mat: Boxed,

source§

unsafe fn modify_inplace<Res>( &mut self, f: impl FnOnce(&Mat, &mut Mat) -> Res ) -> Res

Helper function to call OpenCV functions that allow in-place modification of a Mat or another similar object. By passing a mutable reference to the Mat to this function your closure will get called with the read reference and a write references to the same Mat. This is of course unsafe as it breaks the Rust aliasing rules, but it might be useful for some performance sensitive operations. One example of an OpenCV function that allows such in-place modification is imgproc::threshold. Read more
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.