Class BoxDecoration | UIWidgets | 1.5.4-preview.12
docs.unity3d.com
    Show / Hide Table of Contents

    Class BoxDecoration

    Inheritance
    Object
    Diagnosticable
    Decoration
    BoxDecoration
    Inherited Members
    Decoration.toStringShort()
    Decoration.lerp(Decoration, Decoration, Single)
    Diagnosticable.ToString()
    Diagnosticable.toString(DiagnosticLevel)
    Diagnosticable.toDiagnosticsNode(String, DiagnosticsTreeStyle)
    Namespace: Unity.UIWidgets.painting
    Syntax
    public class BoxDecoration : Decoration, IEquatable<BoxDecoration>

    Constructors

    BoxDecoration(Color, DecorationImage, Border, BorderRadius, List<BoxShadow>, Gradient, Nullable<BlendMode>, BoxShape)

    Declaration
    public BoxDecoration(Color color = null, DecorationImage image = null, Border border = null, BorderRadius borderRadius = null, List<BoxShadow> boxShadow = null, Gradient gradient = null, BlendMode? backgroundBlendMode = default(BlendMode? ), BoxShape shape = BoxShape.rectangle)
    Parameters
    Type Name Description
    Color color
    DecorationImage image
    Border border
    BorderRadius borderRadius
    List<BoxShadow> boxShadow
    Gradient gradient
    Nullable<BlendMode> backgroundBlendMode
    BoxShape shape

    Fields

    backgroundBlendMode

    Declaration
    public readonly BlendMode? backgroundBlendMode
    Field Value
    Type Description
    Nullable<BlendMode>

    border

    Declaration
    public readonly Border border
    Field Value
    Type Description
    Border

    borderRadius

    Declaration
    public readonly BorderRadius borderRadius
    Field Value
    Type Description
    BorderRadius

    boxShadow

    Declaration
    public readonly List<BoxShadow> boxShadow
    Field Value
    Type Description
    List<BoxShadow>

    color

    Declaration
    public readonly Color color
    Field Value
    Type Description
    Color

    gradient

    Declaration
    public readonly Gradient gradient
    Field Value
    Type Description
    Gradient

    image

    Declaration
    public readonly DecorationImage image
    Field Value
    Type Description
    DecorationImage

    shape

    Declaration
    public readonly BoxShape shape
    Field Value
    Type Description
    BoxShape

    Properties

    isComplex

    Declaration
    public override bool isComplex { get; }
    Property Value
    Type Description
    Boolean
    Overrides
    Decoration.isComplex

    padding

    Declaration
    public override EdgeInsets padding { get; }
    Property Value
    Type Description
    EdgeInsets
    Overrides
    Decoration.padding

    Methods

    createBoxPainter(VoidCallback)

    Declaration
    public override BoxPainter createBoxPainter(VoidCallback onChanged = null)
    Parameters
    Type Name Description
    VoidCallback onChanged
    Returns
    Type Description
    BoxPainter
    Overrides
    Decoration.createBoxPainter(VoidCallback)

    debugAssertIsValid()

    Declaration
    public override bool debugAssertIsValid()
    Returns
    Type Description
    Boolean
    Overrides
    Decoration.debugAssertIsValid()

    debugFillProperties(DiagnosticPropertiesBuilder)

    Declaration
    public override void debugFillProperties(DiagnosticPropertiesBuilder properties)
    Parameters
    Type Name Description
    DiagnosticPropertiesBuilder properties
    Overrides
    Diagnosticable.debugFillProperties(DiagnosticPropertiesBuilder)

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    Object obj
    Returns
    Type Description
    Boolean
    Overrides
    Object.Equals(Object)

    Equals(BoxDecoration)

    Declaration
    public bool Equals(BoxDecoration other)
    Parameters
    Type Name Description
    BoxDecoration other
    Returns
    Type Description
    Boolean

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32
    Overrides
    Object.GetHashCode()

    hitTest(Size, Offset)

    Declaration
    public override bool hitTest(Size size, Offset position)
    Parameters
    Type Name Description
    Size size
    Offset position
    Returns
    Type Description
    Boolean
    Overrides
    Decoration.hitTest(Size, Offset)

    lerp(BoxDecoration, BoxDecoration, Single)

    Declaration
    public static BoxDecoration lerp(BoxDecoration a, BoxDecoration b, float t)
    Parameters
    Type Name Description
    BoxDecoration a
    BoxDecoration b
    Single t
    Returns
    Type Description
    BoxDecoration

    lerpFrom(Decoration, Single)

    Declaration
    public override Decoration lerpFrom(Decoration a, float t)
    Parameters
    Type Name Description
    Decoration a
    Single t
    Returns
    Type Description
    Decoration
    Overrides
    Decoration.lerpFrom(Decoration, Single)

    lerpTo(Decoration, Single)

    Declaration
    public override Decoration lerpTo(Decoration b, float t)
    Parameters
    Type Name Description
    Decoration b
    Single t
    Returns
    Type Description
    Decoration
    Overrides
    Decoration.lerpTo(Decoration, Single)

    scale(Single)

    Declaration
    public BoxDecoration scale(float factor)
    Parameters
    Type Name Description
    Single factor
    Returns
    Type Description
    BoxDecoration

    Operators

    Equality(BoxDecoration, BoxDecoration)

    Declaration
    public static bool operator ==(BoxDecoration left, BoxDecoration right)
    Parameters
    Type Name Description
    BoxDecoration left
    BoxDecoration right
    Returns
    Type Description
    Boolean

    Inequality(BoxDecoration, BoxDecoration)

    Declaration
    public static bool operator !=(BoxDecoration left, BoxDecoration right)
    Parameters
    Type Name Description
    BoxDecoration left
    BoxDecoration right
    Returns
    Type Description
    Boolean
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023