From 1a2f22f266c5dd8e9faabc643e1f4e4d6e54fec8 Mon Sep 17 00:00:00 2001 From: Daniel Rempel Date: Sat, 17 Oct 2020 17:03:26 +0300 Subject: [PATCH 1/3] Rename some functions to fit as_, to_ convention --- src/sdl2/controller.rs | 10 ++++++++++ src/sdl2/joystick.rs | 5 +++++ src/sdl2/mouse/mod.rs | 5 +++++ src/sdl2/mouse/relative.rs | 5 +++++ src/sdl2/pixels.rs | 4 ++++ src/sdl2/render.rs | 24 ++++++++++++++++++++++++ src/sdl2/surface.rs | 24 ++++++++++++++++++++---- 7 files changed, 73 insertions(+), 4 deletions(-) diff --git a/src/sdl2/controller.rs b/src/sdl2/controller.rs index 300994dd607..81deab8cc62 100644 --- a/src/sdl2/controller.rs +++ b/src/sdl2/controller.rs @@ -224,7 +224,12 @@ impl Axis { }) } + #[deprecated(since="0.34.4", note="please, use `into_ll()` instead")] pub fn to_ll(self) -> sys::SDL_GameControllerAxis { + self.into_ll() + } + + pub fn into_ll(self) -> sys::SDL_GameControllerAxis { match self { Axis::LeftX => sys::SDL_GameControllerAxis::SDL_CONTROLLER_AXIS_LEFTX, Axis::LeftY => sys::SDL_GameControllerAxis::SDL_CONTROLLER_AXIS_LEFTY, @@ -302,7 +307,12 @@ impl Button { }) } + #[deprecated(since="0.34.4", note="please, use `into_ll()` instead")] pub fn to_ll(self) -> sys::SDL_GameControllerButton { + self.into_ll() + } + + pub fn into_ll(self) -> sys::SDL_GameControllerButton { match self { Button::A => sys::SDL_GameControllerButton::SDL_CONTROLLER_BUTTON_A, Button::B => sys::SDL_GameControllerButton::SDL_CONTROLLER_BUTTON_B, diff --git a/src/sdl2/joystick.rs b/src/sdl2/joystick.rs index 2569b239e83..f0a11c218e7 100644 --- a/src/sdl2/joystick.rs +++ b/src/sdl2/joystick.rs @@ -497,7 +497,12 @@ impl HatState { } } + #[deprecated(since="0.34.4", note="please, use `as_raw()` instead")] pub fn to_raw(self) -> u8 { + self.as_raw() + } + + pub fn as_raw(self) -> u8 { match self { HatState::Centered => 0, HatState::Up => 1, diff --git a/src/sdl2/mouse/mod.rs b/src/sdl2/mouse/mod.rs index ee0c4b014f2..86e1d83c652 100644 --- a/src/sdl2/mouse/mod.rs +++ b/src/sdl2/mouse/mod.rs @@ -177,9 +177,14 @@ impl MouseState { pub fn from_sdl_state(state: u32) -> MouseState { MouseState { mouse_state : state, x: 0, y: 0 } } + + #[deprecated(since="0.34.4", note="please, use `as_sdl_state()` instead")] pub fn to_sdl_state(&self) -> u32 { self.mouse_state } + pub fn as_sdl_state(&self) -> u32 { + self.mouse_state + } fn button_mask(&self, button: u32) -> u32 { 1 << (button - 1) diff --git a/src/sdl2/mouse/relative.rs b/src/sdl2/mouse/relative.rs index c8ea4120216..e58dfef0ab8 100644 --- a/src/sdl2/mouse/relative.rs +++ b/src/sdl2/mouse/relative.rs @@ -30,9 +30,14 @@ impl RelativeMouseState { pub fn from_sdl_state(state: u32) -> RelativeMouseState { RelativeMouseState { mouse_state : state, x: 0, y: 0 } } + + #[deprecated(since="0.34.4", note="please, use `as_sdl_state()` instead")] pub fn to_sdl_state(&self) -> u32 { self.mouse_state } + pub fn as_sdl_state(&self) -> u32 { + self.mouse_state + } fn button_mask(&self, button: u32) -> u32 { 1 << (button - 1) diff --git a/src/sdl2/pixels.rs b/src/sdl2/pixels.rs index 48c93b708be..95eff62a947 100644 --- a/src/sdl2/pixels.rs +++ b/src/sdl2/pixels.rs @@ -111,9 +111,13 @@ impl Color { Color { r, g, b, a } } + #[deprecated(since="0.34.4", note="please, use `as_u32()`")] pub fn to_u32(self, format: &PixelFormat) -> u32 { unsafe { sys::SDL_MapRGBA(format.raw, self.r, self.g, self.b, self.a) } } + pub fn as_u32(self, format: &PixelFormat) -> u32 { + unsafe { sys::SDL_MapRGBA(format.raw, self.r, self.g, self.b, self.a) } + } pub fn from_u32(format: &PixelFormat, pixel: u32) -> Color { let (mut r, mut g, mut b, mut a) = (0, 0, 0, 0); diff --git a/src/sdl2/render.rs b/src/sdl2/render.rs index 349b1822c78..61fd01cd74f 100644 --- a/src/sdl2/render.rs +++ b/src/sdl2/render.rs @@ -355,15 +355,27 @@ impl<'s> Canvas> { /// Gets a reference to the associated surface of the Canvas #[inline] + #[deprecated(since="0.34.4", note="please, use `as_surface()` instead")] pub fn surface(&self) -> &SurfaceRef { &self.target } + /// Gets a reference to the associated surface of the Canvas + #[inline] + pub fn as_surface(&self) -> &SurfaceRef { + &self.target + } /// Gets a mutable reference to the associated surface of the Canvas #[inline] + #[deprecated(since="0.34.4", note="please, use `as_surface_mut()` instead")] pub fn surface_mut(&mut self) -> &mut SurfaceRef { &mut self.target } + /// Gets a mutable reference to the associated surface of the Canvas + #[inline] + pub fn as_surface_mut(&mut self) -> &mut SurfaceRef { + &mut self.target + } /// Gets the associated surface of the Canvas and destroys the Canvas #[inline] @@ -395,15 +407,27 @@ impl RenderTarget for Window { impl Canvas { /// Gets a reference to the associated window of the Canvas #[inline] + #[deprecated(since="0.34.4", note="please, use `as_window()` instead")] pub fn window(&self) -> &Window { &self.target } + /// Gets a reference to the associated window of the Canvas + #[inline] + pub fn as_window(&self) -> &Window { + &self.target + } /// Gets a mutable reference to the associated window of the Canvas #[inline] + #[deprecated(since="0.34.4", note="please, use `as_window_mut()` instead")] pub fn window_mut(&mut self) -> &mut Window { &mut self.target } + /// Gets a mutable reference to the associated window of the Canvas + #[inline] + pub fn as_window_mut(&mut self) -> &mut Window { + &mut self.target + } /// Gets the associated window of the Canvas and destroys the Canvas #[inline] diff --git a/src/sdl2/surface.rs b/src/sdl2/surface.rs index 6eca439557b..ab86608331d 100644 --- a/src/sdl2/surface.rs +++ b/src/sdl2/surface.rs @@ -174,6 +174,14 @@ impl<'a> Surface<'a> { } } + /// A convenience function for [`TextureCreator::create_texture_from_surface`]. + /// Deprecated: use `to_texture()` instead. + #[cfg(not(feature = "unsafe_textures"))] + #[deprecated(since="0.34.4", note="please, use `to_texture()` instead")] + pub fn as_texture<'b, T>(&self, texture_creator: &'b TextureCreator) -> Result, TextureValueError> { + texture_creator.create_texture_from_surface(self) + } + /// A convenience function for [`TextureCreator::create_texture_from_surface`]. /// /// ```no_run @@ -198,10 +206,18 @@ impl<'a> Surface<'a> { /// let texture_creator = canvas.texture_creator(); /// /// let surface = Surface::new(512, 512, PixelFormatEnum::RGB24).unwrap(); - /// let texture = surface.as_texture(&texture_creator).unwrap(); + /// let texture = surface.to_texture(&texture_creator).unwrap(); /// ``` #[cfg(not(feature = "unsafe_textures"))] - pub fn as_texture<'b, T>(&self, texture_creator: &'b TextureCreator) -> Result, TextureValueError> { + pub fn to_texture<'b, T>(&self, texture_creator: &'b TextureCreator) -> Result, TextureValueError> { + texture_creator.create_texture_from_surface(self) + } + + /// A convenience function for [`TextureCreator::create_texture_from_surface`]. + /// Deprecated: use `to_texture()` instead. + #[cfg(feature = "unsafe_textures")] + #[deprecated(since="0.34.4", note="please, use `to_texture()` instead")] + pub fn as_texture(&self, texture_creator: &TextureCreator) -> Result { texture_creator.create_texture_from_surface(self) } @@ -229,10 +245,10 @@ impl<'a> Surface<'a> { /// let texture_creator = canvas.texture_creator(); /// /// let surface = Surface::new(512, 512, PixelFormatEnum::RGB24).unwrap(); - /// let texture = surface.as_texture(&texture_creator).unwrap(); + /// let texture = surface.to_texture(&texture_creator).unwrap(); /// ``` #[cfg(feature = "unsafe_textures")] - pub fn as_texture(&self, texture_creator: &TextureCreator) -> Result { + pub fn to_texture(&self, texture_creator: &TextureCreator) -> Result { texture_creator.create_texture_from_surface(self) } From fb43f6795d14ed9096391dc42072f019c5937d3a Mon Sep 17 00:00:00 2001 From: Daniel Rempel Date: Sat, 17 Oct 2020 17:08:25 +0300 Subject: [PATCH 2/3] Update uses of deprecated code --- src/sdl2/event.rs | 10 +++++----- src/sdl2/render.rs | 2 +- src/sdl2/surface.rs | 4 ++-- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/sdl2/event.rs b/src/sdl2/event.rs index d9ed0516053..ad39d8bea8e 100644 --- a/src/sdl2/event.rs +++ b/src/sdl2/event.rs @@ -905,7 +905,7 @@ impl Event { xrel, yrel } => { - let state = mousestate.to_sdl_state(); + let state = mousestate.as_sdl_state(); let event = sys::SDL_MouseMotionEvent { type_: SDL_EventType::SDL_MOUSEMOTION as u32, timestamp, @@ -1051,7 +1051,7 @@ impl Event { hat_idx, state, } => { - let hatvalue = state.to_raw(); + let hatvalue = state.as_raw(); let event = sys::SDL_JoyHatEvent { type_: SDL_EventType::SDL_JOYHATMOTION as u32, timestamp, @@ -1145,7 +1145,7 @@ impl Event { axis, value, } => { - let axisval = axis.to_ll(); + let axisval = axis.into_ll(); let event = sys::SDL_ControllerAxisEvent { type_: SDL_EventType::SDL_CONTROLLERAXISMOTION as u32, timestamp, @@ -1167,7 +1167,7 @@ impl Event { which, button, } => { - let buttonval = button.to_ll(); + let buttonval = button.into_ll(); let event = sys::SDL_ControllerButtonEvent { type_: SDL_EventType::SDL_CONTROLLERBUTTONDOWN as u32, timestamp, @@ -1190,7 +1190,7 @@ impl Event { which, button, } => { - let buttonval = button.to_ll(); + let buttonval = button.into_ll(); let event = sys::SDL_ControllerButtonEvent { type_: SDL_EventType::SDL_CONTROLLERBUTTONUP as u32, timestamp, diff --git a/src/sdl2/render.rs b/src/sdl2/render.rs index 61fd01cd74f..da38cfbab3d 100644 --- a/src/sdl2/render.rs +++ b/src/sdl2/render.rs @@ -437,7 +437,7 @@ impl Canvas { #[inline] pub fn default_pixel_format(&self) -> PixelFormatEnum { - self.window().window_pixel_format() + self.as_window().window_pixel_format() } /// Returns a `TextureCreator` that can create Textures to be drawn on this `Canvas` diff --git a/src/sdl2/surface.rs b/src/sdl2/surface.rs index ab86608331d..6cd0b0eea5c 100644 --- a/src/sdl2/surface.rs +++ b/src/sdl2/surface.rs @@ -448,7 +448,7 @@ impl SurfaceRef { } pub fn set_color_key(&mut self, enable: bool, color: pixels::Color) -> Result<(), String> { - let key = color.to_u32(&self.pixel_format()); + let key = color.as_u32(&self.pixel_format()); let result = unsafe { sys::SDL_SetColorKey(self.raw(), if enable { 1 } else { 0 }, key) }; @@ -513,7 +513,7 @@ impl SurfaceRef { let rect_ptr = mem::transmute(rect.as_ref()); // TODO find a better way to transform // Option<&...> into a *const _ let format = self.pixel_format(); - let result = sys::SDL_FillRect(self.raw(), rect_ptr, color.to_u32(&format) ); + let result = sys::SDL_FillRect(self.raw(), rect_ptr, color.as_u32(&format) ); match result { 0 => Ok(()), _ => Err(get_error()) From 3ee97517cfd5ef2a3f56b393092c4ba6e9c31949 Mon Sep 17 00:00:00 2001 From: Daniel Rempel Date: Sat, 17 Oct 2020 17:12:43 +0300 Subject: [PATCH 3/3] Fix a warning --- src/sdl2/event.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/sdl2/event.rs b/src/sdl2/event.rs index ad39d8bea8e..5bb9a853dc6 100644 --- a/src/sdl2/event.rs +++ b/src/sdl2/event.rs @@ -45,7 +45,7 @@ impl CustomEventTypeMaps { } lazy_static! { - static ref CUSTOM_EVENT_TYPES : Mutex = { Mutex::new(CustomEventTypeMaps::new()) }; + static ref CUSTOM_EVENT_TYPES : Mutex = Mutex::new(CustomEventTypeMaps::new()); } impl crate::EventSubsystem {