docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Namespace UnityEngine.UI

    Classes

    AnimationTriggers

    Structure that stores the state of an animation transition on a Selectable.

    AspectRatioFitter

    BaseMeshEffect

    Base class for effects that modify the generated Mesh.

    BaseVertexEffect

    Button

    A standard button that sends an event when clicked.

    Button.ButtonClickedEvent

    CanvasScaler

    CanvasUpdateRegistry

    A place where CanvasElements can register themselves for rebuilding.

    ClipperRegistry

    Registry class to keep track of all IClippers that exist in the scene

    Clipping

    Utility class to help when clipping using IClipper.

    ContentSizeFitter

    DefaultControls

    Utility class for creating default implementations of builtin UI controls.

    Dropdown

    Dropdown.DropdownEvent

    Dropdown.DropdownItem

    Dropdown.OptionData

    Dropdown.OptionDataList

    FontData

    FontUpdateTracker

    Utility class that is used to help with Text update.

    Graphic

    Base class for all UI components that should be derived from when creating new Graphic types.

    GraphicRaycaster

    GraphicRebuildTracker

    EditorOnly class for tracking all Graphics. Used when a source asset is reimported into the editor to ensure that Graphics are updated as intended.

    GraphicRegistry

    Registry which maps a Graphic to the canvas it belongs to.

    GridLayoutGroup

    HorizontalLayoutGroup

    HorizontalOrVerticalLayoutGroup

    Abstract base class for HorizontalLayoutGroup and VerticalLayoutGroup to generalize common functionality.

    Image

    Image is a textured element in the UI hierarchy.

    InputField

    Turn a simple label into a interactable input field.

    InputField.EndEditEvent

    InputField.OnChangeEvent

    InputField.SubmitEvent

    LayoutElement

    LayoutGroup

    LayoutRebuilder

    Wrapper class for managing layout rebuilding of CanvasElement.

    LayoutUtility

    Utility functions for querying layout elements for their minimum, preferred, and flexible sizes.

    Mask

    MaskUtilities

    Mask related utility class. This class provides masking-specific utility functions.

    MaskableGraphic

    A Graphic that is capable of being masked out.

    MaskableGraphic.CullStateChangedEvent

    Outline

    PositionAsUV1

    RawImage

    Displays a Texture2D for the UI System.

    RectMask2D

    ScrollRect

    ScrollRect.ScrollRectEvent

    Scrollbar

    Scrollbar.ScrollEvent

    Selectable

    Shadow

    Slider

    Slider.SliderEvent

    StencilMaterial

    Dynamic material class makes it possible to create custom materials on the fly on a per-Graphic basis, and still have them get cleaned up correctly.

    Text

    Toggle

    A standard toggle that has an on / off state.

    Toggle.ToggleEvent

    ToggleGroup

    VertexHelper

    A utility class that can aid in the generation of meshes for the UI.

    VerticalLayoutGroup

    Structs

    ColorBlock

    DefaultControls.Resources

    Object used to pass resources to use for the default controls.

    Navigation

    SpriteState

    Interfaces

    DefaultControls.IFactoryControls

    Factory interface to create a GameObject in this class. It is necessary to use this interface in the whole class so MenuOption and Editor can work using ObjectFactory and default Presets.

    ICanvasElement

    This is an element that can live on a Canvas.

    IClippable

    Interface for elements that can be clipped if they are under an IClipper

    IClipper

    Interface that can be used to recieve clipping callbacks as part of the canvas update loop.

    ILayoutController

    Base interface to be implemented by components that control the layout of RectTransforms.

    ILayoutElement

    A component is treated as a layout element by the auto layout system if it implements ILayoutElement.

    ILayoutGroup

    ILayoutGroup is an ILayoutController that should drive the RectTransforms of its children.

    ILayoutIgnorer

    A RectTransform will be ignored by the layout system if it has a component which implements ILayoutIgnorer.

    ILayoutSelfController

    ILayoutSelfController is an ILayoutController that should drive its own RectTransform.

    IMaskable

    This element is capable of being masked out.

    IMaterialModifier

    Use this interface to modify a Material that renders a Graphic. The Material is modified before the it is passed to the CanvasRenderer.

    IMeshModifier

    Interface which allows for the modification of verticies in a Graphic before they are passed to the CanvasRenderer. When a Graphic generates a list of vertices they are passed (in order) to any components on the GameObject that implement IMeshModifier. This component can modify the given Mesh.

    Enums

    AspectRatioFitter.AspectMode

    Specifies a mode to use to enforce an aspect ratio.

    CanvasScaler.ScaleMode

    Determines how UI elements in the Canvas are scaled.

    CanvasScaler.ScreenMatchMode

    Scale the canvas area with the width as reference, the height as reference, or something in between.

    CanvasScaler.Unit

    The possible physical unit types

    CanvasUpdate

    Values of 'update' called on a Canvas update.

    ContentSizeFitter.FitMode

    The size fit modes avaliable to use.

    GraphicRaycaster.BlockingObjects

    Type of raycasters to check against to check for canvas blocking elements.

    GridLayoutGroup.Axis

    The grid axis we are looking at.

    GridLayoutGroup.Constraint

    Constraint type on either the number of columns or rows.

    GridLayoutGroup.Corner

    Which corner is the starting corner for the grid.

    Image.FillMethod

    The possible fill method types for a Filled Image.

    Image.Origin180

    Origin for the Image.FillMethod.Radial180.

    Image.Origin360

    One of the points of the Arc for the Image.FillMethod.Radial360.

    Image.Origin90

    Origin for the Image.FillMethod.Radial90.

    Image.OriginHorizontal

    Origin for the Image.FillMethod.Horizontal.

    Image.OriginVertical

    Origin for the Image.FillMethod.Vertical.

    Image.Type

    Image fill type controls how to display the image.

    InputField.CharacterValidation

    The type of characters that are allowed to be added to the string.

    InputField.ContentType

    Setting the content type acts as a shortcut for setting a combination of InputType, CharacterValidation, LineType, and TouchScreenKeyboardType

    InputField.EditState

    InputField.InputType

    Type of data expected by the input field mobile keyboard.

    InputField.LineType

    The LineType is used to describe the behavior of the InputField.

    Navigation.Mode

    ScrollRect.MovementType

    A setting for which behavior to use when content moves beyond the confines of its container.

    ScrollRect.ScrollbarVisibility

    Enum for which behavior to use for scrollbar visibility.

    Scrollbar.Direction

    Setting that indicates one of four directions the scrollbar will travel.

    Selectable.SelectionState

    An enumeration of selected states of objects

    Selectable.Transition

    Transition mode for a Selectable.

    Slider.Direction

    Setting that indicates one of four directions.

    Toggle.ToggleTransition

    Display settings for when a toggle is activated or deactivated.

    Delegates

    InputField.OnValidateInput

    In This Article
    Back to top
    Copyright © 2024 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)