Description
The UpdateSceneCamera
method updates a SceneCamera
instance with the settings from the current CameraComponent
. This method allows you to apply the camera component's configuration to a scene camera, which is useful for synchronizing camera settings across different components or systems.
Usage
To use the UpdateSceneCamera
method, you need to have an instance of CameraComponent
and a SceneCamera
that you want to update. You can also specify whether to include tags in the update process by setting the includeTags
parameter to true
or false
.
Parameters:
camera
(SceneCamera
): The scene camera to be updated with the current camera component's settings.
includeTags
(bool
): A boolean value indicating whether to include tags in the update process. If true
, tags will be considered; otherwise, they will be ignored.
Example
// Assuming 'cameraComponent' is an instance of CameraComponent
// and 'sceneCamera' is an instance of SceneCamera
cameraComponent.UpdateSceneCamera(sceneCamera, true); // Updates the scene camera with tags included
cameraComponent.UpdateSceneCamera(sceneCamera, false); // Updates the scene camera without considering tags