Struct sdl2::surface::Surface

source ·

pub struct Surface<'a> { /* private fields */ }

Expand description

Holds a Rc<SurfaceContext>.

Note: If a Surface goes out of scope but it cloned its context, then the SDL_Surface will not be free’d until there are no more references to the SurfaceContext.

Implementations§

source §

impl<'a> Surface<'a>

source

pub unsafe fn from_ll<'b>(raw: *mut SDL_Surface) -> Surface<'b>

source

pub fn new( width: u32, height: u32, format: PixelFormatEnum, ) -> Result<Surface<'static>, String>

Creates a new surface using a pixel format.

§Example

use sdl2::pixels::PixelFormatEnum;
use sdl2::surface::Surface;

let surface = Surface::new(512, 512, PixelFormatEnum::RGB24).unwrap();

source

pub fn from_pixelmasks( width: u32, height: u32, masks: PixelMasks, ) -> Result<Surface<'static>, String>

Creates a new surface using pixel masks.

§Example

use sdl2::pixels::PixelFormatEnum;
use sdl2::surface::Surface;

let masks = PixelFormatEnum::RGB24.into_masks().unwrap();
let surface = Surface::from_pixelmasks(512, 512, masks).unwrap();

source

pub fn from_data( data: &'a mut [u8], width: u32, height: u32, pitch: u32, format: PixelFormatEnum, ) -> Result<Surface<'a>, String>

Creates a new surface from an existing buffer, using a pixel format.

source

pub fn from_data_pixelmasks( data: &'a mut [u8], width: u32, height: u32, pitch: u32, masks: PixelMasks, ) -> Result<Surface<'a>, String>

Creates a new surface from an existing buffer, using pixel masks.

source

pub fn load_bmp_rw(rwops: &mut RWops<'_>) -> Result<Surface<'static>, String>

source

pub fn load_bmp<P: AsRef<Path>>(path: P) -> Result<Surface<'static>, String>

source

pub fn into_canvas(self) -> Result<Canvas<Surface<'a>>, String>

Creates a Software Canvas to allow rendering in the Surface itself. This Canvas will never be accelerated materially, so there is no performance change between Surface and Canvas coming from a Surface.

The only change is this case is that Canvas has a better API to draw stuff in the Surface in that case, but don’t expect any performance changes, there will be none.

source

pub fn context(&self) -> Rc<SurfaceContext<'a>>

Methods from Deref<Target = SurfaceRef>§

source

pub fn with_lock<R, F: FnOnce(&[u8]) -> R>(&self, f: F) -> R

Locks a surface so that the pixels can be directly accessed safely.

source

pub fn with_lock_mut<R, F: FnOnce(&mut [u8]) -> R>(&mut self, f: F) -> R

Locks a surface so that the pixels can be directly accessed safely.

source

pub 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).

source

pub 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).

source

pub fn must_lock(&self) -> bool

Returns true if the Surface needs to be locked before accessing the Surface pixels.

source

pub fn save_bmp_rw(&self, rwops: &mut RWops<'_>) -> Result<(), String>

source

pub fn save_bmp<P: AsRef<Path>>(&self, path: P) -> Result<(), String>

source

pub fn set_palette(&mut self, palette: &Palette) -> Result<(), String>

source

pub fn enable_RLE(&mut self)

source

pub fn disable_RLE(&mut self)

source

pub fn set_color_key( &mut self, enable: bool, color: Color, ) -> Result<(), String>

source

pub fn color_key(&self) -> Result<Color, String>

The function will fail if the surface doesn’t have color key enabled.

source

pub fn set_color_mod(&mut self, color: Color)

source

pub fn color_mod(&self) -> Color

source

pub fn fill_rect<R>(&mut self, rect: R, color: Color) -> Result<(), String>
where R: Into<Option<Rect>>,

source

pub fn fill_rects(&mut self, rects: &[Rect], color: Color) -> Result<(), String>

source

pub fn set_alpha_mod(&mut self, alpha: u8)

source

pub fn alpha_mod(&self) -> u8

source

pub fn set_blend_mode(&mut self, mode: BlendMode) -> Result<(), String>

The function will fail if the blend mode is not supported by SDL.

source

pub fn blend_mode(&self) -> BlendMode

source

pub fn set_clip_rect<R>(&mut self, rect: R) -> bool
where R: Into<Option<Rect>>,

Sets the clip rectangle for the surface.

If the rectangle is None, clipping will be disabled.

source

pub fn clip_rect(&self) -> Option<Rect>

Gets the clip rectangle for the surface.

Returns None if clipping is disabled.

source

pub fn convert(&self, format: &PixelFormat) -> Result<Surface<'static>, String>

Copies the surface into a new one that is optimized for blitting to a surface of a specified pixel format.

source

pub fn blit<R1, R2>( &self, src_rect: R1, dst: &mut SurfaceRef, dst_rect: R2, ) -> Result<Option<Rect>, String>
where R1: Into<Option<Rect>>, R2: Into<Option<Rect>>,

Performs surface blitting (surface copying).

Returns the final blit rectangle, if a dst_rect was provided.

source

pub unsafe fn lower_blit<R1, R2>( &self, src_rect: R1, dst: &mut SurfaceRef, dst_rect: R2, ) -> Result<(), String>
where R1: Into<Option<Rect>>, R2: Into<Option<Rect>>,

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.

source

pub fn blit_scaled<R1, R2>( &self, src_rect: R1, dst: &mut SurfaceRef, dst_rect: R2, ) -> Result<Option<Rect>, String>
where R1: Into<Option<Rect>>, R2: Into<Option<Rect>>,

Performs scaled surface bliting (surface copying).

Returns the final blit rectangle, if a dst_rect was provided.

source

pub unsafe fn lower_blit_scaled<R1, R2>( &self, src_rect: R1, dst: &mut SurfaceRef, dst_rect: R2, ) -> Result<(), String>
where R1: Into<Option<Rect>>, R2: Into<Option<Rect>>,

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.