Struct aravis::Buffer

#[repr(transparent)]
pub struct Buffer { /* private fields */ }

Implementations

impl Buffer

pub fn new_allocate(size: usize) -> Buffer

Creates a new buffer for the storage of the video stream images. The data space is allocated by this function, and will be freed when the buffer is destroyed.

size

payload size

Returns

a new Buffer object

pub fn chunk_data(&self, chunk_id: u64) -> Vec<u8>

Chunk data accessor.

chunk_id

chunk id

Returns

a pointer to the chunk data.

pub fn frame_id(&self) -> u64

Gets the buffer frame id. For GigEVision devices, 0 is an invalid value.

Returns

frame id, 0 on error.

pub fn image_height(&self) -> i32

Gets the image width. This function must only be called on buffer containing a BufferPayloadType::Image payload.

Returns

image height, in pixels.

pub fn image_pixel_format(&self) -> PixelFormat

Gets the image pixel format. This function must only be called on buffer containing a BufferPayloadType::Image payload.

Returns

image pixel format.

pub fn image_region(&self) -> (i32, i32, i32, i32)

Gets the image region. This function must only be called on buffer containing a BufferPayloadType::Image payload.

Returns

x

image x offset placeholder

y

image y offset placeholder

width

image width placholder

height

image height placeholder

pub fn image_width(&self) -> i32

Gets the image width. This function must only be called on buffer containing a BufferPayloadType::Image payload.

Returns

image width, in pixels.

pub fn image_x(&self) -> i32

Gets the image x offset. This function must only be called on buffer containing a BufferPayloadType::Image payload.

Returns

image x offset, in pixels.

pub fn image_y(&self) -> i32

Gets the image y offset. This function must only be called on buffer containing a BufferPayloadType::Image payload.

Returns

image y offset, in pixels.

pub fn payload_type(&self) -> BufferPayloadType

Gets the buffer payload type.

Returns

payload type.

pub fn status(&self) -> BufferStatus

Gets the buffer acquisition status.

Returns

buffer acquisition status.

pub fn system_timestamp(&self) -> u64

Gets the system timestamp for when the frame was received. Expressed in nanoseconds.

Returns

buffer system timestamp, in nanoseconds.

pub fn timestamp(&self) -> u64

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.

pub fn has_chunks(&self) -> bool

Returns

true if self has a payload type that contains chunk data.

pub fn set_frame_id(&self, frame_id: u64)

Available on crate feature v0_8_3 only.

Sets the buffer frame id. For GigEVision devices, 0 is an invalid value.

frame_id

a guint64

pub fn set_system_timestamp(&self, timestamp_ns: u64)

Sets the system timestamp for when the frame was received. Expressed in nanoseconds.

timestamp_ns

a timestamp, expressed as nanoseconds

pub fn set_timestamp(&self, timestamp_ns: u64)

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

impl Buffer

pub fn new_preallocated_owned<F: FnOnce()>( data: *mut u8, len: usize, destroy_callback: F ) -> Self

Create an Aravis buffer that owns its own data from a pre-allocated raw buffer.

The destroy_callback argument is called to destroy the buffer, and should free the resources associated with the buffer.

Safety

The pointer and length parameter must indicate a valid memory region where Aravis can safely write data to until the destroy_callback is called.

pub unsafe fn new_preallocated(data: *mut u8, len: usize) -> Self

👎Deprecated: Use new_preallocated_borrowed instead

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.

pub unsafe fn new_preallocated_borrowed(data: *mut u8, len: usize) -> Self

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 by the data pointer.

Safety

The pointer and length parameter must indicate a valid memory region where Aravis can safely write data to until the buffer is dropped. The created buffer borrows the memory buffer, but it carries no lifetime. See Self::new_preallocated_owned for a safer (but still unsafe) alternative.

pub fn new_leaked_box(len: usize) -> Self

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.

pub fn new_leaked_image( format: PixelFormat, width: usize, height: usize ) -> Self

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.

pub fn data(&self) -> (*mut u8, usize)

Get a pointer to the raw data and the length of the buffer.

pub unsafe fn into_image(self) -> Result<DynamicImage, ImageError>

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

impl Clone for Buffer

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Buffer

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

Formats the value using the given formatter.

impl Display for Buffer

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

Formats the value using the given formatter.

impl HasParamSpec for Buffer

type ParamSpec = ParamSpecObject

type SetValue = Buffer

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Buffer>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Buffer

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Buffer

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for Buffer

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Buffer

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Buffer

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Buffer

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Buffer

impl Send for Buffer