Renamed 'TextLineBreakBehaviour' to 'BreakLineOn'

Adjusted the documentation to include a link to Unicode Standard Annex #14, Unicode Line Breaking Algorithm.

Author: Molot2032

crates/bevy_text/src/glyph_brush.rs

@@ -10,8 +10,8 @@ use glyph_brush_layout::{
 };
 
 use crate::{
-    error::TextError, Font, FontAtlasSet, FontAtlasWarning, GlyphAtlasInfo, TextAlignment,
-    TextLineBreakBehaviour, TextSettings, YAxisOrientation,
+    error::TextError, BreakLineOn, Font, FontAtlasSet, FontAtlasWarning, GlyphAtlasInfo,
+    TextAlignment, TextSettings, YAxisOrientation,
 };
 
 pub struct GlyphBrush {
@@ -36,7 +36,7 @@ impl GlyphBrush {
         sections: &[S],
         bounds: Vec2,
         text_alignment: TextAlignment,
-        linebreak_behaviour: TextLineBreakBehaviour,
+        linebreak_behaviour: BreakLineOn,
     ) -> Result<Vec<SectionGlyph>, TextError> {
         let geom = SectionGeometry {
             bounds: (bounds.x, bounds.y),

crates/bevy_text/src/pipeline.rs

@@ -10,9 +10,8 @@ use bevy_utils::HashMap;
 use glyph_brush_layout::{FontId, SectionText};
 
 use crate::{
-    error::TextError, glyph_brush::GlyphBrush, scale_value, Font, FontAtlasSet, FontAtlasWarning,
-    PositionedGlyph, TextAlignment, TextLineBreakBehaviour, TextSection, TextSettings,
-    YAxisOrientation,
+    error::TextError, glyph_brush::GlyphBrush, scale_value, BreakLineOn, Font, FontAtlasSet,
+    FontAtlasWarning, PositionedGlyph, TextAlignment, TextSection, TextSettings, YAxisOrientation,
 };
 
 #[derive(Default, Resource)]
@@ -46,7 +45,7 @@ impl TextPipeline {
         sections: &[TextSection],
         scale_factor: f64,
         text_alignment: TextAlignment,
-        linebreak_behaviour: TextLineBreakBehaviour,
+        linebreak_behaviour: BreakLineOn,
         bounds: Vec2,
         font_atlas_set_storage: &mut Assets<FontAtlasSet>,
         texture_atlases: &mut Assets<TextureAtlas>,

crates/bevy_text/src/text.rs

@@ -15,15 +15,15 @@ pub struct Text {
     /// Should not affect its position within a container.
     pub alignment: TextAlignment,
     /// How the text should linebreak when running out of the bounds determined by max_size
-    pub linebreak_behaviour: TextLineBreakBehaviour,
+    pub linebreak_behaviour: BreakLineOn,
 }
 
 impl Default for Text {
     fn default() -> Self {
         Self {
             sections: Default::default(),
             alignment: TextAlignment::Left,
-            linebreak_behaviour: TextLineBreakBehaviour::Unicode,
+            linebreak_behaviour: BreakLineOn::WordBoundary,
         }
     }
 }
@@ -177,24 +177,22 @@ impl Default for TextStyle {
 /// Determines how lines will be broken when preventing text from running out of bounds.
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Reflect, Serialize, Deserialize)]
 #[reflect(Serialize, Deserialize)]
-pub enum TextLineBreakBehaviour {
-    /// Lines will be broken up at the nearest word boundary, usually at a space.<br/>
-    /// This behaviour suits most cases, as it keeps words intact. Aims to implement the Unicode line breaking algorithm.
-    Unicode,
-    /// Lines will be broken without discrimination at the first character that runs out of bounds.<br/>
-    /// This is closer to the behaviour one might expect from a terminal.
+pub enum BreakLineOn {
+    /// Uses the [Unicode Line Breaking Algorithm](https://www.unicode.org/reports/tr14/).<br/>
+    /// Lines will be broken up at the nearest suitable word boundary, usually a space.<br/>
+    /// This behaviour suits most cases, as it keeps words intact across linebreaks.<br/>
+    WordBoundary,
+    /// Lines will be broken without discrimination on any character that would leave bounds.<br/>
+    /// This is closer to the behaviour one might expect from text in a terminal. <br/>
+    /// However it may lead to words being broken up across linebreaks<br />
     AnyCharacter,
 }
 
-impl From<TextLineBreakBehaviour> for glyph_brush_layout::BuiltInLineBreaker {
-    fn from(val: TextLineBreakBehaviour) -> Self {
+impl From<BreakLineOn> for glyph_brush_layout::BuiltInLineBreaker {
+    fn from(val: BreakLineOn) -> Self {
         match val {
-            TextLineBreakBehaviour::Unicode => {
-                glyph_brush_layout::BuiltInLineBreaker::UnicodeLineBreaker
-            }
-            TextLineBreakBehaviour::AnyCharacter => {
-                glyph_brush_layout::BuiltInLineBreaker::AnyCharLineBreaker
-            }
+            BreakLineOn::WordBoundary => glyph_brush_layout::BuiltInLineBreaker::UnicodeLineBreaker,
+            BreakLineOn::AnyCharacter => glyph_brush_layout::BuiltInLineBreaker::AnyCharLineBreaker,
         }
     }
 }

examples/2d/text2d.rs

@@ -7,7 +7,7 @@
 
 use bevy::{
     prelude::*,
-    text::{Text2dBounds, TextLineBreakBehaviour},
+    text::{BreakLineOn, Text2dBounds},
 };
 
 fn main() {
@@ -90,7 +90,7 @@ fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
                         slightly_smaller_text_style.clone(),
                     )],
                     alignment: TextAlignment::Left,
-                    linebreak_behaviour: TextLineBreakBehaviour::Unicode,
+                    linebreak_behaviour: BreakLineOn::WordBoundary,
                 },
                 text_2d_bounds: Text2dBounds {
                     // Wrap text in the rectangle
@@ -122,7 +122,7 @@ fn setup(mut commands: Commands, asset_server: Res<AssetServer>) {
                         slightly_smaller_text_style.clone(),
                     )],
                     alignment: TextAlignment::Left,
-                    linebreak_behaviour: TextLineBreakBehaviour::AnyCharacter,
+                    linebreak_behaviour: BreakLineOn::AnyCharacter,
                 },
                 text_2d_bounds: Text2dBounds {
                     // Wrap text in the rectangle