Struct beryllium::Surface

#[repr(transparent)]
pub struct Surface<'sdl> { /* fields omitted */ }

Handle to a "surface", a CPU-side image.

This is fairly easy to edit, but you have to upload it to the GPU before you can get it on the screen.

Methods

impl<'sdl> Surface<'sdl>

pub unsafe fn lock_edit<F: FnMut(*mut u8)>(
    &mut self,
    op: F
) -> Result<(), String>

Lock, edit, unlock, as one easy cycle.

If the Surface cannot be locked you'll get an error, otherwise your closure will be called with the base pointer to the Surface's pixel data.

Safety

• You can't store the pointer and use it past the closure
• You have to follow standard 2D raw pixel editing rules.
  • y * pitch + x * size_of::<PixelType>()
  • Stay in bounds and all that jazz

pub fn width(&self) -> i32

Width in pixels

pub fn height(&self) -> i32

Height in pixels

pub fn pitch(&self) -> i32

Pitch in bytes

pub fn clip_rect(&self) -> Rect

The current clipping rectangle for blits.

pub fn set_clip_rect(&self, opt_rect: Option<Rect>) -> bool

Assigns a new clipping rectangle.

• Some(rect) will clip blits to be within that rect only.
• None will disable clipping.

Returns true if the given rectangle intersects at least part of the Surface (or if it was None). Otherwise you get false and all blits will be completely clipped.

Either way, blits are clipped to be within bounds of the Surface, so you don't have to worry about that.

pub fn palette(&self) -> Option<&Palette>

Gets the surface's palette, if any.

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

Updates the palette for the surface's pixel format.

Trait Implementations

impl<'sdl> Drop for Surface<'sdl>

fn drop(&mut self)

Executes the destructor for this type.

impl<'sdl> Debug for Surface<'sdl>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.