Struct StyleBuilder

pub struct StyleBuilder<'a, 'w> {
    pub target: &'a mut EntityWorldMut<'w>,
    /* private fields */
}

An object that provides a fluent interface for defining styles for bevy_ui nodes. Most components such as BackgroundColor are mutated immediately, however some component types such as Style are cached in the builder and not applied until finish is called.

Fields

target: &'a mut EntityWorldMut<'w>

Implementations

impl<'a, 'w> StyleBuilder<'a, 'w>

pub fn new(target: &'a mut EntityWorldMut<'w>, style: Style) -> Self

Construct a new StyleBuilder instance.

pub fn load_asset<A: Asset>(&mut self, path: AssetPath<'_>) -> Handle<A>

Helper method for loading assets.

pub fn finish(self)

Consumes the StyleBuilder and applies the style to the target entity.

Trait Implementations

impl<'a, 'w> StyleBuilderBackground for StyleBuilder<'a, 'w>

fn background_image<'p>( &mut self, path: impl Into<MaybeHandleOrPath<'p, Image>>, ) -> &mut Self

Set the background image of the target entity.

fn background_image_flipped<'p>( &mut self, path: impl Into<MaybeHandleOrPath<'p, Image>>, flip_x: bool, flip_y: bool, ) -> &mut Self

Set the background image of the target entity, and also explicitly configure the horizontal and vertical flip.

fn background_color(&mut self, color: impl ColorParam) -> &mut Self

Set the background color, or None for transparent.

fn background_image_color(&mut self, color: impl ColorParam) -> &mut Self

Set the background color, or None for transparent.

impl<'a, 'w> StyleBuilderBorderColor for StyleBuilder<'a, 'w>

fn border_color(&mut self, color: impl ColorParam) -> &mut Self

impl<'a, 'w> StyleBuilderBorderRadius for StyleBuilder<'a, 'w>

fn border_radius(&mut self, radius: impl BorderRadiusParam) -> &mut Self

impl<'a, 'w> StyleBuilderFont for StyleBuilder<'a, 'w>

fn color(&mut self, color: impl ColorParam) -> &mut Self

fn font<'p>( &mut self, path: impl Into<MaybeHandleOrPath<'p, Font>>, ) -> &mut Self

fn font_size(&mut self, val: impl OptFloatParam) -> &mut Self

impl<'a, 'w> StyleBuilderLayout for StyleBuilder<'a, 'w>

fn display(&mut self, disp: Display) -> &mut Self

fn flex_row(&mut self) -> &mut Self

Set the display to flex and the flex direction to row.

fn flex_column(&mut self) -> &mut Self

Set the display to flex and the flex direction to column.

fn position(&mut self, pos: PositionType) -> &mut Self

fn overflow(&mut self, ov: OverflowAxis) -> &mut Self

fn overflow_x(&mut self, ov: OverflowAxis) -> &mut Self

fn overflow_y(&mut self, ov: OverflowAxis) -> &mut Self

fn direction(&mut self, dir: Direction) -> &mut Self

fn left(&mut self, length: impl LengthParam) -> &mut Self

fn right(&mut self, length: impl LengthParam) -> &mut Self

fn top(&mut self, length: impl LengthParam) -> &mut Self

fn bottom(&mut self, length: impl LengthParam) -> &mut Self

fn width(&mut self, length: impl LengthParam) -> &mut Self

fn height(&mut self, length: impl LengthParam) -> &mut Self

fn min_width(&mut self, length: impl LengthParam) -> &mut Self

fn min_height(&mut self, length: impl LengthParam) -> &mut Self

fn max_width(&mut self, length: impl LengthParam) -> &mut Self

fn max_height(&mut self, length: impl LengthParam) -> &mut Self

fn aspect_ratio(&mut self, length: impl OptFloatParam) -> &mut Self

fn margin(&mut self, rect: impl UiRectParam) -> &mut Self

fn margin_left(&mut self, length: impl LengthParam) -> &mut Self

fn margin_right(&mut self, length: impl LengthParam) -> &mut Self

fn margin_top(&mut self, length: impl LengthParam) -> &mut Self

fn margin_bottom(&mut self, length: impl LengthParam) -> &mut Self

fn padding(&mut self, rect: impl UiRectParam) -> &mut Self

fn padding_left(&mut self, length: impl LengthParam) -> &mut Self

fn padding_right(&mut self, length: impl LengthParam) -> &mut Self

fn padding_top(&mut self, length: impl LengthParam) -> &mut Self

fn padding_bottom(&mut self, length: impl LengthParam) -> &mut Self

fn border(&mut self, rect: impl UiRectParam) -> &mut Self

fn border_left(&mut self, length: impl LengthParam) -> &mut Self

fn border_right(&mut self, length: impl LengthParam) -> &mut Self

fn border_top(&mut self, length: impl LengthParam) -> &mut Self

fn border_bottom(&mut self, length: impl LengthParam) -> &mut Self

fn flex_direction(&mut self, dir: FlexDirection) -> &mut Self

fn flex_wrap(&mut self, w: FlexWrap) -> &mut Self

fn flex(&mut self, grow: f32, shrink: f32, basis: impl LengthParam) -> &mut Self

fn flex_grow(&mut self, n: f32) -> &mut Self

fn flex_shrink(&mut self, n: f32) -> &mut Self

fn flex_basis(&mut self, length: impl LengthParam) -> &mut Self

fn row_gap(&mut self, length: impl LengthParam) -> &mut Self

fn column_gap(&mut self, length: impl LengthParam) -> &mut Self

fn gap(&mut self, length: impl LengthParam) -> &mut Self

fn align_items(&mut self, align: AlignItems) -> &mut Self

fn align_self(&mut self, align: AlignSelf) -> &mut Self

fn align_content(&mut self, align: AlignContent) -> &mut Self

fn justify_items(&mut self, justify: JustifyItems) -> &mut Self

fn justify_self(&mut self, justify: JustifySelf) -> &mut Self

fn justify_content(&mut self, justify: JustifyContent) -> &mut Self

fn grid_auto_flow(&mut self, flow: GridAutoFlow) -> &mut Self

fn grid_template_rows(&mut self, rows: Vec<RepeatedGridTrack>) -> &mut Self

fn grid_template_columns( &mut self, columns: Vec<RepeatedGridTrack>, ) -> &mut Self

fn grid_auto_rows(&mut self, rows: Vec<GridTrack>) -> &mut Self

fn grid_auto_columns(&mut self, columns: Vec<GridTrack>) -> &mut Self

fn grid_row(&mut self, val: GridPlacement) -> &mut Self

fn grid_row_start(&mut self, val: i16) -> &mut Self

fn grid_row_span(&mut self, val: u16) -> &mut Self

fn grid_row_end(&mut self, val: i16) -> &mut Self

fn grid_column(&mut self, val: GridPlacement) -> &mut Self

fn grid_column_start(&mut self, val: i16) -> &mut Self

fn grid_column_span(&mut self, val: u16) -> &mut Self

fn grid_column_end(&mut self, val: i16) -> &mut Self

impl<'a, 'w> StyleBuilderOutline for StyleBuilder<'a, 'w>

fn outline_color(&mut self, color: impl ColorParam) -> &mut Self

fn outline_width(&mut self, length: impl LengthParam) -> &mut Self

fn outline_offset(&mut self, length: impl LengthParam) -> &mut Self

impl<'a, 'w> StyleBuilderPointerEvents for StyleBuilder<'a, 'w>

fn pointer_events(&mut self, enabled: bool) -> &mut Self

impl<'a, 'w> StyleBuilderVisibility for StyleBuilder<'a, 'w>

fn visible(&mut self, visible: bool) -> &mut Self

impl<'a, 'w> StyleBuilderZIndex for StyleBuilder<'a, 'w>

fn z_index(&mut self, index: impl ZIndexParam) -> &mut Self