UnityEngine.UIModule

Enum mask of possible shader channel properties that can also be included when the Canvas mesh is created.

No additional shader parameters are needed.

Include the normals on the mesh vertices.

Include the Tangent on the mesh vertices.

Include UV1 on the mesh vertices.

Include UV2 on the mesh vertices.

Include UV3 on the mesh vertices.

Element that can be used for screen rendering.

Get or set the mask of additional shader channels to be used when creating the Canvas mesh.

Cached calculated value based upon SortingLayerID.

Is this the root Canvas?

The normalized grid size that the canvas will split the renderable area into.

Allows for nested canvases to override pixelPerfect settings inherited from parent canvases.

Allows for nested canvases to override the Canvas.sortingOrder from parent canvases.

Forces pixel alignment for elements in the canvas. It only applies when Canvas.renderMode is set to Screen Space.

Get the render rect for the Canvas.

How far away from the camera is the Canvas generated? It only applies when Canvas.renderMode is set to RenderMode.ScreenSpaceCamera.

Event that is called just before Canvas rendering happens.

The number of pixels per unit that is considered the default.

Returns the canvas display size based on the selected render mode and target display.

Is the Canvas in World or Overlay mode?

The render order in which the canvas is being emitted to the Scene. (Read Only)

Returns the Canvas closest to root, by checking through each parent and returning the last canvas found. If no other canvas is found then the canvas will return itself.

Scales the entire canvas, ensuring it fits the screen. It only applies when Canvas.renderMode is set to Screen Space.

The normalized grid size that the canvas will split the renderable area into.

Unique ID of the Canvas' sorting layer.

Name of the Canvas' sorting layer.

Canvas' order within a sorting layer.

For Overlay mode, display index on which the UI canvas will appear.

Should the Canvas size be updated based on the render target when a manual Camera.Render call is performed.

Should the Canvas vertex color always be in gamma space before passing to the UI shaders in linear color space work flow.

Event that is called just before Canvas rendering happens.

Camera used for sizing the Canvas when in Screen Space - Camera. Also used as the Camera that events will be sent through for a World Space Canvas.

Force all canvases to update their content.

Returns the default material that can be used for rendering normal elements on the Canvas.

Returns the default material that can be used for rendering text elements on the Canvas.

Gets or generates the ETC1 Material.

The generated ETC1 Material from the Canvas.

A Canvas placable element that can be used to modify children Alpha, Raycasting, Enabled state.

Set the alpha of the group.

Does this group block raycasting (allow collision).

Should the group ignore parent groups?

Is the group interactable (are the elements beneath the group enabled).

Returns true if the Group allows raycasts.

A component that will render to the screen after all normal rendering has completed when attached to a Canvas. Designed for GUI application.

Depth of the renderer relative to the root canvas.

The clipping softness to apply to the renderer.

Indicates whether geometry emitted by this renderer is ignored.

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.

True if any change has occured that would invalidate the positions of generated geometry.

Enable 'render stack' pop draw call.

True if rect clipping has been enabled on this renderer. Additional resources: CanvasRenderer.EnableRectClipping, CanvasRenderer.DisableRectClipping.

Is the UIRenderer a mask component.

The number of materials usable by this renderer.

(Editor Only) Event that gets fired whenever the data in the CanvasRenderer gets invalidated and needs to be rebuilt.

The number of materials usable by this renderer. Used internally for masking.

Depth of the renderer realative to the parent canvas.

Take the Vertex stream and split it corrisponding arrays (positions, colors, uv0s, uv1s, normals and tangents).

The UIVertex list to split. The destination list for the verts positions. The destination list for the verts colors. The destination list for the verts uv0s. The destination list for the verts uv1s. The destination list for the verts normals. The destination list for the verts tangents.

Remove all cached vertices.

Convert a set of vertex components into a stream of UIVertex.

Convert a set of vertex components into a stream of UIVertex.

Disables rectangle clipping for this CanvasRenderer.

Enables rect clipping on the CanvasRendered. Geometry outside of the specified rect will be clipped (not rendered).

Get the current alpha of the renderer.

Get the current color of the renderer.

Get the final inherited alpha calculated by including all the parent alphas from included parent CanvasGroups.

The calculated inherited alpha.

Gets the current Material assigned to the CanvasRenderer.

The material index to retrieve (0 if this parameter is omitted). Result.

Gets the current Material assigned to the CanvasRenderer.

The material index to retrieve (0 if this parameter is omitted). Result.

Returns the current mesh used to render the canvas content into.

The current mesh for the canvas.

Gets the current Material assigned to the CanvasRenderer. Used internally for masking.

Set the alpha of the renderer. Will be multiplied with the UIVertex alpha and the Canvas alpha.

Alpha.

The Alpha Texture that will be passed to the Shader under the _AlphaTex property.

The Texture to be passed.

Set the color of the renderer. Will be multiplied with the UIVertex color and the Canvas color.

Renderer multiply color.

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'. Additional resources: CanvasRenderer.materialCount, CanvasRenderer.SetTexture.

Material for rendering. Material texture overide. Material index.

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'. Additional resources: CanvasRenderer.materialCount, CanvasRenderer.SetTexture.

Material for rendering. Material texture overide. Material index.

Sets the Mesh used by this renderer. Note the Mesh must be read/write enabled.

Set the material for the canvas renderer. Used internally for masking.

Sets the texture used by this renderer's material.

Set the vertices for the UIRenderer.

Array of vertices to set. Number of vertices to set.

Set the vertices for the UIRenderer.

Array of vertices to set. Number of vertices to set.

Given a list of UIVertex, split the stream into it's component types.

This element can filter raycasts. If the top level element is hit it can further 'check' if the location is valid.

Given a point and a camera is the raycast valid.

Screen position. Raycast camera. Valid.

Utility class containing helper methods for working with RectTransform.

Creates a Bounds object that encapsulates all the child RectTransform objects found in the child parameter, and converts the resulting bounds into local space relative to the root transform.

The Transform to use when converting from world to local space. The parent Transform object whose RectTransform children will be encapsulated. The Transform to both search for RectTransform children and convert into world to local space. A Bounds object representing the encapsulated bounds in local space relative to the root Transform.

Creates a Bounds object that encapsulates all the child RectTransform objects found in the child parameter, and converts the resulting bounds into local space relative to the root transform.

The Transform to use when converting from world to local space. The parent Transform object whose RectTransform children will be encapsulated. The Transform to both search for RectTransform children and convert into world to local space. A Bounds object representing the encapsulated bounds in local space relative to the root Transform.

Flips the horizontal and vertical axes of the RectTransform size and alignment, and optionally its children as well.

The RectTransform to flip. Flips around the pivot if true. Flips within the parent rect if false. Flip the children as well?

Flips the alignment of the RectTransform along the horizontal or vertical axis, and optionally its children as well.

The RectTransform to flip. Flips around the pivot if true. Flips within the parent rect if false. Flip the children as well? The axis to flip along. 0 is horizontal and 1 is vertical.

Convert a given point in screen space into a pixel correct point.

Pixel adjusted point.

Given a rect transform, return the corner points in pixel accurate coordinates.

Pixel adjusted rect.

Does the RectTransform contain the screen point?

The RectTransform to test with. The screen point to test. True if the point is inside the rectangle.

Does the RectTransform contain the screen point as seen from the given camera?

The RectTransform to test with. The screen point to test. The camera from which the test is performed from. (Optional) True if the point is inside the rectangle.

Does the RectTransform, with the given offset, contain the screen point as seen from the given camera?

The RectTransform to test with. The screen point to test. The camera from which the test is performed from. (Optional) The offset to apply to the RectTransform. True if the point is inside the rectangle.

Transform a screen space point to a position in the local space of a RectTransform that is on the plane of its rectangle.

The RectTransform to find a point inside. Screen space position. The camera associated with the screen space position. Point in local space of the rect transform. Returns true if the plane of the RectTransform is hit, regardless of whether the point is inside the rectangle.

Transforms a screen space position into a ray.

The camera from which the ray originates. (Optional) The screen point. The ray going from camera through the screen point if the camera is given, or from the screen point going forward if no camera is given.

Transform a screen space point to a position in world space that is on the plane of the given RectTransform.

The RectTransform to find a point inside. Screen space position. The camera associated with the screen space position. Point in world space. Returns true if the plane of the RectTransform is hit, regardless of whether the point is inside the rectangle.

Transforms a position in world space into a screen space point.

The camera associated with the screen space position. (Optional) Point in world space. Returns the screen point.

RenderMode for the Canvas.

Render using the Camera configured on the Canvas.

Render at the end of the Scene using a 2D Canvas.

Render using any Camera in the Scene that can render the layer.

Enum used to determine if a Canvas should be resized when a manual Camera.Render call is performed.

Do not resize the Canvas when a manual Camera.Render call is performed.

Resize the Canvas when a manual Camera.Render call is performed.

The UI module implements basic components required for Unity's UI system