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 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 ButtonSettingswhere
f32: FromReflect,
impl FromReflect for ButtonSettingswhere
f32: FromReflect,
§fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<ButtonSettings>
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<ButtonSettings>
Self
from a reflected value.§impl GetTypeRegistration for ButtonSettings
impl GetTypeRegistration for ButtonSettings
§impl Reflect for ButtonSettings
impl Reflect for ButtonSettings
§fn get_type_info(&self) -> &'static TypeInfo
fn get_type_info(&self) -> &'static TypeInfo
§fn into_any(self: Box<ButtonSettings, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<ButtonSettings, Global>) -> Box<dyn Any + 'static, Global>
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, Global>
) -> Box<dyn Reflect + 'static, Global>
fn into_reflect(
self: Box<ButtonSettings, Global>
) -> Box<dyn Reflect + 'static, Global>
§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 + 'static, Global>
fn clone_value(&self) -> Box<dyn Reflect + 'static, Global>
Reflect
trait object. Read more§fn set(
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>
fn set(
&mut self,
value: Box<dyn Reflect + 'static, Global>
) -> Result<(), Box<dyn Reflect + 'static, Global>>
§fn apply(&mut self, value: &(dyn Reflect + 'static))
fn apply(&mut self, value: &(dyn Reflect + 'static))
§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, Global>) -> ReflectOwned
fn reflect_owned(self: Box<ButtonSettings, Global>) -> 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<'_>>
§impl Struct for ButtonSettings
impl Struct for ButtonSettings
§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
. Read more§fn iter_fields(&self) -> FieldIter<'_> ⓘ
fn iter_fields(&self) -> FieldIter<'_> ⓘ
§fn clone_dynamic(&self) -> DynamicStruct
fn clone_dynamic(&self) -> DynamicStruct
DynamicStruct
.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 Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,
§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. Read more§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
§fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
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)
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. Read more§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. Read more§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<S> GetField for Swhere
S: Struct,
impl<S> GetField for Swhere
S: Struct,
§impl<T> GetPath for Twhere
T: Reflect,
impl<T> GetPath for Twhere
T: Reflect,
§fn path<'r, 'p>(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
fn path<'r, 'p>(
&'r self,
path: &'p str
) -> Result<&'r (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read more§fn path_mut<'r, 'p>(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
fn path_mut<'r, 'p>(
&'r mut self,
path: &'p str
) -> Result<&'r mut (dyn Reflect + 'static), ReflectPathError<'p>>
path
. Read more§fn get_path<T, 'r, 'p>(
&'r self,
path: &'p str
) -> Result<&'r T, ReflectPathError<'p>>where
T: Reflect,
fn get_path<T, 'r, 'p>(
&'r self,
path: &'p str
) -> Result<&'r T, ReflectPathError<'p>>where
T: Reflect,
path
.§fn get_path_mut<T, 'r, 'p>(
&'r mut self,
path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>>where
T: Reflect,
fn get_path_mut<T, 'r, 'p>(
&'r mut self,
path: &'p str
) -> Result<&'r mut T, ReflectPathError<'p>>where
T: Reflect,
path
. Read more