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_...: For each layer, if this layer should be shown. The obj layer is always available. The available backgrounds depend on the video mode. The window layers have to do with the Window special effect, which is enabled and controlled separately.

Methods

impl DisplayControlValue

pub const fn new() -> Self

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Trait Implementations

impl Clone for DisplayControlValue

fn clone(&self) -> DisplayControlValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for DisplayControlValue

impl Debug for DisplayControlValue

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Default for DisplayControlValue

fn default() -> DisplayControlValue

Returns the "default value" for a type.

impl Eq for DisplayControlValue

impl PartialEq<DisplayControlValue> for DisplayControlValue

fn eq(&self, other: &DisplayControlValue) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DisplayControlValue) -> bool

This method tests for !=.

impl StructuralEq for DisplayControlValue

impl StructuralPartialEq for DisplayControlValue