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, RandomState, Global>,
pub axis_settings: HashMap<GamepadAxis, AxisSettings, RandomState, Global>,
pub button_axis_settings: HashMap<GamepadButton, ButtonAxisSettings, RandomState, Global>,
}
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 the gamepad_event_system
, but are never written to
inside of bevy
. 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, RandomState, Global>
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
ButtonSettings: FromReflect,
AxisSettings: FromReflect,
ButtonAxisSettings: FromReflect,
HashMap<GamepadButton, ButtonSettings, RandomState, Global>: FromReflect,
HashMap<GamepadAxis, AxisSettings, RandomState, Global>: FromReflect,
HashMap<GamepadButton, ButtonAxisSettings, RandomState, Global>: FromReflect,
impl FromReflect for GamepadSettingswhere
ButtonSettings: FromReflect,
AxisSettings: FromReflect,
ButtonAxisSettings: FromReflect,
HashMap<GamepadButton, ButtonSettings, RandomState, Global>: FromReflect,
HashMap<GamepadAxis, AxisSettings, RandomState, Global>: FromReflect,
HashMap<GamepadButton, ButtonAxisSettings, RandomState, Global>: FromReflect,
§fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<GamepadSettings>
fn from_reflect(reflect: &(dyn Reflect + 'static)) -> Option<GamepadSettings>
Self
from a reflected value.§impl GetTypeRegistration for GamepadSettings
impl GetTypeRegistration for GamepadSettings
§impl Reflect for GamepadSettings
impl Reflect for GamepadSettings
§fn get_type_info(&self) -> &'static TypeInfo
fn get_type_info(&self) -> &'static TypeInfo
§fn into_any(
self: Box<GamepadSettings, Global>
) -> Box<dyn Any + 'static, Global>
fn into_any(
self: Box<GamepadSettings, 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<GamepadSettings, Global>
) -> Box<dyn Reflect + 'static, Global>
fn into_reflect(
self: Box<GamepadSettings, 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<GamepadSettings, Global>) -> ReflectOwned
fn reflect_owned(self: Box<GamepadSettings, 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 GamepadSettings
impl Struct for GamepadSettings
§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
.§impl Typed for GamepadSettings
impl Typed for GamepadSettings
impl Resource for GamepadSettingswhere
GamepadSettings: 'static + Send + Sync,
Auto Trait Implementations§
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 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