Skip to main content

Command

Enum Command 

Source
pub enum Command {
Show 22 variants DrawRect { rect: Rect, brush: Brush, z: i32, transform: Transform2D, }, DrawRoundedRect { rrect: RoundedRect, brush: Brush, z: i32, transform: Transform2D, }, StrokeRect { rect: Rect, stroke: Stroke, brush: Brush, z: i32, transform: Transform2D, }, StrokeRoundedRect { rrect: RoundedRect, stroke: Stroke, brush: Brush, z: i32, transform: Transform2D, }, DrawText { run: TextRun, z: i32, transform: Transform2D, id: u64, dynamic: bool, }, DrawEllipse { center: [f32; 2], radii: [f32; 2], brush: Brush, z: i32, transform: Transform2D, }, FillPath { path: Path, color: ColorLinPremul, z: i32, transform: Transform2D, }, StrokePath { path: Path, stroke: Stroke, color: ColorLinPremul, z: i32, transform: Transform2D, }, BoxShadow { rrect: RoundedRect, spec: BoxShadowSpec, z: i32, transform: Transform2D, }, HitRegionRect { id: u32, rect: Rect, z: i32, transform: Transform2D, }, HitRegionRoundedRect { id: u32, rrect: RoundedRect, z: i32, transform: Transform2D, }, HitRegionEllipse { id: u32, center: [f32; 2], radii: [f32; 2], z: i32, transform: Transform2D, }, DrawSvg { path: PathBuf, origin: [f32; 2], max_size: [f32; 2], z: i32, transform: Transform2D, }, DrawImage { path: PathBuf, origin: [f32; 2], size: [f32; 2], z: i32, transform: Transform2D, }, DrawHyperlink { hyperlink: Hyperlink, z: i32, transform: Transform2D, id: u64, }, PushClip(ClipRect), PopClip, PushTransform(Transform2D), PopTransform, PushOpacity(f32), PopOpacity, DrawExternalTexture { rect: Rect, texture_id: ExternalTextureId, z: i32, transform: Transform2D, opacity: f32, premultiplied: bool, },
}

Variants§

§

DrawRect

Fields

§rect: Rect
§brush: Brush
§transform: Transform2D
§

DrawRoundedRect

Fields

§brush: Brush
§transform: Transform2D
§

StrokeRect

Fields

§rect: Rect
§stroke: Stroke
§brush: Brush
§transform: Transform2D
§

StrokeRoundedRect

Fields

§stroke: Stroke
§brush: Brush
§transform: Transform2D
§

DrawText

Fields

§transform: Transform2D
§id: u64
§dynamic: bool
§

DrawEllipse

Fields

§center: [f32; 2]
§radii: [f32; 2]
§brush: Brush
§transform: Transform2D
§

FillPath

Filled path (solid color only for now)

Fields

§path: Path
§transform: Transform2D
§

StrokePath

Stroked path (width only; round join/cap for now)

Fields

§path: Path
§stroke: Stroke
§transform: Transform2D
§

BoxShadow

Box shadow for a rounded rectangle. This is handled by a dedicated pass in PassManager, not by the generic solid fill pipeline.

Fields

§transform: Transform2D
§

HitRegionRect

Hit-only regions that do not render. Useful for scene-surface hits or custom zones.

Fields

§id: u32
§rect: Rect
§transform: Transform2D
§

HitRegionRoundedRect

Fields

§id: u32
§transform: Transform2D
§

HitRegionEllipse

Fields

§id: u32
§center: [f32; 2]
§radii: [f32; 2]
§transform: Transform2D
§

DrawSvg

SVG draw at a pixel origin with a max pixel size. The path is interpreted relative to the process working directory.

Fields

§path: PathBuf
§origin: [f32; 2]
§max_size: [f32; 2]
§transform: Transform2D
§

DrawImage

Raster image draw (PNG/JPEG/GIF/WebP) at a pixel origin with a given size. The path is interpreted relative to the process working directory.

Fields

§path: PathBuf
§origin: [f32; 2]
§size: [f32; 2]
§transform: Transform2D

Hyperlink with text, optional underline, and click target.

Fields

§hyperlink: Hyperlink
§transform: Transform2D
§id: u64

Unique ID for this hyperlink instance (for hit testing)

§

PushClip(ClipRect)

§

PopClip

§

PushTransform(Transform2D)

§

PopTransform

§

PushOpacity(f32)

Push a CSS-style group opacity for descendant draw commands. Commands between PushOpacity and PopOpacity are composited to an intermediate layer, then blended back once with this opacity.

§

PopOpacity

§

DrawExternalTexture

Blit an externally-rendered texture (e.g., 3D viewport) into the scene.

Fields

§rect: Rect
§transform: Transform2D
§opacity: f32

Additional alpha multiplier applied at composite time.

§premultiplied: bool

Whether the source texture is already premultiplied alpha.

Implementations§

Source§

impl Command

Source

pub fn z_index(&self) -> Option<i32>

Get the z-index of this command, or None for non-drawable commands

Trait Implementations§

Source§

impl Clone for Command

Source§

fn clone(&self) -> Command

Returns a duplicate 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 Command

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S
where T: Real + Zero + Arithmetics + Clone, Swp: WhitePoint<T>, Dwp: WhitePoint<T>, D: AdaptFrom<S, Swp, Dwp, T>,

Source§

fn adapt_into_using<M>(self, method: M) -> D
where M: TransformMatrix<T>,

Convert the source color to the destination color using the specified method.
Source§

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default.
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, C> ArraysFrom<C> for T
where C: IntoArrays<T>,

Source§

fn arrays_from(colors: C) -> T

Cast a collection of colors into a collection of arrays.
Source§

impl<T, C> ArraysInto<C> for T
where C: FromArrays<T>,

Source§

fn arrays_into(self) -> C

Cast this collection of arrays into a collection of colors.
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<WpParam, T, U> Cam16IntoUnclamped<WpParam, T> for U
where T: FromCam16Unclamped<WpParam, U>,

Source§

type Scalar = <T as FromCam16Unclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn cam16_into_unclamped( self, parameters: BakedParameters<WpParam, <U as Cam16IntoUnclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T, C> ComponentsFrom<C> for T
where C: IntoComponents<T>,

Source§

fn components_from(colors: C) -> T

Cast a collection of colors into a collection of color components.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromAngle<T> for T

Source§

fn from_angle(angle: T) -> T

Performs a conversion from angle.
Source§

impl<T, U> FromStimulus<U> for T
where U: IntoStimulus<T>,

Source§

fn from_stimulus(other: U) -> T

Converts other into Self, while performing the appropriate scaling, rounding and clamping.
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<T, U> IntoAngle<U> for T
where U: FromAngle<T>,

Source§

fn into_angle(self) -> U

Performs a conversion into T.
Source§

impl<WpParam, T, U> IntoCam16Unclamped<WpParam, T> for U
where T: Cam16FromUnclamped<WpParam, U>,

Source§

type Scalar = <T as Cam16FromUnclamped<WpParam, U>>::Scalar

The number type that’s used in parameters when converting.
Source§

fn into_cam16_unclamped( self, parameters: BakedParameters<WpParam, <U as IntoCam16Unclamped<WpParam, T>>::Scalar>, ) -> T

Converts self into C, using the provided parameters.
Source§

impl<T, U> IntoColor<U> for T
where U: FromColor<T>,

Source§

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more
Source§

impl<T, U> IntoColorUnclamped<U> for T
where U: FromColorUnclamped<T>,

Source§

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more
Source§

impl<T> IntoStimulus<T> for T

Source§

fn into_stimulus(self) -> T

Converts self into T, while performing the appropriate scaling, rounding and clamping.
Source§

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

Source§

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, C> TryComponentsInto<C> for T
where C: TryFromComponents<T>,

Source§

type Error = <C as TryFromComponents<T>>::Error

The error for when try_into_colors fails to cast.
Source§

fn try_components_into(self) -> Result<C, <T as TryComponentsInto<C>>::Error>

Try to cast this collection of color components into a collection of colors. Read more
Source§

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

Source§

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>,

Source§

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.
Source§

impl<T, U> TryIntoColor<U> for T
where U: TryFromColor<T>,

Source§

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more
Source§

impl<C, U> UintsFrom<C> for U
where C: IntoUints<U>,

Source§

fn uints_from(colors: C) -> U

Cast a collection of colors into a collection of unsigned integers.
Source§

impl<C, U> UintsInto<C> for U
where C: FromUints<U>,

Source§

fn uints_into(self) -> C

Cast this collection of unsigned integers into a collection of colors.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,