Struct bevy_debug_text_overlay::OverlayPlugin

source · [−]

pub struct OverlayPlugin {
    pub font: Option<&'static str>,
    pub fallback_color: Color,
    pub font_size: f32,
}

Expand description

The text overlay plugin, you must add this plugin for the screen_print! macro to work. You must also spawn a UiCameraBundle.

You can manage some of the text properties by setting the fields of the plugin.

Fields

font: Option<&'static str>

The font to use, by default it is a variant of adobe’s SourcePro only containing ascii characters.

If the builtin-font flag is disabled, you must set this to Some(thing), otherwise the plugin will panic at initialization.

You can provide your own font by setting this to Some("path/to/font.ttf").

fallback_color: Color

The color to use when none are specified in screen_print!, by default it is yellow.

font_size: f32

The size of the message to display on screen, by default it is 13.0

Trait Implementations

source

impl Default for OverlayPlugin

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

impl Plugin for OverlayPlugin

source

fn build(&self, app: &mut App)

Configures the [App] to which this plugin is added.

fn name(&self) -> &str

Configures a name for the [Plugin]. Primarily for debugging.

Auto Trait Implementations

impl RefUnwindSafe for OverlayPlugin

impl Send for OverlayPlugin

impl Sync for OverlayPlugin

impl Unpin for OverlayPlugin

impl UnwindSafe for OverlayPlugin

Blanket Implementations

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> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> DowncastSync for T where
T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more