Class PixelPerfectCamera
The Pixel Perfect Camera component ensures your pixel art remains crisp and clear at different resolutions, and stable in motion.
Inheritance
PixelPerfectCamera
Inherited Members
UnityEngine.Component.GetComponentInParent(System.Type, System.Boolean)
UnityEngine.Component.GetComponentInParent<T>(System.Boolean)
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
Syntax
[ExecuteInEditMode]
[DisallowMultipleComponent]
[AddComponentMenu("Rendering/2D/Pixel Perfect Camera")]
[RequireComponent(typeof(Camera))]
[MovedFrom("UnityEngine.Experimental.Rendering")]
[HelpURL("https://docs.unity3d.com/Packages/com.unity.render-pipelines.universal@latest/index.html?subfolder=/manual/2d-pixelperfect.html%23properties")]
public class PixelPerfectCamera : MonoBehaviour, IPixelPerfectCamera, ISerializationCallbackReceiver
Properties
assetsPPU
Match this value to to the Pixels Per Unit values of all Sprites within the Scene.
Declaration
public int assetsPPU { get; set; }
Property Value
cropFrame
Declaration
public PixelPerfectCamera.CropFrame cropFrame { get; set; }
Property Value
gridSnapping
Declaration
public PixelPerfectCamera.GridSnapping gridSnapping { get; set; }
Property Value
orthographicSize
Declaration
public float orthographicSize { get; }
Property Value
pixelRatio
Ratio of the rendered Sprites compared to their original size (readonly).
Declaration
public int pixelRatio { get; }
Property Value
refResolutionX
The original horizontal resolution your Assets are designed for.
Declaration
public int refResolutionX { get; set; }
Property Value
refResolutionY
Original vertical resolution your Assets are designed for.
Declaration
public int refResolutionY { get; set; }
Property Value
requiresUpscalePass
Declaration
public bool requiresUpscalePass { get; }
Property Value
Methods
CorrectCinemachineOrthoSize(Single)
Find a pixel-perfect orthographic size as close to targetOrthoSize as possible. Used by Cinemachine to solve compatibility issues with Pixel Perfect Camera.
Declaration
public float CorrectCinemachineOrthoSize(float targetOrthoSize)
Parameters
| Type |
Name |
Description |
| Single |
targetOrthoSize |
Orthographic size from the live Cinemachine Virtual Camera.
|
Returns
| Type |
Description |
| Single |
The corrected orthographic size.
|
OnAfterDeserialize()
Declaration
public void OnAfterDeserialize()
Implements
OnBeforeSerialize()
Declaration
public void OnBeforeSerialize()
Implements
RoundToPixel(Vector3)
Round a arbitrary position to an integer pixel position. Works in world space.
Declaration
public Vector3 RoundToPixel(Vector3 position)
Parameters
| Type |
Name |
Description |
| Vector3 |
position |
The position you want to round.
|
Returns
| Type |
Description |
| Vector3 |
The rounded pixel position.
Depending on the values of upscaleRT and pixelSnapping, it could be a screen pixel position or an art pixel position.
|