The SceneCamera class in the Sandbox namespace represents a camera and holds render hooks. This camera can be used to draw tool windows and scene panels.
The SceneCamera class in the Sandbox namespace represents a camera and holds render hooks. This camera can be used to draw tool windows and scene panels.
| Member Name | Summary |
|---|---|
| Bloom | Access tonemapping properties of camera |
| Attributes | Render attributes associated with the camera. |
| Name | The name of this camera for debugging purposes. |
| ExcludeTags | Scene objects with any of these tags won't be rendered by this camera. |
| RenderTags | Only scene objects with one of these tags will be rendered by this camera. |
| OnRenderOpaque | Called when rendering the opaque pass. |
| OnRenderPostProcess | Called when rendering the post process pass. |
| OnRenderTransparent | Called when rendering the transparent pass. |
| OnRenderOverlay | Called when rendering the camera's overlay. |
| OnRenderUI | Called when rendering the UI. |
| Size | The size of the screen. Allows us to work out aspect ratio. |
| VolumetricFog | Control volumetric fog parameters, expect this to take 1-2ms of your GPU frame time. |
| CubemapFog | Control fog based on an image. |
| World | The world we're going to render. |
| Worlds | Your camera can render multiple worlds. |
| Position | The position of the scene's camera. |
| Rotation | The rotation of the scene's camera. |
| Angles | The rotation of the scene's camera. |
| FieldOfView | The horizontal field of view of the Camera in degrees. |
| ZFar | The camera's zFar distance. This is the furthest distance this camera will be able to render. |
| ZNear | The camera's zNear distance. This is the closest distance this camera will be able to render. |
| Ortho | Whether to use orthographic projection. |
| OrthoWidth | No longer used |
| OrthoHeight | Height of the ortho when Ortho is enabled. |
| DebugMode | Render this camera using a different render mode. |
| WireframeMode | Render this camera using a wireframe view. |
| ClearFlags | What kind of clearing should we do before we begin? |
| Rect | The rect of the screen to render to. This is normalized, between 0 and 1. |
| BackgroundColor | Color the scene camera clears the render target to. |
| AmbientLightColor | The color of the ambient light. Set it to black for no ambient light, alpha is used for lerping between IBL and constant color. |
| AntiAliasing | Enable or disable anti-aliasing for this render. |
| EnablePostProcessing | Toggle all post processing effects for this camera. The default is on. |
| TargetEye | The HMD eye that this camera is targeting. Use None for the user's monitor (i.e. the companion window). |
| WantsStereoSubmit | Set this to false if you don't want the stereo renderer to submit this camera's texture to the compositor. |
| EnableDirectLighting | Enable or disable direct lighting. |
| EnableIndirectLighting | Enable or disable indirect lighting. |
| CustomProjectionMatrix | Allows specifying a custom projection matrix for this camera. |
| Tonemap | Access tonemapping properties of camera. |
| Member Name | Summary |
|---|---|
| Dispose | Disposes of the camera resources. |
| SetViewModelCamera | Sets the view model camera parameters. |
| GetFrustum | Gets the camera's frustum for a given pixel rectangle. |
| GetRay | Gets a ray from the camera through a given cursor position. |
| ToScreen | Converts a world position to a screen position. |
| ToScreenNormal | Converts a world position to a normalized screen position. |
| ToWorld | Converts a screen position to a world position. |