Struct ggez::conf::Conf

pub struct Conf {
    pub window_mode: WindowMode,
    pub window_setup: WindowSetup,
    pub backend: Backend,
    pub modules: ModuleConf,
}

A structure containing configuration data for the game engine.

Defaults:

Conf {
    window_mode: WindowMode::default(),
    window_setup: WindowSetup::default(),
    backend: Backend::default(),
    modules: ModuleConf::default(),
}

Fields

window_mode: WindowMode

Window setting information that can be set at runtime

window_setup: WindowSetup

Window setting information that must be set at init-time

backend: Backend

Backend configuration

modules: ModuleConf

Which modules to enable.

Methods

impl Conf

pub fn new() -> Self

Same as Conf::default()

pub 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.

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

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

pub fn window_mode(self, window_mode: WindowMode) -> Self

Sets the window mode

pub fn backend(self, backend: Backend) -> Self

Sets the backend

pub fn modules(self, modules: ModuleConf) -> Self

Sets the backend

Trait Implementations

impl PartialEq<Conf> for Conf

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

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

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

This method tests for !=.

impl Clone for Conf

fn clone(&self) -> Conf

Returns a copy of the value.

default fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Conf

fn default() -> Self

Return Conf { window_mode: Default::default(), window_setup: Default::default(), backend: Default::default(), modules: Default::default() }

impl Debug for Conf

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

Formats the value using the given formatter.

impl Serialize for Conf

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Conf

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.