[][src]Struct rubidium::DisplayControlValue

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

Top level control for the LCD display.

  • video_mode: Video mode setting, see VideoMode.
  • display_frame1: When using video modes 4 or 5, controls if frame 0 or 1 is displayed.
  • hblank_memory_free: If this is enabled the video memory (VRAM, PALRAM, OAM) will be free to access without wait states during the horizontal-blank period. However, in exchange, there's less time available for OBJ display computation so not as many of the video objects can be displayed (details).
  • obj_vram_1d: If the video ram should be used as "1d" or "2d" when displaying an OBJ (details).
  • forced_blank: If this is set the screen displays full white instead of anything else. The vertical counter will continue to change as normal while forced blank is in effect.
  • display_bgX: For background each layer, if this layer should be shown. Background availability, and the registers involved, depends on the video mode selected.
  • display_obj: Display the object entries. The obj layer is always available.
  • display_winX: Enable the layers of the Window special effect, also controlled via WIN_CONTROL, WIN_HORIZONTAL, and WIN_VERTICAL.

Methods

impl DisplayControlValue[src]

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

#[must_use]pub const fn video_mode(self) -> VideoMode[src]

#[must_use]pub const fn with_video_mode(self, t: VideoMode) -> Self[src]

pub fn set_video_mode(&mut self, t: VideoMode)[src]

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Trait Implementations

impl Clone for DisplayControlValue[src]

impl Copy for DisplayControlValue[src]

impl Debug for DisplayControlValue[src]

impl Default for DisplayControlValue[src]

impl Eq for DisplayControlValue[src]

impl PartialEq<DisplayControlValue> for DisplayControlValue[src]

impl StructuralEq for DisplayControlValue[src]

impl StructuralPartialEq for DisplayControlValue[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.