Docsv3.4.0
Back to API Reference
Class

UniTextMagnifier

sealed
Inherits:MonoBehaviour

Shipped Unity-UI presentation used by PrefabMagnifier: a rectangular panel showing a zoomed capture of the canvas around the focal point, re-rendered through a secondary camera with a zoomed projection matrix. Assign its prefab inside a PrefabMagnifier entity; the panel lives in a canvas-level overlay container so the field's RectMask2D never clips it.

Remarks

Capture requires a canvas camera: Built-in RP renders via Render; URP / HDRP go through RenderPipeline.SubmitRenderRequest with a StandardRequest (2023.1+ — Render is unsupported under any SRP). When capture is impossible the magnifier stays hidden rather than showing an opaque blank panel: silently on Screen Space - Overlay canvases (no camera), with a one-time informational log on an SRP without the render-request API.
public float MagnifierWidth{ get; set }

Loupe width in density-independent pixels.

public float MagnifierHeight{ get; set }

Loupe height in density-independent pixels.

public float VerticalOffset{ get; set }

Vertical lift above the focal point in density-independent pixels.

public float ZoomFactor{ get; set }

Magnification applied to the captured region.

public Color BorderColor{ get; set }

Colour of the loupe frame.

public Color BackgroundColor{ get; set }

Colour behind the captured image and capture clear colour.

public float BorderWidth{ get; set }

Frame thickness in density-independent pixels.

public void Show()
public void Hide()
public void UpdatePosition()
Back to API Reference