Struct screen_13::prelude::Program

pub struct Program<'a, 'b> {
    pub author: &'static str,
    pub fullscreen: bool,
    pub icon: Option<Icon<'b>>,
    pub name: &'static str,
    pub resizable: bool,
    pub title: &'a str,
}

Program is the required information to start an event loop, and therefore an Engine.

Remarks: The fullscreen/windowed setting this program describes may not be what Screen 13 chooses at runtime if there is a previously written configuration file present.

Fields

author: &'static str

Program author, or company.

fullscreen: bool

Whether the program uses a full-screen video mode or not.

icon: Option<Icon<'b>>

Program window icon, if set.

name: &'static str

Program name, or title.

resizable: bool

Whether the program window is resizable or not, while in window mode.

Has no effect while in fullscreen mode.

title: &'a str

Program window title.

This is what is shown to the user.

Implementations

impl Program<'static, 'static>

pub const FULLSCREEN: Program<'static, 'static>

A default program description, with a fullscreen setting.

This is most useful for small examples and demos. Real programs should fill in all the info manually.

pub const WINDOW: Program<'static, 'static>

A default program description, with a window mode setting.

This is most useful for small examples and demos. Real programs should fill in all the info manually.

impl Program<'_, '_>

pub const fn new(name: &'static str, author: &'static str) -> Self

Creates a new Program description.

By default the program will be fullscreen; use the builder functions to change this and make other important choices.

Remarks: Programs running in windowed mode automatically select an appropriately sized and placed window. Current logic provides a window centered on the primary display at HD resolution.

Remarks: When in debug mode the default is windowed mode.

pub const fn with_fullscreen(self) -> Self

Sets whether the program starts as fullscreen of in window mode.

pub const fn with_fullscreen_is(self, fullscreen: bool) -> Self

Sets whether the program starts as fullscreen of in window mode.

pub const fn with_name_author(
    self,
    name: &'static str,
    author: &'static str
) -> Self

Sets the program name and program author (also known as publisher). These values are used for multiple purposes, including locating configuration files.

pub const fn with_resizable(self) -> Self

Sets whether the window is resizable or not.

pub const fn with_resizable_is(self, resizable: bool) -> Self

Sets whether the window is resizable or not.

pub const fn with_window(self) -> Self

Sets whether the program starts in window mode instead of as fullscreen.

pub const fn with_window_is(self, window: bool) -> Self

Sets whether the program starts in window mode instead of as fullscreen.

pub fn without_icon(self) -> Self

Clears the previously set window icon.

pub fn root(&self) -> Result<PathBuf, Error>

Gets the filesystem root for this program. The returned path is a good place to store program configuration and data on a per-user basis.

impl<'a> Program<'a, '_>

pub const fn with_title(self, title: &'a str) -> Self

Sets the window title, separately from the program name which is used internally to cache configuration changes.

impl<'b> Program<'_, 'b>

pub fn with_icon(self, icon: Icon<'b>) -> Self

Sets the window icon. The icon must be an rgba formatted pixel array, and must be square.

pub fn with_icon_is(self, icon: Option<Icon<'b>>) -> Self

Sets the window icon. The icon must be an rgba formatted pixel array, and must be square.

Trait Implementations

impl<'a, 'b> AsRef<Program<'a, 'b>> for Program<'a, 'b>

pub fn as_ref(&self) -> &Self

Performs the conversion.

impl<'a, 'b> Debug for Program<'a, 'b>

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

Formats the value using the given formatter.

impl Default for Program<'_, '_>

pub fn default() -> Self

Returns the "default value" for a type.

impl<'a, 'b> Deserialize<'static> for Program<'a, 'b>

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

Deserialize this value from the given Serde deserializer.

impl From<&'_ Program<'_, '_>> for Engine

pub fn from(program: &Program<'_, '_>) -> Self

Performs the conversion.

impl From<Program<'_, '_>> for Engine

pub fn from(program: Program<'_, '_>) -> Self

Performs the conversion.

impl<'a, 'b> Serialize for Program<'a, 'b>

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

Serialize this value into the given Serde serializer.