Open 3D Engine AzFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
AzFramework::CameraState Struct Reference

Represents the camera state populated by the viewport camera. More...

#include <CameraState.h>

Public Member Functions

float VerticalFovRadian () const
 Return the vertical fov of the camera when the view is in perspective.
 
float Zoom () const
 Return the zoom amount of the camera when the view is in orthographic.
 

Static Public Member Functions

static void Reflect (AZ::SerializeContext &context)
 

Public Attributes

AZ::Vector3 m_position = AZ::Vector3::CreateZero()
 World position of the camera.
 
AZ::Vector3 m_forward = AZ::Vector3::CreateAxisY()
 Forward look direction of the camera (world space).
 
AZ::Vector3 m_side = AZ::Vector3::CreateAxisX()
 Side vector of camera (orthogonal to forward and up).
 
AZ::Vector3 m_up = AZ::Vector3::CreateAxisZ()
 Up vector of the camera (cameras frame - world space).
 
AzFramework::ScreenSize m_viewportSize = AzFramework::ScreenSize(0, 0)
 Dimensions of the viewport.
 
float m_nearClip = 0.01f
 Near clip plane of the camera.
 
float m_farClip = 100.0f
 Far clip plane of the camera.
 
float m_fovOrZoom = 0.0f
 Vertical fov or zoom of camera depending on if it is using orthographic projection or not.
 
bool m_orthographic = false
 Is the camera using orthographic projection or not.
 

Detailed Description

Represents the camera state populated by the viewport camera.


The documentation for this struct was generated from the following file: