docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Struct ClipBackgroundRegion

    Description of the on-screen area where a clip is drawn

    Inherited Members
    ValueType.ToString()
    object.Equals(object, object)
    object.GetType()
    object.ReferenceEquals(object, object)
    Namespace: UnityEditor.Timeline
    Assembly: Unity.Timeline.Editor.dll
    Syntax
    public struct ClipBackgroundRegion

    Constructors

    ClipBackgroundRegion(Rect, double, double)

    Constructor

    Declaration
    public ClipBackgroundRegion(Rect _position, double _startTime, double _endTime)
    Parameters
    Type Name Description
    Rect _position
    double _startTime
    double _endTime

    Properties

    endTime

    The end time of the region, relative to the clip.

    Declaration
    public readonly double endTime { get; }
    Property Value
    Type Description
    double

    position

    The rectangle where the background of the clip is drawn.

    Declaration
    public readonly Rect position { get; }
    Property Value
    Type Description
    Rect
    Remarks

    The rectangle is clipped to the screen. The rectangle does not include clip borders.

    startTime

    The start time of the region, relative to the clip.

    Declaration
    public readonly double startTime { get; }
    Property Value
    Type Description
    double

    Methods

    Equals(object)

    Indicates whether this instance and a specified object are equal.

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    object obj

    The object to compare with the current instance.

    Returns
    Type Description
    bool

    Returns true if obj and this instance are the same type and represent the same value.

    Overrides
    ValueType.Equals(object)

    Equals(ClipBackgroundRegion)

    Compares this object with another ClipBackgroundRegion.

    Declaration
    public bool Equals(ClipBackgroundRegion other)
    Parameters
    Type Name Description
    ClipBackgroundRegion other

    The object to compare with.

    Returns
    Type Description
    bool

    Returns true if this and other are equal.

    GetHashCode()

    Returns the hash code for this instance.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int

    A 32-bit signed integer that is the hash code for this instance.

    Overrides
    ValueType.GetHashCode()

    Operators

    operator ==(ClipBackgroundRegion, ClipBackgroundRegion)

    Compares two ClipBackgroundRegion objects.

    Declaration
    public static bool operator ==(ClipBackgroundRegion region1, ClipBackgroundRegion region2)
    Parameters
    Type Name Description
    ClipBackgroundRegion region1

    The first object.

    ClipBackgroundRegion region2

    The second object.

    Returns
    Type Description
    bool

    Returns true if they are equal.

    operator !=(ClipBackgroundRegion, ClipBackgroundRegion)

    Compares two ClipBackgroundRegion objects.

    Declaration
    public static bool operator !=(ClipBackgroundRegion region1, ClipBackgroundRegion region2)
    Parameters
    Type Name Description
    ClipBackgroundRegion region1

    The first object.

    ClipBackgroundRegion region2

    The second object.

    Returns
    Type Description
    bool

    Returns true if they are not equal.

    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)