class in UnityEngine.UI
/
Inherits from:UI.MaskableGraphic
Implements interfaces:ICanvasRaycastFilter, ILayoutElement, ISerializationCallbackReceiver
Displays a Sprite for the UI System.
| defaultETC1GraphicMaterial | Cache of the default Canvas Ericsson Texture Compression 1 (ETC1) and alpha Material. |
| alphaHitTestMinimumThreshold | The alpha threshold specifies the minimum alpha a pixel must have for the event to considered a "hit" on the Image. |
| fillAmount | Amount of the Image shown when the Image.type is set to Image.Type.Filled. |
| fillCenter | Whether or not to render the center of a Tiled or Sliced image. |
| fillClockwise | Whether the Image should be filled clockwise (true) or counter-clockwise (false). |
| fillMethod | What type of fill method to use. |
| fillOrigin | Controls the origin point of the Fill process. Value means different things with each fill method. |
| flexibleHeight | See ILayoutElement.flexibleHeight. |
| flexibleWidth | See ILayoutElement.flexibleWidth. |
| hasBorder | True if the sprite used has borders. |
| layoutPriority | See ILayoutElement.layoutPriority. |
| mainTexture | The image's texture. (ReadOnly). |
| material | The specified Material used by this Image. The default Material is used instead if one wasn't specified. |
| minHeight | See ILayoutElement.minHeight. |
| minWidth | See ILayoutElement.minWidth. |
| overrideSprite | Set an override sprite to be used for rendering. |
| preferredHeight | See ILayoutElement.preferredHeight. |
| preferredWidth | See ILayoutElement.preferredWidth. |
| preserveAspect | Whether this image should preserve its Sprite aspect ratio. |
| sprite | The sprite that is used to render this image. |
| type | How to display the image. |
| useSpriteMesh | Allows you to specify whether the UI Image should be displayed using the mesh generated by the TextureImporter, or by a simple quad mesh. |
| CalculateLayoutInputHorizontal | See ILayoutElement.CalculateLayoutInputHorizontal. |
| CalculateLayoutInputVertical | See ILayoutElement.CalculateLayoutInputVertical. |
| DisableSpriteOptimizations | Disables all automatic sprite optimizations. |
| IsRaycastLocationValid | See:ICanvasRaycastFilter. |
| OnAfterDeserialize | Serialization Callback. |
| OnBeforeSerialize | Serialization Callback. |
| SetNativeSize | Adjusts the image size to make it pixel-perfect. |
| defaultGraphicMaterial | Default material used to draw UI elements if no explicit material was specified. |
| enabled | Enabled Behaviours are Updated, disabled Behaviours are not. |
| isActiveAndEnabled | Has the Behaviour had active and enabled called? |
| gameObject | The game object this component is attached to. A component is always attached to a game object. |
| tag | The tag of this game object. |
| transform | The Transform attached to this GameObject. |
| canvas | A reference to the Canvas this Graphic is rendering to. |
| canvasRenderer | The CanvasRenderer used by this Graphic. |
| color | Base color of the Graphic. |
| defaultMaterial | Returns the default material for the graphic. |
| depth | Absolute depth of the graphic in the hierarchy, used by rendering and events. |
| mainTexture | The graphic's texture. (Read Only). |
| material | The Material set by the user. |
| materialForRendering | The material that will be sent for Rendering (Read only). |
| raycastTarget | Should this graphic be considered a target for raycasting? |
| rectTransform | The RectTransform component used by the Graphic. |
| maskable | Does this graphic allow masking. |
| onCullStateChanged | Callback issued when culling changes. |
| runInEditMode | Allow a specific instance of a MonoBehaviour to run in edit mode (only available in the editor). |
| useGUILayout | Disabling this lets you skip the GUI layout phase. |
| hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
| name | The name of the object. |
| BroadcastMessage | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
| CompareTag | Is this game object tagged with tag ? |
| GetComponent | Returns the component of Type type if the game object has one attached, null if it doesn't. |
| GetComponentInChildren | Returns the component of Type type in the GameObject or any of its children using depth first search. |
| GetComponentInParent | Returns the component of Type type in the GameObject or any of its parents. |
| GetComponents | Returns all components of Type type in the GameObject. |
| GetComponentsInChildren | Returns all components of Type type in the GameObject or any of its children. |
| GetComponentsInParent | Returns all components of Type type in the GameObject or any of its parents. |
| SendMessage | Calls the method named methodName on every MonoBehaviour in this game object. |
| SendMessageUpwards | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
| CrossFadeAlpha | Tweens the alpha of the CanvasRenderer color associated with this Graphic. |
| CrossFadeColor | Tweens the CanvasRenderer color associated with this Graphic. |
| GetPixelAdjustedRect | Returns a pixel perfect Rect closest to the Graphic RectTransform. |
| GraphicUpdateComplete | See ICanvasElement.GraphicUpdateComplete. |
| LayoutComplete | See ICanvasElement.LayoutComplete. |
| OnCullingChanged | Callback function to call when the culling has changed. |
| OnRebuildRequested | Editor-only callback that is issued by Unity if a rebuild of the Graphic is required. |
| PixelAdjustPoint | Adjusts the given pixel to be pixel perfect. |
| Raycast | When a GraphicRaycaster is raycasting into the Scene it does two things. First it filters the elements using their RectTransform rect. Then it uses this Raycast function to determine the elements hit by the raycast. |
| Rebuild | Rebuilds the graphic geometry and its material on the PreRender cycle. |
| RegisterDirtyLayoutCallback | Add a listener to receive notification when the graphics layout is dirtied. |
| RegisterDirtyMaterialCallback | Add a listener to receive notification when the graphics material is dirtied. |
| RegisterDirtyVerticesCallback | Add a listener to receive notification when the graphics vertices are dirtied. |
| SetAllDirty | Mark the Graphic as dirty. |
| SetLayoutDirty | Mark the layout as dirty. |
| SetMaterialDirty | Mark the Material as dirty. |
| SetVerticesDirty | Mark the vertices as dirty. |
| UnregisterDirtyLayoutCallback | Remove a listener from receiving notifications when the graphics layout is dirtied. |
| UnregisterDirtyMaterialCallback | Remove a listener from receiving notifications when the graphics material is dirtied. |
| UnregisterDirtyVerticesCallback | Remove a listener from receiving notifications when the graphics vertices are dirtied. |
| Cull | See IClippable.Cull. |
| GetModifiedMaterial | See IMaterialModifier.GetModifiedMaterial. |
| RecalculateClipping | See: IClippable.RecalculateClipping. |
| RecalculateMasking | See: IMaskable.RecalculateMasking. |
| SetClipRect | See IClippable.SetClipRect. |
| CancelInvoke | Cancels all Invoke calls on this MonoBehaviour. |
| Invoke | Invokes the method methodName in time seconds. |
| InvokeRepeating | Invokes the method methodName in time seconds, then repeatedly every repeatRate seconds. |
| IsInvoking | Is any invoke on methodName pending? |
| StartCoroutine | Starts a coroutine. |
| StopAllCoroutines | Stops all coroutines running on this behaviour. |
| StopCoroutine | Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour. |
| GetInstanceID | Returns the instance id of the object. |
| ToString | Returns the name of the GameObject. |
| IsActive | Returns true if the GameObject and the Component are active. |
| IsDestroyed | Returns true if the native representation of the behaviour has been destroyed. |
| OnDisable | See MonoBehaviour.OnDisable. |
| OnPopulateMesh | Callback function when a UI element needs to generate vertices. |
| UpdateGeometry | Call to update the geometry of the Graphic onto the CanvasRenderer. |
| UpdateMaterial | Call to update the Material of the graphic onto the CanvasRenderer. |
| OnDisable | See MonoBehaviour.OnDisable. |
| Awake | See MonoBehaviour.Awake. |
| OnBeforeTransformParentChanged | See MonoBehaviour.OnBeforeTransformParentChanged. |
| OnCanvasGroupChanged | See MonoBehaviour.OnCanvasGroupChanged. |
| OnCanvasHierarchyChanged | Called when the state of the parent Canvas is changed. |
| OnDestroy | See MonoBehaviour.OnDestroy. |
| OnDidApplyAnimationProperties | See LayoutGroup.OnDidApplyAnimationProperties. |
| OnDisable | See MonoBehaviour.OnDisable. |
| OnEnable | See MonoBehaviour.OnEnable. |
| OnRectTransformDimensionsChange | This callback is called if an associated RectTransform has its dimensions changed. |
| OnTransformParentChanged | See MonoBehaviour.OnRectTransformParentChanged. |
| OnValidate | See MonoBehaviour.OnValidate. |
| Reset | See MonoBehaviour.Reset. |
| Start | See MonoBehaviour.Start. |
| Logs message to the Unity Console (identical to Debug.Log). | |
| Destroy | Removes a gameobject, component or asset. |
| DestroyImmediate | Destroys the object obj immediately. You are strongly recommended to use Destroy instead. |
| DontDestroyOnLoad | Do not destroy the target Object when loading a new Scene. |
| FindObjectOfType | Returns the first active loaded object of Type type. |
| FindObjectsOfType | Returns a list of all active loaded objects of Type type. |
| Instantiate | Clones the object original and returns the clone. |
| bool | Does the object exist? |
| operator != | Compares if two objects refer to a different object. |
| operator == | Compares two object references to see if they refer to the same object. |
| Awake | Awake is called when the script instance is being loaded. |
| FixedUpdate | Frame-rate independent MonoBehaviour.FixedUpdate message for physics calculations. |
| LateUpdate | LateUpdate is called every frame, if the Behaviour is enabled. |
| OnAnimatorIK | Callback for setting up animation IK (inverse kinematics). |
| OnAnimatorMove | Callback for processing animation movements for modifying root motion. |
| OnApplicationFocus | Sent to all GameObjects when the player gets or loses focus. |
| OnApplicationPause | Sent to all GameObjects when the application pauses. |
| OnApplicationQuit | Sent to all game objects before the application quits. |
| OnAudioFilterRead | If OnAudioFilterRead is implemented, Unity will insert a custom filter into the audio DSP chain. |
| OnBecameInvisible | OnBecameInvisible is called when the renderer is no longer visible by any camera. |
| OnBecameVisible | OnBecameVisible is called when the renderer became visible by any camera. |
| OnCollisionEnter | OnCollisionEnter is called when this collider/rigidbody has begun touching another rigidbody/collider. |
| OnCollisionEnter2D | Sent when an incoming collider makes contact with this object's collider (2D physics only). |
| OnCollisionExit | OnCollisionExit is called when this collider/rigidbody has stopped touching another rigidbody/collider. |
| OnCollisionExit2D | Sent when a collider on another object stops touching this object's collider (2D physics only). |
| OnCollisionStay | :ref::OnCollisionStay is called once per frame for every collider/rigidbody that is touching rigidbody/collider. |
| OnCollisionStay2D | Sent each frame where a collider on another object is touching this object's collider (2D physics only). |
| OnConnectedToServer | Called on the client when you have successfully connected to a server. |
| OnControllerColliderHit | OnControllerColliderHit is called when the controller hits a collider while performing a Move. |
| OnDestroy | Destroying the attached Behaviour will result in the game or Scene receiving OnDestroy. |
| OnDisable | This function is called when the behaviour becomes disabled. |
| OnDisconnectedFromServer | Called on the client when the connection was lost or you disconnected from the server. |
| OnDrawGizmos | Implement OnDrawGizmos if you want to draw gizmos that are also pickable and always drawn. |
| OnDrawGizmosSelected | Implement OnDrawGizmosSelected to draw a gizmo if the object is selected. |
| OnEnable | This function is called when the object becomes enabled and active. |
| OnFailedToConnect | Called on the client when a connection attempt fails for some reason. |
| OnFailedToConnectToMasterServer | Called on clients or servers when there is a problem connecting to the MasterServer. |
| OnGUI | OnGUI is called for rendering and handling GUI events. |
| OnJointBreak | Called when a joint attached to the same game object broke. |
| OnJointBreak2D | Called when a Joint2D attached to the same game object breaks. |
| OnMasterServerEvent | Called on clients or servers when reporting events from the MasterServer. |
| OnMouseDown | OnMouseDown is called when the user has pressed the mouse button while over the GUIElement or Collider. |
| OnMouseDrag | OnMouseDrag is called when the user has clicked on a GUIElement or Collider and is still holding down the mouse. |
| OnMouseEnter | Called when the mouse enters the GUIElement or Collider. |
| OnMouseExit | Called when the mouse is not any longer over the GUIElement or Collider. |
| OnMouseOver | Called every frame while the mouse is over the GUIElement or Collider. |
| OnMouseUp | OnMouseUp is called when the user has released the mouse button. |
| OnMouseUpAsButton | OnMouseUpAsButton is only called when the mouse is released over the same GUIElement or Collider as it was pressed. |
| OnNetworkInstantiate | Called on objects which have been network instantiated with Network.Instantiate. |
| OnParticleCollision | OnParticleCollision is called when a particle hits a Collider. |
| OnParticleSystemStopped | OnParticleSystemStopped is called when all particles in the system have died, and no new particles will be born. New particles cease to be created either after Stop is called, or when the duration property of a non-looping system has been exceeded. |
| OnParticleTrigger | OnParticleTrigger is called when any particles in a Particle System meet the conditions in the trigger module. |
| OnPlayerConnected | Called on the server whenever a new player has successfully connected. |
| OnPlayerDisconnected | Called on the server whenever a player disconnected from the server. |
| OnPostRender | OnPostRender is called after a camera finished rendering the Scene. |
| OnPreCull | OnPreCull is called before a camera culls the Scene. |
| OnPreRender | OnPreRender is called before a camera starts rendering the Scene. |
| OnRenderImage | OnRenderImage is called after all rendering is complete to render image. |
| OnRenderObject | OnRenderObject is called after camera has rendered the Scene. |
| OnSerializeNetworkView | Used to customize synchronization of variables in a script watched by a network view. |
| OnServerInitialized | Called on the server whenever a Network.InitializeServer was invoked and has completed. |
| OnTransformChildrenChanged | This function is called when the list of children of the transform of the GameObject has changed. |
| OnTransformParentChanged | This function is called when the parent property of the transform of the GameObject has changed. |
| OnTriggerEnter | OnTriggerEnter is called when the GameObject collides with another GameObject. |
| OnTriggerEnter2D | Sent when another object enters a trigger collider attached to this object (2D physics only). |
| OnTriggerExit | OnTriggerExit is called when the Collider other has stopped touching the trigger. |
| OnTriggerExit2D | Sent when another object leaves a trigger collider attached to this object (2D physics only). |
| OnTriggerStay | OnTriggerStay is called once per physics update for every Collider other that is touching the trigger. |
| OnTriggerStay2D | Sent each frame where another object is within a trigger collider attached to this object (2D physics only). |
| OnValidate | This function is called when the script is loaded or a value is changed in the Inspector (Called in the editor only). |
| OnWillRenderObject | OnWillRenderObject is called for each camera if the object is visible and not a UI element. |
| Reset | Reset to default values. |
| Start | Start is called on the frame when a script is enabled just before any of the Update methods are called the first time. |
| Update | Update is called every frame, if the MonoBehaviour is enabled. |