class in UnityEngine
/
Inherits from:Component
/
Implemented in:UnityEngine.UIModule
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
CloseFor some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
CloseA component that will render to the screen after all normal rendering has completed when attached to a Canvas. Designed for GUI application.
See Also:Canvas.
absoluteDepth | Depth of the renderer relative to the root canvas. |
clippingSoftness | The clipping softness to apply to the renderer. |
cull | Indicates whether geometry emitted by this renderer is ignored. |
cullTransparentMesh | Indicates whether geometry emitted by this renderer can be ignored when the vertex color alpha is close to zero for every vertex of the mesh. |
hasMoved | True if any change has occured that would invalidate the positions of generated geometry. |
hasPopInstruction | Enable 'render stack' pop draw call. |
hasRectClipping | True if rect clipping has been enabled on this renderer. See Also: CanvasRenderer.EnableRectClipping, CanvasRenderer.DisableRectClipping. |
materialCount | The number of materials usable by this renderer. |
popMaterialCount | The number of materials usable by this renderer. Used internally for masking. |
relativeDepth | Depth of the renderer realative to the parent canvas. |
Clear | Remove all cached vertices. |
DisableRectClipping | Disables rectangle clipping for this CanvasRenderer. |
EnableRectClipping | Enables rect clipping on the CanvasRendered. Geometry outside of the specified rect will be clipped (not rendered). |
GetAlpha | Get the current alpha of the renderer. |
GetColor | Get the current color of the renderer. |
GetInheritedAlpha | Get the final inherited alpha calculated by including all the parent alphas from included parent CanvasGroups. |
GetMaterial | Gets the current Material assigned to the CanvasRenderer. |
GetPopMaterial | Gets the current Material assigned to the CanvasRenderer. Used internally for masking. |
SetAlpha | Set the alpha of the renderer. Will be multiplied with the UIVertex alpha and the Canvas alpha. |
SetAlphaTexture | The Alpha Texture that will be passed to the Shader under the _AlphaTex property. |
SetColor | Set the color of the renderer. Will be multiplied with the UIVertex color and the Canvas color. |
SetMaterial | Set the material for the canvas renderer. If a texture is specified then it will be used as the 'MainTex' instead of the material's 'MainTex'. See Also: CanvasRenderer.SetMaterialCount, CanvasRenderer.SetTexture. |
SetMesh | Sets the Mesh used by this renderer. Note the Mesh must be read/write enabled. |
SetPopMaterial | Set the material for the canvas renderer. Used internally for masking. |
SetTexture | Sets the texture used by this renderer's material. |
AddUIVertexStream | Take the Vertex steam and split it corrisponding arrays (positions, colors, uv0s, uv1s, normals and tangents). |
CreateUIVertexStream | Convert a set of vertex components into a stream of UIVertex. |
SplitUIVertexStreams | Given a list of UIVertex, split the stream into it's component types. |
onRequestRebuild | (Editor Only) Event that gets fired whenever the data in the CanvasRenderer gets invalidated and needs to be rebuilt. |
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. |
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 GameObject has one attached, null if it doesn't. Will also return disabled components. |
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. |
TryGetComponent | Gets the component of the specified type, if it exists. |
GetInstanceID | Returns the instance id of the object. |
ToString | Returns the name of the object. |
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 | Gets a list of all 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. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thanks for helping to make the Unity documentation better!