[−][src]Struct amethyst_ui::UiText

pub struct UiText {
    pub text: String,
    pub font_size: f32,
    pub color: [f32; 4],
    pub font: FontHandle,
    pub password: bool,
    pub line_mode: LineMode,
    pub align: Anchor,
    // some fields omitted
}

A component used to display text in this entity's UiTransform

Fields

text: String

The string rendered by this.

font_size: f32

The height of a line of text in pixels.

color: [f32; 4]

The color of the rendered text, using a range of 0.0 to 1.0 per channel.

font: FontHandle

The font used for rendering.

password: bool

If true this will be rendered as dots instead of the text.

line_mode: LineMode

How the text should handle new lines.

align: Anchor

How to align the text within its UiTransform.

Methods

`impl UiText`[src]

`pub fn new( font: FontHandle, text: String, color: [f32; 4], font_size: f32 ) -> UiText`[src]

Initializes a new UiText

Parameters

font: A handle to a Font asset
text: the glyphs to render
color: RGBA color with a maximum of 1.0 and a minimum of 0.0 for each channel
font_size: a uniform scale applied to the glyphs

Trait Implementations

`impl Clone for UiText`[src]

`fn clone(&self) -> UiText`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

Performs copy-assignment from source. Read more

`impl Debug for UiText`[src]

`fn fmt(&self, __f: &mut Formatter) -> Result`[src]

`impl Serialize for UiText`[src]

`fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer,` [src]

`impl Component for UiText`[src]

`type Storage = DenseVecStorage<Self>`

Associated storage type for this component.

Auto Trait Implementations

`impl Unpin for UiText`

`impl Sync for UiText`

`impl Send for UiText`

`impl UnwindSafe for UiText`

`impl RefUnwindSafe for UiText`

Blanket Implementations

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Same<T> for T`[src]

`type Output = T`

Should always be Self

`impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>,` [src]

`fn to_subset(&self) -> Option<SS>`[src]

`fn is_in_subset(&self) -> bool`[src]

`unsafe fn to_subset_unchecked(&self) -> SS`[src]

`fn from_subset(element: &SS) -> SP`[src]

`impl<T> Resource for T where T: Any + Send + Sync,` [src]

`impl<T> Any for T where T: Any,` [src]

`fn get_type_id(&self) -> TypeId`[src]

`impl<T> Event for T where T: Send + Sync + 'static,` [src]

`impl<T> Serialize for T where T: Serialize + ?Sized,` [src]

`fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>`[src]

`impl<T> Erased for T`[src]

`impl<T> Clone for T where T: Clone,` [src]

`unsafe fn clone_box(&self) -> *mut ()`[src]

`impl<T> SetParameter for T`[src]

`fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where T: Parameter<Self>,` [src]

Sets value as a parameter of self.

`impl<T> Supports<T> for T`[src]

`impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where D: AdaptFrom<S, Swp, Dwp, T>, Dwp: WhitePoint, Swp: WhitePoint, T: Component + Float,` [src]

`fn adapt_into_using<M>(self, method: M) -> D where M: TransformMatrix<Swp, Dwp, T>,` [src]

`fn adapt_into(self) -> D`[src]

Convert the source color to the destination color using the bradford method by default Read more

[−][src]Struct amethyst_ui::UiText

Fields

Methods

impl UiText[src]

pub fn new( font: FontHandle, text: String, color: [f32; 4], font_size: f32) -> UiText[src]

Parameters

Trait Implementations

impl Clone for UiText[src]

fn clone(&self) -> UiText[src]

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Debug for UiText[src]

fn fmt(&self, __f: &mut Formatter) -> Result[src]

impl Serialize for UiText[src]

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where __S: Serializer, [src]

impl Component for UiText[src]

type Storage = DenseVecStorage<Self>

Auto Trait Implementations

impl Unpin for UiText

impl Sync for UiText

impl Send for UiText

impl UnwindSafe for UiText

impl RefUnwindSafe for UiText

Blanket Implementations

impl<T> ToOwned for T where T: Clone, [src]

type Owned = T

fn to_owned(&self) -> T[src]

fn clone_into(&self, target: &mut T)[src]

impl<T> From<T> for T[src]

fn from(t: T) -> T[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

fn into(self) -> U[src]

impl<T, U> TryFrom<U> for T where U: Into<T>, [src]

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

impl<T, U> TryInto<U> for T where U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

fn borrow_mut(&mut self) -> &mut T[src]

impl<T> Any for T where T: 'static + ?Sized, [src]

fn type_id(&self) -> TypeId[src]

impl<T> Same<T> for T[src]

type Output = T

impl<SS, SP> SupersetOf<SS> for SP where SS: SubsetOf<SP>, [src]

fn to_subset(&self) -> Option<SS>[src]

fn is_in_subset(&self) -> bool[src]

unsafe fn to_subset_unchecked(&self) -> SS[src]

fn from_subset(element: &SS) -> SP[src]

impl<T> Resource for T where T: Any + Send + Sync, [src]

impl<T> Any for T where T: Any, [src]

fn get_type_id(&self) -> TypeId[src]

impl<T> Event for T where T: Send + Sync + 'static, [src]

impl<T> Serialize for T where T: Serialize + ?Sized, [src]

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>[src]

impl<T> Erased for T[src]

impl<T> Clone for T where T: Clone, [src]

unsafe fn clone_box(&self) -> *mut ()[src]

impl<T> SetParameter for T[src]

fn set<T>(&mut self, value: T) -> <T as Parameter<Self>>::Result where T: Parameter<Self>, [src]

impl<T> Supports<T> for T[src]

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where D: AdaptFrom<S, Swp, Dwp, T>, Dwp: WhitePoint, Swp: WhitePoint, T: Component + Float, [src]

fn adapt_into_using<M>(self, method: M) -> D where M: TransformMatrix<Swp, Dwp, T>, [src]

fn adapt_into(self) -> D[src]

impl<V, T> VZip<V> for T where V: MultiLane<T>, [src]

fn vzip(self) -> V[src]