Struct ggez::conf::WindowSetup

pub struct WindowSetup {
    pub title: String,
    pub samples: NumSamples,
    pub vsync: bool,
    pub icon: String,
    pub srgb: bool,
}

A builder structure containing window settings that must be set at init time and cannot be changed afterwards.

Defaults:

WindowSetup {
    title: "An easy, good game".to_owned(),
    samples: NumSamples::One,
    vsync: true,
    icon: "".to_owned(),
    srgb: true,
}

Fields

title: String

The window title.

samples: NumSamples

Number of samples to use for multisample anti-aliasing.

vsync: bool

Whether or not to enable vsync.

icon: String

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

srgb: bool

Whether or not to enable sRGB (gamma corrected color) handling on the display.

Implementations

impl WindowSetup

pub fn title(self, title: &str) -> Self

Set window title.

pub fn samples(self, samples: NumSamples) -> Self

Set number of samples to use for multisample anti-aliasing.

pub fn vsync(self, vsync: bool) -> Self

Set whether vsync is enabled.

pub fn icon(self, icon: &str) -> Self

Set the window’s icon.

pub fn srgb(self, active: bool) -> Self

Set sRGB color mode.

Trait Implementations

impl Clone for WindowSetup

fn clone(&self) -> WindowSetup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WindowSetup

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

Formats the value using the given formatter.

impl Default for WindowSetup

fn default() -> Self

Return WindowSetup { title: String :: from("An easy, good game"), samples: NumSamples :: One, vsync: true, icon: String :: new(), srgb: true }

impl<'de> Deserialize<'de> for WindowSetup

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<WindowSetup> for WindowSetup

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

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

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

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

impl Serialize for WindowSetup

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

Serialize this value into the given Serde serializer.

impl Eq for WindowSetup

impl StructuralEq for WindowSetup

impl StructuralPartialEq for WindowSetup