Struct bevy_vector_shapes::ShapePlugin
source · pub struct ShapePlugin {
pub base_config: ShapeConfig,
pub exclude_2d: bool,
}
Expand description
Plugin that contains all necessary functionality to draw shapes with a 3D or 2D camera.
Fields§
§base_config: ShapeConfig
Default config that will be used for all ShapePainter
s.
Available as a resource BaseShapeConfig
.
exclude_2d: bool
Whether to also add the 2d plugin.
Useful if you want to add the 3d functionality when another plugin has already added the 2d plugin.
Implementations§
source§impl ShapePlugin
impl ShapePlugin
sourcepub fn new(base_config: ShapeConfig) -> Self
pub fn new(base_config: ShapeConfig) -> Self
Examples found in repository?
examples/canvas_bloom.rs (lines 14-17)
11 12 13 14 15 16 17 18 19 20 21 22 23
fn main() {
App::new()
.add_plugins(DefaultPlugins)
.add_plugins(ShapePlugin::new(ShapeConfig {
disable_laa: true,
..ShapeConfig::default_3d()
}))
.insert_resource(ClearColor(Color::BLACK))
.insert_resource(Msaa::Off)
.add_systems(Startup, setup)
.add_systems(Update, draw_shapes)
.run();
}
More examples
examples/canvas_low_res.rs (lines 12-15)
9 10 11 12 13 14 15 16 17 18 19 20 21
fn main() {
App::new()
.add_plugins(DefaultPlugins)
.add_plugins(ShapePlugin::new(ShapeConfig {
disable_laa: true,
..ShapeConfig::default_3d()
}))
.insert_resource(ClearColor(Color::DARK_GRAY))
.insert_resource(Msaa::Off)
.add_systems(Startup, setup)
.add_systems(Update, draw_shapes)
.run();
}
Trait Implementations§
source§impl Default for ShapePlugin
impl Default for ShapePlugin
source§impl Plugin for ShapePlugin
impl Plugin for ShapePlugin
§fn ready(&self, _app: &App) -> bool
fn ready(&self, _app: &App) -> bool
Has the plugin finished its setup? This can be useful for plugins that need something
asynchronous to happen before they can finish their setup, like the initialization of a renderer.
Once the plugin is ready,
finish
should be called.§fn finish(&self, _app: &mut App)
fn finish(&self, _app: &mut App)
Finish adding this plugin to the [
App
], once all plugins registered are ready. This can
be useful for plugins that depends on another plugin asynchronous setup, like the renderer.§fn cleanup(&self, _app: &mut App)
fn cleanup(&self, _app: &mut App)
Runs after all plugins are built and finished, but before the app schedule is executed.
This can be useful if you have some resource that other plugins need during their build step,
but after build you want to remove it and send it to another thread.
Auto Trait Implementations§
impl !RefUnwindSafe for ShapePlugin
impl Send for ShapePlugin
impl Sync for ShapePlugin
impl Unpin for ShapePlugin
impl !UnwindSafe for ShapePlugin
Blanket Implementations§
§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
Return the
T
[ShaderType
] for self
. When used in [AsBindGroup
]
derives, it is safe to assume that all images in self
exist.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.§fn as_any(&self) -> &(dyn Any + 'static)
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.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
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.§impl<T> DowncastSync for T
impl<T> DowncastSync for T
§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates
Self
using data from the given [World
].