[][src]Struct rubidium::WindowControlValue

#[repr(transparent)]pub struct WindowControlValue(_);

Lets you set what layers appear inside and outside of the window areas.

  • bg / obj / effect in win 0/1: These bits let you enable bg0/1/2/3 as well as obj display and/or color special effect inside windows 0 and/or 1.
  • bg / obj / effect outside win: These bits let you enable bg0/1/2/3 as well as obj display and/or color special effect outside of all windows.
  • bg / obj / effect in obj win: These bits let you enable bg0/1/2/3 as well as obj display and/or color special effect inside of the OBJ window.

The obj window doesn't actually have a simple area control like win0 and win1 do. Instead, the OBJ window includes the transparent pixels of any OBJ with an ObjMode set to "ObjWindow" (and the non-transparent pixels of such OBJ entries aren't drawn).

If more than one window is enabled and would draw a pixel, the priority is for win0, then win1, then the obj window, then anything outside the windows.

Methods

impl WindowControlValue[src]

pub const fn new() -> Self[src]

#[must_use]pub const fn bg0_in_win0(self) -> bool[src]

#[must_use]pub const fn with_bg0_in_win0(self, b: bool) -> Self[src]

pub fn set_bg0_in_win0(&mut self, b: bool)[src]

#[must_use]pub const fn bg1_in_win0(self) -> bool[src]

#[must_use]pub const fn with_bg1_in_win0(self, b: bool) -> Self[src]

pub fn set_bg1_in_win0(&mut self, b: bool)[src]

#[must_use]pub const fn bg2_in_win0(self) -> bool[src]

#[must_use]pub const fn with_bg2_in_win0(self, b: bool) -> Self[src]

pub fn set_bg2_in_win0(&mut self, b: bool)[src]

#[must_use]pub const fn bg3_in_win0(self) -> bool[src]

#[must_use]pub const fn with_bg3_in_win0(self, b: bool) -> Self[src]

pub fn set_bg3_in_win0(&mut self, b: bool)[src]

#[must_use]pub const fn obj_in_win0(self) -> bool[src]

#[must_use]pub const fn with_obj_in_win0(self, b: bool) -> Self[src]

pub fn set_obj_in_win0(&mut self, b: bool)[src]

#[must_use]pub const fn color_effect_in_win0(self) -> bool[src]

#[must_use]pub const fn with_color_effect_in_win0(self, b: bool) -> Self[src]

pub fn set_color_effect_in_win0(&mut self, b: bool)[src]

#[must_use]pub const fn bg0_in_win1(self) -> bool[src]

#[must_use]pub const fn with_bg0_in_win1(self, b: bool) -> Self[src]

pub fn set_bg0_in_win1(&mut self, b: bool)[src]

#[must_use]pub const fn bg1_in_win1(self) -> bool[src]

#[must_use]pub const fn with_bg1_in_win1(self, b: bool) -> Self[src]

pub fn set_bg1_in_win1(&mut self, b: bool)[src]

#[must_use]pub const fn bg2_in_win1(self) -> bool[src]

#[must_use]pub const fn with_bg2_in_win1(self, b: bool) -> Self[src]

pub fn set_bg2_in_win1(&mut self, b: bool)[src]

#[must_use]pub const fn bg3_in_win1(self) -> bool[src]

#[must_use]pub const fn with_bg3_in_win1(self, b: bool) -> Self[src]

pub fn set_bg3_in_win1(&mut self, b: bool)[src]

#[must_use]pub const fn obj_in_win1(self) -> bool[src]

#[must_use]pub const fn with_obj_in_win1(self, b: bool) -> Self[src]

pub fn set_obj_in_win1(&mut self, b: bool)[src]

#[must_use]pub const fn color_effect_in_win1(self) -> bool[src]

#[must_use]pub const fn with_color_effect_in_win1(self, b: bool) -> Self[src]

pub fn set_color_effect_in_win1(&mut self, b: bool)[src]

#[must_use]pub const fn bg0_outside_win(self) -> bool[src]

#[must_use]pub const fn with_bg0_outside_win(self, b: bool) -> Self[src]

pub fn set_bg0_outside_win(&mut self, b: bool)[src]

#[must_use]pub const fn bg1_outside_win(self) -> bool[src]

#[must_use]pub const fn with_bg1_outside_win(self, b: bool) -> Self[src]

pub fn set_bg1_outside_win(&mut self, b: bool)[src]

#[must_use]pub const fn bg2_outside_win(self) -> bool[src]

#[must_use]pub const fn with_bg2_outside_win(self, b: bool) -> Self[src]

pub fn set_bg2_outside_win(&mut self, b: bool)[src]

#[must_use]pub const fn bg3_outside_win(self) -> bool[src]

#[must_use]pub const fn with_bg3_outside_win(self, b: bool) -> Self[src]

pub fn set_bg3_outside_win(&mut self, b: bool)[src]

#[must_use]pub const fn obj_outside_win(self) -> bool[src]

#[must_use]pub const fn with_obj_outside_win(self, b: bool) -> Self[src]

pub fn set_obj_outside_win(&mut self, b: bool)[src]

#[must_use]pub const fn color_effect_outside_win(self) -> bool[src]

#[must_use]pub const fn with_color_effect_outside_win(self, b: bool) -> Self[src]

pub fn set_color_effect_outside_win(&mut self, b: bool)[src]

#[must_use]pub const fn bg0_in_obj_win(self) -> bool[src]

#[must_use]pub const fn with_bg0_in_obj_win(self, b: bool) -> Self[src]

pub fn set_bg0_in_obj_win(&mut self, b: bool)[src]

#[must_use]pub const fn bg1_in_obj_win(self) -> bool[src]

#[must_use]pub const fn with_bg1_in_obj_win(self, b: bool) -> Self[src]

pub fn set_bg1_in_obj_win(&mut self, b: bool)[src]

#[must_use]pub const fn bg2_in_obj_win(self) -> bool[src]

#[must_use]pub const fn with_bg2_in_obj_win(self, b: bool) -> Self[src]

pub fn set_bg2_in_obj_win(&mut self, b: bool)[src]

#[must_use]pub const fn bg3_in_obj_win(self) -> bool[src]

#[must_use]pub const fn with_bg3_in_obj_win(self, b: bool) -> Self[src]

pub fn set_bg3_in_obj_win(&mut self, b: bool)[src]

#[must_use]pub const fn obj_in_obj_win(self) -> bool[src]

#[must_use]pub const fn with_obj_in_obj_win(self, b: bool) -> Self[src]

pub fn set_obj_in_obj_win(&mut self, b: bool)[src]

#[must_use]pub const fn color_effect_in_obj_win(self) -> bool[src]

#[must_use]pub const fn with_color_effect_in_obj_win(self, b: bool) -> Self[src]

pub fn set_color_effect_in_obj_win(&mut self, b: bool)[src]

Trait Implementations

impl Clone for WindowControlValue[src]

impl Copy for WindowControlValue[src]

impl Debug for WindowControlValue[src]

impl Default for WindowControlValue[src]

impl Eq for WindowControlValue[src]

impl PartialEq<WindowControlValue> for WindowControlValue[src]

impl StructuralEq for WindowControlValue[src]

impl StructuralPartialEq for WindowControlValue[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.