Graphics::CameraContext Class Reference

#include <cameracontext.h>

Detailed Description

Handles cameras.

Copyright

(C) 2018-2020 Individual contributors, see AUTHORS file

Inherits Graphics::GraphicsContext.

Public Member Functions
	CameraContext ()
	constructor
virtual	~CameraContext ()
	destructor
Public Member Functions inherited from Graphics::GraphicsContext
	GraphicsContext ()
	constructor
virtual	~GraphicsContext ()
	destructor

Static Public Member Functions
static void	Create ()
	create context
static void	UpdateCameras (const Graphics::FrameContext &ctx)
	runs before frame is updated
static void	SetupProjectionFov (const Graphics::GraphicsEntityId id, float aspect, float fov, float znear, float zfar, const Graphics::StageMask=Graphics::PRIMARY_STAGE_MASK)
	setup as projection and fov
static void	SetupOrthographic (const Graphics::GraphicsEntityId id, float width, float height, float znear, float zfar, const Graphics::StageMask=Graphics::PRIMARY_STAGE_MASK)
	setup as ortographic
static void	SetView (const Graphics::GraphicsEntityId id, const Math::mat4 &mat)
	set view
static const Math::mat4 &	GetView (const Graphics::GraphicsEntityId id)
	get view
static const Math::mat4	GetTransform (const Graphics::GraphicsEntityId id)
	get transform
static const Math::mat4 &	GetProjection (const Graphics::GraphicsEntityId id)
	get projection
static const Math::mat4 &	GetViewProjection (const Graphics::GraphicsEntityId id)
	get view-projection
static const CameraSettings &	GetSettings (const Graphics::GraphicsEntityId id)
	get settings
static Graphics::StageMask	GetStageMask (const Graphics::GraphicsEntityId id)
	Get stage mask.
static const Util::Array< Graphics::GraphicsEntityId > &	GetLODCameras ()
	Get all cameras affecting LOD.
static void	AddLODCamera (const Graphics::GraphicsEntityId id)
	Add a camera to affect lod.
static void	RemoveLODCamera (const Graphics::GraphicsEntityId id)
	Remove a camera from affecting lod.
static Graphics::GraphicsEntityId	GetLODCamera ()
	get the LOD camera
static void	SetLODCamera (const Graphics::GraphicsEntityId id)
	set the LOD camera

Private Types
enum	{   Camera_Settings , Camera_Projection , Camera_View , Camera_ViewProjection ,   Camera_StageMask }
typedef Ids::IdAllocator< Graphics::CameraSettings, Math::mat4, Math::mat4, Math::mat4, Graphics::StageMask >	CameraAllocator

Private Member Functions
	__DeclareContext ()

Static Private Member Functions
static Graphics::ContextEntityId	Alloc ()
	allocate a new slice for this context
static void	Dealloc (const Graphics::ContextEntityId id)
	deallocate a slice

Static Private Attributes
static CameraAllocator	cameraAllocator
static Util::Array< Graphics::GraphicsEntityId >	LodCameras
static Graphics::GraphicsEntityId	lodCamera

Additional Inherited Members
Static Protected Member Functions inherited from Graphics::GraphicsContext
static void	InternalRegisterEntity (const Graphics::GraphicsEntityId id, Graphics::GraphicsContextState &&state)
static void	InternalDeregisterEntity (const Graphics::GraphicsEntityId id, Graphics::GraphicsContextState &&state)
template<class ID_ALLOCATOR>
static void	InternalDefragment (ID_ALLOCATOR &allocator, Graphics::GraphicsContextState &&state)

Member Typedef Documentation

CameraAllocator

typedef Ids::IdAllocator< Graphics::CameraSettings, Math::mat4, Math::mat4, Math::mat4, Graphics::StageMask > Graphics::CameraContext::CameraAllocator

private

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
Camera_Settings
Camera_Projection
Camera_View
Camera_ViewProjection
Camera_StageMask

Constructor & Destructor Documentation

CameraContext()

Graphics::CameraContext::CameraContext

(

)

constructor

~CameraContext()

Graphics::CameraContext::~CameraContext ( )

virtual

destructor

Member Function Documentation

__DeclareContext()

Graphics::CameraContext::__DeclareContext ( )

private

AddLODCamera()

void Graphics::CameraContext::AddLODCamera ( const Graphics::GraphicsEntityId id )

static

Add a camera to affect lod.

Alloc()

Graphics::ContextEntityId Graphics::CameraContext::Alloc ( )

inlinestaticprivate

allocate a new slice for this context

Create()

void Graphics::CameraContext::Create ( )

static

create context

Dealloc()

void Graphics::CameraContext::Dealloc ( const Graphics::ContextEntityId id )

inlinestaticprivate

deallocate a slice

GetLODCamera()

Graphics::GraphicsEntityId Graphics::CameraContext::GetLODCamera ( )

static

get the LOD camera

GetLODCameras()

const Util::Array< Graphics::GraphicsEntityId > & Graphics::CameraContext::GetLODCameras ( )

static

Get all cameras affecting LOD.

GetProjection()

const Math::mat4 & Graphics::CameraContext::GetProjection ( const Graphics::GraphicsEntityId id )

static

get projection

GetSettings()

const CameraSettings & Graphics::CameraContext::GetSettings ( const Graphics::GraphicsEntityId id )

static

get settings

GetStageMask()

Graphics::StageMask Graphics::CameraContext::GetStageMask ( const Graphics::GraphicsEntityId id )

static

Get stage mask.

GetTransform()

const Math::mat4 Graphics::CameraContext::GetTransform ( const Graphics::GraphicsEntityId id )

static

get transform

GetView()

const Math::mat4 & Graphics::CameraContext::GetView ( const Graphics::GraphicsEntityId id )

static

get view

GetViewProjection()

const Math::mat4 & Graphics::CameraContext::GetViewProjection ( const Graphics::GraphicsEntityId id )

static

get view-projection

RemoveLODCamera()

void Graphics::CameraContext::RemoveLODCamera ( const Graphics::GraphicsEntityId id )

static

Remove a camera from affecting lod.

SetLODCamera()

void Graphics::CameraContext::SetLODCamera ( const Graphics::GraphicsEntityId id )

static

set the LOD camera

SetupOrthographic()

void Graphics::CameraContext::SetupOrthographic ( const Graphics::GraphicsEntityId id, float width, float height, float znear, float zfar, const Graphics::StageMask stageMask = Graphics::PRIMARY_STAGE_MASK )

static

setup as ortographic

SetupProjectionFov()

void Graphics::CameraContext::SetupProjectionFov ( const Graphics::GraphicsEntityId id, float aspect, float fov, float znear, float zfar, const Graphics::StageMask stageMask = Graphics::PRIMARY_STAGE_MASK )

static

setup as projection and fov

SetView()

void Graphics::CameraContext::SetView ( const Graphics::GraphicsEntityId id, const Math::mat4 & mat )

static

set view

UpdateCameras()

void Graphics::CameraContext::UpdateCameras ( const Graphics::FrameContext & ctx )

static

runs before frame is updated

Member Data Documentation

cameraAllocator

CameraContext::CameraAllocator Graphics::CameraContext::cameraAllocator

staticprivate

lodCamera

Graphics::GraphicsEntityId Graphics::CameraContext::lodCamera

staticprivate

LodCameras

Util::Array< Graphics::GraphicsEntityId > Graphics::CameraContext::LodCameras

staticprivate

---

The documentation for this class was generated from the following files:

• /github/workspace/code/render/graphics/cameracontext.h
• /github/workspace/code/render/graphics/cameracontext.cc