Struct bevy_gizmos::config::GizmoConfig
source · pub struct GizmoConfig {
pub enabled: bool,
pub line_width: f32,
pub line_perspective: bool,
pub line_style: GizmoLineStyle,
pub depth_bias: f32,
pub render_layers: RenderLayers,
pub line_joints: GizmoLineJoint,
}
Expand description
A struct that stores configuration for gizmos.
Fields§
§enabled: bool
Set to false
to stop drawing gizmos.
Defaults to true
.
line_width: f32
Line width specified in pixels.
If line_perspective
is true
then this is the size in pixels at the camera’s near plane.
Defaults to 2.0
.
line_perspective: bool
Apply perspective to gizmo lines.
This setting only affects 3D, non-orthographic cameras.
Defaults to false
.
line_style: GizmoLineStyle
Determine the style of gizmo lines.
depth_bias: f32
How closer to the camera than real geometry the line should be.
In 2D this setting has no effect and is effectively always -1.
Value between -1 and 1 (inclusive).
- 0 means that there is no change to the line position when rendering
- 1 means it is furthest away from camera as possible
- -1 means that it will always render in front of other things.
This is typically useful if you are drawing wireframes on top of polygons and your wireframe is z-fighting (flickering on/off) with your main model. You would set this value to a negative number close to 0.
render_layers: RenderLayers
Describes which rendering layers gizmos will be rendered to.
Gizmos will only be rendered to cameras with intersecting layers.
line_joints: GizmoLineJoint
Describe how lines should join
Trait Implementations§
source§impl Clone for GizmoConfig
impl Clone for GizmoConfig
source§fn clone(&self) -> GizmoConfig
fn clone(&self) -> GizmoConfig
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Default for GizmoConfig
impl Default for GizmoConfig
source§impl FromReflect for GizmoConfigwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
f32: FromReflect + TypePath + RegisterForReflection,
GizmoLineStyle: FromReflect + TypePath + RegisterForReflection,
RenderLayers: FromReflect + TypePath + RegisterForReflection,
GizmoLineJoint: FromReflect + TypePath + RegisterForReflection,
impl FromReflect for GizmoConfigwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
f32: FromReflect + TypePath + RegisterForReflection,
GizmoLineStyle: FromReflect + TypePath + RegisterForReflection,
RenderLayers: FromReflect + TypePath + RegisterForReflection,
GizmoLineJoint: FromReflect + TypePath + RegisterForReflection,
source§fn from_reflect(reflect: &dyn Reflect) -> Option<Self>
fn from_reflect(reflect: &dyn Reflect) -> Option<Self>
Self
from a reflected value.source§fn take_from_reflect(
reflect: Box<dyn Reflect>
) -> Result<Self, Box<dyn Reflect>>
fn take_from_reflect( reflect: Box<dyn Reflect> ) -> Result<Self, Box<dyn Reflect>>
Self
using,
constructing the value using from_reflect
if that fails. Read moresource§impl GetTypeRegistration for GizmoConfigwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
f32: FromReflect + TypePath + RegisterForReflection,
GizmoLineStyle: FromReflect + TypePath + RegisterForReflection,
RenderLayers: FromReflect + TypePath + RegisterForReflection,
GizmoLineJoint: FromReflect + TypePath + RegisterForReflection,
impl GetTypeRegistration for GizmoConfigwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
f32: FromReflect + TypePath + RegisterForReflection,
GizmoLineStyle: FromReflect + TypePath + RegisterForReflection,
RenderLayers: FromReflect + TypePath + RegisterForReflection,
GizmoLineJoint: FromReflect + TypePath + RegisterForReflection,
source§fn get_type_registration() -> TypeRegistration
fn get_type_registration() -> TypeRegistration
TypeRegistration
for this type.source§fn register_type_dependencies(registry: &mut TypeRegistry)
fn register_type_dependencies(registry: &mut TypeRegistry)
source§impl Reflect for GizmoConfigwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
f32: FromReflect + TypePath + RegisterForReflection,
GizmoLineStyle: FromReflect + TypePath + RegisterForReflection,
RenderLayers: FromReflect + TypePath + RegisterForReflection,
GizmoLineJoint: FromReflect + TypePath + RegisterForReflection,
impl Reflect for GizmoConfigwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
f32: FromReflect + TypePath + RegisterForReflection,
GizmoLineStyle: FromReflect + TypePath + RegisterForReflection,
RenderLayers: FromReflect + TypePath + RegisterForReflection,
GizmoLineJoint: FromReflect + TypePath + RegisterForReflection,
source§fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
source§fn as_any_mut(&mut self) -> &mut dyn Any
fn as_any_mut(&mut self) -> &mut dyn Any
&mut dyn Any
.source§fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>
source§fn as_reflect(&self) -> &dyn Reflect
fn as_reflect(&self) -> &dyn Reflect
source§fn as_reflect_mut(&mut self) -> &mut dyn Reflect
fn as_reflect_mut(&mut self) -> &mut dyn Reflect
source§fn clone_value(&self) -> Box<dyn Reflect>
fn clone_value(&self) -> Box<dyn Reflect>
Reflect
trait object. Read moresource§fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
source§fn reflect_kind(&self) -> ReflectKind
fn reflect_kind(&self) -> ReflectKind
source§fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
source§fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
source§fn reflect_owned(self: Box<Self>) -> ReflectOwned
fn reflect_owned(self: Box<Self>) -> ReflectOwned
source§fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
fn reflect_partial_eq(&self, value: &dyn Reflect) -> Option<bool>
source§fn apply(&mut self, value: &(dyn Reflect + 'static))
fn apply(&mut self, value: &(dyn Reflect + 'static))
source§fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
source§fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
source§fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
source§fn is_dynamic(&self) -> bool
fn is_dynamic(&self) -> bool
source§impl Struct for GizmoConfigwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
f32: FromReflect + TypePath + RegisterForReflection,
GizmoLineStyle: FromReflect + TypePath + RegisterForReflection,
RenderLayers: FromReflect + TypePath + RegisterForReflection,
GizmoLineJoint: FromReflect + TypePath + RegisterForReflection,
impl Struct for GizmoConfigwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
f32: FromReflect + TypePath + RegisterForReflection,
GizmoLineStyle: FromReflect + TypePath + RegisterForReflection,
RenderLayers: FromReflect + TypePath + RegisterForReflection,
GizmoLineJoint: FromReflect + TypePath + RegisterForReflection,
source§fn field(&self, name: &str) -> Option<&dyn Reflect>
fn field(&self, name: &str) -> Option<&dyn Reflect>
name
as a &dyn Reflect
.source§fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>
fn field_mut(&mut self, name: &str) -> Option<&mut dyn Reflect>
name
as a
&mut dyn Reflect
.source§fn field_at(&self, index: usize) -> Option<&dyn Reflect>
fn field_at(&self, index: usize) -> Option<&dyn Reflect>
index
as a
&dyn Reflect
.source§fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>
fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn Reflect>
index
as a &mut dyn Reflect
.source§fn name_at(&self, index: usize) -> Option<&str>
fn name_at(&self, index: usize) -> Option<&str>
index
.source§fn iter_fields(&self) -> FieldIter<'_>
fn iter_fields(&self) -> FieldIter<'_>
source§fn clone_dynamic(&self) -> DynamicStruct
fn clone_dynamic(&self) -> DynamicStruct
DynamicStruct
.source§impl TypePath for GizmoConfig
impl TypePath for GizmoConfig
source§fn type_path() -> &'static str
fn type_path() -> &'static str
source§fn short_type_path() -> &'static str
fn short_type_path() -> &'static str
source§fn type_ident() -> Option<&'static str>
fn type_ident() -> Option<&'static str>
source§fn crate_name() -> Option<&'static str>
fn crate_name() -> Option<&'static str>
source§impl Typed for GizmoConfigwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
f32: FromReflect + TypePath + RegisterForReflection,
GizmoLineStyle: FromReflect + TypePath + RegisterForReflection,
RenderLayers: FromReflect + TypePath + RegisterForReflection,
GizmoLineJoint: FromReflect + TypePath + RegisterForReflection,
impl Typed for GizmoConfigwhere
Self: Any + Send + Sync,
bool: FromReflect + TypePath + RegisterForReflection,
f32: FromReflect + TypePath + RegisterForReflection,
GizmoLineStyle: FromReflect + TypePath + RegisterForReflection,
RenderLayers: FromReflect + TypePath + RegisterForReflection,
GizmoLineJoint: FromReflect + TypePath + RegisterForReflection,
Auto Trait Implementations§
impl Freeze for GizmoConfig
impl RefUnwindSafe for GizmoConfig
impl Send for GizmoConfig
impl Sync for GizmoConfig
impl Unpin for GizmoConfig
impl UnwindSafe for GizmoConfig
Blanket Implementations§
source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<GpuImage>) -> U
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
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<T> DynamicTypePath for Twhere
T: TypePath,
impl<T> DynamicTypePath for Twhere
T: TypePath,
source§fn reflect_type_path(&self) -> &str
fn reflect_type_path(&self) -> &str
TypePath::type_path
.source§fn reflect_short_type_path(&self) -> &str
fn reflect_short_type_path(&self) -> &str
source§fn reflect_type_ident(&self) -> Option<&str>
fn reflect_type_ident(&self) -> Option<&str>
TypePath::type_ident
.source§fn reflect_crate_name(&self) -> Option<&str>
fn reflect_crate_name(&self) -> Option<&str>
TypePath::crate_name
.source§fn reflect_module_path(&self) -> Option<&str>
fn reflect_module_path(&self) -> Option<&str>
source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Self
using data from the given World
.source§impl<S> GetField for Swhere
S: Struct,
impl<S> GetField for Swhere
S: Struct,
source§impl<T> GetPath for T
impl<T> GetPath for T
source§fn reflect_path<'p>(
&self,
path: impl ReflectPath<'p>
) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path<'p>( &self, path: impl ReflectPath<'p> ) -> Result<&(dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn reflect_path_mut<'p>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn reflect_path_mut<'p>( &mut self, path: impl ReflectPath<'p> ) -> Result<&mut (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read moresource§fn path<'p, T>(
&self,
path: impl ReflectPath<'p>
) -> Result<&T, ReflectPathError<'p>>where
T: Reflect,
fn path<'p, T>(
&self,
path: impl ReflectPath<'p>
) -> Result<&T, ReflectPathError<'p>>where
T: Reflect,
path
. Read moresource§fn path_mut<'p, T>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut T, ReflectPathError<'p>>where
T: Reflect,
fn path_mut<'p, T>(
&mut self,
path: impl ReflectPath<'p>
) -> Result<&mut T, ReflectPathError<'p>>where
T: Reflect,
path
. Read more