Skip to content

Commit cfc8b65

Browse files
committed
Update docs
1 parent 9409bc5 commit cfc8b65

3 files changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ let font = full_font!(include_bytes!("my_font.bin"), ewram);
4040
use gba_agb_font_renderer::prelude::*;
4141
use agb::fixnum::vec2;
4242

43-
let format = TextFormat::new(TextOverflow::Wrap(200), TextAlign::Left, (0, 0), 15);
43+
let format = TextFormat::new(TextOverflow::Wrap(200, true), TextAlign::Left, (0, 0));
4444
let mut renderer = TextRenderer::default();
4545
renderer.draw_text(b"Hello, world!", &font, &mut bg, vec2(8, 16), &format);
4646
```
@@ -53,7 +53,7 @@ renderer.draw_text(b"Hello, world!", &font, &mut bg, vec2(8, 16), &format);
5353
use gba_agb_font_renderer::prelude::*;
5454
use agb::fixnum::vec2;
5555

56-
let format = TextFormat::new(TextOverflow::Wrap(200), TextAlign::Left, (0, 0), 15);
56+
let format = TextFormat::new(TextOverflow::Wrap(200, true), TextAlign::Left, (0, 0));
5757
// 1 character revealed every 2 frames
5858
let mut tw = TypewriterRenderer::new(1, 2, &format);
5959
tw.load_text(b"Hello, world!", vec2(8, 16));
@@ -69,7 +69,7 @@ loop {
6969
To clear the text area before loading new text:
7070

7171
```rust
72-
tw.clear(&font, &mut bg, 15);
72+
tw.clear(&font);
7373
tw.load_text(b"New message", vec2(8, 16));
7474
```
7575

@@ -82,7 +82,7 @@ use gba_agb_font_renderer::prelude::*;
8282
use agb::fixnum::vec2;
8383

8484
let name_format = TextFormat::default();
85-
let dialog_format = TextFormat::new(TextOverflow::Wrap(200), TextAlign::Left, (0, 0), 15);
85+
let dialog_format = TextFormat::new(TextOverflow::Wrap(200, true), TextAlign::Left, (0, 0));
8686

8787
// default: 1 char revealed every 2 frames
8888
let mut mtw = MultiTypewriterRenderer::new(2, 1);
@@ -95,7 +95,7 @@ loop {
9595
if mtw.is_complete() { break; }
9696
vblank.wait_for_vblank();
9797
}
98-
mtw.clear_all(&mut bg, 15);
98+
mtw.clear_all();
9999
```
100100

101101
## Font binary format

src/multi_typewriter.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ impl TypewriterSlot {
148148
///# use agb::fixnum::vec2;
149149
///
150150
/// let name_format = TextFormat::default();
151-
/// let dialog_format = TextFormat::new(TextOverflow::Wrap(200, true), TextAlign::Left, (0, 0), 15);
151+
/// let dialog_format = TextFormat::new(TextOverflow::Wrap(200, true), TextAlign::Left, (0, 0));
152152
/// let mut mtw = MultiTypewriterRenderer::new(2, 1); // 1 char every 2 frames by default
153153
/// mtw.add_text(SlotFont::from(FONT), b"Hero", vec2(8, 8), &name_format);
154154
/// let dialog = mtw.add_text(SlotFont::from(OTHER_FONT), b"Hello, world!", vec2(8, 24), &dialog_format);
@@ -159,7 +159,7 @@ impl TypewriterSlot {
159159
/// if mtw.is_complete() { break; }
160160
/// vblank.wait_for_vblank();
161161
/// }
162-
/// mtw.clear_all(&mut bg, 15);
162+
/// mtw.clear_all();
163163
/// ```
164164
#[derive(Debug, Default)]
165165
pub struct MultiTypewriterRenderer {

src/typewriter.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ use gba_agb_font_eb::AgbFont;
1414
/// ```ignore
1515
///# use agb::fixnum::vec2;
1616
///
17-
/// let format = TextFormat::new(TextOverflow::Wrap(200, true), TextAlign::Left, (0, 0), 15);
17+
/// let format = TextFormat::new(TextOverflow::Wrap(200, true), TextAlign::Left, (0, 0));
1818
/// let mut tw = TypewriterRenderer::new(1, 2, &format); // 1 char every 2 frames, wrap at 200px
1919
/// tw.load_text(b"Hello, world!", vec2(8, 16));
2020
///

0 commit comments

Comments
 (0)