void UpdateSceneCamera( SceneCamera camera, bool includeTags )

robot_2Generated
code_blocksInput

Description

The UpdateSceneCamera method is responsible for updating a SceneCamera with the settings from the current CameraComponent. This method allows you to apply the camera component's configuration to a scene camera, ensuring that the scene camera reflects the component's properties such as field of view, clear flags, and other relevant settings.

Usage

To use the UpdateSceneCamera method, you need to have an instance of CameraComponent and a SceneCamera that you wish to update. You can call this method and pass the SceneCamera instance along with a boolean indicating whether to include tags in the update process.

Parameters:

  • camera (SceneCamera): The scene camera that will be updated with the settings from this component.
  • includeTags (bool): A boolean value indicating whether to include tags in the update process. If true, the method will consider the tags set in the camera component when updating the scene camera.

Example

// Assuming 'cameraComponent' is an instance of CameraComponent
// and 'sceneCamera' is an instance of SceneCamera

cameraComponent.UpdateSceneCamera(sceneCamera, true);