Struct nannou::draw::primitive::text::Text

pub struct Text { /* fields omitted */ }

Properties related to drawing the Text primitive.

Implementations

impl Text

pub fn new(ctxt: DrawingContext<'_>, text: &str) -> Self

Begin drawing some text.

pub fn font_size(self, size: FontSize) -> Self

The font size to use for the text.

pub fn line_wrap(self, line_wrap: Option<Wrap>) -> Self

Specify whether or not text should be wrapped around some width and how to do so.

The default value is DEFAULT_LINE_WRAP.

pub fn no_line_wrap(self) -> Self

Specify that the Text should not wrap lines around the width.

Shorthand for builder.line_wrap(None).

pub fn wrap_by_word(self) -> Self

Line wrap the Text at the beginning of the first word that exceeds the width.

Shorthand for builder.line_wrap(Some(Wrap::Whitespace)).

pub fn wrap_by_character(self) -> Self

Line wrap the Text at the beginning of the first character that exceeds the width.

Shorthand for builder.line_wrap(Some(Wrap::Character)).

pub fn font(self, font: Font) -> Self

A method for specifying the Font used for displaying the Text.

pub fn justify(self, justify: Justify) -> Self

Describe the end along the x axis to which the text should be aligned.

pub fn left_justify(self) -> Self

Align the text to the left of its bounding Rect’s x axis range.

pub fn center_justify(self) -> Self

Align the text to the middle of its bounding Rect’s x axis range.

pub fn right_justify(self) -> Self

Align the text to the right of its bounding Rect’s x axis range.

pub fn line_spacing(self, spacing: Scalar) -> Self

Specify how much vertical space should separate each line of text.

pub fn y_align(self, align: Align) -> Self

Specify how the whole text should be aligned along the y axis of its bounding rectangle

pub fn align_top(self) -> Self

Align the top edge of the text with the top edge of its bounding rectangle.

pub fn align_middle_y(self) -> Self

Align the middle of the text with the middle of the bounding rect along the y axis.

This is the default behaviour.

pub fn align_bottom(self) -> Self

Align the bottom edge of the text with the bottom edge of its bounding rectangle.

pub fn layout(self, layout: &Layout) -> Self

Set all the parameters via an existing Layout

pub fn with_style(self, style: Style) -> Self

Specify the entire styling for the Text.

pub fn glyph_colors(self, colors: Vec<LinSrgba>) -> Self

Set a color for each glyph. Colors unspecified glyphs using the drawing color.

Trait Implementations

impl Clone for Text

fn clone(&self) -> Text

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Text

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

Formats the value using the given formatter.

impl From<Text> for Primitive

fn from(prim: Text) -> Self

Performs the conversion.

impl RenderPrimitive for Text

fn render_primitive(
    self,
    ctxt: RenderContext<'_>,
    mesh: &mut Mesh
) -> PrimitiveRender

Render self into the given mesh.

impl SetColor<f32> for Text

fn rgba_mut(&mut self) -> &mut Option<LinSrgba>

Provide a mutable reference to the RGBA field which can be used for setting colors.

fn color<C>(self, color: C) -> Self where
    C: IntoLinSrgba<S>, 

Specify a color.

fn rgb<T>(self, r: T, g: T, b: T) -> Self where
    T: Component,
    S: Float, 

Specify the color via red, green and blue channels.

fn rgb8(self, r: u8, g: u8, b: u8) -> Self where
    S: Float, 

Specify the color via red, green and blue channels as bytes

fn rgba<T>(self, r: T, g: T, b: T, a: T) -> Self where
    T: Component,
    S: Float, 

Specify the color via red, green, blue and alpha channels.

fn rgba8(self, r: u8, g: u8, b: u8, a: u8) -> Self where
    S: Float, 

Specify the color via red, green, blue and alpha channels as bytes

fn hsl(self, h: S, s: S, l: S) -> Self where
    S: Float + Into<RgbHue<S>>, 

Specify the color via hue, saturation and luminance.

fn hsla(self, h: S, s: S, l: S, a: S) -> Self where
    S: Float + Into<RgbHue<S>>, 

Specify the color via hue, saturation, luminance and an alpha channel.

fn hsv(self, h: S, s: S, v: S) -> Self where
    S: Float, 

Specify the color via hue, saturation and value (brightness).

fn hsva(self, h: S, s: S, v: S, a: S) -> Self where
    S: Float, 

Specify the color via hue, saturation, value (brightness) and an alpha channel.

fn gray<T>(self, g: T) -> Self where
    T: Component,
    S: Float, 

Specify the color as gray scale

impl SetDimensions for Text

fn properties(&mut self) -> &mut Properties

Provide a mutable reference to the dimension::Properties for updating.

fn width(self, w: f32) -> Self

Set the absolute width for the primitive.

fn height(self, h: f32) -> Self

Set the absolute height for the primitive.

fn depth(self, d: f32) -> Self

Set the absolute depth for the primitive.

fn w(self, w: f32) -> Self

Short-hand for the width method.

fn h(self, h: f32) -> Self

Short-hand for the height method.

fn d(self, d: f32) -> Self

Short-hand for the depth method.

fn wh(self, v: Vec2) -> Self

Set the x and y dimensions for the primitive.

fn whd(self, v: Vec3) -> Self

Set the x, y and z dimensions for the primitive.

fn w_h(self, x: f32, y: f32) -> Self

Set the width and height for the primitive.

fn w_h_d(self, x: f32, y: f32, z: f32) -> Self

Set the width and height for the primitive.

impl SetOrientation for Text

fn properties(&mut self) -> &mut Properties

Provide a mutable reference to the orientation::Properties for updating.

fn look_at(self, target: Point3) -> Self

Describe orientation via the vector that points to the given target.

fn x_radians(self, x: f32) -> Self

Specify the orientation around the x axis as an absolute value in radians.

fn y_radians(self, y: f32) -> Self

Specify the orientation around the y axis as an absolute value in radians.

fn z_radians(self, z: f32) -> Self

Specify the orientation around the z axis as an absolute value in radians.

fn x_degrees(self, x: f32) -> Self

Specify the orientation around the x axis as an absolute value in degrees.

fn y_degrees(self, y: f32) -> Self

Specify the orientation around the y axis as an absolute value in degrees.

fn z_degrees(self, z: f32) -> Self

Specify the orientation around the z axis as an absolute value in degrees.

fn x_turns(self, x: f32) -> Self

Specify the orientation around the x axis as a number of turns around the axis.

fn y_turns(self, y: f32) -> Self

Specify the orientation around the y axis as a number of turns around the axis.

fn z_turns(self, z: f32) -> Self

Specify the orientation around the z axis as a number of turns around the axis.

fn radians(self, v: Vec3) -> Self

Specify the orientation along each axis with the given Vector of radians.

fn degrees(self, v: Vec3) -> Self

Specify the orientation along each axis with the given Vector of degrees.

fn turns(self, v: Vec3) -> Self

Specify the orientation along each axis with the given Vector of “turns”.

fn euler(self, e: Vec3) -> Self

Specify the orientation with the given euler orientation in radians.

fn quaternion(self, q: Quat) -> Self

Specify the orientation with the given Quaternion.

fn pitch(self, pitch: f32) -> Self

Specify the “pitch” of the orientation in radians.

fn yaw(self, yaw: f32) -> Self

Specify the “yaw” of the orientation in radians.

fn roll(self, roll: f32) -> Self

Specify the “roll” of the orientation in radians.

fn rotate(self, radians: f32) -> Self

Assuming we’re looking at a 2D plane, positive values cause a clockwise rotation where the given value is specified in radians.

impl SetPosition for Text

fn properties(&mut self) -> &mut Properties

Provide a mutable reference to the position::Properties for updating.

fn x(self, x: f32) -> Self

Build with the given Absolute Position along the x axis.

fn y(self, y: f32) -> Self

Build with the given Absolute Position along the y axis.

fn z(self, z: f32) -> Self

Build with the given Absolute Position along the z axis.

fn xy(self, p: Point2) -> Self

Set the Position with some two-dimensional point.

fn xyz(self, p: Point3) -> Self

Set the Position with some three-dimensional point.

fn x_y(self, x: f32, y: f32) -> Self

Set the Position with x y coordinates.

fn x_y_z(self, x: f32, y: f32, z: f32) -> Self

Set the Position with x y z coordinates.