Skip to main content

UI

Screen-space layout, images, masks, and hints.

Commonly used

Guides

All APIs in this topic

Add components to a scene object.

Components, assets, and modules

APIDescription
CanvasA root of the 2D ScreenTransform hierarchy in 3D space.
HintsComponentUsed to display text hints in a Lens.
ImageUsed to display 2D textures within a scene.
MaskingComponentMasks out visuals and InteractionComponent touch events area within a rectangle defined by ScreenTransform component.
RectangleSetterPositions ScreenTransform according to a cropped region of a texture provided by CropTextureProvider.
ScreenRegionComponentOverrides the settings on a local ScreenTransform to fit specific screen region on the device.
ScreenTransformUsed for positioning objects in 2D screen space.

Enums

APIDescription
ScreenRegionTypeTypes of screen regions that can be used with ScreenRegionComponent.
StretchModeOptions for stretching a mesh to fit a ScreenTransform Used in RenderMeshVisual stretchMode property, as long as the SceneObject has a ScreenTransform attached.