CanvasRenderer
class in UnityEngine
/
Inherits from:Component
/
Implemented in:UnityEngine.UIModule
Switch to Manual
Description 描述
A 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.
Properties 属性
| absoluteDepth | Depth of the renderer relative to the root canvas. | ||
| 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. |
Public Methods 公共方法
| 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. |
Static Methods 静态方法
| 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. |
Events
| onRequestRebuild | (Editor Only) Event that gets fired whenever the data in the CanvasRenderer gets invalidated and needs to be rebuilt. |
Inherited Members 继承成员
Properties 属性
| 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. |
Public Methods 公共方法
| 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. | ||
| 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. |
Static Methods 静态方法
| 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. |
Operators 运算符
| 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. |