Chicane Graphics Engine - Documentation

Types

Name	Value	Description
ControllerObservable	EventObservable<Controller*>
ControllerSubscription	EventSubscription<Controller*>
SceneObservable	EventObservable<std::shared_ptr<Scene>>
SceneSubscription	EventSubscription<std::shared_ptr<Scene>>
ViewObservable	EventObservable<std::shared_ptr<Grid::View>>
ViewSubscription	EventSubscription<std::shared_ptr<Grid::View>>

Constructors

Name	Description
Application()
Application()
Application()

Functions

Access	Return	Modifier	Name
public	Application&	static	getInstance()
public	Application&		operator=()
public	Application&		operator=()
public	void		run( const ApplicationCreateInfo& inCreateInfo )
public	const ApplicationTelemetry&	const	getTelemetry()
public	bool		hasController()
public	Controller*		getController()
public	void		setController( Controller* inController )
public	ControllerSubscription		watchController( ControllerSubscription::NextCallback inNext, ControllerSubscription::ErrorCallback inError, ControllerSubscription::CompleteCallback inComplete )
public	std::shared_ptr<T>	inline	getScene()
public	void	inline	setScene( Params... inParams )
public	void	inline	setScene( std::shared_ptr<Scene> inScene )
public	SceneSubscription		watchScene( SceneSubscription::NextCallback inNext, SceneSubscription::ErrorCallback inError, SceneSubscription::CompleteCallback inComplete )
public	std::shared_ptr<T>	inline	getView()
public	void	inline	setView( Params... inParams )
public	ViewSubscription		watchView( ViewSubscription::NextCallback inNext, ViewSubscription::ErrorCallback inError, ViewSubscription::CompleteCallback inComplete )
public	bool	const	hasWindow()
public	Window*	const	getWindow()
public	Vec<2, std::uint32_t>	const	getScreenViewport()
public	Bounds2D	const	getScreenViewportRect()
public	bool	const	hasRenderer()
public	Renderer::Instance*	const	getRenderer()
public	void		setRenderer( WindowBackend inBackend )
public	void		pushTrace( const SceneTraceRequest& inRequest )
private	void		initRenderer( const Renderer::Settings& inSettings )
private	void		shutdownRenderer()
private	void		initWindow( const WindowSettings& inSettings )
private	void		initModules( const std::vector<FileSystem::Path>& inModules )
private	void		shutdownModules()
private	void		initBox()
private	void		initKerb()
private	void		initDrift()
private	void		shutdownDrift()
private	void		initScreech()
private	void		initSmoke()
private	void		shutdownSmoke()
private	void		render()
private	void		uploadPreviewTextures()
private	void		snapshotRendererState()
private	bool	const	hasSceneFeature( Renderer::RendererFeature inFeature )
private	Vec<2, std::uint32_t>	const	getRendererResolution()
private	void		initScene()
private	void		shutdownScene()
private	void		tickScene()
private	void		buildSceneCommands( std::shared_ptr<Scene> inScene )
private	void		renderScene()
private	void		initUI()
private	void		shutdownUI()
private	void		tickUI()
private	void		snapshotScreenViewport( const std::shared_ptr<Grid::View>& inView )
private	void		buildUICommands( std::shared_ptr<Grid::View> inView )
private	void		renderUI()

Members

Access	Type	Name
private	ApplicationTelemetry	m_telemetry
private	std::atomic<bool>	m_bIsRunning
private	Controller*	m_controller
private	ControllerObservable	m_controllerObservable
private	std::shared_ptr<Scene>	m_scene
private	std::thread	m_sceneThread
private	std::vector<Renderer::DrawPoly3DCommand>	m_sceneCommandBuffers
private	std::atomic<std::size_t>	m_sceneWriteIndex
private	std::atomic<std::size_t>	m_sceneReadIndex
private	std::atomic<std::size_t>	m_sceneBusyIndex
private	SceneObservable	m_sceneObservable
private	std::shared_ptr<Grid::View>	m_view
private	std::thread	m_viewThread
private	std::vector<Renderer::DrawPoly2DCommand>	m_viewCommandBuffers
private	std::vector<Grid::Component*>	m_viewDrawables
private	std::atomic<std::size_t>	m_viewWriteIndex
private	std::atomic<std::size_t>	m_viewReadIndex
private	std::atomic<std::uint32_t>	m_screenViewportX
private	std::atomic<std::uint32_t>	m_screenViewportY
private	std::atomic<std::uint32_t>	m_screenViewportWidth
private	std::atomic<std::uint32_t>	m_screenViewportHeight
private	ViewObservable	m_viewObservable
private	std::unique_ptr<Window>	m_window
private	std::unique_ptr<Renderer::Instance>	m_renderer
private	std::atomic<std::uint8_t>	m_featureFlags
private	std::atomic<std::uint32_t>	m_rendererWidth
private	std::atomic<std::uint32_t>	m_rendererHeight

Application

Types

Constructors

Functions

Members