Skip to content

Commit 719364a

Browse files
committed
Updated readme
1 parent ad5200b commit 719364a

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This package simplifies making a Unity camera render to exact pixel units, for u
77
## Features ##
88

99
* Simple setup
10-
* Perspective camera support
10+
* Experimental perspective camera support
1111

1212
*Standard unity camera*
1313

@@ -26,8 +26,9 @@ This package simplifies making a Unity camera render to exact pixel units, for u
2626
## Advanced Settings ##
2727

2828
* __Camera Material__ - A material applied to the camera output, allows shaders to modify the image. The camera output is set as the `_MainTex` of the material.
29-
* __Aspect Stretch__ - Apply a stretch to the output, allowing the display to be non square pixels.
30-
* __Perspective Z__ - Only for perspective cameras. The Z distance from the camera that is rendered as pixel perfect.
29+
* __Aspect Stretch__ - Apply a stretch to the output, allows the display to be non square pixels.
30+
* __Down Sample__ - Scales down the render resolution, making the output blockier.
31+
* __Perspective Z__ - Only for perspective cameras. The Z distance between the near and far clip planes, that is rendered as pixel perfect.
3132

3233
## Caveats ##
3334

@@ -65,13 +66,17 @@ __AspectStretch__ : Vector2
6566

6667
An additional stretch applied to the camera, allows camera to render as non square pixels.
6768

69+
__DownSample__ : float
70+
71+
Scales down the render resolution, makes the output blockier. Minimum value is clamped at 1.
72+
6873
__PerspectiveZ__ : float
6974

70-
With a perspective camera, the distance from the camera that is rendered as pixel perfect.
75+
With a perspective camera, the distance between the camera near and far planes that is rendered as pixel perfect. Value is clamped between the near and far plane values.
7176

7277
__RenderTexture__ : RenderTexture, read only
7378

74-
Access to the RenderTexture used as the camera output.
79+
Access the RenderTexture used as the camera output.
7580

7681
__CameraSize__ : int[], read only
7782

@@ -82,3 +87,7 @@ Actual pixel size of the camera, as an integer array.
8287
__ForceRefresh()__ : void
8388

8489
Force the camera to recalculate rendering sizes.
90+
91+
__CheckCamera()__ : bool
92+
93+
Checks camera settings. If different from the last camera settings, will setup the camera again. Returns true if settings changed.

0 commit comments

Comments
 (0)