Cinemachine Confiner
Use the Cinemachine Confiner extension to limit the camera’s position to a volume or area.
Confiner operates in 2D or 3D mode. The mode influences the kind of bounding shape it accepts. In 3D mode, the camera’s position in 3D is confined to a volume. This also works for 2D games, but you need to take the depth into account. In 2D mode, you don’t have to worry about depth.
For orthographic cameras, there is an additional option to confine the screen edges, not just the camera point. This ensures that the entire screen area stays within the bounding area.
Property: |
|
Function: |
Confine Mode |
|
Operate using a 2D bounding area or a 3D bounding volume. |
|
Confine 2D |
Use a Collider2D bounding area. |
|
Confine 3D |
Use a 3D Collider bounding volume. |
Bounding Volume |
|
The 3D volume to contain the camera in. This property is available when Confine Mode is set to Confine 3D. |
Bounding Shape 2D |
|
The 2D area to contain the camera in. This property is available when Confine Mode is set to Confine 2D. |
Confine Screen Edges |
|
Check to confine screen edges to the area when the camera is orthographic. When unchecked, confine only the camera center. Has no effect if camera is in perspective mode. |
Damping |
|
How gradually to return the camera to the bounding volume or area if it goes beyond the borders. Higher numbers are more gradual. |
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.