UnityEngine.AccessibilityModule

Represents the hierarchy data model that the screen reader uses for reading and navigating the UI.

The root nodes of the hierarchy.

Creates and adds a new node with the given label in this hierarchy under the given parent node. If no parent is provided, the new node is added as a root in the hierarchy.

A label that succinctly describes the accessibility node. The parent of the node being added. When the value given is null, the created node is placed at the root level. The node created and added.

Resets the hierarchy to an empty state, removing all the nodes and removing focus.

Returns whether a given node exists in the hierarchy.

The node to search for in the hierarchy. Whether the node exists in this hierarchy.

Initializes and returns an instance of an AccessibilityHierarchy.

Retrieves the lowest common ancestor of two nodes in the hierarchy. The lowest common ancestor is the node that is the common node that both nodes share in their path to the root node of their branch in the hierarchy.

The first node to find the lowest common ancestor of. The second node to find the lowest common ancestor of. The lowest common ancestor of the two given nodes, or null if there is no common ancestor.

Creates and inserts a new node with the given label at the given index in this hierarchy under the given parent node. If no parent is provided, the new node is inserted at the given index as a root in the hierarchy.

A zero-based index for positioning the inserted node in the parent's children list, or in the list of roots if the node is a root node. If the index is invalid, the inserted node will be the last child of its parent (or the last root node). A label that succinctly describes the accessibility node. The parent of the node being added. When the value given is null, the created node is placed at the root level. The node created and inserted.

Moves the node elsewhere in the hierarchy, which causes the given node to be parented by a different node in the hierarchy. An optional index can be supplied for specifying the position within the list of children the moved node should take (zero-based). If no index is supplied, the node is added as the last child of the new parent by default. Root nodes can be moved elsewhere in the hierarchy, therefore ceasing to be a root. Non-root nodes can be moved to become a root node by providing null as the new parent node. Warning: The moving operation is costly as many checks have to be executed to guarantee the integrity of the hierarchy. Therefore this operation should not be done excessively as it may affect performance.

The node to move. The new parent of the moved node, or null if the moved node should be made into a root node. An optional zero-based index for positioning the moved node in the new parent's children list, or in the list of roots if the node is becoming a root node. If the index is not provided or is invalid, the moved node will be the last child of its parent. Whether the node was successfully moved.

Refreshes all the node frames (i.e. the screen elements' positions) for the hierarchy.

Removes the node from the hierarchy. Can also optionally remove nodes under the given node depending on the value of the removeChildren parameter.

The node to remove. Default value is true. If removeChildren is false, Unity grafts the child nodes to the parent.

Tries to get the node in this hierarchy that has the given ID.

The ID of the node to retrieve. The valid node with the associated ID, or null if no such node exists in this hierarchy. Returns true if a node is found and false otherwise.

Tries to retrieve the node at the given position on the screen.

The horizontal position on the screen. The vertical position on the screen. The node found at that screen position, or null if there are no nodes at that position. Returns true if a node is found and false otherwise.

An instance of a node in the AccessibilityHierarchy, representing an element in the UI that the screen reader can read, focus, and execute actions on.

Whether this node allows direct touch interaction for users.

The children nodes of the node.

Called when the user of the screen reader decrements the content of the node.

Called when the user of the screen reader dismisses this node.

Called when the node gains or loses screen reader focus.

The Rect represents the position in screen coordinates of the node in the UI. This can be set directly but it is recommended that frameGetter is set instead, so that the value can be recalculated when necessary.

Optional delegate that can be set to calculate the frame for the node instead of setting a flat value. If the frame of the node may change over time, this delegate should be set instead of giving a one time value for the frame.

Provides additional information about the accessibility node. For example, the result of performing an action on the node.

The ID of this node.

Called when the user of the screen reader increments the content of the node.

Whether this node is active in the hierarchy. The default value is true.

Whether the node is focused by the screen reader.

A string value that succinctly describes this node. The label is the first thing read by the screen reader when a node is focused.

The parent of the node. If the node is at the root level, the parent value is null.

The role for the node.

Called when the user of the screen reader selects this node.

The state for the node.

The value of this node.

A hash used for comparisons.

A unique hash code.

Provides a debugging string.

A string containing the accessibility node ID and generational version.

Describes the role of an accessibility node.

The accessibility node behaves like a button.

The accessibility node behaves like a header that divides content into sections (for example, the title of a navigation bar).

The accessibility node behaves like an image.

The accessibility node behaves like a keyboard key.

The accessibility node has no roles.

The accessibility node behaves like a search field.

The accessibility node behaves like a slider. The value of this node can be continuously adjusted through a range.

The accessibility node behaves like static text that can't change.

The accessibility node behaves like an ordered list of tabs.

The accessibility node behaves like a toggle.

Provides access to the accessibility settings for the current platform.

Event that is invoked on the main thread when the user changes the bold text setting in the system settings.

Event that is invoked on the main thread when the user changes the closed captioning setting in the system settings.

Gets the font scale set by the user in the system settings.

Event that is invoked on the main thread when the user changes the font scale in the system settings.

Checks whether or not bold text is enabled in the system settings.

Checks whether or not closed captioning is enabled in the system settings.

Describes the state of an accessibility node.

The accessibility node is currently in a disabled state and does not respond to user interaction.

The accessibility node is in none of the other states.

The accessibility node is currently in a selected state (for example, a selected row in a table or a selected button within a segmented control).

Access point to assistive technology support APIs.

The active AccessibilityHierarchy for the screen reader. May be null if no hierarchy is active. You need an active accessibility hierarchy to present any content to the user through the screen reader. If the screen reader is off, there is no active hierarchy. If the screen reader is turned off on the device while an active hierarchy is set, the active hierarchy is automatically set to null. For all the supported platforms, refer to AssistiveSupport.

Whether the screen reader is enabled on the operating system. For all the supported platforms, refer to AssistiveSupport.

Event that is invoked on the main thread when the screen reader focus changes. For all the supported platforms, refer to AssistiveSupport.

Service used to send accessibility notifications to the screen reader. For all the supported platforms, refer to AssistiveSupport.

Event that is invoked on the main thread when the screen reader is enabled or disabled. For all the supported platforms, refer to AssistiveSupport.

Sends accessibility notifications to the screen reader.

Sends a notification to the screen reader conveying an announcement. Use this notification to provide accessibility information about events that don't update the app's UI, or that update the UI only briefly.

The string representing the announcement.

Sends a notification to the screen reader when the layout of a screen changes (for example, when an individual element appears or disappears). An optional parameter can be used to request the screen reader focus on a specific node after processing the notification.

Optional node to be focused by the screen reader.

Sends a notification to the screen reader when the screen has changed considerably. An optional parameter can be used to request the screen reader focus on a specific node after processing the notification.

Optional node to be focused by the screen reader.

A class containing methods to assist with accessibility for users with different vision capabilities.

Gets a palette of colors that should be distinguishable for normal vision, deuteranopia, protanopia, and tritanopia.

An array of colors to populate with a palette. Minimum allowable perceived luminance from 0 to 1. A value of 0.2 or greater is recommended for dark backgrounds. Maximum allowable perceived luminance from 0 to 1. A value of 0.8 or less is recommended for light backgrounds. The number of unambiguous colors in the palette.

The Accessibility module includes utilities to facilitate the development of accessible user experiences in Unity.