Struct ContextBuilder

pub struct ContextBuilder { /* private fields */ }

A builder object for creating a Context.

Implementations

impl ContextBuilder

pub fn new(game_id: &str, author: &str) -> Self

Create a new ContextBuilder with default settings.

pub fn window_setup(self, setup: WindowSetup) -> Self

Sets the window setup settings.

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

Sets the window mode settings.

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

Sets the graphics backend.

pub fn default_conf(self, conf: Conf) -> Self

Sets all the config options, overriding any previous ones from window_setup(), window_mode(), and backend(). These are used as defaults and are overridden by any external config file found.

pub fn resources_dir_name(self, new_name: impl Into<PathBuf>) -> Self

Sets resources dir name. Default resources dir name is resources.

pub fn resources_zip_name(self, new_name: impl Into<PathBuf>) -> Self

Sets resources zip name. Default resources dir name is resources.zip.

pub fn add_resource_path<T>(self, path: T) -> Self

where T: Into<PathBuf>,

Add a new read-only filesystem path to the places to search for resources.

pub fn add_zipfile_bytes<B>(self, bytes: B) -> Self

where B: Into<Cow<'static, [u8]>>,

Add a new zip file from bytes whose contents will be searched for resources. The zip file will be stored in-memory. You can pass it a static slice, a Vec of bytes, etc.

use ggez::context::ContextBuilder;
let _ = ContextBuilder::new()
    .add_zipfile_bytes(include_bytes!("../resources.zip").to_vec())
    .build();

pub fn with_conf_file(self, load_conf_file: bool) -> Self

Specifies whether or not to load the conf.toml file if it exists and use its settings to override the provided values. Defaults to true which is usually what you want, but being able to fiddle with it is sometimes useful for debugging.

pub fn build(self) -> GameResult<(Context, EventLoop<()>)>

Build the Context.

Trait Implementations

impl Clone for ContextBuilder

fn clone(&self) -> ContextBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContextBuilder

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

Formats the value using the given formatter.

impl PartialEq for ContextBuilder

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ContextBuilder