Struct aravis::Buffer [−][src]
pub struct Buffer(_);
Implementations
Gets the buffer frame id. For GigEVision devices, 0 is an invalid value.
Returns
frame id, 0 on error.
Gets the image width. This function must only be called on buffer containing a BufferPayloadType::Image
payload.
Returns
image height, in pixels.
Gets the image pixel format. This function must only be called on buffer containing a BufferPayloadType::Image
payload.
Returns
image pixel format.
Gets the image width. This function must only be called on buffer containing a BufferPayloadType::Image
payload.
Returns
image width, in pixels.
Gets the image x offset. This function must only be called on buffer containing a BufferPayloadType::Image
payload.
Returns
image x offset, in pixels.
Gets the image y offset. This function must only be called on buffer containing a BufferPayloadType::Image
payload.
Returns
image y offset, in pixels.
Gets the system timestamp for when the frame was received. Expressed in nanoseconds.
Returns
buffer system timestamp, in nanoseconds.
Gets the buffer camera timestamp, expressed as nanoseconds. Not all devices
provide reliable timestamp, which means sometimes its better to rely on the
buffer completion host local time, or to use
system_timestamp()
.
Returns
buffer timestamp, in nanoseconds.
This is supported on crate feature v0_8_3
only.
v0_8_3
only.Sets the system timestamp for when the frame was received. Expressed in nanoseconds.
timestamp_ns
a timestamp, expressed as nanoseconds
Sets the buffer timestamp, which allows to override the timpestamp set by the camera, which in some case is incorrect.
timestamp_ns
a timestamp, expressed as nanoseconds
Create an Aravis buffer from a pre-allocated raw buffer.
The created buffer has no registered user data or destroy callback, so management of the underlying buffer has to be done externally. The buffer can be identified later when it is returned by a stream only byt the data pointer.
Safety
The resulting buffer borrows the data, but it carries no lifetime. The user has to ensure the buffer stays valid.
Create a new buffer backed by a leaked Box<[u8]>
.
The buffer can later be turned into an image using [Self::into_image]
.
If the buffer is dropped without taking ownership of the data again, the memory is leaked.
Create a new buffer for an image of the specified format and dimensions, backed by a leaked Box<[u8]>
.
The buffer can later be turned into an image using [Self::into_image]
.
If the buffer is dropped without taking ownership of the data again, the memory is leaked.
Get a pointer to the raw data and the length of the buffer.
Convert the buffer into an image.
Safety
This function assumes the buffer is backed by a leaked box,
such as created by Buffer::new_leaked_box
.
This function takes ownership of the leaked box, so the memory will be freed when the resulting image is dropped.
Trait Implementations
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Returns the type identifier of Self
.
Auto Trait Implementations
Blanket Implementations
Mutably borrows from an owned value. Read more
Upcasts an object to a superclass or interface T
. Read more
Upcasts an object to a reference of its superclass or interface T
. Read more
Tries to downcast to a subclass or interface implementor T
. Read more
Tries to downcast to a reference of its subclass or interface implementor T
. Read more
Tries to cast to an object of type T
. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast
and upcast
will do many checks at compile-time already. Read more
Tries to cast to reference to an object of type T
. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast
and upcast
will do many checks at compile-time already. Read more
Casts to T
unconditionally. Read more
Casts to &T
unconditionally. Read more
Returns true
if the object is an instance of (can be cast to) T
.
pub fn set_property<'a, N, V>(
&self,
property_name: N,
value: V
) -> Result<(), BoolError> where
V: ToValue,
N: Into<&'a str>,
pub fn set_property_from_value<'a, N>(
&self,
property_name: N,
value: &Value
) -> Result<(), BoolError> where
N: Into<&'a str>,
pub fn set_properties_from_value(
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>
pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
N: Into<&'a str>,
pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
N: Into<&'a str>,
Safety Read more
Safety Read more
Safety Read more
Safety Read more
pub fn connect<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
N: Into<&'a str>,
Same as connect
but takes a SignalId
instead of a signal name.
pub fn connect_local<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static,
N: Into<&'a str>,
Same as connect_local
but takes a SignalId
instead of a signal name.
pub unsafe fn connect_unsafe<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>,
N: Into<&'a str>,
Same as connect_unsafe
but takes a SignalId
instead of a signal name.
Emit signal by signal id.
Same as emit
but takes Value
for the arguments.
Emit signal by its name.
Same as emit_by_name
but takes Value
for the arguments.
Emit signal with details by signal id.
Same as emit_with_details
but takes Value
for the arguments.
pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,
pub fn connect_notify_local<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec),
pub unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
pub fn bind_property<'a, O, N, M>(
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
O: ObjectType,
N: Into<&'a str>,
M: Into<&'a str>,
Returns a SendValue
clone of self
.
impl<'a, T, C> FromValueOptional<'a> for T where
C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,
T: FromValue<'a, Checker = C>,