Struct ggez::conf::Conf

pub struct Conf {
    pub version: String,
    pub window_title: String,
    pub window_icon: String,
    pub window_height: u32,
    pub window_width: u32,
}

A structure containing configuration data for the game engine.

Fields

version: String

Version of ggez your game is designed to work with.

window_title: String

The window title.

window_icon: String

A file path to the window's icon.

window_height: u32

The window's default height

window_width: u32

The window's default width

Methods

impl Conf

fn new() -> Conf

Create a new Conf with some vague defaults.

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.

It only looks for things under the [ggez] section heading, so you can put your own sections in the file and use them for your own purposes and they will not interfere here.

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 Decodable for Conf

fn decode<__D: Decoder>(__arg_0: &mut __D) -> Result<Conf, __D::Error>

Deserialize a value using a Decoder.

impl Encodable for Conf

fn encode<__S: Encoder>(&self, __arg_0: &mut __S) -> Result<(), __S::Error>

Serialize a value using an Encoder.

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() -> Conf

Returns the "default value" for a type.