Struct ggez::graphics::GraphicsContext

pub struct GraphicsContext { /* private fields */ }

A concrete graphics context for WGPU rendering.

Implementations

impl GraphicsContext

pub fn wgpu(&self) -> &WgpuContext

Returns a reference to the underlying WGPU context.

pub fn present(&mut self, image: &Image) -> GameResult

Sets the image that will be presented to the screen at the end of the frame.

pub fn add_font(&mut self, name: &str, font: FontData)

Adds a new font with a given name.

pub fn drawable_size(&self) -> (f32, f32)

Returns the size of the window’s underlying drawable in physical pixels as (width, height).

pub fn set_drawable_size(&mut self, width: f32, height: f32) -> GameResult

Sets the window size (in physical pixels) / resolution to the specified width and height.

Note: These dimensions are only interpreted as resolutions in true fullscreen mode. If the selected resolution is not supported this function will return an Error.

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

Sets the window title.

pub fn window_position(&self) -> GameResult<PhysicalPosition<i32>>

Returns the position of the system window, including the outer frame.

pub fn set_window_position(&self, position: impl Into<Position>) -> GameResult

Sets the window position.

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

Returns the size of the window in pixels as (width, height), including borders, titlebar, etc. Returns zeros if the window doesn’t exist.

pub fn supported_resolutions(&self) -> impl Iterator<Item = PhysicalSize<u32>>

Returns an iterator providing all resolutions supported by the current monitor.

pub fn window(&self) -> &Window

Returns a reference to the Winit window.

pub fn set_window_icon<P: AsRef<Path>>( &self, filesystem: &impl Has<Filesystem>, path: impl Into<Option<P>> ) -> GameResult

Sets the window icon. None for path removes the icon.

pub fn set_fullscreen(&mut self, fullscreen: FullscreenType) -> GameResult

Sets the window to fullscreen or back.

pub fn set_resizable(&mut self, resizable: bool) -> GameResult

Sets whether or not the window is resizable.

pub fn set_mode(&mut self, mode: WindowMode) -> GameResult

Sets the window mode, such as the size and other properties.

Setting the window mode may have side effects, such as clearing the screen or setting the screen coordinates viewport to some undefined value (for example, the window was resized). It is recommended to call set_screen_coordinates() after changing the window size to make sure everything is what you want it to be.

pub fn frame(&self) -> &Image

Returns the default frame image.

This is the image that is rendered to when Canvas::from_frame is used.

pub fn surface_format(&self) -> ImageFormat

Returns the image format of the window surface.

pub fn commands(&mut self) -> Option<&mut CommandEncoder>

Returns the current wgpu::CommandEncoder if there is a frame in progress.

pub fn begin_frame(&mut self) -> GameResult

Begins a new frame.

The only situation you need to call this in is when you are rolling your own event loop.

pub fn end_frame(&mut self) -> GameResult

Ends the current frame.

The only situation you need to call this in is when you are rolling your own event loop.

Trait Implementations

impl Has<GraphicsContext> for Context

fn retrieve(&self) -> &GraphicsContext

Method to retrieve the context type.

impl HasMut<GraphicsContext> for Context

fn retrieve_mut(&mut self) -> &mut GraphicsContext

Method to retrieve the context type as mutable.