Properties available through the ObjectData (data) field of an Object when the ObjectType is kCamera. A camera object could be defined as an eye looking at your scene. Based on the LensType applied to the camera the behavior of that eye will change. In addition, cameras can optionally use a FrameBuffer. This type of structure allow you to redirect the camera output to multiple render targets. When using a frame buffer you can draw offscreen and store the render result to existing texture(s). This approach is usually used for post processing effects, deferred rendering and more...

Static Variables

Name	Description
`object`	Reference to the Object holding the current Camera data.
Declaration Object *object
`framebuffer`	FrameBuffer reference attached to the current Camera (if any).
Declaration FrameBuffer *framebuffer
`frustum`	Contain information about each frustum planes used at runtime to clip Object out of the Camera FOV.
Declaration clip frustum
`view_matrix`	A 4x4 matrix containing the view matrix of the Camera.
Declaration mat4 view_matrix Note The view matrix is updated automatically when the underlying Object associated with the camera is updated. This matrix is calculated as the inverse of the object world matrix.

Variables

Name	Description
`lens_type`	The type of lens the active Camera is using.
Declaration LensType lens_type
`fov`	Field of view of the camera in degrees ranging from `1` to `180`.
Declaration float fov Range 1.0 to 180.0
`zoom`	Scane the projection matrix of the active Camera (used only when the LensType is set to `kOrthographic`).
Declaration float zoom Range 0.01 to inf.
`clip_start`	Distance of the near clipping plane.
Declaration float clip_start
`clip_end`	Distance of the far clipping plane.
Declaration float clip_end Range 0.0 to inf.
`ortho_preset`	OrthoPreset method to use for the active orthographic projection of the Camera.
Declaration OrthoPreset ortho_preset
`projection_matrix`	4x4 matrix that stores the active Camera projection matrix.
Declaration mat4 projection_matrix

Functions

Name	Description
`UpdateProjection`	Force the `projection_matrix` to be updated.
Declaration void UpdateProjection( const quad viewport ) Parameters `viewport`: The viewport quad used to recalculate the projection matrix.
`UpdateFrustum`	Manually update the Camera `frustum`.
Declaration void UpdateFrustum( void )
`AddFrameBuffer`	Creates a new FrameBuffer object and return its pointer.
Declaration FrameBuffer AddFrameBuffer( void ) Return Value* Return the newly created or existing FrameBuffer reference pointer.
`RemoveFrameBuffer`	Destroy the FrameBuffer attached to the current Camera (if any).
Declaration bool RemoveFrameBuffer( void ) Return Value `true` if the FrameBuffer have been successfully destroyed; else return `false` if no frame buffer was attached to the Camera.

LensType

Constant values that represent the type of lens that can be applied to a camera object.

kPerspective: This type of lens represents how you view things in the real world; taking in consideration the distance of the object making them appears smaller as they fade into distance.
kOrthographic: In orthographic mode objects always keep their actual size regardless of the view angle and distance applied on the camera.
kProjection: Override the Camera projection upate and specify your own projection matrix.

Example

-- Print the value associated to the orthographic camera lens type:
print( "The value of kOrthographic is " .. Camera.LensType.kOrthographic )

OrthoPreset

Constant values enumerating the default methods available when using an kOrthographic Camera LensType.

kScreenRatio: This type of orthographic projection uses the active screen ratio to calculate the projection matrix of the Camera. This is the mode that the View 3d is using when entering Ortho. mode.
kFullscreen2d: Ideal for rendering pixel accurate 2d interface, HUD or GUI (such as the NRGeditor). This preset gives you a 1/1 pixel ratio over the active screen width and height.
kManualQuad: Allows you to setup the coordinate of the orthographic quad.

Events

Callbacks	Description
`OnDraw`	Triggered when the Camera is ready to draw.
Declaration function OnDraw()
`OnDisplay`	Called right after the Camera is done drawing.
Declaration function OnDisplay()
`OnBegin`	Occurs when the Camera is ready to draw into its FrameBuffer.
Declaration function OnBegin()
`OnEnd`	Triggered just before the Camera is done drawing with its active FrameBuffer.
Declaration function OnEnd()