bn::sprite_position_hbe_ptr class
#include <bn_sprite_position_hbe_ptr.h>

std::shared_ptr like smart pointer that retains shared ownership of a H-Blank effect which changes the position of a sprite in each screen horizontal line.

Base classes

class hbe_ptr
std::shared_ptr like smart pointer that retains shared ownership of a H-Blank effect.

Public static functions

static auto create_horizontal(sprite_ptr sprite, const span<const fixed>& deltas_ref) -> sprite_position_hbe_ptr
Creates a sprite_position_hbe_ptr which changes the horizontal position of a sprite in each screen horizontal line.
static auto create_vertical(sprite_ptr sprite, const span<const fixed>& deltas_ref) -> sprite_position_hbe_ptr
Creates a sprite_position_hbe_ptr which changes the vertical position of a sprite in each screen horizontal line.
static auto create_horizontal_optional(sprite_ptr sprite, const span<const fixed>& deltas_ref) -> optional<sprite_position_hbe_ptr>
Creates a sprite_position_hbe_ptr which changes the horizontal position of a sprite in each screen horizontal line.
static auto create_vertical_optional(sprite_ptr sprite, const span<const fixed>& deltas_ref) -> optional<sprite_position_hbe_ptr>
Creates a sprite_position_hbe_ptr which changes the vertical position of a sprite in each screen horizontal line.

Public functions

auto sprite() const -> const sprite_ptr&
Returns the sprite modified by this H-Blank effect.
auto deltas_ref() const -> span<const fixed>
Returns the referenced array of 160 deltas to add to the horizontal or vertical position of the managed sprite in each screen horizontal line.
void set_deltas_ref(const span<const fixed>& deltas_ref)
Sets the reference to an array of 160 deltas to add to the horizontal or vertical position of the managed sprite in each screen horizontal line.
void reload_deltas_ref()
Rereads the content of the referenced deltas to add to the horizontal or vertical position of the managed sprite in each screen horizontal line.
void swap(sprite_position_hbe_ptr& other)
Exchanges the contents of this sprite_position_hbe_ptr with those of the other one.

Friends

void swap(sprite_position_hbe_ptr& a, sprite_position_hbe_ptr& b)
Exchanges the contents of a sprite_position_hbe_ptr with those of another one.

Function documentation

static sprite_position_hbe_ptr bn::sprite_position_hbe_ptr::create_horizontal(sprite_ptr sprite, const span<const fixed>& deltas_ref)

Creates a sprite_position_hbe_ptr which changes the horizontal position of a sprite in each screen horizontal line.

Parameters
sprite Sprite to be modified.
deltas_ref Reference to an array of 160 deltas to add to the horizontal position of the given sprite in each screen horizontal line.
Returns The requested sprite_position_hbe_ptr.

The deltas are not copied but referenced, so they should outlive the sprite_position_hbe_ptr to avoid dangling references.

static sprite_position_hbe_ptr bn::sprite_position_hbe_ptr::create_vertical(sprite_ptr sprite, const span<const fixed>& deltas_ref)

Creates a sprite_position_hbe_ptr which changes the vertical position of a sprite in each screen horizontal line.

Parameters
sprite Sprite to be modified.
deltas_ref Reference to an array of 160 deltas to add to the vertical position of the given sprite in each screen horizontal line.
Returns The requested sprite_position_hbe_ptr.

The deltas are not copied but referenced, so they should outlive the sprite_position_hbe_ptr to avoid dangling references.

static optional<sprite_position_hbe_ptr> bn::sprite_position_hbe_ptr::create_horizontal_optional(sprite_ptr sprite, const span<const fixed>& deltas_ref)

Creates a sprite_position_hbe_ptr which changes the horizontal position of a sprite in each screen horizontal line.

Parameters
sprite Sprite to be modified.
deltas_ref Reference to an array of 160 deltas to add to the horizontal position of the given sprite in each screen horizontal line.
Returns The requested sprite_position_hbe_ptr if it could be allocated; bn::nullopt otherwise.

The deltas are not copied but referenced, so they should outlive the sprite_position_hbe_ptr to avoid dangling references.

static optional<sprite_position_hbe_ptr> bn::sprite_position_hbe_ptr::create_vertical_optional(sprite_ptr sprite, const span<const fixed>& deltas_ref)

Creates a sprite_position_hbe_ptr which changes the vertical position of a sprite in each screen horizontal line.

Parameters
sprite Sprite to be modified.
deltas_ref Reference to an array of 160 deltas to add to the vertical position of the given sprite in each screen horizontal line.
Returns The requested sprite_position_hbe_ptr if it could be allocated; bn::nullopt otherwise.

The deltas are not copied but referenced, so they should outlive the sprite_position_hbe_ptr to avoid dangling references.

span<const fixed> bn::sprite_position_hbe_ptr::deltas_ref() const

Returns the referenced array of 160 deltas to add to the horizontal or vertical position of the managed sprite in each screen horizontal line.

The deltas are not copied but referenced, so they should outlive the sprite_position_hbe_ptr to avoid dangling references.

void bn::sprite_position_hbe_ptr::set_deltas_ref(const span<const fixed>& deltas_ref)

Sets the reference to an array of 160 deltas to add to the horizontal or vertical position of the managed sprite in each screen horizontal line.

The deltas are not copied but referenced, so they should outlive the sprite_position_hbe_ptr to avoid dangling references.

void bn::sprite_position_hbe_ptr::reload_deltas_ref()

Rereads the content of the referenced deltas to add to the horizontal or vertical position of the managed sprite in each screen horizontal line.

The deltas are not copied but referenced, so they should outlive the sprite_position_hbe_ptr to avoid dangling references.

void bn::sprite_position_hbe_ptr::swap(sprite_position_hbe_ptr& other)

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

Parameters
other sprite_position_hbe_ptr to exchange the contents with.

void swap(sprite_position_hbe_ptr& a, sprite_position_hbe_ptr& b)

Exchanges the contents of a sprite_position_hbe_ptr with those of another one.

Parameters
a First sprite_position_hbe_ptr to exchange the contents with.
b Second sprite_position_hbe_ptr to exchange the contents with.