Struct SurfaceRef
pub struct SurfaceRef { /* private fields */ }
dep_sdl3
only.Expand description
An unsized Surface reference.
This type is used whenever Surfaces need to be borrowed from the SDL library, without concern for freeing the Surface.
Implementations§
§impl SurfaceRef
impl SurfaceRef
pub unsafe fn from_ll<'a>(raw: *const SDL_Surface) -> &'a SurfaceRef
pub unsafe fn from_ll_mut<'a>(raw: *mut SDL_Surface) -> &'a mut SurfaceRef
pub fn raw(&self) -> *mut SDL_Surface
pub fn width(&self) -> u32 ⓘ
pub fn height(&self) -> u32 ⓘ
pub fn pitch(&self) -> u32 ⓘ
pub fn size(&self) -> (u32, u32) ⓘ
pub fn pixel_format(&self) -> PixelFormat
pub fn pixel_format_enum(&self) -> PixelFormat
pub fn with_lock<R, F>(&self, f: F) -> R
pub fn with_lock<R, F>(&self, f: F) -> R
Locks a surface so that the pixels can be directly accessed safely.
pub fn with_lock_mut<R, F>(&mut self, f: F) -> R
pub fn with_lock_mut<R, F>(&mut self, f: F) -> R
Locks a surface so that the pixels can be directly accessed safely.
pub unsafe fn without_lock(&self) -> Option<&[u8]> ⓘ
pub unsafe fn without_lock(&self) -> Option<&[u8]> ⓘ
Returns the Surface’s pixel buffer if the Surface doesn’t require locking (e.g. it’s a software surface).
pub unsafe fn without_lock_mut(&mut self) -> Option<&mut [u8]> ⓘ
pub unsafe fn without_lock_mut(&mut self) -> Option<&mut [u8]> ⓘ
Returns the Surface’s pixel buffer if the Surface doesn’t require locking (e.g. it’s a software surface).
pub unsafe fn must_lock(&self) -> bool
pub unsafe fn must_lock(&self) -> bool
Returns true if the Surface needs to be locked before accessing the Surface pixels.
pub fn save_bmp_rw(&self, iostream: &mut IOStream<'_>) -> Result<(), Error> ⓘ
pub fn save_bmp<P>(&self, path: P) -> Result<(), Error> ⓘ
pub fn set_palette(&mut self, palette: &Palette) -> Result<(), Error> ⓘ
pub fn enable_RLE(&mut self)
pub fn disable_RLE(&mut self)
pub fn set_color_key(&mut self, enable: bool, color: Color) -> Result<(), Error> ⓘ
pub fn color_key(&self) -> Result<Color, Error> ⓘ
pub fn color_key(&self) -> Result<Color, Error> ⓘ
The function will fail if the surface doesn’t have color key enabled.
pub fn set_color_mod(&mut self, color: Color)
pub fn color_mod(&self) -> Color
pub fn fill_rect<R>(&mut self, rect: R, color: Color) -> Result<(), Error> ⓘ
pub fn fill_rects(&mut self, rects: &[Rect], color: Color) -> Result<(), Error> ⓘ
pub fn set_alpha_mod(&mut self, alpha: u8)
pub fn alpha_mod(&self) -> u8
pub fn set_blend_mode(&mut self, mode: BlendMode) -> Result<(), Error> ⓘ
pub fn set_blend_mode(&mut self, mode: BlendMode) -> Result<(), Error> ⓘ
The function will fail if the blend mode is not supported by SDL.
pub fn blend_mode(&self) -> BlendMode
pub fn set_clip_rect<R>(&mut self, rect: R) -> bool
pub fn set_clip_rect<R>(&mut self, rect: R) -> bool
Sets the clip rectangle for the surface.
If the rectangle is None
, clipping will be disabled.
pub fn clip_rect(&self) -> Option<Rect> ⓘ
pub fn clip_rect(&self) -> Option<Rect> ⓘ
Gets the clip rectangle for the surface.
Returns None
if clipping is disabled.
pub fn convert(&self, format: &PixelFormat) -> Result<Surface<'static>, Error> ⓘ
pub fn convert(&self, format: &PixelFormat) -> Result<Surface<'static>, Error> ⓘ
Copies the surface into a new one that is optimized for blitting to a surface of a specified pixel format.
pub fn convert_format(
&self,
format: PixelFormat,
) -> Result<Surface<'static>, Error> ⓘ
pub fn convert_format( &self, format: PixelFormat, ) -> Result<Surface<'static>, Error> ⓘ
Copies the surface into a new one of a specified pixel format.
pub fn blit<R1, R2>(
&self,
src_rect: R1,
dst: &mut SurfaceRef,
dst_rect: R2,
) -> Result<Option<Rect>, Error> ⓘ
pub fn blit<R1, R2>( &self, src_rect: R1, dst: &mut SurfaceRef, dst_rect: R2, ) -> Result<Option<Rect>, Error> ⓘ
Performs surface blitting (surface copying).
Returns the final blit rectangle, if a dst_rect
was provided.
pub unsafe fn lower_blit<R1, R2>(
&self,
src_rect: R1,
dst: &mut SurfaceRef,
dst_rect: R2,
) -> Result<(), Error> ⓘ
pub unsafe fn lower_blit<R1, R2>( &self, src_rect: R1, dst: &mut SurfaceRef, dst_rect: R2, ) -> Result<(), Error> ⓘ
Performs low-level surface blitting.
Unless you know what you’re doing, use blit()
instead, which will clip the input rectangles.
This function could crash if the rectangles aren’t pre-clipped to the surface, and is therefore unsafe.
pub unsafe fn soft_stretch_linear<R1, R2>(
&self,
src_rect: R1,
dst: &mut SurfaceRef,
dst_rect: R2,
) -> Result<Option<Rect>, Error> ⓘ
pub unsafe fn soft_stretch_linear<R1, R2>( &self, src_rect: R1, dst: &mut SurfaceRef, dst_rect: R2, ) -> Result<Option<Rect>, Error> ⓘ
Performs bilinear scaling between two surfaces of the same format, 32BPP.
Returns the final blit rectangle, if a dst_rect
was provided.
pub fn blit_scaled<R1, R2>(
&self,
src_rect: R1,
dst: &mut SurfaceRef,
dst_rect: R2,
scale_mode: SDL_ScaleMode,
) -> Result<Option<Rect>, Error> ⓘ
pub fn blit_scaled<R1, R2>( &self, src_rect: R1, dst: &mut SurfaceRef, dst_rect: R2, scale_mode: SDL_ScaleMode, ) -> Result<Option<Rect>, Error> ⓘ
Performs scaled surface bliting (surface copying).
Returns the final blit rectangle, if a dst_rect
was provided.
pub unsafe fn lower_blit_scaled<R1, R2>(
&self,
src_rect: R1,
dst: &mut SurfaceRef,
dst_rect: R2,
scale_mode: SDL_ScaleMode,
) -> Result<(), Error> ⓘ
pub unsafe fn lower_blit_scaled<R1, R2>( &self, src_rect: R1, dst: &mut SurfaceRef, dst_rect: R2, scale_mode: SDL_ScaleMode, ) -> Result<(), Error> ⓘ
Performs low-level scaled surface blitting.
Unless you know what you’re doing, use blit_scaled()
instead, which will clip the input rectangles.
This function could crash if the rectangles aren’t pre-clipped to the surface, and is therefore unsafe.
Trait Implementations§
§impl AsMut<SurfaceRef> for Surface<'_>
impl AsMut<SurfaceRef> for Surface<'_>
§fn as_mut(&mut self) -> &mut SurfaceRef
fn as_mut(&mut self) -> &mut SurfaceRef
§impl AsRef<SurfaceRef> for Surface<'_>
impl AsRef<SurfaceRef> for Surface<'_>
§fn as_ref(&self) -> &SurfaceRef
fn as_ref(&self) -> &SurfaceRef
§impl AsRef<SurfaceRef> for SurfaceRef
impl AsRef<SurfaceRef> for SurfaceRef
§fn as_ref(&self) -> &SurfaceRef
fn as_ref(&self) -> &SurfaceRef
Auto Trait Implementations§
impl Freeze for SurfaceRef
impl RefUnwindSafe for SurfaceRef
impl Send for SurfaceRef
impl Sync for SurfaceRef
impl Unpin for SurfaceRef
impl UnwindSafe for SurfaceRef
Blanket Implementations§
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
Source§impl<T> ByteSized for T
impl<T> ByteSized for T
Source§const BYTE_ALIGN: usize = _
const BYTE_ALIGN: usize = _
Source§fn byte_align(&self) -> usize
fn byte_align(&self) -> usize
Source§fn ptr_size_ratio(&self) -> [usize; 2]
fn ptr_size_ratio(&self) -> [usize; 2]
Source§impl<T, R> Chain<R> for Twhere
T: ?Sized,
impl<T, R> Chain<R> for Twhere
T: ?Sized,
Source§impl<T> ExtAny for T
impl<T> ExtAny for T
Source§fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64
fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64
TypeId
of Self
using a custom hasher.Source§fn as_any_mut(&mut self) -> &mut dyn Anywhere
Self: Sized,
fn as_any_mut(&mut self) -> &mut dyn Anywhere
Self: Sized,
Source§impl<T> ExtMem for Twhere
T: ?Sized,
impl<T> ExtMem for Twhere
T: ?Sized,
Source§const NEEDS_DROP: bool = _
const NEEDS_DROP: bool = _
Source§fn mem_align_of<T>() -> usize
fn mem_align_of<T>() -> usize
Source§fn mem_align_of_val(&self) -> usize
fn mem_align_of_val(&self) -> usize
Source§fn mem_size_of<T>() -> usize
fn mem_size_of<T>() -> usize
Source§fn mem_size_of_val(&self) -> usize
fn mem_size_of_val(&self) -> usize
Source§fn mem_needs_drop(&self) -> bool
fn mem_needs_drop(&self) -> bool
true
if dropping values of this type matters. Read moreSource§fn mem_forget(self)where
Self: Sized,
fn mem_forget(self)where
Self: Sized,
self
without running its destructor. Read moreSource§fn mem_replace(&mut self, other: Self) -> Selfwhere
Self: Sized,
fn mem_replace(&mut self, other: Self) -> Selfwhere
Self: Sized,
Source§unsafe fn mem_zeroed<T>() -> T
unsafe fn mem_zeroed<T>() -> T
unsafe_layout
only.T
represented by the all-zero byte-pattern. Read moreSource§unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst
unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst
unsafe_layout
only.T
represented by the all-zero byte-pattern. Read moreSource§fn mem_as_bytes(&self) -> &[u8] ⓘ
fn mem_as_bytes(&self) -> &[u8] ⓘ
unsafe_slice
only.§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
Source§impl<T> Hook for T
impl<T> Hook for T
§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