Skip to main content

GameConfig

Struct GameConfig 

Source
pub struct GameConfig {
    pub title: String,
    pub width: u32,
    pub height: u32,
    pub vsync: bool,
    pub fullscreen: bool,
    pub resizable: bool,
    pub target_fps: u32,
    pub debug_rendering: bool,
    pub show_fps_overlay: bool,
    pub fps_update_interval: f32,
}
Expand description

Configuration for creating a GoudGame instance.

This struct holds all the settings needed to initialize the game engine, including window properties, rendering options, and engine settings.

§Example

use goud_engine::sdk::GameConfig;

let config = GameConfig {
    title: "My Awesome Game".to_string(),
    width: 1280,
    height: 720,
    vsync: true,
    ..Default::default()
};

Fields§

§title: String

Window title displayed in the title bar.

§width: u32

Window width in pixels.

§height: u32

Window height in pixels.

§vsync: bool

Enable vertical sync to prevent screen tearing.

§fullscreen: bool

Enable fullscreen mode.

§resizable: bool

Enable window resizing.

§target_fps: u32

Target frames per second (0 = unlimited).

§debug_rendering: bool

Enable debug rendering (collision boxes, etc.).

§show_fps_overlay: bool

Show the FPS stats overlay.

§fps_update_interval: f32

How often (in seconds) the FPS overlay recomputes statistics.

Implementations§

Source§

impl GameConfig

Source

pub fn new(title: impl Into<String>, width: u32, height: u32) -> GameConfig

Creates a new configuration with the given title and dimensions.

§Example
use goud_engine::sdk::GameConfig;

let config = GameConfig::new("My Game", 800, 600);
Source

pub fn with_title(self, title: impl Into<String>) -> GameConfig

Sets the window title.

Source

pub fn with_size(self, width: u32, height: u32) -> GameConfig

Sets the window dimensions.

Source

pub fn with_vsync(self, enabled: bool) -> GameConfig

Enables or disables vsync.

Source

pub fn with_fullscreen(self, enabled: bool) -> GameConfig

Enables or disables fullscreen mode.

Source

pub fn with_target_fps(self, fps: u32) -> GameConfig

Sets the target FPS (0 for unlimited).

Source

pub fn with_fps_overlay(self, enabled: bool) -> GameConfig

Enables or disables the FPS stats overlay.

Source

pub fn with_fps_update_interval(self, interval: f32) -> GameConfig

Sets how often (in seconds) the FPS overlay recomputes statistics.

Trait Implementations§

Source§

impl Clone for GameConfig

Source§

fn clone(&self) -> GameConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GameConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for GameConfig

Source§

fn default() -> GameConfig

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> Event for T
where T: Send + Sync + 'static,

Source§

impl<T> QueryState for T
where T: Send + Sync + Clone + 'static,

Source§

impl<T> Resource for T
where T: Send + Sync + 'static,