Component:Canvas

From Resonite Wiki
Revision as of 21:36, 3 March 2024 by PJB (talk | contribs) (Automated: update Fields, Categories)


This article or section is a Stub. You can help the Resonite Wiki by expanding it.


Component image 
Canvas component as seen in the Scene Inspector


Introduction

A Canvas is the starting point for anything based on UIX. It provides the bounds of the UI and controls how users can interact with it.

Usage

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
Size Float2 The dimensions of the canvas. At normal scale, this is equivalent to meters.
EditModeOnly Bool FIXME
AcceptRemoteTouch Bool Makes the canvas accepts laser touches
AcceptPhysicalTouch Bool Makes the canvas accepts direct touches
AcceptExistingTouch Bool FIXME
HighPriorityIntegration Bool FIXME
IgnoreTouchesFromBehind Bool Makes the canvas ignore all touches from behind
BlockAllInteractions Bool Prevents any interaction if enabled
LaserPassThrough Bool Allows the laser to go through the canvas
PixelScale Float FIXME
UnitScale Float
_rootRect RectTransform Internal
Collider BoxCollider The collider that receives touches
DefaultCulling Culling
_colliderSize field drive of Float3 Internal
_colliderOffset field drive of Float3 Internal
StartingOffset Int FIXME
StartingMaskDepth Int FIXME

Behavior

Examples

Related Components