level_bgs_builder class
#include <ldtk_level_bgs_builder.h>
Constructors, destructors, conversion operators
- level_bgs_builder(const level& level) explicit
- Constructor.
Public functions
- auto level() const -> const level&
- Returns the
levelcontaining the required information to generate the level backgrounds. - auto has_background(gen::layer_ident layer_identifier) const -> bool
- Checks if the given layer will generate a background or not.
- auto x() const -> bn::fixed
- Returns the horizontal position of the level backgrounds to generate (relative to their camera, if they are going to have one).
-
auto set_x(bn::fixed x) -> level_
bgs_ builder& - Sets the horizontal position of the level backgrounds to generate (relative to their camera, if they are going to have one).
- auto y() const -> bn::fixed
- Returns the vertical position of the level backgrounds to generate (relative to their camera, if they are going to have one).
-
auto set_y(bn::fixed y) -> level_
bgs_ builder& - Sets the vertical position of the level backgrounds to generate (relative to their camera, if they are going to have one).
- auto position() const -> const bn::fixed_point&
- Returns the position of the level backgrounds to generate (relative to their camera, if they are going to have one).
-
auto set_position(bn::fixed x,
bn::fixed y) -> level_
bgs_ builder& - Sets the position of the level backgrounds to generate (relative to their camera, if they are going to have one).
-
auto set_position(const bn::fixed_point& position) -> level_
bgs_ builder& - Sets the position of the level backgrounds to generate (relative to their camera, if they are going to have one).
- auto top_left_x() const -> bn::fixed
- Returns the horizontal top-left position of the level backgrounds to generate (relative to their camera, if they are going to have one).
-
auto set_top_left_x(bn::fixed top_left_x) -> level_
bgs_ builder& - Sets the horizontal top-left position of the level backgrounds to generate (relative to their camera, if they are going to have one).
- auto top_left_y() const -> bn::fixed
- Returns the vertical top-left position of the level backgrounds to generate (relative to their camera, if they are going to have one).
-
auto set_top_left_y(bn::fixed top_left_y) -> level_
bgs_ builder& - Sets the vertical top-left position of the level backgrounds to generate (relative to their camera, if they are going to have one).
- auto top_left_position() const -> bn::fixed_point
- Returns the top-left position of the level backgrounds to generate (relative to their camera, if they are going to have one).
-
auto set_top_left_position(bn::fixed top_left_x,
bn::fixed top_left_y) -> level_
bgs_ builder& - Sets the top-left position of the level backgrounds to generate (relative to their camera, if they are going to have one).
-
auto set_top_left_position(const bn::fixed_point& top_left_position) -> level_
bgs_ builder& - Sets the top-left position of the level backgrounds to generate (relative to their camera, if they are going to have one).
- auto priority(gen::layer_ident layer_identifier) const -> int
- Returns the priority of a background of the given layer to generate relative to sprites and other backgrounds.
-
auto set_priority(int priority) -> level_
bgs_ builder& - Sets the priority of the level backgrounds to generate relative to sprites and other backgrounds.
-
auto set_priority(int priority,
gen::layer_ident layer_identifier) -> level_
bgs_ builder& - Sets the priority of a level background of the given layer to generate relative to sprites and other backgrounds.
- auto z_order(gen::layer_ident layer_identifier) const -> int
- Returns the priority of a background of the given layer to generate relative to other backgrounds, excluding sprites.
-
auto set_z_order(int z_order) -> level_
bgs_ builder& - Sets the priority of the level backgrounds to generate relative to other backgrounds, excluding sprites.
-
auto set_z_order(int z_order,
gen::layer_ident layer_identifier) -> level_
bgs_ builder& - Sets the priority of a level background of the given layer to generate relative to other backgrounds, excluding sprites.
- auto mosaic_enabled(gen::layer_ident layer_identifier) const -> bool
- Indicates if the mosaic effect must be applied to a level background with the given layer to generate or not.
-
auto set_mosaic_enabled(bool mosaic_enabled) -> level_
bgs_ builder& - Sets if the mosaic effect must be applied to the level backgrounds to generate or not.
-
auto set_mosaic_enabled(bool mosaic_enabled,
gen::layer_ident layer_identifier) -> level_
bgs_ builder& - Sets if the mosaic effect must be applied to a level background of the given layer to generate or not.
- auto blending_enabled(gen::layer_ident layer_identifier) const -> bool
- Indicates if blending must be applied to a level background with the given layer to generate or not.
-
auto set_blending_enabled(bool blending_enabled) -> level_
bgs_ builder& - Sets if blending must be applied to the level backgrounds to generate or not.
-
auto set_blending_enabled(bool blending_enabled,
gen::layer_ident layer_identifier) -> level_
bgs_ builder& - Sets if blending must be applied to a level background of the given layer to generate or not.
- auto blending_top_enabled(gen::layer_ident layer_identifier) const -> bool
- Indicates if a level background with the given layer to generate must be part of the blending top layer or not.
-
auto set_blending_top_enabled(bool blending_top_enabled) -> level_
bgs_ builder& - Sets if the level backgrounds to generate must be part of the blending top layer or not.
-
auto set_blending_top_enabled(bool blending_top_enabled,
gen::layer_ident layer_identifier) -> level_
bgs_ builder& - Sets if a level background of the given layer to generate must be part of the blending top layer or not.
- auto blending_bottom_enabled(gen::layer_ident layer_identifier) const -> bool
- Indicates if a level background with the given layer to generate must be part of the blending bottom layer or not.
-
auto set_blending_bottom_enabled(bool blending_bottom_enabled) -> level_
bgs_ builder& - Sets if the level backgrounds to generate must be part of the blending bottom layer or not.
-
auto set_blending_bottom_enabled(bool blending_bottom_enabled,
gen::layer_ident layer_identifier) -> level_
bgs_ builder& - Sets if a level background of the given layer to generate must be part of the blending bottom layer or not.
- auto green_swap_mode(gen::layer_ident layer_identifier) const -> bn::green_swap_mode
- Indicates how a level background with the given layer to generate must be displayed when green swap is enabled.
-
auto set_green_swap_mode(bn::green_swap_mode green_swap_mode) -> level_
bgs_ builder& - Sets how the level backgrounds to generate must be displayed when green swap is enabled.
-
auto set_green_swap_mode(bn::green_swap_mode green_swap_mode,
gen::layer_ident layer_identifier) -> level_
bgs_ builder& - Sets how a level background of the given layer to generate must be displayed when green swap is enabled.
- auto visible(gen::layer_ident layer_identifier) const -> bool
- Indicates if a level background with the given layer to generate must be committed to the GBA or not.
-
auto set_visible(bool visible) -> level_
bgs_ builder& - Sets if the level backgrounds to generate must be committed to the GBA or not.
-
auto set_visible(bool visible,
gen::layer_ident layer_identifier) -> level_
bgs_ builder& - Sets if a level background of the given layer to generate must be committed to the GBA or not.
- auto camera() const -> const bn::optional<bn::camera_ptr>&
- Returns the camera_ptr to attach to the level backgrounds to generate (if any).
-
auto set_camera(const bn::camera_ptr& camera) -> level_
bgs_ builder& - Sets the camera_ptr to attach to the level backgrounds to generate.
-
auto set_camera(bn::camera_ptr&& camera) -> level_
bgs_ builder& - Sets the camera_ptr to attach to the level backgrounds to generate.
-
auto set_camera(const bn::optional<bn::camera_ptr>& camera) -> level_
bgs_ builder& - Sets or removes the camera_ptr to attach to the level backgrounds to generate.
-
auto set_camera(bn::optional<bn::camera_ptr>&& camera) -> level_
bgs_ builder& - Sets or removes the camera_ptr to attach to the level backgrounds to generate.
-
auto remove_camera() -> level_
bgs_ builder& - Removes the camera_ptr to attach to the level backgrounds to generate.
- auto release_camera() -> bn::optional<bn::camera_ptr>
- Releases and returns the camera_ptr to attach to the level backgrounds to generate (if any).
-
auto build() const -> level_
bgs_ ptr - Generates and returns a
level_without releasing the acquired resources.bgs_ ptr -
auto release_build() -> level_
bgs_ ptr - Generates and returns a
level_releasing the acquired resources.bgs_ ptr -
auto build_optional() const -> bn::optional<level_
bgs_ ptr> - Generates and returns a
level_without releasing the acquired resources if it could be allocated;bgs_ ptr bn::nulloptotherwise. -
auto release_build_optional() -> bn::optional<level_
bgs_ ptr> - Generates and returns a
level_releasing the acquired resources if it could be allocated;bgs_ ptr bn::nulloptotherwise.
Function documentation
ldtk::
Constructor.
| Parameters | |
|---|---|
| level | level containing the required information to generate the level backgrounds. |
bool ldtk::
Checks if the given layer will generate a background or not.
| Parameters | |
|---|---|
| layer_identifier | identifier of the layer to check if it will generate a background. |
level_
Sets the horizontal position of the level backgrounds to generate (relative to their camera, if they are going to have one).
| Parameters | |
|---|---|
| x | Horizontal position of the level backgrounds to generate. |
| Returns | Reference to this. |
level_
Sets the vertical position of the level backgrounds to generate (relative to their camera, if they are going to have one).
| Parameters | |
|---|---|
| y | vertical position of the level backgrounds to generate. |
| Returns | Reference to this. |
level_
Sets the position of the level backgrounds to generate (relative to their camera, if they are going to have one).
| Parameters | |
|---|---|
| x | Horizontal position of the level backgrounds to generate. |
| y | Vertical position of the level backgrounds to generate. |
| Returns | Reference to this. |
level_
Sets the position of the level backgrounds to generate (relative to their camera, if they are going to have one).
| Parameters | |
|---|---|
| position | Position of the level backgrounds to generate. |
| Returns | Reference to this. |
level_
Sets the horizontal top-left position of the level backgrounds to generate (relative to their camera, if they are going to have one).
| Parameters | |
|---|---|
| top_left_x | Horizontal top-left position of the level backgrounds to generate. |
| Returns | Reference to this. |
level_
Sets the vertical top-left position of the level backgrounds to generate (relative to their camera, if they are going to have one).
| Parameters | |
|---|---|
| top_left_y | Vertical top-left position of the level backgrounds to generate. |
| Returns | Reference to this. |
level_
Sets the top-left position of the level backgrounds to generate (relative to their camera, if they are going to have one).
| Parameters | |
|---|---|
| top_left_x | Horizontal top-left position of the level backgrounds to generate. |
| top_left_y | Vertical top-left position of the level backgrounds to generate. |
| Returns | Reference to this. |
level_
Sets the top-left position of the level backgrounds to generate (relative to their camera, if they are going to have one).
| Parameters | |
|---|---|
| top_left_position | Top-left position of the level backgrounds to generate. |
| Returns | Reference to this. |
int ldtk::
Returns the priority of a background of the given layer to generate relative to sprites and other backgrounds.
| Parameters | |
|---|---|
| layer_identifier | identifier of the layer to get the background priority from. |
Backgrounds with higher priority are drawn first (and therefore can be covered by later sprites and backgrounds).
level_
Sets the priority of the level backgrounds to generate relative to sprites and other backgrounds.
| Parameters | |
|---|---|
| priority | Priority in the range [0..3]. |
| Returns | Reference to this. |
Backgrounds with higher priority are drawn first (and therefore can be covered by later sprites and backgrounds).
level_
Sets the priority of a level background of the given layer to generate relative to sprites and other backgrounds.
| Parameters | |
|---|---|
| priority | Priority in the range [0..3]. |
| layer_identifier | identifier of the layer to set the background priority to. |
| Returns | Reference to this. |
Backgrounds with higher priority are drawn first (and therefore can be covered by later sprites and backgrounds).
int ldtk::
Returns the priority of a background of the given layer to generate relative to other backgrounds, excluding sprites.
| Parameters | |
|---|---|
| layer_identifier | identifier of the layer to get the background priority from. |
Backgrounds with higher z orders are drawn first (and therefore can be covered by later backgrounds).
Due to hardware limitations, affine backgrounds can be drawn before regular backgrounds with higher z order.
level_
Sets the priority of the level backgrounds to generate relative to other backgrounds, excluding sprites.
| Parameters | |
|---|---|
| z_order | Priority relative to other backgrounds, excluding sprites, in the range [-32767..32767]. |
| Returns | Reference to this. |
Backgrounds with higher z orders are drawn first (and therefore can be covered by later backgrounds).
Due to hardware limitations, affine backgrounds can be drawn before regular backgrounds with higher z order.
level_
Sets the priority of a level background of the given layer to generate relative to other backgrounds, excluding sprites.
| Parameters | |
|---|---|
| z_order | Priority relative to other backgrounds, excluding sprites, in the range [-32767..32767]. |
| layer_identifier | identifier of the layer to set the background priority to. |
| Returns | Reference to this. |
Backgrounds with higher z orders are drawn first (and therefore can be covered by later backgrounds).
Due to hardware limitations, affine backgrounds can be drawn before regular backgrounds with higher z order.
bool ldtk::
Indicates if the mosaic effect must be applied to a level background with the given layer to generate or not.
| Parameters | |
|---|---|
| layer_identifier | identifier of the layer to get the flag from. |
level_
Sets if the mosaic effect must be applied to the level backgrounds to generate or not.
| Parameters | |
|---|---|
| mosaic_enabled | true if the mosaic effect must be applied; false otherwise. |
| Returns | Reference to this. |
level_
Sets if the mosaic effect must be applied to a level background of the given layer to generate or not.
| Parameters | |
|---|---|
| mosaic_enabled | true if the mosaic effect must be applied; false otherwise. |
| layer_identifier | identifier of the layer to set the flag to. |
| Returns | Reference to this. |
bool ldtk::
Indicates if blending must be applied to a level background with the given layer to generate or not.
| Parameters | |
|---|---|
| layer_identifier | identifier of the layer to get the flag from. |
Blending is applied to level backgrounds by making them part of the blending top layer.
level_
Sets if blending must be applied to the level backgrounds to generate or not.
| Parameters | |
|---|---|
| blending_enabled | true if blending must be applied; false otherwise. |
| Returns | Reference to this. |
Blending is applied to level backgrounds by making them part of the blending top layer.
level_
Sets if blending must be applied to a level background of the given layer to generate or not.
| Parameters | |
|---|---|
| blending_enabled | true if blending must be applied; false otherwise. |
| layer_identifier | identifier of the layer to set the flag to. |
| Returns | Reference to this. |
Blending is applied to level backgrounds by making them part of the blending top layer.
bool ldtk::
Indicates if a level background with the given layer to generate must be part of the blending top layer or not.
| Parameters | |
|---|---|
| layer_identifier | identifier of the layer to get the flag from. |
level_
Sets if the level backgrounds to generate must be part of the blending top layer or not.
| Parameters | |
|---|---|
| blending_top_enabled | true if generated backgrounds must be part of the blending top layer; false otherwise. |
| Returns | Reference to this. |
level_
Sets if a level background of the given layer to generate must be part of the blending top layer or not.
| Parameters | |
|---|---|
| blending_top_enabled | true if generated background must be part of the blending top layer; false otherwise. |
| layer_identifier | identifier of the layer to set the flag to. |
| Returns | Reference to this. |
bool ldtk::
Indicates if a level background with the given layer to generate must be part of the blending bottom layer or not.
| Parameters | |
|---|---|
| layer_identifier | identifier of the layer to get the flag from. |
level_
Sets if the level backgrounds to generate must be part of the blending bottom layer or not.
| Parameters | |
|---|---|
| blending_bottom_enabled | true if generated backgrounds must be part of the blending bottom layer; false otherwise. |
| Returns | Reference to this. |
level_
Sets if a level background of the given layer to generate must be part of the blending bottom layer or not.
| Parameters | |
|---|---|
| blending_bottom_enabled | true if generated background must be part of the blending bottom layer; false otherwise. |
| layer_identifier | identifier of the layer to set the flag to. |
| Returns | Reference to this. |
bn::green_swap_mode ldtk::
Indicates how a level background with the given layer to generate must be displayed when green swap is enabled.
| Parameters | |
|---|---|
| layer_identifier | identifier of the layer to get the mode from. |
level_
Sets how the level backgrounds to generate must be displayed when green swap is enabled.
| Parameters | |
|---|---|
| green_swap_mode | Green swap mode. |
| Returns | Reference to this. |
level_
Sets how a level background of the given layer to generate must be displayed when green swap is enabled.
| Parameters | |
|---|---|
| green_swap_mode | Green swap mode. |
| layer_identifier | identifier of the layer to set the mode to. |
| Returns | Reference to this. |
bool ldtk::
Indicates if a level background with the given layer to generate must be committed to the GBA or not.
| Parameters | |
|---|---|
| layer_identifier | identifier of the layer to get the flag from. |
level_
Sets if the level backgrounds to generate must be committed to the GBA or not.
| Parameters | |
|---|---|
| visible | true if the level backgrounds must be committed to the GBA; false otherwise. |
| Returns | Reference to this. |
level_
Sets if a level background of the given layer to generate must be committed to the GBA or not.
| Parameters | |
|---|---|
| visible | true if the level backgrounds must be committed to the GBA; false otherwise. |
| layer_identifier | identifier of the layer to set the flag to. |
| Returns | Reference to this. |
level_
Sets the camera_ptr to attach to the level backgrounds to generate.
| Parameters | |
|---|---|
| camera | camera_ptr to copy to the builder. |
| Returns | Reference to this. |
level_
Sets the camera_ptr to attach to the level backgrounds to generate.
| Parameters | |
|---|---|
| camera | camera_ptr to move to the builder. |
| Returns | Reference to this. |
level_
Sets or removes the camera_ptr to attach to the level backgrounds to generate.
| Parameters | |
|---|---|
| camera | Optional camera_ptr to copy to the builder. |
| Returns | Reference to this. |
level_
Sets or removes the camera_ptr to attach to the level backgrounds to generate.
| Parameters | |
|---|---|
| camera | Optional camera_ptr to move to the builder. |
| Returns | Reference to this. |
level_
Removes the camera_ptr to attach to the level backgrounds to generate.
| Returns | Reference to this. |
|---|
level_
Generates and returns a level_ releasing the acquired resources.
level_ generation after calling this method may stop working.
bn::optional<level_
Generates and returns a level_ releasing the acquired resources if it could be allocated; bn::nullopt otherwise.
level_ generation after calling this method may stop working.