Canvas

класс в UnityEngine / Наследует от: Behaviour / Реализовано в: UnityEngine.UIModule

Описание

Элемент, который можно использовать для рендеринга экрана.

Элементы на холсте визуализируются ПОСЛЕ визуализации сцены либо с подключенной камеры, либо в режиме наложения.

using System.Collections;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;
using UnityEngine.UI;

// Create a Canvas that holds a Text GameObject.

public class ExampleClass : MonoBehaviour
{
    void Start()
    {
        GameObject myGO;
        GameObject myText;
        Canvas myCanvas;
        Text text;
        RectTransform rectTransform;

        // Canvas
        myGO = new GameObject();
        myGO.name = "TestCanvas";
        myGO.AddComponent<Canvas>();

        myCanvas = myGO.GetComponent<Canvas>();
        myCanvas.renderMode = RenderMode.ScreenSpaceOverlay;
        myGO.AddComponent();
        myGO.AddComponent();

        // Text
        myText = new GameObject();
        myText.transform.parent = myGO.transform;
        myText.name = "wibble";

        text = myText.AddComponent();
        text.font = (Font)Resources.Load("MyFont");
        text.text = "wobble";
        text.fontSize = 100;

        // Text position
        rectTransform = text.GetComponent<RectTransform>();
        rectTransform.localPosition = new Vector3(0, 0, 0);
        rectTransform.sizeDelta = new Vector2(400, 200);
    }
}

Свойства

additionalShaderChannels	Получает или устанавливает маску дополнительных каналов шейдера, которые будут использоваться при создании сетки Canvas.
cachedSortingLayerValue	Кэшированное вычисляемое значение на основе SortingLayerID.
isRootCanvas	Это корневой холст?
normalizedSortingGridSize	Нормализованный размер сетки, на который холст разделит визуализируемую область.
overridePixelPerfect	Позволяет вложенным холстам переопределять настройки pixelPerfect, унаследованные от родительских холстов.
overrideSorting	Переопределяет сортировку холста.
pixelPerfect	Принудительное выравнивание элементов на холсте по пикселям. Применяется только с режимом рендеринга "Пространство экрана".
pixelRect	Получает прямоугольник рендеринга для Canvas.
planeDistance	На каком расстоянии от камеры создается холст.
referencePixelsPerUnit	Количество пикселей на единицу, которое считается значением по умолчанию.
renderingDisplaySize	Возвращает размер экрана холста на основе выбранного режима рендеринга и целевого дисплея.
renderMode	Находится ли холст в общем режиме или в режиме наложения?
renderOrder	Порядок рендеринга, в котором холст передается в сцену. (Только чтение)
rootCanvas	Возвращает холст, ближайший к корню, проверяя каждого родителя и возвращая последний найденный холст. Если другой холст не найден, холст вернется сам.
scaleFactor	Используется для масштабирования всего холста, сохраняя при этом размер экрана. Применяется только с режимом рендеринга "Пространство экрана".
sortingLayerID	Уникальный идентификатор слоя сортировки Canvas.
sortingLayerName	Имя слоя сортировки Canvas.
sortingOrder	Порядок холста в слое сортировки.
targetDisplay	Для режима наложения индекс отображения, на котором будет отображаться холст пользовательского интерфейса.
worldCamera	Камера, используемая для изменения размера холста в режиме "Пространство экрана — Камера". Также используется в качестве камеры, через которую будут отправляться события для мирового пространства [[Canvas].

Статические Методы

ForceUpdateCanvases	Принудительное обновление содержимого всех холстов.
GetDefaultCanvasMaterial	Возвращает материал по умолчанию, который можно использовать для визуализации обычных элементов на холсте.
GetETC1SupportedCanvasMaterial	Получает или создает Материал ETC1.

События

preWillRenderCanvases	Событие, вызываемое непосредственно перед отрисовкой Canvas.
willRenderCanvases	Событие, вызываемое непосредственно перед отрисовкой Canvas.

Унаследованные члены

Свойства

enabled	Включенные поведения обновляются, отключенные — нет.
isActiveAndEnabled	Было ли поведение активным и включенным?
gameObject	Игровой объект, к которому прикреплен компонент. Компонент всегда привязан к игровому объекту.
tag	Тег игрового объекта.
transform	Transform, прикрепленный игровому объекту.
hideFlags	Должен ли объект быть скрыт, сохранен вместе со сценой или изменен пользователем?
name	Имя объекта

Публичные Методы

BroadcastMessage	Вызывает метод с именем methodName для каждого MonoBehaviour в игровом объекте или любом из его дочерних элементов.
CompareTag	Помечен ли этот игровой объект тегом?
GetComponent	Возвращает компонент, если он прикреплён к игровому объекту, и null, если нет. Также возвращает отключенные компоненты.
GetComponentInChildren	Возвращает компонент дочернего элемента игрового объекта, используя поиск в глубину.
GetComponentInParent	Возвращает компонент игрового объекта в любом из его родителей.
GetComponents	Возвращает все компоненты игрового объекта
GetComponentsInChildren	Возвращает все компоненты дочерних элементов игрового объекта. Работает рекурсивно.
GetComponentsInParent	Возвращает все компоненты игрового объекта любого из родителя.
SendMessage	Вызывает метод с именем methodName для каждого MonoBehaviour в этом игровом объекте.
SendMessageUpwards	Вызывает метод с именем methodName для каждого MonoBehaviour в этом игровом объекте и для каждого behaviour.
TryGetComponent	Получает компонент указанного типа, если он существует.
GetInstanceID	Возвращает идентификатор экземпляра объекта.
ToString	Возвращает имя объекта.

Статические Методы

Destroy	Удаляет игровой объект, компонент или актив.
DestroyImmediate	Уничтожает объект obj. Настоятельно рекомендуется использовать Destroy.
DontDestroyOnLoad	Не уничтожает целевой объект при загрузке новой сцены.
FindObjectOfType	Возвращает первый активный загруженный объект.
FindObjectsOfType	Получает список всех загруженных объектов.
Instantiate	Клонирует исходный объект и возвращает клон.

Операторы

bool	Объект существует?
operator !=	Сравнивает, ссылаются ли два объекта на другой объект.
operator ==	Сравнивает две ссылки на объекты, чтобы определить, ссылаются ли они на один и тот же объект.

Вы можете отблагодарить автора, за перевод документации на русский язык. ₽ Спасибо