Version: 2017.3

CanvasScaler

class in UnityEngine.UI

/

继承自:EventSystems.UIBehaviour

切换到手册

描述

Canvas Scaler 组件用于控制画布中 UI 元素的整体缩放和像素密度。此缩放会影响画布下的所有内容,包括字体大小和图像边框。

对于设置为“Screen Space - Overlay”或“Screen Space - Camera”的画布,画布缩放器“UI Scale Mode”可以设置为“Constant Pixel Size”、“Scale With Screen Size”或“Constant Physical Size”。

使用“Constant Pixel Size”模式时,可在屏幕上按像素指定 UI 元素的位置和大小。这也是画布在未附加任何画布缩放器时的默认功能。但是,借助画布缩放器中的“Scale Factor”设置,可以向画布中的所有 UI 元素应用常量缩放。

Using the Scale With Screen Size mode, positions and sizes can be specified according to the pixels of a specified reference resolution. If the current screen resolution is larger then the reference resolution, the Canvas will keep having only the resolution of the reference resolution, but will scale up in order to fit the screen. If the current screen resolution is smaller than the reference resolution, the Canvas will similarly be scaled down to fit. If the current screen resolution has a different aspect ratio than the reference resolution, scaling each axis individually to fit the screen would result in non-uniform scaling, which is generally undesirable. Instead of this, the ReferenceResolution component will make the Canvas resolution deviate from the reference resolution in order to respect the aspect ratio of the screen. It is possible to control how this deviation should behave using the screenMatchMode setting.

使用“Constant Physical Size”模式时,可按物理单位(如毫米、点或派卡)指定 UI 元素的位置和大小。此模式依赖于正确报告其屏幕 DPI 的设备。对于不报告 DPI 的设备,可以指定回退 DPI。

对于设置为“World Space”的画布,画布缩放器组件可以用于控制画布中 UI 元素的像素密度。

另请参阅:Canvas

变量

defaultSpriteDPI用于 Sprite 的每英寸像素,使其“Pixels Per Unit”设置与“Reference Pixels Per Unit”设置匹配。
dynamicPixelsPerUnit用于 UI 中动态创建的位图(如文本)的每单位像素量。
fallbackScreenDPI在屏幕 DPI 未知时采用的 DPI。
matchWidthOrHeight用于缩放画布以匹配参考分辨率的宽度或高度(或两者组合)的设置。
physicalUnit用于指定位置和大小的物理单位。
referencePixelsPerUnit如果 Sprite 具有此“Pixels Per Unit”设置,则 Sprite 中的每个像素覆盖 UI 中的一个单位。
referenceResolutionUI 布局设计为使用的分辨率。
scaleFactor按此系数缩放画布中的所有 UI 元素。
screenMatchMode在当前分辨率的宽高比不适应参考分辨率时,用于缩放画布区域的模式。
uiScaleMode确定画布中的 UI 元素的缩放方式。

受保护的函数

Handle处理画布缩放计算的方法。
HandleConstantPhysicalSize为“Constant Physical Size”处理画布缩放。
HandleConstantPixelSize为“Constant Pixel Size”处理画布缩放。
HandleScaleWithScreenSize处理随屏幕大小缩放的画布缩放。
HandleWorldCanvas为世界画布处理画布缩放。
OnDisable请参阅 MonoBehaviour.OnDisable。
SetReferencePixelsPerUnit对画布设置 referencePixelsPerUnit。
SetScaleFactor对画布设置缩放因子。
Update如果画布缩放需要更新,则处理每帧检查。

继承的成员

变量

enabled启用的 Behaviour 可更新,禁用的 Behaviour 不可更新。
isActiveAndEnabled已调用启用的 Behaviour。
gameObject此组件附加到的游戏对象。始终将组件附加到游戏对象。
tag此游戏对象的标签。
transform附加到此 GameObject 的 Transform。
runInEditMode允许 MonoBehaviour 的特定实例在编辑模式下运行(仅可在 Editor 中使用)。
useGUILayout禁用该属性可跳过 GUI 布局阶段。
hideFlags该对象应该隐藏、随场景一起保存还是由用户修改?
name对象的名称。

公共函数

BroadcastMessage调用此游戏对象或其任何子项中的每个 MonoBehaviour 上名为 methodName 的方法。
CompareTag此游戏对象是否使用 tag 进行了标记?
GetComponent如果游戏对象附加了类型为 type 的组件,则将其返回,否则返回 null。
GetComponentInChildren使用深度首次搜索返回 GameObject 或其任何子项中类型为 type 的组件。
GetComponentInParent返回 GameObject 或其任何父项中类型为 type 的组件。
GetComponents返回 GameObject 中类型为 type 的所有组件。
GetComponentsInChildren返回 GameObject 或其任何子项中类型为 type 的所有组件。
GetComponentsInParent返回 GameObject 或其任何父项中类型为 type 的所有组件。
SendMessage调用此游戏对象中的每个 MonoBehaviour 上名为 methodName 的方法。
SendMessageUpwards调用此游戏对象中的每个 MonoBehaviour 上或此行为的每个父级上名为 methodName 的方法。
CancelInvoke取消该 MonoBehaviour 上的所有 Invoke 调用。
Invoke在 time 秒后调用 methodName 方法。
InvokeRepeating在 time 秒后调用 methodName 方法,然后每 repeatRate 秒调用一次。
IsInvoking是否有任何待处理的 methodName 调用?
StartCoroutine启动一个协同程序。
StopAllCoroutines停止在该行为上运行的所有协同程序。
StopCoroutine停止在该行为上运行的第一个名为 methodName 的协同程序或存储在 routine 中的协同程序。
GetInstanceID返回对象的实例 ID。
ToString返回 GameObject 的名称。
IsActive如果 GameObject 和 Component 处于激活状态,则返回 true。
IsDestroyed如果行为的原生表示已被销毁,则返回 true。

受保护的函数

Awake请参阅 MonoBehaviour.Awake。
OnBeforeTransformParentChanged请参阅 MonoBehaviour.OnBeforeTransformParentChanged。
OnCanvasGroupChanged请参阅 MonoBehaviour.OnCanvasGroupChanged。
OnCanvasHierarchyChanged在父画布的状态发生更改时调用。
OnDestroy请参阅 MonoBehaviour.OnDestroy。
OnDidApplyAnimationProperties请参阅 LayoutGroup.OnDidApplyAnimationProperties。
OnEnable请参阅 MonoBehaviour.OnEnable。
OnRectTransformDimensionsChangeThis callback is called if an associated RectTransform has its dimensions changed. The call is also made to all child rect transforms, even if the child transform itself doesn't change - as it could have, depending on its anchoring.
OnTransformParentChanged请参阅 MonoBehaviour.OnRectTransformParentChanged。
OnValidate请参阅 MonoBehaviour.OnValidate。
Reset请参阅 MonoBehaviour.Reset。
Start请参阅 MonoBehaviour.Start。

静态函数

print将消息记录到 Unity 控制台(与 Debug.Log 相同)。
Destroy删除 GameObject、组件或资源。
DestroyImmediate立即销毁对象 /obj/。强烈建议您改用 Destroy。
DontDestroyOnLoad加载新场景时,不自动销毁对象 /target/。
FindObjectOfType返回第一个类型为 type 的已加载的激活对象。
FindObjectsOfType返回所有类型为 type 的已加载的激活对象的列表。
Instantiate克隆 original 对象并返回克隆对象。

运算符

bool该对象是否存在?
operator !=比较两个对象是否引用不同的对象。
operator ==比较两个对象引用,判断它们是否引用同一个对象。

消息

AwakeAwake 在加载脚本实例时调用。
FixedUpdate如果启用了 MonoBehaviour,则每个固定帧率帧调用该函数。
LateUpdate如果启用了 Behaviour,则每帧调用 LateUpdate。
OnAnimatorIK用于设置动画 IK(反向运动学)的回调。
OnAnimatorMove用于处理动画移动以修改根运动的回调。
OnApplicationFocus当玩家获得或失去焦点时,发送给所有 GameObject。
OnApplicationPause当应用程序暂停时,发送给所有 GameObject。
OnApplicationQuitSent to all game objects before the application is quit.
OnAudioFilterRead如果实现了 OnAudioFilterRead,Unity 将在音频 DSP 链中插入一个自定义滤波器。
OnBecameInvisibleOnBecameInvisible 在渲染器对任何摄像机都不可见时调用。
OnBecameVisibleOnBecameVisible 在渲染器变为对任意摄像机可见时调用。
OnCollisionEnter当该碰撞体/刚体已开始接触另一个刚体/碰撞体时,调用 OnCollisionEnter。
OnCollisionEnter2D当传入碰撞体与该对象的碰撞体接触时发送(仅限 2D 物理)。
OnCollisionExit当该碰撞体/刚体已停止接触另一个刚体/碰撞体时,调用 OnCollisionExit。
OnCollisionExit2D当另一个对象上的碰撞体停止接触该对象的碰撞体时发送(仅限 2D 物理)。
OnCollisionStay对应正在接触刚体/碰撞体的每一个碰撞体/刚体,每帧调用一次 OnCollisionStay。
OnCollisionStay2D在另一个对象上的碰撞体正在接触该对象的碰撞体时发送每个帧(仅限 2D 物理)。
OnConnectedToServer成功连接到服务器后在客户端上调用。
OnControllerColliderHit当该控制器在执行 Move 时撞到碰撞体时调用 OnControllerColliderHit。
OnDestroyThis function is called when the MonoBehaviour will be destroyed.
OnDisconnectedFromServer当连接丢失或与服务器断开连接时,在客户端上调用。
OnDrawGizmos如果您想绘制能够选择并且始终绘制的辅助图标,则可以实现 OnDrawGizmos。
OnDrawGizmosSelected如果选择了对象,则实现 OnDrawGizmosSelected 来绘制辅助图标。
OnEnable该函数在对象变为启用和激活状态时调用。
OnFailedToConnect出于某种原因连接尝试失败时,在客户端上调用。
OnFailedToConnectToMasterServer在连接到 MasterServer 时发生问题的情况下,在客户端或服务器上调用。
OnGUI系统调用 OnGUI 来渲染和处理 GUI 事件。
OnJointBreak在附加到相同游戏对象的关节断开时调用。
OnJointBreak2D在附加到相同游戏对象的 Joint2D 断开时调用。
OnMasterServerEvent在从 MasterServer 报告事件时,在客户端或服务器上调用。
OnMouseDownOnMouseDown is called when the user has pressed the mouse button while over the GUIElement or Collider.
OnMouseDrag当用户单击 GUIElement 或 Collider 并仍然按住鼠标时,将调用 OnMouseDrag。
OnMouseEnter当鼠标进入 GUIElement 或 Collider 时调用。
OnMouseExit当鼠标不再处于 GUIElement 或 Collider 上方时调用。
OnMouseOver当鼠标悬停在 GUIElement 或 Collider 上时,每帧调用一次。
OnMouseUp当用户松开鼠标按钮时,将调用 OnMouseUp。
OnMouseUpAsButton松开鼠标时,仅当鼠标在按下时所在的 GUIElement 或 Collider 上时,才调用 OnMouseUpAsButton。
OnNetworkInstantiate在已通过 Network.Instantiate 进行网络实例化的对象上调用。
OnParticleCollision当粒子击中碰撞体时,将调用 OnParticleCollision。
OnParticleTrigger当粒子系统中的任何粒子满足触发模块中的条件时,将调用 OnParticleTrigger。
OnPlayerConnected每当有新玩家成功连接,就在服务器上调用。
OnPlayerDisconnected每当有玩家与服务器断开连接,就在服务器上调用。
OnPostRender在摄像机完成场景渲染后,将调用 OnPostRender。
OnPreCullOnPreCull 在摄像机剔除场景前调用。
OnPreRenderOnPreRender 在摄像机开始渲染场景前调用。
OnRenderImageOnRenderImage 在图像的所有渲染操作全部完成后调用。
OnRenderObjectOnRenderObject 在摄像机渲染场景后调用。
OnSerializeNetworkView用于在网络视图监视的脚本中自定义变量同步。
OnServerInitialized每当调用 Network.InitializeServer 并且完成时,对该服务器调用该函数。
OnTransformChildrenChanged当 GameObject 的变换的子项列表发生更改时,将调用该函数。
OnTransformParentChanged当 GameObject 的变换的父属性发生更改时,将调用该函数。
OnTriggerEnter当 Collider other 事件进入该触发器时调用 OnTriggerEnter。
OnTriggerEnter2D当另一个对象进入附加到该对象的触发碰撞体时发送(仅限 2D 物理)。
OnTriggerExit当 Collider other 已停止接触该触发器时调用 OnTriggerExit。
OnTriggerExit2D当另一个对象离开附加到该对象的触发碰撞体时发送(仅限 2D 物理)。
OnTriggerStayOnTriggerStay is called once per frame for every Collider other that is touching the trigger.
OnTriggerStay2D在另一个对象位于附加到该对象的触发碰撞体之内时发送每个帧(仅限 2D 物理)。
OnValidate加载脚本后或 Inspector 中的值发生更改时,将调用该函数(只能在 Editor 中调用)。
OnWillRenderObject如果对象可见并且不是 UI 元素,则为每个摄像机调用 OnWillRenderObject。
Reset重置为默认值。
StartStart is called on the frame when a script is enabled just before any of the Update methods is called the first time.