Type Alias freya_engine::prelude::svg::Dom

pub type Dom = RCHandle<SkSVGDOM>;

Aliased Type

struct Dom(/* private fields */);

Implementations

impl RCHandle<SkSVGDOM>

This type represents an SVG as a node-based data structure.

To convert an SVG to a Dom, a [NativeResourceProvider] is required.

Creating a Resource Provider

To create a resource provider, a crate::FontMgr is required at a minimum.

• If you don’t need font support, pass [crate::FontMgr::new_empty()] as the resource provider.
• To use the installed fonts on your system, pass [crate::FontMgr::default()] as the resource provider.

When you pass a crate::FontMgr as the resource provider, a crate::resources::LocalResourceProvider is created behind the scenes. This provider, in addition to supporting typefaces, also adds support for data: URLs.

Supporting External Resources

To support http:// or https:// external resources, enable the ureq feature and create a [crate::resources::UReqResourceProvider].

Custom Resource Providers

If you need more customization, you can implement the trait [crate::resources::ResourceProvider].

pub fn read<R>( reader: R, resource_provider: impl Into<RCHandle<RustResourceProvider>>, ) -> Result<RCHandle<SkSVGDOM>, LoadError>

where R: Read,

pub fn from_str( svg: impl AsRef<str>, resource_provider: impl Into<RCHandle<RustResourceProvider>>, ) -> Result<RCHandle<SkSVGDOM>, LoadError>

pub fn from_bytes( svg: &[u8], resource_provider: impl Into<RCHandle<RustResourceProvider>>, ) -> Result<RCHandle<SkSVGDOM>, LoadError>

pub fn root(&self) -> RCHandle<SkSVGSVG>

pub fn render(&self, canvas: &Canvas)

pub fn set_container_size(&mut self, size: impl Into<Size>)

impl<T> RCHandle<T>

where T: NativeRefCounted + NodeSubtype,

pub fn as_base(&self) -> &RCHandle<<T as NodeSubtype>::Base>

pub fn as_base_mut(&mut self) -> &mut RCHandle<<T as NodeSubtype>::Base>

pub fn into_node(self) -> RCHandle<SkSVGNode>

All concrete node types can be converted to the supertype Node.

pub fn typed(self) -> TypedNode

All concrete node types can be converted to a TypedNode

Trait Implementations

impl<N> AsRef<RCHandle<N>> for RCHandle<N>

where N: NativeRefCounted,

fn as_ref(&self) -> &RCHandle<N>

Converts this type into a shared reference of the (usually inferred) input type.

impl<N> Clone for RCHandle<N>

where N: NativeRefCounted,

fn clone(&self) -> RCHandle<N>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<H> ConditionallySend for RCHandle<H>

where H: NativeRefCountedBase,

RCHandle<H> is conditionally Send and can be sent to another thread when its reference count is 1.

fn can_send(&self) -> bool

Returns true if the handle can be sent to another thread.

fn wrap_send(self) -> Result<Sendable<RCHandle<H>>, RCHandle<H>>

Wrap the handle in a type that can be sent to another thread and unwrapped there.

impl<N> Debug for RCHandle<N>

where N: NativeRefCounted, RCHandle<N>: DebugAttributes,

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

Formats the value using the given formatter.

impl Debug for RCHandle<SkSVGDOM>

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

Formats the value using the given formatter.

impl<T> Deref for RCHandle<T>

where T: NativeRefCounted + NodeSubtype,

type Target = RCHandle<<T as NodeSubtype>::Base>

The resulting type after dereferencing.

fn deref(&self) -> &<RCHandle<T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for RCHandle<T>

where T: NativeRefCounted + NodeSubtype,

This implementation of DerefMut causes subsequent UB when the containing [RCHandle] gets overwritten by a base type that does not match the actual underlying type.

fn deref_mut(&mut self) -> &mut <RCHandle<T> as Deref>::Target

Mutably dereferences the value.

impl<N> Drop for RCHandle<N>

where N: NativeRefCounted,

fn drop(&mut self)

Executes the destructor for this type.

impl<N> Flattenable for RCHandle<N>

where N: NativeFlattenable + NativeRefCountedBase,

fn type_name(&self) -> &CStr

fn serialize(&self) -> RCHandle<SkData>

fn deserialize(data: &[u8]) -> Option<RCHandle<N>>

impl<N> From<&RCHandle<N>> for RCHandle<N>

where N: NativeRefCounted,

A reference counted handle is cheap to clone, so we do support a conversion from a reference to a ref counter to an owned handle.

fn from(rch: &RCHandle<N>) -> RCHandle<N>

Converts to this type from the input type.

impl<N> PartialEq for RCHandle<N>

where N: NativeRefCounted + NativePartialEq,

fn eq(&self, rhs: &RCHandle<N>) -> 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<N> PointerWrapper<N> for RCHandle<N>

where N: NativeRefCounted,

fn wrap(ptr: *mut N) -> Option<RCHandle<N>>

Wraps a native pointer into a wrapper type. Returns None if the pointer is null.

fn unwrap(self) -> *mut N

Unwraps the wrapper type into the native pointer.

fn inner(&self) -> &N

Access the wrapped pointer.

fn inner_mut(&mut self) -> &mut N

Access the wrapped pointer.