Skip to content

Commit 0ef1564

Browse files
authored
Apply suggestions from code review
1 parent 1b632a5 commit 0ef1564

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

content/en-us/reference/engine/classes/Camera.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -546,25 +546,25 @@ properties:
546546
summary: |
547547
The dimensions of the device safe area on a Roblox client.
548548
description: |
549-
`Class.Camera.ViewportSize` returns the dimensions of the
549+
`Class.Camera.ViewportSize|ViewportSize` returns the dimensions of the
550550
device safe area on the current screen. This area is a rectangle which
551551
includes the Roblox top bar area but does not include any device notches
552-
or screen cutouts. The units of `Class.Camera.ViewportSize` are Roblox
552+
or screen cutouts. The units of `Class.Camera.ViewportSize|ViewportSize` are Roblox
553553
UI offset units which may be different from native display pixels.
554554
555555
<img src="../../../assets/engine-api/classes/Camera/DeviceSafeAreaVsFullscreen.png" width="840" alt="Mobile device screen with cutout showing device safe area." />
556556
557-
As noted above, `Class.Camera.ViewportSize` is not equal to the fullscreen area size
558-
on displays with cutouts or
557+
As noted above, `Class.Camera.ViewportSize|ViewportSize` is not equal to the fullscreen
558+
area size on displays with cutouts or
559559
notches. To obtain the fullscreen area size on all displays, you can query the
560560
`Class.ScreenGui.AbsoluteSize|AbsoluteSize` property of a `Class.ScreenGui` with
561561
`Class.ScreenGui.ScreenInsets|ScreenInsets` set to `Enum.ScreenInsets.None|None`. See
562562
`Enum.ScreenInsets` for a more information about how screen areas are defined.
563563
564-
Finally, note that `Class.Camera.ViewportSize` is not the actual viewport size the camera
565-
uses for rendering (the camera renders in the fullscreen area). Also, the
564+
Finally, note that `Class.Camera.ViewportSize|ViewportSize` is not the actual viewport size
565+
the camera uses for rendering (the camera renders in the fullscreen area). Also, the
566566
`Class.Camera.FieldOfView` and `Class.Camera.DiagonalFieldOfView` properties are
567-
based on the fullscreen area, not `Class.Camera.ViewportSize`.
567+
based on the fullscreen area, not `Class.Camera.ViewportSize|ViewportSize`.
568568
569569
Only one `Class.Camera` has its `Class.Camera.ViewportSize` updated each
570570
frame: the `Class.Camera` currently referred to by `Class.Workspace.

0 commit comments

Comments
 (0)