Documentation

Camera - Open Dev Kit Documentation

Open Dev Kit Documentation :: Game :: Camera

Game.Camera

Functions

Constructor ( )

Properties

Clearing Canvas Clearing
clear options for the camera
Background Color Color HDR
color of the background behind rendered objects
Projection Camera Projection
type of projection used by the camera
Field Of View Float
angle of the camera's field of view
Range Near Float
near clipping camera distance
Range Far Float
far clipping camera distance
Target Offset 3D Vector
offset from the camera's position to its target position
Bloom Enabled Boolean
enables bloom post-processing for this camera (works in both LDR and HDR modes)
HDR Enabled Boolean
when bloom is enabled, renders the scene to a 16-bit float buffer and applies ACES tonemapping; otherwise the bloom path uses an 8-bit buffer with additive composite
HDR Exposure Float
exposure multiplier applied before tonemapping (HDR mode only)
Bloom Threshold Float
luminance value above which pixels contribute to bloom
Bloom Intensity Float
strength of the bloom contribution added on top of the scene
Bloom Radius Float
upsample tent filter radius, controls how wide the bloom halo spreads
Bloom Mip Count Integer
number of bloom pyramid levels (clamped to 1..8 at runtime)
Distance Float
Distance from the target
VR Force Perspective Boolean
Forces orthogonal views to be displayed as perspective views in the VR headset
VR Clamp Orientation Boolean
Clamps the camera's orbit orientation to Z-rotation only so that the user is not floating and is correctly oriented where looking down is the ground; only disable this when a flying camera is desired
Vector Source 3D Vector
starting point of the camera's direction, representing the camera's position in world space
Vector Destination 3D Vector
endpoint of the camera's direction, indicating the point in space towards which the camera is looking
Vector Forward 3D Vector
direction in which the camera is facing, pointing from its position towards its destination
Vector Up 3D Vector
upward direction of the camera, perpendicular to the camera's forward direction
Vector VR Positions 3D Vector Array
VR tracking positions
Vector VR Orientations 4D Vector (Quaternion) Array
VR tracking orientations

If you think anything is missing, please feel free to: submit documentation feedback on this page