alex/agb
1
0
Fork 0
mirror of https://github.com/italicsjenga/agb.git synced 2024-12-23 08:11:33 +11:00
Code Issues Packages Projects Releases Wiki Activity

Add docs for pub exports of backgrounds

Browse source
This commit is contained in:
Gwilym Inzani 2024-08-28 14:55:12 +01:00
parent bc979d7299
commit f25fe7f707
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
agb/src/lib.rs
View file

@ -106,6 +106,15 @@
/// # use agb::include_background_gfx;
/// include_background_gfx!(generated_background, "000000", DATA => "$OUT_DIR/generated_background.aseprite");
/// ```
///
/// You can also make the exported background a public module which will allow other modules access them. The following
/// will declare `water_tiles` as a `pub mod` rather than a `mod`.
///
/// ```rust,no_run
/// ##![no_std]
/// ##![no_main]
/// agb::include_background_gfx!(pub water_tiles, tiles => "examples/water_tiles.png");
/// ```
pub use agb_image_converter::include_background_gfx;
#[doc(hidden)]