Class PixelPerfectCamera

The Pixel Perfect Camera component ensures your pixel art remains crisp and clear at different resolutions, and stable in motion.

Inheritance

System.Object

PixelPerfectCamera

Namespace: UnityEngine.U2D

Syntax

public class PixelPerfectCamera : MonoBehaviour, IPixelPerfectCamera

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

Type	Description
System.Int32

cropFrameX

Set to true to crop the viewport with black bars to match refResolutionX in the horizontal direction.

Declaration

public bool cropFrameX { get; set; }

Property Value

Type	Description
System.Boolean

cropFrameY

Set to true to crop the viewport with black bars to match refResolutionY in the vertical direction.

Declaration

public bool cropFrameY { get; set; }

Property Value

Type	Description
System.Boolean

pixelRatio

Ratio of the rendered Sprites compared to their original size (readonly).

Declaration

public int pixelRatio { get; }

Property Value

Type	Description
System.Int32

pixelSnapping

Set to true to prevent subpixel movement and make Sprites appear to move in pixel-by-pixel increments. Only applicable when upscaleRT is false.

Declaration

public bool pixelSnapping { get; set; }

Property Value

Type	Description
System.Boolean

refResolutionX

The original horizontal resolution your Assets are designed for.

Declaration

public int refResolutionX { get; set; }

Property Value

Type	Description
System.Int32

refResolutionY

Original vertical resolution your Assets are designed for.

Declaration

public int refResolutionY { get; set; }

Property Value

Type	Description
System.Int32

stretchFill

Set to true to expand the viewport to fit the screen resolution while maintaining the viewport's aspect ratio. Only applicable when both cropFrameX and cropFrameY are true.

Declaration

public bool stretchFill { get; set; }

Property Value

Type	Description
System.Boolean

upscaleRT

Set to true to have the Scene rendered to a temporary texture set as close as possible to the Reference Resolution, while maintaining the full screen aspect ratio. This temporary texture is then upscaled to fit the full screen.

Declaration

public bool upscaleRT { get; set; }

Property Value

Type	Description
System.Boolean

Methods

OnDisable()

Declaration

public void OnDisable()

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.