Struct bevy::input::gamepad::ButtonSettings
pub struct ButtonSettings { /* private fields */ }
Expand description
Manages settings for gamepad buttons.
It is used inside of GamepadSettings
to define the threshold for a gamepad button
to be considered pressed or released. A button is considered pressed if the press_threshold
value is surpassed and released if the release_threshold
value is undercut.
Allowed values: 0.0 <= ``release_threshold`` <= ``press_threshold`` <= 1.0
Implementations§
§impl ButtonSettings
impl ButtonSettings
pub fn new(
press_threshold: f32,
release_threshold: f32
) -> Result<ButtonSettings, ButtonSettingsError>
pub fn new( press_threshold: f32, release_threshold: f32 ) -> Result<ButtonSettings, ButtonSettingsError>
Creates a new ButtonSettings
instance.
§Parameters
press_threshold
is the button input value above which the button is considered pressed.release_threshold
is the button input value below which the button is considered released.
Restrictions:
0.0 <= ``release_threshold`` <= ``press_threshold`` <= 1.0
§Errors
If the restrictions are not met, returns one of
GamepadSettingsError::ButtonReleaseThresholdOutOfRange
,
GamepadSettingsError::ButtonPressThresholdOutOfRange
, or
GamepadSettingsError::ButtonReleaseThresholdGreaterThanPressThreshold
.
pub fn is_pressed(&self, value: f32) -> bool
pub fn is_pressed(&self, value: f32) -> bool
Returns true
if the button is pressed.
A button is considered pressed if the value
passed is greater than or equal to the press threshold.
pub fn is_released(&self, value: f32) -> bool
pub fn is_released(&self, value: f32) -> bool
Returns true
if the button is released.
A button is considered released if the value
passed is lower than or equal to the release threshold.
pub fn press_threshold(&self) -> f32
pub fn press_threshold(&self) -> f32
Get the button input threshold above which the button is considered pressed.
pub fn try_set_press_threshold(
&mut self,
value: f32
) -> Result<(), ButtonSettingsError>
pub fn try_set_press_threshold( &mut self, value: f32 ) -> Result<(), ButtonSettingsError>
Try to set the button input threshold above which the button is considered pressed.
§Errors
If the value passed is outside the range [release threshold..=1.0], returns either
GamepadSettingsError::ButtonPressThresholdOutOfRange
or
GamepadSettingsError::ButtonReleaseThresholdGreaterThanPressThreshold
.
pub fn set_press_threshold(&mut self, value: f32) -> f32
pub fn set_press_threshold(&mut self, value: f32) -> f32
Try to set the button input threshold above which the button is considered pressed. If the value passed is outside the range [release threshold..=1.0], the value will not be changed.
Returns the new value of the press threshold.
pub fn release_threshold(&self) -> f32
pub fn release_threshold(&self) -> f32
Get the button input threshold below which the button is considered released.
pub fn try_set_release_threshold(
&mut self,
value: f32
) -> Result<(), ButtonSettingsError>
pub fn try_set_release_threshold( &mut self, value: f32 ) -> Result<(), ButtonSettingsError>
Try to set the button input threshold below which the button is considered released.
§Errors
If the value passed is outside the range [0.0..=press threshold], returns
ButtonSettingsError::ReleaseThresholdOutOfRange
or
ButtonSettingsError::ReleaseThresholdGreaterThanPressThreshold
.
pub fn set_release_threshold(&mut self, value: f32) -> f32
pub fn set_release_threshold(&mut self, value: f32) -> f32
Try to set the button input threshold below which the button is considered released. If the value passed is outside the range [0.0..=press threshold], the value will not be changed.
Returns the new value of the release threshold.
Trait Implementations§
§impl Clone for ButtonSettings
impl Clone for ButtonSettings
§fn clone(&self) -> ButtonSettings
fn clone(&self) -> ButtonSettings
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more§impl Debug for ButtonSettings
impl Debug for ButtonSettings
§impl Default for ButtonSettings
impl Default for ButtonSettings
§fn default() -> ButtonSettings
fn default() -> ButtonSettings
§impl FromReflect for ButtonSettings
impl FromReflect for ButtonSettings
§fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<ButtonSettings>
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<ButtonSettings>
Self
from a reflected value.§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 more§impl GetTypeRegistration for ButtonSettings
impl GetTypeRegistration for ButtonSettings
§impl Reflect for ButtonSettings
impl Reflect for ButtonSettings
§fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
§fn into_any(self: Box<ButtonSettings>) -> Box<dyn Any>
fn into_any(self: Box<ButtonSettings>) -> Box<dyn Any>
Box<dyn Any>
.§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut dyn Any
.§fn into_reflect(self: Box<ButtonSettings>) -> Box<dyn Reflect>
fn into_reflect(self: Box<ButtonSettings>) -> Box<dyn Reflect>
§fn as_reflect(&self) -> &(dyn Reflect + 'static)
fn as_reflect(&self) -> &(dyn Reflect + 'static)
§fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)
fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)
§fn clone_value(&self) -> Box<dyn Reflect>
fn clone_value(&self) -> Box<dyn Reflect>
Reflect
trait object. Read more§fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>
§fn apply(&mut self, value: &(dyn Reflect + 'static))
fn apply(&mut self, value: &(dyn Reflect + 'static))
§fn reflect_kind(&self) -> ReflectKind
fn reflect_kind(&self) -> ReflectKind
§fn reflect_ref(&self) -> ReflectRef<'_>
fn reflect_ref(&self) -> ReflectRef<'_>
§fn reflect_mut(&mut self) -> ReflectMut<'_>
fn reflect_mut(&mut self) -> ReflectMut<'_>
§fn reflect_owned(self: Box<ButtonSettings>) -> ReflectOwned
fn reflect_owned(self: Box<ButtonSettings>) -> ReflectOwned
§fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>
fn reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>
§fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>
§fn reflect_hash(&self) -> Option<u64>
fn reflect_hash(&self) -> Option<u64>
§fn serializable(&self) -> Option<Serializable<'_>>
fn serializable(&self) -> Option<Serializable<'_>>
§fn is_dynamic(&self) -> bool
fn is_dynamic(&self) -> bool
§impl Struct for ButtonSettings
impl Struct for ButtonSettings
§fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>
fn field(&self, name: &str) -> Option<&(dyn Reflect + 'static)>
name
as a &dyn Reflect
.§fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>
fn field_mut(&mut self, name: &str) -> Option<&mut (dyn Reflect + 'static)>
name
as a
&mut dyn Reflect
.§fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>
fn field_at(&self, index: usize) -> Option<&(dyn Reflect + 'static)>
index
as a
&dyn Reflect
.§fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>
fn field_at_mut(&mut self, index: usize) -> Option<&mut (dyn Reflect + 'static)>
index
as a &mut dyn Reflect
.§fn iter_fields(&self) -> FieldIter<'_> ⓘ
fn iter_fields(&self) -> FieldIter<'_> ⓘ
§fn clone_dynamic(&self) -> DynamicStruct
fn clone_dynamic(&self) -> DynamicStruct
DynamicStruct
.§impl TypePath for ButtonSettings
impl TypePath for ButtonSettings
§fn short_type_path() -> &'static str
fn short_type_path() -> &'static str
§fn type_ident() -> Option<&'static str>
fn type_ident() -> Option<&'static str>
§fn crate_name() -> Option<&'static str>
fn crate_name() -> Option<&'static str>
§impl Typed for ButtonSettings
impl Typed for ButtonSettings
Auto Trait Implementations§
impl RefUnwindSafe for ButtonSettings
impl Send for ButtonSettings
impl Sync for ButtonSettings
impl Unpin for ButtonSettings
impl UnwindSafe for ButtonSettings
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
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
§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>
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>
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)
&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)
&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> DynamicTypePath for Twhere
T: TypePath,
impl<T> DynamicTypePath for Twhere
T: TypePath,
§fn reflect_type_path(&self) -> &str
fn reflect_type_path(&self) -> &str
TypePath::type_path
.§fn reflect_short_type_path(&self) -> &str
fn reflect_short_type_path(&self) -> &str
§fn reflect_type_ident(&self) -> Option<&str>
fn reflect_type_ident(&self) -> Option<&str>
TypePath::type_ident
.§fn reflect_crate_name(&self) -> Option<&str>
fn reflect_crate_name(&self) -> Option<&str>
TypePath::crate_name
.§fn reflect_module_path(&self) -> Option<&str>
fn reflect_module_path(&self) -> Option<&str>
§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
§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
Self
using data from the given World
.§impl<T> GetPath for T
impl<T> GetPath for T
§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 more§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 more§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 more§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