Struct beryllium::RendererWindow

pub struct RendererWindow<'sdl> { /* fields omitted */ }

This is a [Widow] that also allows SDL2's cross-platform 2D rendering system.

This is 2D only, but if you just want a rectangular bitmap on the screen (eg: an emulator or similar) then it's just fine.

Methods

impl<'sdl> RendererWindow<'sdl>

pub fn create_texture_from_surface<'ren>(
    &'ren self,
    surf: &Surface
) -> Result<Texture<'sdl, 'ren>, String>

Makes a texture with the contents of the surface specified.

The TextureAccess hint for textures from this is "static".

The pixel format might be different from the surface's pixel format.

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

Obtains the current draw color.

pub fn set_draw_color(&self, color: Color) -> Result<(), String>

Assigns the color used for drawing.

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

Clears the render target with the current draw color.

pub fn output_size(&self) -> Result<(i32, i32), String>

Obtains the output area size in physical pixels.

pub fn draw_line(
    &self,
    x1: i32,
    y1: i32,
    x2: i32,
    y2: i32
) -> Result<(), String>

Draws a line that includes both end points.

pub fn draw_lines(&self, points: &[Point]) -> Result<(), String>

Using the slice of n points, draws n-1 lines end to end.

pub fn copy(
    &self,
    t: &Texture,
    src: Option<Rect>,
    dst: Option<Rect>
) -> Result<(), String>

Blits the texture to the rendering target.

• src: Optional clip rect of where to copy from. If None, the whole texture is used.
• dst: Optional clip rect of where to copy data to. If None, the whole render target is used.

The image is stretched as necessary if the src and dst are different sizes. This is a GPU operation, so it's fast no matter how much upscale or downscale you do.

pub fn present(&self)

Presents the backbuffer to the user.

After a present, all backbuffer data should be assumed to be invalid, and you should also clear the backbuffer before doing the next render pass even if you intend to write to every pixel.

Methods from Deref<Target = Window<'sdl>>

pub fn modal_message_box(
    &self,
    box_type: MessageBox,
    title: &str,
    message: &str
) -> Result<(), String>

Like the lone_message_box function, but modal to this Window.

Because you need a valid Window to call this method, we don't need to mark it as unsafe.

pub fn flags(&self) -> WindowFlags

Use this function to get the window flags.

pub fn resizable(&self) -> bool

Returns the user-resizable state of a window.

pub fn set_resizable(&self, resizable: bool)

Use this function to set the user-resizable state of a window.

pub fn title(&self) -> String

Returns the title of the window in UTF-8 format or "" if there is no title.

pub fn set_title(&self, title: &str)

Sets the title of the window.

pub fn show(&self)

Use this function to show a window.

pub fn hide(&self)

Use this function to hide a window.

pub fn size(&self) -> (i32, i32)

Gets the logical size of the window (in screen coordinates).

For physical pixel counts use the method appropriate to your backend: GLWindow::drawable_size or RendererWindow::output_size.

pub fn set_size(&self, width: i32, height: i32)

Sets the logical size of the window.

Note that fullscreen windows automatically match the size of the display mode, so use set_display_mode instead.

pub fn window_display_mode(&self) -> Result<DisplayMode, String>

Obtains info about the fullscreen settings of the window.

Use this function to get info about the display mode that the Window uses when it's fullscreen.

pub fn desktop_display_mode(&self) -> Result<DisplayMode, String>

Obtains info about the monitor settings that the center of the window is being displayed on.

Use this function to get information about the Desktop display mode (even if a Window is currently fullscreen).

pub fn set_display_mode(
    &self,
    opt_mode: Option<DisplayMode>
) -> Result<(), String>

Assigns the fullscreen display mode for the window.

• If Some(mode), attempts to set the mode given.
• If None, it will use the window's dimensions, and the desktop's current format and refresh rate.

pub fn set_fullscreen_style(&self, style: FullscreenStyle) -> Result<(), String>

Sets the window's fullscreen style.

• Fullscreen: Performs an actual video mode change.
• Fullscreen Desktop: "fake" fullscreen with full resolution but no video mode change.
• Windowed: Don't use fullscreen.

Trait Implementations

impl<'sdl> Drop for RendererWindow<'sdl>

fn drop(&mut self)

Executes the destructor for this type.

impl<'sdl> Deref for RendererWindow<'sdl>

type Target = Window<'sdl>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'sdl> Debug for RendererWindow<'sdl>

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

Formats the value using the given formatter.