Skip to main content

Window

Struct Window 

Source
pub struct Window { /* private fields */ }

Implementations§

Source§

impl Window

Source

pub fn new(width: u32, height: u32, title: &str) -> Result<Self, Errors>

Create a new window with the given width and height and title, and enable polling for the given window events. If the window cannot be created, returns an error of type Errors::WindowCreationError.

§Arguments
  • width - The width of the window in pixels.
  • height - The height of the window in pixels.
  • title - The title of the window.
§Returns

A Result containing a Window instance if successful, or an error of type Errors::WindowCreationError otherwise.

Source

pub fn init_gl(&mut self) -> Result<(), Errors>

Initialize the OpenGL context for the window.

This function sets the current context to the window’s OpenGL context and loads the OpenGL function pointers using the gl crate.

§Errors

This function will return an error if there are any OpenGL errors during the initialization process.

Source

pub fn should_close(&self) -> bool

Check if the window should close.

§Returns

true if the window should close, otherwise false.

Source

pub fn enable_depth_test(&self)

Enable depth testing for this window.

§OpenGL Functions

This function is a wrapper around glEnable(GL_DEPTH_TEST).

Source

pub fn enable_blend(&self)

Enable blending for this window.

§OpenGL Functions

This function is a wrapper around glEnable(GL_BLEND) and glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA).

Source

pub fn clear(&self, r: f32, g: f32, b: f32, a: f32)

Clear the screen with the given color.

§OpenGL Functions

This function is a wrapper around glClearColor and glClear.

§Arguments
  • r - The red component of the color.
  • g - The green component of the color.
  • b - The blue component of the color.
  • a - The alpha component of the color.
Source

pub fn update(&mut self)

Process window events and swap the front and back buffers.

This must be called every frame to keep the window responsive.

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