Struct CameraViewer 

pub struct CameraViewer { /* private fields */ }

Renders the latest frame produced by a Camera.

Example

use freya::{
    camera::*,
    prelude::*,
};

fn app() -> impl IntoElement {
    let camera = use_camera(CameraConfig::default);
    CameraViewer::new(camera)
}

Implementations

impl CameraViewer

pub fn new(camera: Camera) -> Self

pub fn corner_radius(self, corner_radius: impl Into<CornerRadius>) -> Self

pub fn loading_placeholder(self, placeholder: impl Into<Element>) -> Self

Custom element rendered while the camera has not yet produced a frame.

pub fn error_renderer( self, renderer: impl Into<Callback<CameraError, Element>>, ) -> Self

Custom element rendered when the camera fails before producing any frame.

Trait Implementations

impl AccessibilityExt for CameraViewer

fn get_accessibility_data(&mut self) -> &mut AccessibilityData

Returns a mutable reference to the element’s accessibility data.

fn accessibility(self, accessibility: AccessibilityData) -> Self

Replace all of the element’s accessibility data at once. See [AccessibilityData].

fn a11y_id(self, a11y_id: impl Into<Option<NodeId>>) -> Self

Set an explicit accessibility id instead of an autogenerated one. See [AccessibilityId].

fn a11y_focusable(self, a11y_focusable: impl Into<Focusable>) -> Self

Set whether the element can receive keyboard focus. See [Focusable].

fn a11y_auto_focus(self, a11y_auto_focus: impl Into<bool>) -> Self

Request that the element be focused automatically when it is mounted.

fn a11y_member_of(self, a11y_member_of: impl Into<NodeId>) -> Self

Mark the element as a member of the group identified by the given [AccessibilityId].

fn a11y_role(self, a11y_role: impl Into<Role>) -> Self

Set the accessibility role exposed in the accessibility tree. See [AccessibilityRole].

fn a11y_alt(self, value: impl Into<Box<str>>) -> Self

Set the text label that describes the element in the accessibility tree.

fn a11y_builder(self, with: impl FnOnce(&mut Node)) -> Self

Edit the underlying accesskit node directly for advanced accessibility properties.

impl ChildrenExt for CameraViewer

fn get_children(&mut self) -> &mut Vec<Element>

Returns a mutable reference to the internal children vector.

fn children(self, children: impl IntoIterator<Item = Element>) -> Self

Extends the children with an iterable of [Element]s.

fn maybe_child<C>(self, child: Option<C>) -> Self

where C: IntoElement,

Appends a child only when the Option is Some.

fn child<C>(self, child: C) -> Self

where C: IntoElement,

Appends a single child element.

impl Component for CameraViewer

fn render(&self) -> impl IntoElement

fn render_key(&self) -> DiffKey

impl ContainerExt for CameraViewer

fn position(self, position: impl Into<Position>) -> Self

Set how the element is placed relative to its parent or the window. See [Position].

fn padding(self, padding: impl Into<Gaps>) -> Self

Set the inner spacing between the element’s edges and its content. See [Gaps].

fn margin(self, margin: impl Into<Gaps>) -> Self

Set the outer spacing between the element’s edges and its surroundings. See [Gaps].

fn min_width(self, minimum_width: impl Into<Size>) -> Self

Set the minimum width the element can shrink to. See [Size].

fn min_height(self, minimum_height: impl Into<Size>) -> Self

Set the minimum height the element can shrink to. See [Size].

fn max_width(self, maximum_width: impl Into<Size>) -> Self

Set the maximum width the element can grow to. See [Size].

fn max_height(self, maximum_height: impl Into<Size>) -> Self

Set the maximum height the element can grow to. See [Size].

fn visible_width(self, visible_width: impl Into<VisibleSize>) -> Self

Set how much of the measured width is actually used in layout. See [VisibleSize].

fn visible_height(self, visible_height: impl Into<VisibleSize>) -> Self

Set how much of the measured height is actually used in layout. See [VisibleSize].

impl ContainerWithContentExt for CameraViewer

fn direction(self, direction: Direction) -> Self

Set the axis children are stacked along. See [Direction].

fn main_align(self, main_align: Alignment) -> Self

Set how children are aligned along the direction axis. See [Alignment].

fn cross_align(self, cross_align: Alignment) -> Self

Set how children are aligned across the direction axis. See [Alignment].

fn spacing(self, spacing: impl Into<f32>) -> Self

Set the gap inserted between adjacent children, in pixels.

fn content(self, content: Content) -> Self

Set how children share the available space along the direction axis. See [Content].

fn center(self) -> Self

Center children on both axes. Shorthand for main_align and cross_align set to [Alignment::Center].

fn offset_x(self, offset_x: impl Into<f32>) -> Self

Shift the element’s children horizontally by the given pixels.

fn offset_y(self, offset_y: impl Into<f32>) -> Self

Shift the element’s children vertically by the given pixels.

fn vertical(self) -> Self

Stack children vertically. Shorthand for direction set to [Direction::Vertical].

fn horizontal(self) -> Self

Stack children horizontally. Shorthand for direction set to [Direction::Horizontal].

impl EffectExt for CameraViewer

fn get_effect(&mut self) -> &mut EffectData

Returns a mutable reference to the element’s effect data.

fn effect(self, effect: EffectData) -> Self

Replace all of the element’s effect data at once. See [EffectData].

fn overflow(self, overflow: impl Into<Overflow>) -> Self

Set whether content overflowing the element’s bounds is clipped. See [Overflow].

fn blur(self, blur: impl Into<f32>) -> Self

Apply a gaussian blur of the given radius to the element.

fn rotation(self, rotation: impl Into<f32>) -> Self

Rotate the element by the given angle in degrees.

fn opacity(self, opacity: impl Into<f32>) -> Self

Set the element’s opacity, from 0.0 (transparent) to 1.0 (opaque).

fn scale(self, scale: impl Into<Scale>) -> Self

Scale the element. See [Scale].

fn transform_origin(self, transform_origin: impl Into<TransformOrigin>) -> Self

Set the point that the scale and rotation effects pivot around.

impl ImageExt for CameraViewer

fn get_image_data(&mut self) -> &mut ImageData

Returns a mutable reference to the element’s image data.

fn image_data(self, image_data: ImageData) -> Self

Replace all of the element’s image data at once. See [ImageData].

fn sampling_mode(self, sampling_mode: SamplingMode) -> Self

Set the filtering used when the image is scaled. See [SamplingMode].

fn aspect_ratio(self, aspect_ratio: AspectRatio) -> Self

Set how the image is scaled to fit its bounds. See [AspectRatio].

fn image_cover(self, image_cover: ImageCover) -> Self

Set how the image is positioned within its bounds. See [ImageCover].

impl KeyExt for CameraViewer

fn write_key(&mut self) -> &mut DiffKey

Returns a mutable reference to the element’s diff key.

fn key(self, key: impl Hash) -> Self

Assign a key derived from any hashable value, used to reconcile elements in dynamic lists.

impl LayoutExt for CameraViewer

fn get_layout(&mut self) -> &mut LayoutData

Returns a mutable reference to the element’s layout data.

fn layout(self, layout: LayoutData) -> Self

Replace all of the element’s layout data at once. See [LayoutData].

impl PartialEq for CameraViewer

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for CameraViewer