Struct bevy::input::gamepad::GamepadSettings
pub struct GamepadSettings {
pub default_button_settings: ButtonSettings,
pub default_axis_settings: AxisSettings,
pub default_button_axis_settings: ButtonAxisSettings,
pub button_settings: HashMap<GamepadButton, ButtonSettings>,
pub axis_settings: HashMap<GamepadAxis, AxisSettings>,
pub button_axis_settings: HashMap<GamepadButton, ButtonAxisSettings>,
}
Expand description
Settings for all Gamepad
s.
§Usage
It is used to create a bevy
resource that stores the settings of every GamepadButton
and
GamepadAxis
. If no user defined ButtonSettings
, AxisSettings
, or ButtonAxisSettings
are defined, the default settings of each are used as a fallback accordingly.
§Note
The GamepadSettings
are used inside of bevy_gilrs
to determine when raw gamepad events from gilrs
,
should register as a GamepadEvent
. Events that don’t meet the change thresholds defined in GamepadSettings
will not register. To modify these settings, mutate the corresponding resource.
Fields§
The default button settings.
default_axis_settings: AxisSettings
The default axis settings.
The default button axis settings.
The user defined button settings.
axis_settings: HashMap<GamepadAxis, AxisSettings>
The user defined axis settings.
The user defined button axis settings.
Implementations§
§impl GamepadSettings
impl GamepadSettings
Returns the ButtonSettings
of the button
.
If no user defined ButtonSettings
are specified the default ButtonSettings
get returned.
§Examples
let button = GamepadButton::new(Gamepad::new(1), GamepadButtonType::South);
let button_settings = settings.get_button_settings(button);
pub fn get_axis_settings(&self, axis: GamepadAxis) -> &AxisSettings
pub fn get_axis_settings(&self, axis: GamepadAxis) -> &AxisSettings
Returns the AxisSettings
of the axis
.
If no user defined AxisSettings
are specified the default AxisSettings
get returned.
§Examples
let axis = GamepadAxis::new(Gamepad::new(1), GamepadAxisType::LeftStickX);
let axis_settings = settings.get_axis_settings(axis);
Returns the ButtonAxisSettings
of the button
.
If no user defined ButtonAxisSettings
are specified the default ButtonAxisSettings
get returned.
§Examples
let button = GamepadButton::new(Gamepad::new(1), GamepadButtonType::South);
let button_axis_settings = settings.get_button_axis_settings(button);
Trait Implementations§
§impl Debug for GamepadSettings
impl Debug for GamepadSettings
§impl Default for GamepadSettings
impl Default for GamepadSettings
§fn default() -> GamepadSettings
fn default() -> GamepadSettings
§impl FromReflect for GamepadSettingswhere
GamepadSettings: Any + Send + Sync,
ButtonSettings: FromReflect + TypePath + RegisterForReflection,
AxisSettings: FromReflect + TypePath + RegisterForReflection,
ButtonAxisSettings: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadAxis, AxisSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonAxisSettings>: FromReflect + TypePath + RegisterForReflection,
impl FromReflect for GamepadSettingswhere
GamepadSettings: Any + Send + Sync,
ButtonSettings: FromReflect + TypePath + RegisterForReflection,
AxisSettings: FromReflect + TypePath + RegisterForReflection,
ButtonAxisSettings: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadAxis, AxisSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonAxisSettings>: FromReflect + TypePath + RegisterForReflection,
§fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<GamepadSettings>
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<GamepadSettings>
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 GamepadSettingswhere
GamepadSettings: Any + Send + Sync,
ButtonSettings: FromReflect + TypePath + RegisterForReflection,
AxisSettings: FromReflect + TypePath + RegisterForReflection,
ButtonAxisSettings: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadAxis, AxisSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonAxisSettings>: FromReflect + TypePath + RegisterForReflection,
impl GetTypeRegistration for GamepadSettingswhere
GamepadSettings: Any + Send + Sync,
ButtonSettings: FromReflect + TypePath + RegisterForReflection,
AxisSettings: FromReflect + TypePath + RegisterForReflection,
ButtonAxisSettings: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadAxis, AxisSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonAxisSettings>: FromReflect + TypePath + RegisterForReflection,
§fn get_type_registration() -> TypeRegistration
fn get_type_registration() -> TypeRegistration
TypeRegistration
for this type.§fn register_type_dependencies(registry: &mut TypeRegistry)
fn register_type_dependencies(registry: &mut TypeRegistry)
§impl Reflect for GamepadSettingswhere
GamepadSettings: Any + Send + Sync,
ButtonSettings: FromReflect + TypePath + RegisterForReflection,
AxisSettings: FromReflect + TypePath + RegisterForReflection,
ButtonAxisSettings: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadAxis, AxisSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonAxisSettings>: FromReflect + TypePath + RegisterForReflection,
impl Reflect for GamepadSettingswhere
GamepadSettings: Any + Send + Sync,
ButtonSettings: FromReflect + TypePath + RegisterForReflection,
AxisSettings: FromReflect + TypePath + RegisterForReflection,
ButtonAxisSettings: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadAxis, AxisSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonAxisSettings>: FromReflect + TypePath + RegisterForReflection,
§fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
fn get_represented_type_info(&self) -> Option<&'static TypeInfo>
§fn into_any(self: Box<GamepadSettings>) -> Box<dyn Any>
fn into_any(self: Box<GamepadSettings>) -> 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<GamepadSettings>) -> Box<dyn Reflect>
fn into_reflect(self: Box<GamepadSettings>) -> 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<GamepadSettings>) -> ReflectOwned
fn reflect_owned(self: Box<GamepadSettings>) -> 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 GamepadSettingswhere
GamepadSettings: Any + Send + Sync,
ButtonSettings: FromReflect + TypePath + RegisterForReflection,
AxisSettings: FromReflect + TypePath + RegisterForReflection,
ButtonAxisSettings: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadAxis, AxisSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonAxisSettings>: FromReflect + TypePath + RegisterForReflection,
impl Struct for GamepadSettingswhere
GamepadSettings: Any + Send + Sync,
ButtonSettings: FromReflect + TypePath + RegisterForReflection,
AxisSettings: FromReflect + TypePath + RegisterForReflection,
ButtonAxisSettings: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadAxis, AxisSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonAxisSettings>: FromReflect + TypePath + RegisterForReflection,
§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 GamepadSettings
impl TypePath for GamepadSettings
§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 GamepadSettingswhere
GamepadSettings: Any + Send + Sync,
ButtonSettings: FromReflect + TypePath + RegisterForReflection,
AxisSettings: FromReflect + TypePath + RegisterForReflection,
ButtonAxisSettings: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadAxis, AxisSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonAxisSettings>: FromReflect + TypePath + RegisterForReflection,
impl Typed for GamepadSettingswhere
GamepadSettings: Any + Send + Sync,
ButtonSettings: FromReflect + TypePath + RegisterForReflection,
AxisSettings: FromReflect + TypePath + RegisterForReflection,
ButtonAxisSettings: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadAxis, AxisSettings>: FromReflect + TypePath + RegisterForReflection,
HashMap<GamepadButton, ButtonAxisSettings>: FromReflect + TypePath + RegisterForReflection,
impl Resource for GamepadSettings
Auto Trait Implementations§
impl Freeze for GamepadSettings
impl RefUnwindSafe for GamepadSettings
impl Send for GamepadSettings
impl Sync for GamepadSettings
impl Unpin for GamepadSettings
impl UnwindSafe for GamepadSettings
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<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
§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§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
fn into_sample(self) -> T
§impl<T> NoneValue for Twhere
T: Default,
impl<T> NoneValue for Twhere
T: Default,
type NoneType = T
§fn null_value() -> T
fn null_value() -> T
§impl<T> Pointable for T
impl<T> Pointable for T
source§impl<R, P> ReadPrimitive<R> for P
impl<R, P> ReadPrimitive<R> for P
source§fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
fn read_from_little_endian(read: &mut R) -> Result<Self, Error>
ReadEndian::read_from_little_endian()
.