GraphicsBuilder

Struct GraphicsBuilder 

Source
pub struct GraphicsBuilder<F>
where F: Fn(&mut Graphics),
{ /* private fields */ }
Expand description

Builder for creating a Graphics instance.

Implementations§

Source§

impl<F> GraphicsBuilder<F>
where F: Fn(&mut Graphics),

Source

pub fn new() -> GraphicsBuilder<F>

Create a new empty GraphicsBuilder By default there is no resource manager or resource initializer, dimensions are 0, 0, name is empty

Examples found in repository?
examples/hello.rs (line 61)
59async fn main() {
60    let resource_manager = Arc::new(Mutex::new(ResourceManager::new()));
61    let graphics = graphics::GraphicsBuilder::new()
62        .window_name(String::from("game"))
63        .dimensions((500, 500))
64        .resource_manager(resource_manager.clone())
65        // we bulk load resources here because either we'll have to deal with
66        // ownership of `graphics` (the actual `let graphics`, not the closure
67        // argument)
68        // you may think of it like about just some initialization func
69        .initializer(|graphics| {
70            resource_manager.lock().unwrap().load_dir(PathBuf::from("assets"), graphics).unwrap();
71        })
72        .build();
73    let mut window = Window::new(graphics.unwrap(), resource_manager);
74
75    // because events::run takes a `&'static mut dyn WindowEventHandler` as a second argument we
76    // need to do this seemingly weird thing (while `app.rs` in fennel-engine has an ass solution
77    // with raw pointers lmfao) 
78    let handler: &'static mut dyn WindowEventHandler = {
79        let boxed = Box::new(State);
80        Box::leak(boxed) as &'static mut dyn WindowEventHandler
81    };
82    events::run(&mut window, handler).await;
83}
Source

pub fn resource_manager( self, resource_manager: Arc<Mutex<ResourceManager>>, ) -> GraphicsBuilder<F>

Set the resource manager

Examples found in repository?
examples/hello.rs (line 64)
59async fn main() {
60    let resource_manager = Arc::new(Mutex::new(ResourceManager::new()));
61    let graphics = graphics::GraphicsBuilder::new()
62        .window_name(String::from("game"))
63        .dimensions((500, 500))
64        .resource_manager(resource_manager.clone())
65        // we bulk load resources here because either we'll have to deal with
66        // ownership of `graphics` (the actual `let graphics`, not the closure
67        // argument)
68        // you may think of it like about just some initialization func
69        .initializer(|graphics| {
70            resource_manager.lock().unwrap().load_dir(PathBuf::from("assets"), graphics).unwrap();
71        })
72        .build();
73    let mut window = Window::new(graphics.unwrap(), resource_manager);
74
75    // because events::run takes a `&'static mut dyn WindowEventHandler` as a second argument we
76    // need to do this seemingly weird thing (while `app.rs` in fennel-engine has an ass solution
77    // with raw pointers lmfao) 
78    let handler: &'static mut dyn WindowEventHandler = {
79        let boxed = Box::new(State);
80        Box::leak(boxed) as &'static mut dyn WindowEventHandler
81    };
82    events::run(&mut window, handler).await;
83}
Source

pub fn dimensions(self, dimensions: (u32, u32)) -> GraphicsBuilder<F>

Set the window dimensions

Examples found in repository?
examples/hello.rs (line 63)
59async fn main() {
60    let resource_manager = Arc::new(Mutex::new(ResourceManager::new()));
61    let graphics = graphics::GraphicsBuilder::new()
62        .window_name(String::from("game"))
63        .dimensions((500, 500))
64        .resource_manager(resource_manager.clone())
65        // we bulk load resources here because either we'll have to deal with
66        // ownership of `graphics` (the actual `let graphics`, not the closure
67        // argument)
68        // you may think of it like about just some initialization func
69        .initializer(|graphics| {
70            resource_manager.lock().unwrap().load_dir(PathBuf::from("assets"), graphics).unwrap();
71        })
72        .build();
73    let mut window = Window::new(graphics.unwrap(), resource_manager);
74
75    // because events::run takes a `&'static mut dyn WindowEventHandler` as a second argument we
76    // need to do this seemingly weird thing (while `app.rs` in fennel-engine has an ass solution
77    // with raw pointers lmfao) 
78    let handler: &'static mut dyn WindowEventHandler = {
79        let boxed = Box::new(State);
80        Box::leak(boxed) as &'static mut dyn WindowEventHandler
81    };
82    events::run(&mut window, handler).await;
83}
Source

pub fn window_name(self, name: String) -> GraphicsBuilder<F>

Set the window name

Examples found in repository?
examples/hello.rs (line 62)
59async fn main() {
60    let resource_manager = Arc::new(Mutex::new(ResourceManager::new()));
61    let graphics = graphics::GraphicsBuilder::new()
62        .window_name(String::from("game"))
63        .dimensions((500, 500))
64        .resource_manager(resource_manager.clone())
65        // we bulk load resources here because either we'll have to deal with
66        // ownership of `graphics` (the actual `let graphics`, not the closure
67        // argument)
68        // you may think of it like about just some initialization func
69        .initializer(|graphics| {
70            resource_manager.lock().unwrap().load_dir(PathBuf::from("assets"), graphics).unwrap();
71        })
72        .build();
73    let mut window = Window::new(graphics.unwrap(), resource_manager);
74
75    // because events::run takes a `&'static mut dyn WindowEventHandler` as a second argument we
76    // need to do this seemingly weird thing (while `app.rs` in fennel-engine has an ass solution
77    // with raw pointers lmfao) 
78    let handler: &'static mut dyn WindowEventHandler = {
79        let boxed = Box::new(State);
80        Box::leak(boxed) as &'static mut dyn WindowEventHandler
81    };
82    events::run(&mut window, handler).await;
83}
Source

pub fn initializer(self, initializer: F) -> GraphicsBuilder<F>
where F: Fn(&mut Graphics),

Set the resource initializer (closure)

Examples found in repository?
examples/hello.rs (lines 69-71)
59async fn main() {
60    let resource_manager = Arc::new(Mutex::new(ResourceManager::new()));
61    let graphics = graphics::GraphicsBuilder::new()
62        .window_name(String::from("game"))
63        .dimensions((500, 500))
64        .resource_manager(resource_manager.clone())
65        // we bulk load resources here because either we'll have to deal with
66        // ownership of `graphics` (the actual `let graphics`, not the closure
67        // argument)
68        // you may think of it like about just some initialization func
69        .initializer(|graphics| {
70            resource_manager.lock().unwrap().load_dir(PathBuf::from("assets"), graphics).unwrap();
71        })
72        .build();
73    let mut window = Window::new(graphics.unwrap(), resource_manager);
74
75    // because events::run takes a `&'static mut dyn WindowEventHandler` as a second argument we
76    // need to do this seemingly weird thing (while `app.rs` in fennel-engine has an ass solution
77    // with raw pointers lmfao) 
78    let handler: &'static mut dyn WindowEventHandler = {
79        let boxed = Box::new(State);
80        Box::leak(boxed) as &'static mut dyn WindowEventHandler
81    };
82    events::run(&mut window, handler).await;
83}
Source

pub fn resizable(self, resizable: bool) -> GraphicsBuilder<F>

Will the window be resizable?

Source

pub fn fullscreen(self, fullscreen: bool) -> GraphicsBuilder<F>

Will the window be fullscreen?

Source

pub fn centered(self, centered: bool) -> GraphicsBuilder<F>

Will the window be centered?

Source

pub fn build(self) -> Result<Graphics>

Build Graphics

§Panic

Panics if no resource manager or initializer was provided

Examples found in repository?
examples/hello.rs (line 72)
59async fn main() {
60    let resource_manager = Arc::new(Mutex::new(ResourceManager::new()));
61    let graphics = graphics::GraphicsBuilder::new()
62        .window_name(String::from("game"))
63        .dimensions((500, 500))
64        .resource_manager(resource_manager.clone())
65        // we bulk load resources here because either we'll have to deal with
66        // ownership of `graphics` (the actual `let graphics`, not the closure
67        // argument)
68        // you may think of it like about just some initialization func
69        .initializer(|graphics| {
70            resource_manager.lock().unwrap().load_dir(PathBuf::from("assets"), graphics).unwrap();
71        })
72        .build();
73    let mut window = Window::new(graphics.unwrap(), resource_manager);
74
75    // because events::run takes a `&'static mut dyn WindowEventHandler` as a second argument we
76    // need to do this seemingly weird thing (while `app.rs` in fennel-engine has an ass solution
77    // with raw pointers lmfao) 
78    let handler: &'static mut dyn WindowEventHandler = {
79        let boxed = Box::new(State);
80        Box::leak(boxed) as &'static mut dyn WindowEventHandler
81    };
82    events::run(&mut window, handler).await;
83}

Trait Implementations§

Source§

impl<F> Default for GraphicsBuilder<F>
where F: Fn(&mut Graphics),

Source§

fn default() -> Self

Default implementation delegates to [GraphicsBuilder::new]

Auto Trait Implementations§

§

impl<F> Freeze for GraphicsBuilder<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for GraphicsBuilder<F>
where F: RefUnwindSafe,

§

impl<F> Send for GraphicsBuilder<F>
where F: Send,

§

impl<F> Sync for GraphicsBuilder<F>
where F: Sync,

§

impl<F> Unpin for GraphicsBuilder<F>
where F: Unpin,

§

impl<F> UnwindSafe for GraphicsBuilder<F>
where F: UnwindSafe,

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> 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, 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>,