Component:Camera: Difference between revisions

From Resonite Wiki
m Fix typo in fields: Clear => Color
add rest of info for now
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
The component represents a [https://docs.unity3d.com/ScriptReference/Camera.html Unity Camera] which is centered on the slot and facing in the forward (+z) [[direction]]. The produced image can either be accesed through a [[Component:RenderTextureProvider|RenderTextureProvider]] component or by creating a [[Texture2D]] asset using the [[ProtoFlux:Render To Texture Asset|Render To Texture Asset]] Protoflux node.
<languages></languages>
<languages></languages>
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=CameraComponent.png
|Image=CameraComponent.png
|Name=Camera
|Name=Camera
}}
}}
The component represents a [https://docs.unity3d.com/ScriptReference/Camera.html Unity Camera] which is centered on the slot and facing in the forward (+z) [[Direction]].


<!--T:2-->
<!--T:2-->
Line 21: Line 19:
|FarClipping|Float|The point in units where the camera ignores far objects.
|FarClipping|Float|The point in units where the camera ignores far objects.
|UseTransformScale|Bool|Determines if the scale of the camera should be taken into account.
|UseTransformScale|Bool|Determines if the scale of the camera should be taken into account.
|Clear|CameraClearMode|
|Clear|CameraClearMode| See [[Type:CameraClearMode|Camera Clear Mode]] for what this does.
|ClearColor|Color|If <code>CameraClearMode</code> is set to <code>Color</code>.
|ClearColor|ColorX|If <code>CameraClearMode</code> is set to <code>Color</code>.
|Viewport|Rect|2D rectangular where the camera is allowed to render
|Viewport|Rect|2D rectangular where the camera is allowed to render
|Depth|Float|
|Depth|Float| Whether this camera should be rendered before or after other cameras render.
|RenderTexture|IAssetProvider`1|TypeString12=IAssetProvider<RenderTexture>|The RenderTextureProvider input in order to get a ITexture2D
|RenderTexture|{{RootFieldType|AssetRef`1|[[Type:RenderTexture|RenderTexture]]}}|TypeAdv12=true|The RenderTextureProvider input in order to get a ITexture2D
|Postprocessing|Bool|Determines if post processing is allowed.
|Postprocessing|Bool|Determines if post processing is allowed.
|ScreenSpaceReflections|Bool|Determines if [https://en.wikipedia.org/wiki/Reflection_(computer_graphics)#Approaches_to_reflection_rendering ScreenSpaceReflections] are rendered.
|ScreenSpaceReflections|Bool|Determines if [https://en.wikipedia.org/wiki/Reflection_(computer_graphics)#Approaches_to_reflection_rendering ScreenSpaceReflections] are rendered.
|MotionBlur|Bool|Determines if MotionBlur is rendered or not.
|MotionBlur|Bool|Determines if MotionBlur is rendered or not.
|RenderShadows|Bool|Determines if shadows are rendered or not.
|RenderShadows|Bool|Determines if shadows are rendered or not.
|SelectiveRender|SyncRefList`1|TypeString17=SyncRefList<Slot>|A list of SyncReferences to slots the camera is allowed to render.
|SelectiveRender|{{RootFieldType|AutoSyncRefList`1|[[Type:Slot|Slot]]}}|TypeAdv17=true|A list of SyncReferences to slots the camera is allowed to render.
|ExcludeRender|SyncRefList`1|TypeString18=SyncRefList<Slot>|A list of SyncReferences to slots the camera is NOT allowed to render.
|ExcludeRender|{{RootFieldType|AutoSyncRefList`1|[[Type:Slot|Slot]]}}|TypeAdv18=true|A list of SyncReferences to slots the camera is NOT allowed to render.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Put the component onto a slot, and position the slot. The produced image can either be accesed through a [[Component:RenderTextureProvider|RenderTextureProvider]] component or by creating a [[Texture2D]] asset using the [[ProtoFlux:Render To Texture Asset|Render To Texture Asset]] Protoflux node.


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
Security cameras, drones, picture takers, layered texture bakers, scanners, and more.


<!--T:5-->
<!--T:5-->
== Related Components ==
== Related Components ==
[[Component:CameraPortal|Camera Portal (mirror)]]
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Camera]]
[[Category:Components{{#translation:}}|Camera]]
[[Category:Components:Rendering{{#translation:}}|Camera]]
[[Category:Components:Rendering{{#translation:}}|Camera]]

Latest revision as of 18:20, 15 October 2024

Component image 
Camera component as seen in the Scene Inspector

The component represents a Unity Camera which is centered on the slot and facing in the forward (+z) Direction.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled.
DoubleBuffered Bool Determines if DoubleBuffering is applied or not.
ForwardOnly Bool Determine whether the render technique is only forward.
Projection CameraProjection Determines whether it's perspective or orthographic
OrthographicSize Float The size of the render-output in orthographic view. (Only active when Projection is set to Orthographic
FieldOfView Float The size of the render-output in perspective view. (Only active when Projection is set to Perspective
NearClipping Float The point in units where the camera ignores near objects.
FarClipping Float The point in units where the camera ignores far objects.
UseTransformScale Bool Determines if the scale of the camera should be taken into account.
Clear CameraClearMode See Camera Clear Mode for what this does.
ClearColor ColorX If CameraClearMode is set to Color.
Viewport Rect 2D rectangular where the camera is allowed to render
Depth Float Whether this camera should be rendered before or after other cameras render.
RenderTexture RenderTexture The RenderTextureProvider input in order to get a ITexture2D
Postprocessing Bool Determines if post processing is allowed.
ScreenSpaceReflections Bool Determines if ScreenSpaceReflections are rendered.
MotionBlur Bool Determines if MotionBlur is rendered or not.
RenderShadows Bool Determines if shadows are rendered or not.
SelectiveRender direct AutoSyncRefList`1<Slot> A list of SyncReferences to slots the camera is allowed to render.
ExcludeRender direct AutoSyncRefList`1<Slot> A list of SyncReferences to slots the camera is NOT allowed to render.

Usage

Put the component onto a slot, and position the slot. The produced image can either be accesed through a RenderTextureProvider component or by creating a Texture2D asset using the Render To Texture Asset Protoflux node.

Examples

Security cameras, drones, picture takers, layered texture bakers, scanners, and more.

Related Components

Camera Portal (mirror)