Struct BackgroundControlValue

pub struct BackgroundControlValue(/* private fields */);

Lets you adjust how each background layer is displayed.

The effects of setting a BackgroundControlValue only apply in VideoMode 0, 1, and 2, and also the specific layer must be present in that video mode (eg: changing the BG0 control while in VideoMode2 has no effect).

• priority: Determines the “z-order” of the background layers. When drawing a background pixel, the background layer with the lowest priority value non-transparent pixel gets its pixel drawn. If two BG layers have the same priority value set then the lower numbered background wins. Also note that the OBJ layer is part of this same calculation.
• char_base_block: This determines the character base block for all tile ID offsets used by this background layer’s tile map.
• mosaic: If this background layer should have the “mosaic” effect enabled.
• bpp8: If the background should use use 8 bits per pixel (otherwise it uses 4 bits per pixel).
• screen_base_block: Determines the tile map to use for arranging this background’s tiles.
• affine_wrap: This causes the display area overflow to wrap when the layer is in affine mode, otherwise the display area is transparent. Has no effect on text mode backgrounds.
• screen_size: This value affects the size of the background, but the details depend on if the background is in text mode or affine mode.

Screen Size	Text Mode (px)	Affine Mode (px)
0	256^2	128^2
1	512x256 (wide)	256^2
2	256x512 (tall)	512^2
3	512^2	1024^2

Implementations

impl BackgroundControlValue

pub const fn new() -> Self

pub const fn priority(self) -> u16

pub const fn with_priority(self, u: u16) -> Self

pub fn set_priority(&mut self, u: u16)

pub const fn char_base_block(self) -> u16

pub const fn with_char_base_block(self, u: u16) -> Self

pub fn set_char_base_block(&mut self, u: u16)

pub const fn mosaic(self) -> bool

pub const fn with_mosaic(self, b: bool) -> Self

pub fn set_mosaic(&mut self, b: bool)

pub const fn bpp8(self) -> bool

pub const fn with_bpp8(self, b: bool) -> Self

pub fn set_bpp8(&mut self, b: bool)

pub const fn screen_base_block(self) -> u16

pub const fn with_screen_base_block(self, u: u16) -> Self

pub fn set_screen_base_block(&mut self, u: u16)

pub const fn affine_wrap(self) -> bool

pub const fn with_affine_wrap(self, b: bool) -> Self

pub fn set_affine_wrap(&mut self, b: bool)

pub const fn screen_size(self) -> u16

pub const fn with_screen_size(self, u: u16) -> Self

pub fn set_screen_size(&mut self, u: u16)

Trait Implementations

impl Clone for BackgroundControlValue

fn clone(&self) -> BackgroundControlValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BackgroundControlValue

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

Formats the value using the given formatter.

impl Default for BackgroundControlValue

fn default() -> BackgroundControlValue

Returns the “default value” for a type.

impl PartialEq for BackgroundControlValue

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for BackgroundControlValue

impl Eq for BackgroundControlValue

impl StructuralPartialEq for BackgroundControlValue