Struct ggez::conf::Conf

pub struct Conf {
    pub window_title: String,
    pub window_icon: String,
    pub window_height: u32,
    pub window_width: u32,
    pub vsync: bool,
    pub resizable: bool,
}

A structure containing configuration data for the game engine.

Fields

window_title: String

The window title.

window_icon: String

A file path to the window's icon. It is rooted in the resources directory (see the filesystem module for details), and an empty string results in a blank/default icon.

window_height: u32

The window's height

window_width: u32

The window's width

vsync: bool

Whether or not the graphics draw rate should be synchronized with the monitor's draw rate.

resizable: bool

Methods

impl Conf

fn new() -> Self

Same as Conf::default()

fn from_toml_file<R: Read>(file: &mut R) -> GameResult<Conf>

Load a TOML file from the given Read and attempts to parse a Conf from it.

fn to_toml_file<W: Write>(&self, file: &mut W) -> GameResult<()>

Saves the Conf to the given Write object, formatted as TOML.

Trait Implementations

impl Debug for Conf

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

Formats the value using the given formatter.

impl PartialEq for Conf

fn eq(&self, __arg_0: &Conf) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &Conf) -> bool

This method tests for !=.

impl Default for Conf

fn default() -> Self

Create a new Conf with some vague defaults.

Conf {
    window_title: "An easy, good game"
    window_icon: ""
    window_height: 600
    window_width: 800
    vsync: true
}