bn::affine_bg_ptr class

#include <bn_affine_bg_ptr.h>

Public static functions

static auto create(const affine_bg_item& item) -> affine_bg_ptr

Creates an affine_bg_ptr from the given affine_bg_item.

static auto create(const affine_bg_item& item, int map_index) -> affine_bg_ptr

Creates an affine_bg_ptr from the given affine_bg_item.

static auto create(affine_bg_map_ptr map) -> affine_bg_ptr

Creates an affine_bg_ptr from the given affine_bg_map_ptr.

static auto create(fixed x, fixed y, const affine_bg_item& item) -> affine_bg_ptr

Creates an affine_bg_ptr from the given affine_bg_item.

static auto create(fixed x, fixed y, const affine_bg_item& item, int map_index) -> affine_bg_ptr

Creates an affine_bg_ptr from the given affine_bg_item.

static auto create(const fixed_point& position, const affine_bg_item& item) -> affine_bg_ptr

Creates an affine_bg_ptr from the given affine_bg_item.

static auto create(const fixed_point& position, const affine_bg_item& item, int map_index) -> affine_bg_ptr

Creates an affine_bg_ptr from the given affine_bg_item.

static auto create(fixed x, fixed y, affine_bg_map_ptr map) -> affine_bg_ptr

Creates an affine_bg_ptr from the given affine_bg_map_ptr.

static auto create(const fixed_point& position, affine_bg_map_ptr map) -> affine_bg_ptr

Creates an affine_bg_ptr from the given affine_bg_map_ptr.

static auto create(const affine_bg_builder& builder) -> affine_bg_ptr

Creates an affine_bg_ptr from an affine_bg_builder reference.

static auto create(affine_bg_builder&& builder) -> affine_bg_ptr

Creates an affine_bg_ptr from a moved affine_bg_builder.

static auto create_optional(const affine_bg_item& item) -> optional<affine_bg_ptr>

Creates an affine_bg_ptr from the given affine_bg_item.

static auto create_optional(const affine_bg_item& item, int map_index) -> optional<affine_bg_ptr>

Creates an affine_bg_ptr from the given affine_bg_item.

static auto create_optional(affine_bg_map_ptr map) -> optional<affine_bg_ptr>

Creates an affine_bg_ptr from the given affine_bg_map_ptr.

static auto create_optional(fixed x, fixed y, const affine_bg_item& item) -> optional<affine_bg_ptr>

Creates an affine_bg_ptr from the given affine_bg_item.

static auto create_optional(fixed x, fixed y, const affine_bg_item& item, int map_index) -> optional<affine_bg_ptr>

Creates an affine_bg_ptr from the given affine_bg_item.

static auto create_optional(const fixed_point& position, const affine_bg_item& item) -> optional<affine_bg_ptr>

Creates an affine_bg_ptr from the given affine_bg_item.

static auto create_optional(const fixed_point& position, const affine_bg_item& item, int map_index) -> optional<affine_bg_ptr>

Creates an affine_bg_ptr from the given affine_bg_item.

static auto create_optional(fixed x, fixed y, affine_bg_map_ptr map) -> optional<affine_bg_ptr>

Creates an affine_bg_ptr from the given affine_bg_map_ptr.

static auto create_optional(const fixed_point& position, affine_bg_map_ptr map) -> optional<affine_bg_ptr>

Creates an affine_bg_ptr from the given affine_bg_map_ptr.

static auto create_optional(const affine_bg_builder& builder) -> optional<affine_bg_ptr>

Creates an affine_bg_ptr from an affine_bg_builder reference.

static auto create_optional(affine_bg_builder&& builder) -> optional<affine_bg_ptr>

Creates an affine_bg_ptr from a moved affine_bg_builder.

Constructors, destructors, conversion operators

affine_bg_ptr(const affine_bg_ptr& other)

Copy constructor.

affine_bg_ptr(affine_bg_ptr&& other) noexcept

Move constructor.

~affine_bg_ptr()

Releases the referenced affine background if no more affine_bg_ptr objects reference to it.

Public functions

auto operator=(const affine_bg_ptr& other) -> affine_bg_ptr&

Copy assignment operator.

auto operator=(affine_bg_ptr&& other) -> affine_bg_ptr& noexcept

Move assignment operator.

auto dimensions() const -> size

Returns the size in pixels of the affine background.

auto big() const -> bool

Indicates if this affine background is big or not.

auto tiles() const -> const affine_bg_tiles_ptr&

Returns the tiles used by this affine background.

void set_tiles(const affine_bg_tiles_ptr& tiles)

Sets the tiles used by this affine background.

void set_tiles(affine_bg_tiles_ptr&& tiles)

Sets the tiles used by this affine background.

void set_tiles(const affine_bg_tiles_item& tiles_item)

Replaces the tiles used by this affine background with a new tile set created with the given affine_bg_tiles_item.

auto palette() const -> const bg_palette_ptr&

Returns the color palette used by this affine background.

void set_palette(const bg_palette_ptr& palette)

Sets the color palette to use by this affine background.

void set_palette(bg_palette_ptr&& palette)

Sets the color palette to use by this affine background.

void set_palette(const bg_palette_item& palette_item)

Replaces the color palette used by this affine background with a new one created with the given bg_palette_item.

auto map() const -> const affine_bg_map_ptr&

Returns the map used by this affine background.

void set_map(const affine_bg_map_ptr& map)

Sets the map used by this affine background.

void set_map(affine_bg_map_ptr&& map)

Sets the map used by this affine background.

void set_map(const affine_bg_map_item& map_item)

Replaces the map used by this affine background with a new map created with the given affine_bg_map_item.

void set_map(const affine_bg_map_item& map_item, int map_index)

Replaces the map used by this affine background with a new map created with the given affine_bg_map_item.

void set_item(const affine_bg_item& item)

Replaces the tiles, the color palette and the map used by this affine background with the created with the given affine_bg_item.

void set_item(const affine_bg_item& item, int map_index)

Replaces the tiles, the color palette and the map used by this affine background with the created with the given affine_bg_item.

auto x() const -> fixed

Returns the horizontal position of the affine background (relative to its camera, if it has one).

void set_x(fixed x)

Sets the horizontal position of the affine background (relative to its camera, if it has one).

auto y() const -> fixed

Returns the vertical position of the affine background (relative to its camera, if it has one).

void set_y(fixed y)

Sets the vertical position of the affine background (relative to its camera, if it has one).

auto position() const -> const fixed_point&

Returns the position of the affine background (relative to its camera, if it has one).

void set_position(fixed x, fixed y)

Sets the position of the affine background (relative to its camera, if it has one).

void set_position(const fixed_point& position)

Sets the position of the affine background (relative to its camera, if it has one).

auto top_left_x() const -> fixed

Returns the horizontal top-left position of the affine background (relative to its camera, if it has one).

void set_top_left_x(fixed top_left_x)

Sets the horizontal top-left position of the affine background (relative to its camera, if it has one).

auto top_left_y() const -> fixed

Returns the vertical top-left position of the affine background (relative to its camera, if it has one).

void set_top_left_y(fixed top_left_y)

Sets the vertical top-left position of the affine background (relative to its camera, if it has one).

auto top_left_position() const -> fixed_point

Returns the top-left position of the affine background (relative to its camera, if it has one).

void set_top_left_position(fixed top_left_x, fixed top_left_y)

Sets the top-left position of the affine background (relative to its camera, if it has one).

void set_top_left_position(const fixed_point& top_left_position)

Sets the top-left position of the affine background (relative to its camera, if it has one).

auto rotation_angle() const -> fixed

Returns the rotation angle in degrees of the affine background.

void set_rotation_angle(fixed rotation_angle)

Sets the rotation angle in degrees of the affine background.

void set_rotation_angle_safe(fixed rotation_angle)

Sets the rotation angle in degrees of the affine background.

auto horizontal_scale() const -> fixed

Returns the horizontal scale of the affine background.

void set_horizontal_scale(fixed horizontal_scale)

Sets the horizontal scale of the affine background.

auto vertical_scale() const -> fixed

Returns the vertical scale of the affine background.

void set_vertical_scale(fixed vertical_scale)

Sets the vertical scale of the affine background.

void set_scale(fixed scale)

Sets the scale of the affine background.

void set_scale(fixed horizontal_scale, fixed vertical_scale)

Sets the scale of the affine background.

auto horizontal_shear() const -> fixed

Returns the horizontal shear of the affine background.

void set_horizontal_shear(fixed horizontal_shear)

Sets the horizontal shear of the affine background.

auto vertical_shear() const -> fixed

Returns the vertical shear of the affine background.

void set_vertical_shear(fixed vertical_shear)

Sets the vertical shear of the affine background.

void set_shear(fixed shear)

Sets the shear of the affine background.

void set_shear(fixed horizontal_shear, fixed vertical_shear)

Sets the shear of the affine background.

auto horizontal_flip() const -> bool

Indicates if this affine background is flipped in the horizontal axis or not.

void set_horizontal_flip(bool horizontal_flip)

Sets if this affine background must be flipped in the horizontal axis or not.

auto vertical_flip() const -> bool

Indicates if this affine background must be flipped in the vertical axis or not.

void set_vertical_flip(bool vertical_flip)

Sets if this affine background must be flipped in the vertical axis or not.

auto pivot_x() const -> fixed

Returns the horizontal position of the affine transformations pivot point of this affine background.

void set_pivot_x(fixed pivot_x)

Sets the horizontal position of the affine transformations pivot point of this affine background.

auto pivot_y() const -> fixed

Returns the vertical position of the affine transformations pivot point of this affine background.

void set_pivot_y(fixed pivot_y)

Sets the vertical position of the affine transformations pivot point of this affine background.

auto pivot_position() const -> const fixed_point&

Returns the position of the affine transformations pivot point of this affine background.

void set_pivot_position(fixed pivot_x, fixed pivot_y)

Sets the position of the affine transformations pivot point of this affine background.

void set_pivot_position(const fixed_point& pivot_position)

Sets the position of the affine transformations pivot point of this affine background.

auto mat_attributes() const -> const affine_bg_mat_attributes&

Returns the attributes of the position and the transformation matrix of this affine background.

void set_mat_attributes(const affine_mat_attributes& mat_attributes)

Sets the attributes of the affine transformation matrix of this affine background.

auto priority() const -> int

Returns the priority of the affine background relative to sprites and other backgrounds.

void set_priority(int priority)

Sets the priority of the affine background relative to sprites and other backgrounds.

auto z_order() const -> int

Returns the priority of the affine background relative to other backgrounds, excluding sprites.

void set_z_order(int z_order)

Sets the priority of the affine background relative to other backgrounds, excluding sprites.

void put_above()

Modify this affine background to be drawn above all of the other backgrounds with the same priority.

void put_below()

Modify this affine background to be drawn below all of the other backgrounds with the same priority.

auto wrapping_enabled() const -> bool

Indicates if this affine background wraps around at the edges or not.

void set_wrapping_enabled(bool wrapping_enabled)

Sets if this affine background must wrap around at the edges or not.

auto mosaic_enabled() const -> bool

Indicates if the mosaic effect must be applied to this affine background or not.

void set_mosaic_enabled(bool mosaic_enabled)

Sets if the mosaic effect must be applied to this affine background or not.

auto blending_enabled() const -> bool

Indicates if blending must be applied to this affine background or not.

void set_blending_enabled(bool blending_enabled)

Sets if blending must be applied to this affine background or not.

auto blending_top_enabled() const -> bool

Indicates if this affine background is part of the blending top layer or not.

void set_blending_top_enabled(bool blending_top_enabled)

Sets if this affine background is part of the blending top layer or not.

auto blending_bottom_enabled() const -> bool

Indicates if this affine background is part of the blending bottom layer or not.

void set_blending_bottom_enabled(bool blending_bottom_enabled)

Sets if this affine background is part of the blending bottom layer or not.

auto visible() const -> bool

Indicates if this affine background must be committed to the GBA or not.

void set_visible(bool visible)

Sets if this affine background must be committed to the GBA or not.

auto visible_in_window(const window& window) const -> bool

Indicates if this affine background is visible in the given window or not.

void set_visible_in_window(bool visible, window& window)

Sets if this affine background must be visible in the given window or not.

auto camera() const -> const optional<camera_ptr>&

Returns the camera_ptr attached to this affine background (if any).

void set_camera(const camera_ptr& camera)

Sets the camera_ptr attached to this affine background.

void set_camera(camera_ptr&& camera)

Sets the camera_ptr attached to this affine background.

void set_camera(const optional<camera_ptr>& camera)

Sets or removes the camera_ptr attached to this affine background.

void set_camera(optional<camera_ptr>&& camera)

Sets or removes the camera_ptr attached to this affine background.

void remove_camera()

Removes the camera_ptr attached to this affine background (if any).

auto attributes() const -> affine_bg_attributes

Returns the attributes to commit to the GBA for this affine background.

void set_attributes(const affine_bg_attributes& attributes)

Sets the attributes to commit to the GBA for this affine background.

auto hw_id() const -> optional<int>

Returns the hardware ID assigned to this background or bn::nullopt if no hardware ID has been assigned.

auto handle() const -> const void*

Returns the internal handle.

void swap(affine_bg_ptr& other)

Exchanges the contents of this affine_bg_ptr with those of the other one.

Friends

void swap(affine_bg_ptr& a, affine_bg_ptr& b)

Exchanges the contents of an affine_bg_ptr with those of another one.

auto operator==(const affine_bg_ptr& a, const affine_bg_ptr& b) -> bool defaulted

Default equal operator.

Function documentation