The CameraComponent class in the Sandbox namespace is a crucial component for rendering scenes. Every scene should have at least one camera to capture and display the visual elements. This class provides a variety of methods and properties to control camera behavior, rendering settings, and more.
| Member Name | Summary |
|---|---|
| AddCommandList | Add a command list to the render |
| RemoveCommandList | Remove an entry |
| ClearCommandLists | Remove all entries in this stage |
| Reset | Resets the camera component to its default state |
| UpdateSceneCamera | Update a SceneCamera with the settings from this component |
| AddHookAfterOpaque | Obsolete. Adds a render hook after opaque rendering |
| AddHookAfterTransparent | Adds a render hook after transparent rendering |
| AddHookBeforeOverlay | Adds a render hook before overlay rendering |
| AddHookAfterUI | Obsolete. Adds a render hook after UI rendering |
| PointToScreenNormal | Converts a world position to screen space in normalized coordinates |
| PointToScreenPixels | Converts a world position to screen space in pixel coordinates |
| BBoxToScreenPixels | Returns the screen space rect that contains the given BBox |
| ScreenPixelToRay | Converts a screen pixel position to a world space ray |
| ScreenNormalToRay | Converts a screen normal position to a world space ray |
| ScreenToWorld | Converts a screen position to a world position |
| GetFrustum | Gets the camera's frustum for a given screen rectangle |
| RenderToTexture | Renders the camera view to a specified texture |
| CalculateObliqueMatrix | Calculates a projection matrix with an oblique clip-plane |
| RenderToBitmap | Render this camera to the target bitmap |
| Member Name | Summary |
|---|---|
| ClearFlags | The clear flags for this camera |
| BackgroundColor | The background color of this camera's view |
| IsMainCamera | Returns true if this is the main game camera |
| FovAxis | The axis to use for the field of view |
| FieldOfView | The field of view of this camera |
| ZNear | The camera's near clip plane distance |
| ZFar | The camera's far clip plane distance |
| Priority | The priority of this camera |
| Orthographic | Whether to use orthographic projection |
| OrthographicHeight | The orthographic size for this camera |
| TargetEye | The target eye for stereo rendering |
| RenderTags | Tags to include specific game objects when rendering |
| RenderExcludeTags | Tags to exclude specific game objects when rendering |
| Viewport | The size of the camera on the screen |
| RenderTarget | The texture to draw this camera to |
| ScreenRect | The size of the viewport in screen coordinates |
| CustomProjectionMatrix | Specifies a custom projection matrix for this camera |
| CustomSize | Specifies a custom aspect ratio for this camera |
| ProjectionMatrix | Get frustum projection matrix |
| Hud | Allows drawing on the camera before post processing |
| Overlay | Used to draw to the screen for debug overlays |