Struct gba_types::DisplayControlSetting

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

The Display Control register value.

This sets the video mode, which affects almost all other aspects of the display, and also directly controls what layers are displayed or not.

Implementations

impl DisplayControlSetting

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

The PPU's video mode. More details are on the VideoMode type.

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

Determines if Frame 0 or Frame 1 is shown when using video mode 4 or 5. Otherwise this has no effect.

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

This sets the OAM memory to be free for CPU editing during Hblank.

The downside is that this gives the PPU less time for object display calculation, so the number of objects that can be displayed per line goes down slightly (by about 20%).

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

Determines if the object tile memory region should be "2d" or "1d" when displaying multi-tile objects.

In 2d mode, the object video memory is considered to be a single 256x256 area, so each row is 32 tiles offset. In 1d mode, the object video memory is considered more like a standard array of tiles.

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

If this bit is active, the ppu is blanked regardless of its actual position.

While force-blank is on, the ppu only draws white pixels.

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

Display background 0. Only effective in video modes 0 and 1.

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

Display background 1. Only effective in video modes 0 and 1.

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

Display background 2. BG2 has some sort of content in all video modes.

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

Display background 3. Only effective in video modes 0 and 2.

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

Display the object layer. Available in all video modes.

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

Display window 0 content.

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

Display window 1 content.

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

Display object window content.

pub fn set_video_mode(&mut self, video_mode: VideoMode)

pub fn set_show_frame1(&mut self, show_frame1: bool)

pub fn set_hblank_oam_free(&mut self, hblank_oam_free: bool)

pub fn set_obj_vram_is_1d(&mut self, obj_vram_is_1d: bool)

pub fn set_forced_blank(&mut self, forced_blank: bool)

pub fn set_display_bg0(&mut self, display_bg0: bool)

pub fn set_display_bg1(&mut self, display_bg1: bool)

pub fn set_display_bg2(&mut self, display_bg2: bool)

pub fn set_display_bg3(&mut self, display_bg3: bool)

pub fn set_display_obj(&mut self, display_obj: bool)

pub fn set_display_win0(&mut self, display_win0: bool)

pub fn set_display_win1(&mut self, display_win1: bool)

pub fn set_display_obj_win(&mut self, display_obj_win: bool)

Trait Implementations

impl Clone for DisplayControlSetting

fn clone(&self) -> DisplayControlSetting

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for DisplayControlSetting

impl Debug for DisplayControlSetting

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

Formats the value using the given formatter.

impl Default for DisplayControlSetting

fn default() -> DisplayControlSetting

Returns the "default value" for a type.

impl Eq for DisplayControlSetting

impl Hash for DisplayControlSetting

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Ord for DisplayControlSetting

fn cmp(&self, other: &DisplayControlSetting) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<DisplayControlSetting> for DisplayControlSetting

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

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

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

This method tests for !=.

impl PartialOrd<DisplayControlSetting> for DisplayControlSetting

fn partial_cmp(&self, other: &DisplayControlSetting) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &DisplayControlSetting) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &DisplayControlSetting) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &DisplayControlSetting) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &DisplayControlSetting) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for DisplayControlSetting

impl StructuralPartialEq for DisplayControlSetting