#include <Engine.hpp>

Inheritance diagram for castor3d::Engine:

[legend]

Collaboration diagram for castor3d::Engine:

[legend]

Public Member Functions
C3D_API	Engine (EngineConfig config)
	Constructor.

C3D_API	Engine (EngineConfig config, castor::LoggerInstance &logger)
	Constructor.

C3D_API	~Engine () noexcept
	Destructor.

C3D_API void	initialise (uint32_t wantedFPS=100, bool threaded=false)
	Initialisation function, Sets the wanted frame rate.

C3D_API void	cleanup ()
	Cleanup function, destroys everything created from the beginning.

C3D_API bool	loadRenderer (castor::String const &type)
	Loads a renderer plug-in, given the renderer type.

C3D_API void	loadRenderer (Renderer renderer)
	Loads a renderer plug-in, given the renderer type.

C3D_API CpuFrameEvent *	postEvent (CpuFrameEventUPtr event) const
	Posts a frame event to the default frame listener.

C3D_API void	sendEvent (GpuFrameEventUPtr event) const
	If a device is enabled, executes the given event, if not posts it to the default frame listener.

C3D_API GpuFrameEvent *	postEvent (GpuFrameEventUPtr event) const
	Posts a frame event to the default frame listener.

C3D_API bool	fireMouseMove (castor::Position const &position, bool ctrl, bool alt, bool shift)
	Fires a mouse move event.

C3D_API void	update (CpuUpdater &updater)
	Updates the engine, CPU wise.

C3D_API void	update (GpuUpdater &updater)
	Updates the engine, GPU wise.

C3D_API void	upload (UploadData &uploader)
	Updates the buffers.

C3D_API bool	isCleaned () const noexcept
	Retrieves the cleanup status.

C3D_API void	setCleaned () noexcept
	Tells the engine is cleaned up.

C3D_API void	pushCpuJob (castor::AsyncJobQueue::Job job)
	Enqueues the given CPU job.

C3D_API castor::RgbaColour	getNextRainbowColour () const
	Retrieves a colour issued from a rainbow colours iterator.

C3D_API void	registerWindow (RenderWindow &window)
	Registers a RenderWindow.

C3D_API void	unregisterWindow (RenderWindow const &window)
	Unregisters a RenderWindow.

C3D_API void	registerParsers (castor::String name, castor::AttributeParsers parsers, castor::StrUInt32Map sections, castor::UserContextCreator contextCreator)
	Registers additional parsers for SceneFileParser.

C3D_API void	unregisterParsers (castor::String const &name) noexcept
	Unregisters parsers for SceneFileParser.

C3D_API void	registerTimer (castor::String const &category, FramePassTimer &timer)
	Registers a render pass timer.

C3D_API void	unregisterTimer (castor::String const &category, FramePassTimer &timer) noexcept
	Unregisters a render pass timer.

C3D_API void	registerLightingModel (castor::String const &baseName, shader::LightingModelDesc const &defaultDesc, shader::LightingModelCreator const &creator) const
	Registers a lighting model.

C3D_API void	unregisterLightingModel (castor::String const &baseName) const
	Unregisters a lighting model.

C3D_API void	registerDiffuseBrdf (shader::DiffuseBrdfDesc const &desc) const
	Registers a diffuse BRDF.

C3D_API void	unregisterDiffuseBrdf (castor::String const &name) const
	Unegisters a diffuse BRDF.

C3D_API void	registerSpecularBrdf (shader::SpecularBrdfDesc const &desc) const
	Registers a specular BRDF.

C3D_API void	unregisterSpecularBrdf (castor::String const &name) const
	Unegisters a specular BRDF.

C3D_API void	registerSheenBrdf (shader::SheenBrdfDesc const &desc) const
	Registers a sheen BRDF.

C3D_API void	unregisterSheenBrdf (castor::String const &name) const
	Unegisters a sheen BRDF.

C3D_API void	registerClearcoatBrdf (shader::ClearcoatBrdfDesc const &desc) const
	Registers a clearcoat BRDF.

C3D_API void	unregisterClearcoatBrdf (castor::String const &name) const
	Unegisters a clearcoat BRDF.

C3D_API void	registerScatteringModel (shader::ScatteringModelDesc const &desc) const
	Registers a scattering model.

C3D_API void	unregisterScatteringModel (castor::String const &name) const
	Unegisters a scattering model.

C3D_API BackgroundModelID	registerBackgroundModel (castor::String const &name, shader::BackgroundModelCreator creator)
	Registers a Background Model.

C3D_API BackgroundModelID	unregisterBackgroundModel (castor::String const &name)
	Unregisters a Background Model.

C3D_API void	registerBuffer (ShaderBuffer const &buffer)
	Registers a ShaderBuffer.

C3D_API void	unregisterBuffer (ShaderBuffer const &buffer)
	Unregisters a ShaderBuffer.

C3D_API void	registerPassModel (PassRegisterInfo const &info) const
	Registers the given pass info with all background models.

C3D_API void	unregisterPassModel (castor::String const &baseName) const
	Unregisters a pass model.

C3D_API void	registerSpecificsBuffer (castor::String const &name, castor3d::SpecificsBuffer buffer) const
	Registers a specific data shader buffer.

C3D_API void	unregisterSpecificsBuffer (castor::String const &name) const
	Unregisters a pass' specific data buffer.

C3D_API void	addSpecificsBuffersBindings (ashes::VkDescriptorSetLayoutBindingArray &bindings, VkShaderStageFlags shaderStages, uint32_t &index) const
	Addw the pass' specific data buffer into the given descriptor layout bindings array.

C3D_API void	addSpecificsBuffersDescriptors (ashes::WriteDescriptorSetArray &descriptorWrites, uint32_t &index) const
	Writes the pass' specific data buffer into the given descriptor writes array.

C3D_API void	createSpecificsBuffersPassBindings (crg::FramePass &pass, uint32_t &index) const
	Writes the pass' specific data buffer bindings into given frame pass.

C3D_API void	declareSpecificsShaderBuffers (sdw::ShaderWriter &writer, castor::StringMap< castor3d::shader::BufferBaseUPtr > &buffers, uint32_t &binding, uint32_t set) const
	Declares pass' specific data shader buffers.

C3D_API PassComponentID	registerPassComponent (castor::String const &type, PassComponentPluginUPtr componentPlugin) const
	Registers a pass component.

C3D_API void	unregisterPassComponent (castor::String const &type) const
	Unregisters a pass component.

C3D_API SubmeshComponentID	registerSubmeshComponent (castor::String const &type, SubmeshComponentPluginUPtr componentPlugin) const
	Registers a pass component.

C3D_API void	unregisterSubmeshComponent (castor::String const &type) const
	Unregisters a pass component.

C3D_API void	registerRenderPassType (castor::String const &renderPassType, castor::UniquePtr< RenderPassRegisterInfo > info)
	Registers a scene render pass type, used to render given material pass type.

C3D_API void	setRenderPassTypeConfiguration (castor::String const &renderPassType, Parameters parameters)
	Registers a scene render pass type's configuration parameters.

C3D_API Parameters	getRenderPassTypeConfiguration (castor::String const &renderPassType) const
	Retrieve a scene render pass type's configuration parameters.

C3D_API RenderPassTypeID	getRenderPassTypeID (castor::String const &renderPassType) const
	Retrieves the ID for given scene render pass type name.

C3D_API RenderPassRegisterInfo *	getRenderPassInfo (castor::String const &renderPassType) const
	Retrieves a scene render pass type's creation informations.

C3D_API castor::Vector< RenderPassRegisterInfo * >	getRenderPassInfos (TechniquePassEvent event) const
	Retrieves the scene render passes type creation informations.

C3D_API void	unregisterRenderPassType (castor::String const &renderPassType)
	Unregisters a scene render pass type.

C3D_API std::default_random_engine	createRandomEngine () const


Getters.
C3D_API castor::String	getDefaultLightingModelName () const

C3D_API ToneMappingFactory const &	getToneMappingFactory () const

C3D_API ToneMappingFactory &	getToneMappingFactory ()

C3D_API PostEffectFactory const &	getPostEffectFactory () const

C3D_API PostEffectFactory &	getPostEffectFactory ()

C3D_API uint32_t	getWantedFps () const

C3D_API castor3d::MaterialObs	getDefaultMaterial () const

C3D_API bool	hasMeshShaders () const

C3D_API uint32_t	getMaxPassTypeCount () const

C3D_API RenderDevice *	getRenderDevice () const

C3D_API ControlsManager *	getControlsManager () const

C3D_API UploadData &	getUploadData () const noexcept

C3D_API ast::ShaderAllocator &	getShaderAllocator ()

castor::String const &	getAppName () const noexcept

Version const &	getAppVersion () const noexcept

bool	isShaderValidationEnabled () const noexcept

bool	isValidationEnabled () const noexcept

uint32_t	getShaderDebugLevel () const noexcept

bool	areUpdateOptimisationsEnabled () const noexcept

bool	isRandomisationEnabled () const noexcept

bool	isApiTraceEnabled () const noexcept

bool	areTextShadersKept () const noexcept

bool	areDebugTargetsEnabled () const noexcept

UserInputListenerRPtr	getUserInputListener () noexcept

RenderSystem *	getRenderSystem () const noexcept

auto	getDefaultSampler () const noexcept

auto	getLightsSampler () const noexcept

auto const &	getAdditionalParsers () const noexcept

Version const &	getVersion () const noexcept

bool	hasRenderLoop () const noexcept

RenderLoop &	getRenderLoop () const noexcept

bool	isThreaded () const noexcept

MeshFactory &	getMeshFactory () const noexcept

PassFactory &	getPassFactory () const noexcept

PassComponentRegister &	getPassComponentsRegister () const noexcept

SubmeshComponentRegister &	getSubmeshComponentsRegister () const noexcept

ImporterFileFactory &	getImporterFileFactory () const noexcept

ParticleFactory &	getParticleFactory () const noexcept

castor::CpuInformations const &	getCpuInformations () const noexcept

LightingModelID	getDefaultLightingModel () const noexcept

castor::ImageLoader const &	getImageLoader () const noexcept

castor::ImageLoader &	getImageLoader () noexcept

castor::ImageWriter const &	getImageWriter () const noexcept

ashes::RendererList const &	getRenderersList () const noexcept

castor::LoggerInstance &	getLogger () const noexcept

uint32_t	getLpvGridSize () const noexcept

uint32_t	getMaxImageSize () const noexcept

auto const &	getRenderWindows () const noexcept

crg::ResourceHandler &	getGraphResourceHandler () noexcept

LightingModelFactory &	getLightingModelFactory () const noexcept

shader::BackgroundModelFactory const &	getBackgroundModelFactory () const noexcept

shader::BackgroundModelFactory &	getBackgroundModelFactory () noexcept

SceneRPtr	getLoadingScene () const noexcept

Texture const &	getPrefilteredBrdfTexture () const noexcept

castor::LengthUnit	getLengthUnit () const noexcept


Mutators.
C3D_API void	setLoadingScene (SceneUPtr scene)

void	setUserInputListener (UserInputListenerUPtr listener) noexcept

template<typename ListenerT >
void	setUserInputListenerT (castor::UniquePtr< ListenerT > listener) noexcept

void	setDefaultLightingModel (LightingModelID value) noexcept

void	enableDebugTargets (bool value) noexcept

void	setMaxImageSize (uint32_t size) noexcept

void	setLpvGridSize (uint32_t size) noexcept

template<typename ComponentT >
PassComponentID	registerPassComponent (CreatePassComponentPlugin const &createPlugin=&ComponentT::createPlugin)

template<typename ComponentT >
SubmeshComponentID	registerSubmeshComponent (CreateSubmeshComponentPlugin const &createPlugin=&ComponentT::createPlugin)

void	setLengthUnit (castor::LengthUnit value) noexcept


Fonts.
template<typename ... ParametersT>
castor::FontCache::ElementPtrT	createFont (castor::String const &name, uint32_t height, castor::Path const &path) const

template<typename ... ParametersT>
castor::FontCache::ElementObsT	addNewFont (castor::String const &name, uint32_t height, castor::Path const &path)

template<typename ... ParametersT>
castor::FontCache::ElementPtrT	createSdfFont (castor::String const &name, castor::Path const &path) const

template<typename ... ParametersT>
castor::FontCache::ElementObsT	addNewSdfFont (castor::String const &name, castor::Path const &path)

castor::FontCache::ElementObsT	addFont (castor::FontCache::ElementKeyT const &key, castor::FontCache::ElementPtrT &element, bool initialise=false)

void	removeFont (castor::FontCache::ElementKeyT const &key, bool cleanup=false)

castor::FontCache::ElementObsT	findFont (castor::FontCache::ElementKeyT const &key) const

bool	hasFont (castor::FontCache::ElementKeyT const &key) const

castor::FontCache::ElementObsT	tryFindFont (castor::FontCache::ElementKeyT const &key) const

template<typename FuncT >
void	forEachFont (FuncT func) const

castor::FontResPtr	getDefaultFont ()

castor::FontCache &	getFontCache (PrivEngineToken const &)

uint32_t	getFontsCount () const


Images.
template<typename ... ParametersT>
castor::ImageCache::ElementPtrT	createImage (castor::ImageCache::ElementKeyT const &key, ParametersT &&... parameters) const

template<typename ... ParametersT>
castor::ImageCache::ElementObsT	addNewImage (castor::ImageCache::ElementKeyT const &key, ParametersT &&... parameters)

castor::ImageCache::ElementObsT	addImage (castor::ImageCache::ElementKeyT const &key, castor::ImageCache::ElementPtrT &element, bool initialise=false)

void	removeImage (castor::ImageCache::ElementKeyT const &key, bool cleanup=false) noexcept

castor::ImageCache::ElementObsT	findImage (castor::ImageCache::ElementKeyT const &key) const

bool	hasImage (castor::ImageCache::ElementKeyT const &key) const

castor::ImageCache::ElementObsT	tryFindImage (castor::ImageCache::ElementKeyT const &key) const noexcept

template<typename ... ParametersT>
castor::ImageCache::ElementObsT	tryAddNewImage (castor::ImageCache::ElementKeyT const &name, bool initialise, castor::ImageCache::ElementObsT &created, ParametersT &&... parameters)

uint32_t	getImagesCount () const

Static Public Member Functions
static C3D_API castor::Path	getPluginsDirectory ()
	Retrieves plug-ins path.

static C3D_API castor::Path	getEngineDirectory ()
	Gives the Castor directory.

static C3D_API castor::Path	getDataDirectory ()
	Retrieves data path.

static C3D_API std::locale const &	getLocale ()
	Retrieves data path.

static C3D_API void	addParsers (castor::AttributeParsers &result)

Additional Inherited Members
Protected Member Functions inherited from castor::Unique< Engine >
	Unique (Engine *pThis)
	Constructor.

	~Unique () noexcept
	Destructor.

Constructor & Destructor Documentation

◆ Engine() [1/2]

C3D_API castor3d::Engine::Engine ( EngineConfig config )

explicit

Constructor.

Parameters

[in] config The engine configuration.

◆ Engine() [2/2]

C3D_API castor3d::Engine::Engine	(	EngineConfig	config,
		castor::LoggerInstance &	logger )

Constructor.

Parameters

[in]	config	The engine configuration.
[in]	logger	The logger instance.

◆ ~Engine()

C3D_API castor3d::Engine::~Engine ( )

noexcept

Destructor.

Member Function Documentation

◆ addFont()

castor::FontCache::ElementObsT castor3d::Engine::addFont	(	castor::FontCache::ElementKeyT const &	key,
		castor::FontCache::ElementPtrT &	element,
		bool	initialise = false )

inline

◆ addImage()

castor::ImageCache::ElementObsT castor3d::Engine::addImage	(	castor::ImageCache::ElementKeyT const &	key,
		castor::ImageCache::ElementPtrT &	element,
		bool	initialise = false )

inline

◆ addNewFont()

template<typename ... ParametersT>

castor::FontCache::ElementObsT castor3d::Engine::addNewFont	(	castor::String const &	name,
		uint32_t	height,
		castor::Path const &	path )

inline

◆ addNewImage()

template<typename ... ParametersT>

castor::ImageCache::ElementObsT castor3d::Engine::addNewImage	(	castor::ImageCache::ElementKeyT const &	key,
		ParametersT &&...	parameters )

inline

◆ addNewSdfFont()

template<typename ... ParametersT>

castor::FontCache::ElementObsT castor3d::Engine::addNewSdfFont	(	castor::String const &	name,
		castor::Path const &	path )

inline

◆ addParsers()

static C3D_API void castor3d::Engine::addParsers ( castor::AttributeParsers & result )

static

◆ addSpecificsBuffersBindings()

C3D_API void castor3d::Engine::addSpecificsBuffersBindings	(	ashes::VkDescriptorSetLayoutBindingArray &	bindings,
		VkShaderStageFlags	shaderStages,
		uint32_t &	index ) const

Addw the pass' specific data buffer into the given descriptor layout bindings array.

Parameters

[in,out]	bindings	Receives the buffers descriptor layout bindings.
[in]	shaderStages	The shader stage flags.
[in,out]	index	The binding index.

◆ addSpecificsBuffersDescriptors()

C3D_API void castor3d::Engine::addSpecificsBuffersDescriptors	(	ashes::WriteDescriptorSetArray &	descriptorWrites,
		uint32_t &	index ) const

Writes the pass' specific data buffer into the given descriptor writes array.

Parameters

[in,out]	descriptorWrites	Receives the buffers descriptor writes.
[in,out]	index	The binding index.

◆ areDebugTargetsEnabled()

bool castor3d::Engine::areDebugTargetsEnabled ( ) const

inlinenoexcept

◆ areTextShadersKept()

bool castor3d::Engine::areTextShadersKept ( ) const

inlinenoexcept

◆ areUpdateOptimisationsEnabled()

bool castor3d::Engine::areUpdateOptimisationsEnabled ( ) const

inlinenoexcept

◆ cleanup()

C3D_API void castor3d::Engine::cleanup ( )

Cleanup function, destroys everything created from the beginning.

Remarks: Destroys also RenderWindows, the only things left after that is RenderSystem and loaded plug-ins

◆ createFont()

template<typename ... ParametersT>

castor::FontCache::ElementPtrT castor3d::Engine::createFont	(	castor::String const &	name,
		uint32_t	height,
		castor::Path const &	path ) const

inline

◆ createImage()

template<typename ... ParametersT>

castor::ImageCache::ElementPtrT castor3d::Engine::createImage	(	castor::ImageCache::ElementKeyT const &	key,
		ParametersT &&...	parameters ) const

inline

◆ createRandomEngine()

C3D_API std::default_random_engine castor3d::Engine::createRandomEngine ( ) const

Returns: A random engine, with a random seed if enabled.

◆ createSdfFont()

template<typename ... ParametersT>

castor::FontCache::ElementPtrT castor3d::Engine::createSdfFont	(	castor::String const &	name,
		castor::Path const &	path ) const

inline

◆ createSpecificsBuffersPassBindings()

C3D_API void castor3d::Engine::createSpecificsBuffersPassBindings	(	crg::FramePass &	pass,
		uint32_t &	index ) const

Writes the pass' specific data buffer bindings into given frame pass.

Parameters

[in,out]	pass	The target frame pass.
[in,out]	index	The binding index.

◆ declareSpecificsShaderBuffers()

C3D_API void castor3d::Engine::declareSpecificsShaderBuffers	(	sdw::ShaderWriter &	writer,
		castor::StringMap< castor3d::shader::BufferBaseUPtr > &	buffers,
		uint32_t &	binding,
		uint32_t	set ) const

Declares pass' specific data shader buffers.

Parameters

[in,out]	writer	The shader writer.
[out]	buffers	Receives the registered shader buffers.
[in,out]	binding	The descriptor binding index.
[in]	set	The descriptor set index.

◆ enableDebugTargets()

void castor3d::Engine::enableDebugTargets ( bool value )

inlinenoexcept

◆ findFont()

castor::FontCache::ElementObsT castor3d::Engine::findFont ( castor::FontCache::ElementKeyT const & key ) const

inline

◆ findImage()

castor::ImageCache::ElementObsT castor3d::Engine::findImage ( castor::ImageCache::ElementKeyT const & key ) const

inline

◆ fireMouseMove()

C3D_API bool castor3d::Engine::fireMouseMove	(	castor::Position const &	position,
		bool	ctrl,
		bool	alt,
		bool	shift )

Fires a mouse move event.

Parameters

[in]	position	The mouse position.
[in]	ctrl	Tells if the Ctrl key is down.
[in]	alt	Tells if the Alt key is down.
[in]	shift	Tells if the Shift key is down.

Returns: true if the event is processed by a handler.

◆ forEachFont()

template<typename FuncT >

void castor3d::Engine::forEachFont ( FuncT func ) const

inline

References castor::makeUniqueLock().

Here is the call graph for this function:

◆ getAdditionalParsers()

auto const & castor3d::Engine::getAdditionalParsers ( ) const

inlinenoexcept

◆ getAppName()

castor::String const & castor3d::Engine::getAppName ( ) const

inlinenoexcept

◆ getAppVersion()

Version const & castor3d::Engine::getAppVersion ( ) const

inlinenoexcept

◆ getBackgroundModelFactory() [1/2]

shader::BackgroundModelFactory const & castor3d::Engine::getBackgroundModelFactory ( ) const

inlinenoexcept

◆ getBackgroundModelFactory() [2/2]

shader::BackgroundModelFactory & castor3d::Engine::getBackgroundModelFactory ( )

inlinenoexcept

◆ getControlsManager()

C3D_API ControlsManager * castor3d::Engine::getControlsManager ( ) const

◆ getCpuInformations()

castor::CpuInformations const & castor3d::Engine::getCpuInformations ( ) const

inlinenoexcept

◆ getDataDirectory()

static C3D_API castor::Path castor3d::Engine::getDataDirectory ( )

static

Retrieves data path.

Returns: The data path

◆ getDefaultFont()

castor::FontResPtr castor3d::Engine::getDefaultFont ( )

inline

◆ getDefaultLightingModel()

LightingModelID castor3d::Engine::getDefaultLightingModel ( ) const

inlinenoexcept

◆ getDefaultLightingModelName()

C3D_API castor::String castor3d::Engine::getDefaultLightingModelName ( ) const

◆ getDefaultMaterial()

C3D_API castor3d::MaterialObs castor3d::Engine::getDefaultMaterial ( ) const

◆ getDefaultSampler()

auto castor3d::Engine::getDefaultSampler ( ) const

inlinenoexcept

◆ getEngineDirectory()

static C3D_API castor::Path castor3d::Engine::getEngineDirectory ( )

static

Gives the Castor directory.

Returns: The directory

◆ getFontCache()

castor::FontCache & castor3d::Engine::getFontCache ( PrivEngineToken const & )

inline

◆ getFontsCount()

uint32_t castor3d::Engine::getFontsCount ( ) const

inline

◆ getGraphResourceHandler()

crg::ResourceHandler & castor3d::Engine::getGraphResourceHandler ( )

inlinenoexcept

◆ getImageLoader() [1/2]

castor::ImageLoader const & castor3d::Engine::getImageLoader ( ) const

inlinenoexcept

◆ getImageLoader() [2/2]

castor::ImageLoader & castor3d::Engine::getImageLoader ( )

inlinenoexcept

◆ getImagesCount()

uint32_t castor3d::Engine::getImagesCount ( ) const

inline

◆ getImageWriter()

castor::ImageWriter const & castor3d::Engine::getImageWriter ( ) const

inlinenoexcept

◆ getImporterFileFactory()

ImporterFileFactory & castor3d::Engine::getImporterFileFactory ( ) const

inlinenoexcept

◆ getLengthUnit()

castor::LengthUnit castor3d::Engine::getLengthUnit ( ) const

inlinenoexcept

◆ getLightingModelFactory()

LightingModelFactory & castor3d::Engine::getLightingModelFactory ( ) const

inlinenoexcept

◆ getLightsSampler()

auto castor3d::Engine::getLightsSampler ( ) const

inlinenoexcept

◆ getLoadingScene()

SceneRPtr castor3d::Engine::getLoadingScene ( ) const

inlinenoexcept

◆ getLocale()

static C3D_API std::locale const & castor3d::Engine::getLocale ( )

static

Retrieves data path.

Returns: The data path

◆ getLogger()

castor::LoggerInstance & castor3d::Engine::getLogger ( ) const

inlinenoexcept

◆ getLpvGridSize()

uint32_t castor3d::Engine::getLpvGridSize ( ) const

inlinenoexcept

◆ getMaxImageSize()

uint32_t castor3d::Engine::getMaxImageSize ( ) const

inlinenoexcept

◆ getMaxPassTypeCount()

C3D_API uint32_t castor3d::Engine::getMaxPassTypeCount ( ) const

◆ getMeshFactory()

MeshFactory & castor3d::Engine::getMeshFactory ( ) const

inlinenoexcept

◆ getNextRainbowColour()

C3D_API castor::RgbaColour castor3d::Engine::getNextRainbowColour ( ) const

Retrieves a colour issued from a rainbow colours iterator.

◆ getParticleFactory()

ParticleFactory & castor3d::Engine::getParticleFactory ( ) const

inlinenoexcept

◆ getPassComponentsRegister()

PassComponentRegister & castor3d::Engine::getPassComponentsRegister ( ) const

inlinenoexcept

◆ getPassFactory()

PassFactory & castor3d::Engine::getPassFactory ( ) const

inlinenoexcept

◆ getPluginsDirectory()

static C3D_API castor::Path castor3d::Engine::getPluginsDirectory ( )

static

Retrieves plug-ins path.

Returns: The plug-ins path

◆ getPostEffectFactory() [1/2]

C3D_API PostEffectFactory & castor3d::Engine::getPostEffectFactory ( )

◆ getPostEffectFactory() [2/2]

C3D_API PostEffectFactory const & castor3d::Engine::getPostEffectFactory ( ) const

◆ getPrefilteredBrdfTexture()

Texture const & castor3d::Engine::getPrefilteredBrdfTexture ( ) const

inlinenoexcept

◆ getRenderDevice()

C3D_API RenderDevice * castor3d::Engine::getRenderDevice ( ) const

◆ getRenderersList()

ashes::RendererList const & castor3d::Engine::getRenderersList ( ) const

inlinenoexcept

◆ getRenderLoop()

RenderLoop & castor3d::Engine::getRenderLoop ( ) const

inlinenoexcept

◆ getRenderPassInfo()

C3D_API RenderPassRegisterInfo * castor3d::Engine::getRenderPassInfo ( castor::String const & renderPassType ) const

Retrieves a scene render pass type's creation informations.

Parameters

[in] renderPassType The pass type name.

◆ getRenderPassInfos()

C3D_API castor::Vector< RenderPassRegisterInfo * > castor3d::Engine::getRenderPassInfos ( TechniquePassEvent event ) const

Retrieves the scene render passes type creation informations.

Parameters

[in] event The event type for wanted passes.

◆ getRenderPassTypeConfiguration()

C3D_API Parameters castor3d::Engine::getRenderPassTypeConfiguration ( castor::String const & renderPassType ) const

Retrieve a scene render pass type's configuration parameters.

Parameters

[in] renderPassType The pass type name.

Returns: The pass configuration parameters.

◆ getRenderPassTypeID()

C3D_API RenderPassTypeID castor3d::Engine::getRenderPassTypeID ( castor::String const & renderPassType ) const

Retrieves the ID for given scene render pass type name.

Parameters

[in] renderPassType The pass type name.

◆ getRenderSystem()

RenderSystem * castor3d::Engine::getRenderSystem ( ) const

inlinenoexcept

◆ getRenderWindows()

auto const & castor3d::Engine::getRenderWindows ( ) const

inlinenoexcept

◆ getShaderAllocator()

C3D_API ast::ShaderAllocator & castor3d::Engine::getShaderAllocator ( )

◆ getShaderDebugLevel()

uint32_t castor3d::Engine::getShaderDebugLevel ( ) const

inlinenoexcept

◆ getSubmeshComponentsRegister()

SubmeshComponentRegister & castor3d::Engine::getSubmeshComponentsRegister ( ) const

inlinenoexcept

◆ getToneMappingFactory() [1/2]

C3D_API ToneMappingFactory & castor3d::Engine::getToneMappingFactory ( )

◆ getToneMappingFactory() [2/2]

C3D_API ToneMappingFactory const & castor3d::Engine::getToneMappingFactory ( ) const

◆ getUploadData()

C3D_API UploadData & castor3d::Engine::getUploadData ( ) const

noexcept

◆ getUserInputListener()

UserInputListenerRPtr castor3d::Engine::getUserInputListener ( )

inlinenoexcept

◆ getVersion()

Version const & castor3d::Engine::getVersion ( ) const

inlinenoexcept

◆ getWantedFps()

C3D_API uint32_t castor3d::Engine::getWantedFps ( ) const

◆ hasFont()

bool castor3d::Engine::hasFont ( castor::FontCache::ElementKeyT const & key ) const

inline

◆ hasImage()

bool castor3d::Engine::hasImage ( castor::ImageCache::ElementKeyT const & key ) const

inline

◆ hasMeshShaders()

C3D_API bool castor3d::Engine::hasMeshShaders ( ) const

◆ hasRenderLoop()

bool castor3d::Engine::hasRenderLoop ( ) const

inlinenoexcept

◆ initialise()

C3D_API void castor3d::Engine::initialise	(	uint32_t	wantedFPS = 100,
		bool	threaded = false )

Initialisation function, Sets the wanted frame rate.

Parameters

[in]	wantedFPS	The wanted FPS count
[in]	threaded	If `false`, the render can't be threaded

◆ isApiTraceEnabled()

bool castor3d::Engine::isApiTraceEnabled ( ) const

inlinenoexcept

◆ isCleaned()

C3D_API bool castor3d::Engine::isCleaned ( ) const

noexcept

Retrieves the cleanup status.

Remarks: Thread-safe

Returns: true if cleaned up

◆ isRandomisationEnabled()

bool castor3d::Engine::isRandomisationEnabled ( ) const

inlinenoexcept

◆ isShaderValidationEnabled()

bool castor3d::Engine::isShaderValidationEnabled ( ) const

inlinenoexcept

◆ isThreaded()

bool castor3d::Engine::isThreaded ( ) const

inlinenoexcept

◆ isValidationEnabled()

bool castor3d::Engine::isValidationEnabled ( ) const

inlinenoexcept

◆ loadRenderer() [1/2]

C3D_API bool castor3d::Engine::loadRenderer ( castor::String const & type )

Loads a renderer plug-in, given the renderer type.

Parameters

[in] type The renderer type.

Returns: true if ok

◆ loadRenderer() [2/2]

C3D_API void castor3d::Engine::loadRenderer ( Renderer renderer )

Loads a renderer plug-in, given the renderer type.

Parameters

[in] renderer The renderer.

◆ postEvent() [1/2]

C3D_API CpuFrameEvent * castor3d::Engine::postEvent ( CpuFrameEventUPtr event ) const

Posts a frame event to the default frame listener.

Parameters

[in] event The event to add

◆ postEvent() [2/2]

C3D_API GpuFrameEvent * castor3d::Engine::postEvent ( GpuFrameEventUPtr event ) const

Posts a frame event to the default frame listener.

Parameters

[in] event The event to add

◆ pushCpuJob()

C3D_API void castor3d::Engine::pushCpuJob ( castor::AsyncJobQueue::Job job )

Enqueues the given CPU job.

Parameters

[in] job The job to execute.

◆ registerBackgroundModel()

C3D_API BackgroundModelID castor3d::Engine::registerBackgroundModel	(	castor::String const &	name,
		shader::BackgroundModelCreator	creator )

Registers a Background Model.

Parameters

[in]	name	The model name.
[in]	creator	The model creation function.

Returns: The model ID.

◆ registerBuffer()

C3D_API void castor3d::Engine::registerBuffer ( ShaderBuffer const & buffer )

Registers a ShaderBuffer.

Parameters

[in] buffer The ShaderBuffer.

◆ registerClearcoatBrdf()

C3D_API void castor3d::Engine::registerClearcoatBrdf ( shader::ClearcoatBrdfDesc const & desc ) const

Registers a clearcoat BRDF.

Parameters

[in] desc The BRDF description.

◆ registerDiffuseBrdf()

C3D_API void castor3d::Engine::registerDiffuseBrdf ( shader::DiffuseBrdfDesc const & desc ) const

Registers a diffuse BRDF.

Parameters

[in] desc The BRDF description.

◆ registerLightingModel()

C3D_API void castor3d::Engine::registerLightingModel	(	castor::String const &	baseName,
		shader::LightingModelDesc const &	defaultDesc,
		shader::LightingModelCreator const &	creator ) const

Registers a lighting model.

Parameters

[in]	baseName	The lighting model base name.
[in]	defaultDesc	The default model description.
[in]	creator	The model creation function.

◆ registerParsers()

C3D_API void castor3d::Engine::registerParsers	(	castor::String	name,
		castor::AttributeParsers	parsers,
		castor::StrUInt32Map	sections,
		castor::UserContextCreator	contextCreator )

Registers additional parsers for SceneFileParser.

Parameters

[in]	name	The registering name.
[in]	parsers	The parsers.
[in]	sections	The sections.
[in]	contextCreator	The user parser context creation function.

◆ registerPassComponent() [1/2]

C3D_API PassComponentID castor3d::Engine::registerPassComponent	(	castor::String const &	type,
		PassComponentPluginUPtr	componentPlugin ) const

Registers a pass component.

Parameters

[in]	type	The component type name.
[in]	componentPlugin	The component's specific functions.

◆ registerPassComponent() [2/2]

template<typename ComponentT >

PassComponentID castor3d::Engine::registerPassComponent ( CreatePassComponentPlugin const & createPlugin = &ComponentT::createPlugin )

inline

◆ registerPassModel()

C3D_API void castor3d::Engine::registerPassModel ( PassRegisterInfo const & info ) const

Registers the given pass info with all background models.

Parameters

[in] info The pass registering info.

◆ registerRenderPassType()

C3D_API void castor3d::Engine::registerRenderPassType	(	castor::String const &	renderPassType,
		castor::UniquePtr< RenderPassRegisterInfo >	info )

Registers a scene render pass type, used to render given material pass type.

Parameters

[in]	renderPassType	The pass type name.
[in]	info	The pass creation informations.

◆ registerScatteringModel()

C3D_API void castor3d::Engine::registerScatteringModel ( shader::ScatteringModelDesc const & desc ) const

Registers a scattering model.

Parameters

[in] desc The model description.

◆ registerSheenBrdf()

C3D_API void castor3d::Engine::registerSheenBrdf ( shader::SheenBrdfDesc const & desc ) const

Registers a sheen BRDF.

Parameters

[in] desc The BRDF description.

◆ registerSpecificsBuffer()

C3D_API void castor3d::Engine::registerSpecificsBuffer	(	castor::String const &	name,
		castor3d::SpecificsBuffer	buffer ) const

Registers a specific data shader buffer.

Parameters

[in,out]	name	The shader buffer name.
[out]	buffer	The shader buffer.

◆ registerSpecularBrdf()

C3D_API void castor3d::Engine::registerSpecularBrdf ( shader::SpecularBrdfDesc const & desc ) const

Registers a specular BRDF.

Parameters

[in] desc The BRDF description.

◆ registerSubmeshComponent() [1/2]

C3D_API SubmeshComponentID castor3d::Engine::registerSubmeshComponent	(	castor::String const &	type,
		SubmeshComponentPluginUPtr	componentPlugin ) const

Registers a pass component.

Parameters

[in]	type	The component type name.
[in]	componentPlugin	The component's specific functions.

◆ registerSubmeshComponent() [2/2]

template<typename ComponentT >

SubmeshComponentID castor3d::Engine::registerSubmeshComponent ( CreateSubmeshComponentPlugin const & createPlugin = &ComponentT::createPlugin )

inline

◆ registerTimer()

C3D_API void castor3d::Engine::registerTimer	(	castor::String const &	category,
		FramePassTimer &	timer )

Registers a render pass timer.

Parameters

[in]	category	The timer category name.
[in]	timer	The timer to register.

◆ registerWindow()

C3D_API void castor3d::Engine::registerWindow ( RenderWindow & window )

Registers a RenderWindow.

Parameters

[in] window The RenderWindow.

◆ removeFont()

void castor3d::Engine::removeFont	(	castor::FontCache::ElementKeyT const &	key,
		bool	cleanup = false )

inline

◆ removeImage()

void castor3d::Engine::removeImage	(	castor::ImageCache::ElementKeyT const &	key,
		bool	cleanup = false )

inlinenoexcept

◆ sendEvent()

C3D_API void castor3d::Engine::sendEvent ( GpuFrameEventUPtr event ) const

If a device is enabled, executes the given event, if not posts it to the default frame listener.

Parameters

[in] event The event.

◆ setCleaned()

C3D_API void castor3d::Engine::setCleaned ( )

noexcept

Tells the engine is cleaned up.

Remarks: Thread-safe

◆ setDefaultLightingModel()

void castor3d::Engine::setDefaultLightingModel ( LightingModelID value )

inlinenoexcept

◆ setLengthUnit()

void castor3d::Engine::setLengthUnit ( castor::LengthUnit value )

inlinenoexcept

◆ setLoadingScene()

C3D_API void castor3d::Engine::setLoadingScene ( SceneUPtr scene )

◆ setLpvGridSize()

void castor3d::Engine::setLpvGridSize ( uint32_t size )

inlinenoexcept

◆ setMaxImageSize()

void castor3d::Engine::setMaxImageSize ( uint32_t size )

inlinenoexcept

◆ setRenderPassTypeConfiguration()

C3D_API void castor3d::Engine::setRenderPassTypeConfiguration	(	castor::String const &	renderPassType,
		Parameters	parameters )

Registers a scene render pass type's configuration parameters.

Parameters

[in]	renderPassType	The pass type name.
[in]	parameters	The pass configuration parameters.

◆ setUserInputListener()

void castor3d::Engine::setUserInputListener ( UserInputListenerUPtr listener )

inlinenoexcept

◆ setUserInputListenerT()

template<typename ListenerT >

void castor3d::Engine::setUserInputListenerT ( castor::UniquePtr< ListenerT > listener )

inlinenoexcept

◆ tryAddNewImage()

template<typename ... ParametersT>

castor::ImageCache::ElementObsT castor3d::Engine::tryAddNewImage	(	castor::ImageCache::ElementKeyT const &	name,
		bool	initialise,
		castor::ImageCache::ElementObsT &	created,
		ParametersT &&...	parameters )

inline

◆ tryFindFont()

castor::FontCache::ElementObsT castor3d::Engine::tryFindFont ( castor::FontCache::ElementKeyT const & key ) const

inline

◆ tryFindImage()

castor::ImageCache::ElementObsT castor3d::Engine::tryFindImage ( castor::ImageCache::ElementKeyT const & key ) const

inlinenoexcept

◆ unregisterBackgroundModel()

C3D_API BackgroundModelID castor3d::Engine::unregisterBackgroundModel ( castor::String const & name )

Unregisters a Background Model.

Parameters

[in] name The model name.

◆ unregisterBuffer()

C3D_API void castor3d::Engine::unregisterBuffer ( ShaderBuffer const & buffer )

Unregisters a ShaderBuffer.

Parameters

[in] buffer The ShaderBuffer.

◆ unregisterClearcoatBrdf()

C3D_API void castor3d::Engine::unregisterClearcoatBrdf ( castor::String const & name ) const

Unegisters a clearcoat BRDF.

Parameters

[in] name The BRDF name.

◆ unregisterDiffuseBrdf()

C3D_API void castor3d::Engine::unregisterDiffuseBrdf ( castor::String const & name ) const

Unegisters a diffuse BRDF.

Parameters

[in] name The BRDF name.

◆ unregisterLightingModel()

C3D_API void castor3d::Engine::unregisterLightingModel ( castor::String const & baseName ) const

Unregisters a lighting model.

Parameters

[in] baseName The lighting model base name.

◆ unregisterParsers()

C3D_API void castor3d::Engine::unregisterParsers ( castor::String const & name )

noexcept

Unregisters parsers for SceneFileParser.

Parameters

[in] name The registering name.

◆ unregisterPassComponent()

C3D_API void castor3d::Engine::unregisterPassComponent ( castor::String const & type ) const

Unregisters a pass component.

Parameters

[in] type The component type name.

◆ unregisterPassModel()

C3D_API void castor3d::Engine::unregisterPassModel ( castor::String const & baseName ) const

Unregisters a pass model.

Parameters

[in] baseName The model base name.

◆ unregisterRenderPassType()

C3D_API void castor3d::Engine::unregisterRenderPassType ( castor::String const & renderPassType )

Unregisters a scene render pass type.

Parameters

[in] renderPassType The pass type name.

◆ unregisterScatteringModel()

C3D_API void castor3d::Engine::unregisterScatteringModel ( castor::String const & name ) const

Unegisters a scattering model.

Parameters

[in] name The model name.

◆ unregisterSheenBrdf()

C3D_API void castor3d::Engine::unregisterSheenBrdf ( castor::String const & name ) const

Unegisters a sheen BRDF.

Parameters

[in] name The BRDF name.

◆ unregisterSpecificsBuffer()

C3D_API void castor3d::Engine::unregisterSpecificsBuffer ( castor::String const & name ) const

Unregisters a pass' specific data buffer.

Parameters

[in,out] name The shader buffer name.

◆ unregisterSpecularBrdf()

C3D_API void castor3d::Engine::unregisterSpecularBrdf ( castor::String const & name ) const

Unegisters a specular BRDF.

Parameters

[in] name The BRDF name.

◆ unregisterSubmeshComponent()

C3D_API void castor3d::Engine::unregisterSubmeshComponent ( castor::String const & type ) const

Unregisters a pass component.

Parameters

[in] type The component type name.

◆ unregisterTimer()

C3D_API void castor3d::Engine::unregisterTimer	(	castor::String const &	category,
		FramePassTimer &	timer )

noexcept

Unregisters a render pass timer.

Parameters

[in]	category	The timer category name.
[in]	timer	The timer to unregister.

◆ unregisterWindow()

C3D_API void castor3d::Engine::unregisterWindow ( RenderWindow const & window )

Unregisters a RenderWindow.

Parameters

[in] window The RenderWindow.

◆ update() [1/2]

C3D_API void castor3d::Engine::update ( CpuUpdater & updater )

Updates the engine, CPU wise.

Parameters

[in,out] updater The update data.

◆ update() [2/2]

C3D_API void castor3d::Engine::update ( GpuUpdater & updater )

Updates the engine, GPU wise.

Parameters

[in,out] updater The update data.

◆ upload()

C3D_API void castor3d::Engine::upload ( UploadData & uploader )

Updates the buffers.

Parameters

[in,out] uploader Receives the upload requests.

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

Castor3D/Engine.hpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

◆ Engine() [1/2]

◆ Engine() [2/2]

◆ ~Engine()

Member Function Documentation

◆ addFont()

◆ addImage()

◆ addNewFont()

◆ addNewImage()

◆ addNewSdfFont()

◆ addParsers()

◆ addSpecificsBuffersBindings()

◆ addSpecificsBuffersDescriptors()

◆ areDebugTargetsEnabled()

◆ areTextShadersKept()

◆ areUpdateOptimisationsEnabled()

◆ cleanup()

◆ createFont()

◆ createImage()

◆ createRandomEngine()

◆ createSdfFont()

◆ createSpecificsBuffersPassBindings()

◆ declareSpecificsShaderBuffers()

◆ enableDebugTargets()

◆ findFont()

◆ findImage()

◆ fireMouseMove()

◆ forEachFont()

◆ getAdditionalParsers()

◆ getAppName()

◆ getAppVersion()

◆ getBackgroundModelFactory() [1/2]

◆ getBackgroundModelFactory() [2/2]

◆ getControlsManager()

◆ getCpuInformations()

◆ getDataDirectory()

◆ getDefaultFont()

◆ getDefaultLightingModel()

◆ getDefaultLightingModelName()

◆ getDefaultMaterial()

◆ getDefaultSampler()

◆ getEngineDirectory()

◆ getFontCache()

◆ getFontsCount()

◆ getGraphResourceHandler()

◆ getImageLoader() [1/2]

◆ getImageLoader() [2/2]

◆ getImagesCount()

◆ getImageWriter()

◆ getImporterFileFactory()

◆ getLengthUnit()

◆ getLightingModelFactory()

◆ getLightsSampler()

◆ getLoadingScene()

◆ getLocale()

◆ getLogger()

◆ getLpvGridSize()

◆ getMaxImageSize()

◆ getMaxPassTypeCount()

◆ getMeshFactory()

◆ getNextRainbowColour()

◆ getParticleFactory()

◆ getPassComponentsRegister()

◆ getPassFactory()

◆ getPluginsDirectory()

◆ getPostEffectFactory() [1/2]

◆ getPostEffectFactory() [2/2]

◆ getPrefilteredBrdfTexture()

◆ getRenderDevice()

◆ getRenderersList()

◆ getRenderLoop()

◆ getRenderPassInfo()

◆ getRenderPassInfos()

◆ getRenderPassTypeConfiguration()

◆ getRenderPassTypeID()

◆ getRenderSystem()

◆ getRenderWindows()