Graphe d'héritage de castor3d::Engine:

Graphe de collaboration de castor3d::Engine:

Fonctions membres publiques
C3D_API	Engine (castor::String const &appName, Version const &appVersion, bool enableValidation)
	Constructeur. Plus de détails...

C3D_API	Engine (castor::String const &appName, Version const &appVersion, bool enableValidation, castor::LoggerInstance &logger)
	Constructeur. Plus de détails...

C3D_API	~Engine ()
	Destructeur. Plus de détails...

C3D_API void	initialise (uint32_t wantedFPS=100, bool threaded=false)
	Fonction d'initialisation, définit le frame rate voulu. Plus de détails...

C3D_API void	cleanup ()
	Fonction de nettoyage, détruit tout ce qui a été créé depuis le début. Plus de détails...

C3D_API bool	loadRenderer (castor::String const &type)
	Charge un plug-in de rendu, selon le type de rendu. Plus de détails...

C3D_API void	postEvent (CpuFrameEventUPtr event)
	Ajoute un évènement de frame au frame listener par défaut. Plus de détails...

C3D_API void	sendEvent (GpuFrameEventUPtr event)
	Si un device est actif, exécute l'évènement donné, sinon il est ajouté au frame listener par défaut. Plus de détails...

C3D_API void	postEvent (GpuFrameEventUPtr event)
	Ajoute un évènement de frame au frame listener par défaut. Plus de détails...

C3D_API bool	fireMouseMove (castor::Position const &position)

C3D_API bool	isCleaned ()
	Récupère le statut de nettoyage. Plus de détails...

C3D_API void	setCleaned ()
	Dit que le moteur est nettoyé Plus de détails...

C3D_API void	registerWindow (RenderWindow &window)
	Enregistre une RenderWindow. Plus de détails...

C3D_API void	unregisterWindow (RenderWindow const &window)
	Désenregistre une RenderWindow. Plus de détails...

C3D_API void	registerParsers (castor::String const &name, castor::AttributeParsersBySection const &parsers)
	Enregistre des analyseurs supplémentaires pour SceneFileParser. Plus de détails...

C3D_API void	registerSections (castor::String const &name, castor::StrUInt32Map const &sections)
	Enregistre des sections supplémentaires pour SceneFileParser. Plus de détails...

C3D_API void	unregisterParsers (castor::String const &name)
	Désenregistre des analyseurs pour SceneFileParser. Plus de détails...

C3D_API void	unregisterSections (castor::String const &name)
	Désenregistre des sections pour SceneFileParser. Plus de détails...

C3D_API void	renderDepth (ashes::RenderPass const &renderPass, ashes::FrameBuffer const &frameBuffer, castor::Position const &position, castor::Size const &size, TextureLayout const &texture)
	Rend la texture profondeur donnée dans le tampon d'image donné. Plus de détails...


C3D_API castor::RgbaColour	getNextRainbowColour () const

castor::String const &	getAppName () const

Version const &	getAppVersion () const

castor::ImageCache const &	getImageCache () const

castor::ImageCache &	getImageCache ()

castor::FontCache const &	getFontCache () const

castor::FontCache &	getFontCache ()

UserInputListenerSPtr	getUserInputListener ()

RenderSystem *	getRenderSystem () const

SamplerSPtr	getDefaultSampler () const

SamplerSPtr	getLightsSampler () const

std::map< castor::String, castor::AttributeParsersBySection > const &	getAdditionalParsers () const

std::map< castor::String, castor::StrUInt32Map > const &	getAdditionalSections () const

Version const &	getVersion () const

bool	isValidationEnabled () const

bool	isApiTraceEnabled () const

bool	hasRenderLoop () const

RenderLoop const &	getRenderLoop () const

RenderLoop &	getRenderLoop ()

bool	isThreaded ()

MeshFactory const &	getMeshFactory () const

MeshFactory &	getMeshFactory ()

MeshSubdividerFactory const &	getSubdividerFactory () const

MeshSubdividerFactory &	getSubdividerFactory ()

MeshImporterFactory const &	getImporterFactory () const

MeshImporterFactory &	getImporterFactory ()

ParticleFactory &	getParticleFactory ()

castor::CpuInformations const &	getCpuInformations () const

MaterialType	getMaterialsType () const

castor::ImageLoader const &	getImageLoader () const

castor::ImageWriter const &	getImageWriter () const

ashes::RendererList const &	getRenderersList () const

castor::LoggerInstance &	getLogger ()

uint32_t	getLpvGridSize ()


void	setUserInputListener (UserInputListenerSPtr listener)

void	setMaterialsType (MaterialType type)

void	setLpvGridSize (uint32_t size)

Fonctions membres publiques statiques
static C3D_API castor::Path	getPluginsDirectory ()
	Récupère le chemin des plug-ins. Plus de détails...

static C3D_API castor::Path	getEngineDirectory ()
	donne le répertoire du Castor Plus de détails...

static C3D_API castor::Path	getDataDirectory ()
	Récupère le chemin des données. Plus de détails...

static C3D_API std::locale const &	getLocale ()
	Récupère le chemin des données. Plus de détails...

Documentation des constructeurs et destructeur

◆ Engine() [1/2]

C3D_API castor3d::Engine::Engine	(	castor::String const &	appName,
		Version const &	appVersion,
		bool	enableValidation
	)

Constructeur.

◆ Engine() [2/2]

C3D_API castor3d::Engine::Engine	(	castor::String const &	appName,
		Version const &	appVersion,
		bool	enableValidation,
		castor::LoggerInstance &	logger
	)

Constructeur.

◆ ~Engine()

C3D_API castor3d::Engine::~Engine ( )

Destructeur.

Documentation des fonctions membres

◆ cleanup()

C3D_API void castor3d::Engine::cleanup ( )

Fonction de nettoyage, détruit tout ce qui a été créé depuis le début.

Remarques: Détruit aussi les RenderWindows, les seules choses restantes après ça sont le RenderSystem et les plug-ins chargés

◆ fireMouseMove()

C3D_API bool castor3d::Engine::fireMouseMove ( castor::Position const & position )

◆ getAdditionalParsers()

std::map< castor::String, castor::AttributeParsersBySection > const& castor3d::Engine::getAdditionalParsers ( ) const

inline

◆ getAdditionalSections()

std::map< castor::String, castor::StrUInt32Map > const& castor3d::Engine::getAdditionalSections ( ) const

inline

◆ getAppName()

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

inline

◆ getAppVersion()

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

inline

◆ getCpuInformations()

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

inline

◆ getDataDirectory()

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

static

Récupère le chemin des données.

Renvoie: Le chemin des données

◆ getDefaultSampler()

SamplerSPtr castor3d::Engine::getDefaultSampler ( ) const

inline

◆ getEngineDirectory()

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

static

donne le répertoire du Castor

Renvoie: Le répertoire

◆ getFontCache() [1/2]

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

inline

◆ getFontCache() [2/2]

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

inline

◆ getImageCache() [1/2]

castor::ImageCache const& castor3d::Engine::getImageCache ( ) const

inline

◆ getImageCache() [2/2]

castor::ImageCache& castor3d::Engine::getImageCache ( )

inline

◆ getImageLoader()

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

inline

◆ getImageWriter()

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

inline

◆ getImporterFactory() [1/2]

MeshImporterFactory const& castor3d::Engine::getImporterFactory ( ) const

inline

◆ getImporterFactory() [2/2]

MeshImporterFactory& castor3d::Engine::getImporterFactory ( )

inline

◆ getLightsSampler()

SamplerSPtr castor3d::Engine::getLightsSampler ( ) const

inline

◆ getLocale()

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

static

Récupère le chemin des données.

Renvoie: Le chemin des données

◆ getLogger()

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

inline

◆ getLpvGridSize()

uint32_t castor3d::Engine::getLpvGridSize ( )

inline

◆ getMaterialsType()

MaterialType castor3d::Engine::getMaterialsType ( ) const

inline

◆ getMeshFactory() [1/2]

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

inline

◆ getMeshFactory() [2/2]

MeshFactory& castor3d::Engine::getMeshFactory ( )

inline

◆ getNextRainbowColour()

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

name Accesseurs.

◆ getParticleFactory()

ParticleFactory& castor3d::Engine::getParticleFactory ( )

inline

◆ getPluginsDirectory()

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

static

Récupère le chemin des plug-ins.

Renvoie: Le chemin des plug-ins

◆ getRenderersList()

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

inline

◆ getRenderLoop() [1/2]

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

inline

◆ getRenderLoop() [2/2]

RenderLoop& castor3d::Engine::getRenderLoop ( )

inline

◆ getRenderSystem()

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

inline

◆ getSubdividerFactory() [1/2]

MeshSubdividerFactory const& castor3d::Engine::getSubdividerFactory ( ) const

inline

◆ getSubdividerFactory() [2/2]

MeshSubdividerFactory& castor3d::Engine::getSubdividerFactory ( )

inline

◆ getUserInputListener()

UserInputListenerSPtr castor3d::Engine::getUserInputListener ( )

inline

◆ getVersion()

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

inline

◆ hasRenderLoop()

bool castor3d::Engine::hasRenderLoop ( ) const

inline

◆ initialise()

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

Fonction d'initialisation, définit le frame rate voulu.

Paramètres

[in]	wantedFPS	Le nombre voulu de FPS
[in]	threaded	Si `false`, le rendu ne peut pas être threadé

◆ isApiTraceEnabled()

bool castor3d::Engine::isApiTraceEnabled ( ) const

inline

◆ isCleaned()

C3D_API bool castor3d::Engine::isCleaned ( )

Récupère le statut de nettoyage.

Remarques: Thread-safe

Renvoie: true si nettoyé

◆ isThreaded()

bool castor3d::Engine::isThreaded ( )

inline

◆ isValidationEnabled()

bool castor3d::Engine::isValidationEnabled ( ) const

inline

◆ loadRenderer()

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

Charge un plug-in de rendu, selon le type de rendu.

Paramètres

[in] type Le type de rendu

Renvoie: true si tout s'est bien passé

◆ postEvent() [1/2]

C3D_API void castor3d::Engine::postEvent ( CpuFrameEventUPtr event )

Ajoute un évènement de frame au frame listener par défaut.

Paramètres

[in] event L'évènement

◆ postEvent() [2/2]

C3D_API void castor3d::Engine::postEvent ( GpuFrameEventUPtr event )

Ajoute un évènement de frame au frame listener par défaut.

Paramètres

[in] event L'évènement

◆ registerParsers()

C3D_API void castor3d::Engine::registerParsers	(	castor::String const &	name,
		castor::AttributeParsersBySection const &	parsers
	)

Enregistre des analyseurs supplémentaires pour SceneFileParser.

Paramètres

[in]	name	Le nom d'enregistrement.
[in]	parsers	Les analyseurs.

◆ registerSections()

C3D_API void castor3d::Engine::registerSections	(	castor::String const &	name,
		castor::StrUInt32Map const &	sections
	)

Enregistre des sections supplémentaires pour SceneFileParser.

Paramètres

[in]	name	Le nom d'enregistrement.
[in]	sections	Les sections.

◆ registerWindow()

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

Enregistre une RenderWindow.

◆ renderDepth()

C3D_API void castor3d::Engine::renderDepth	(	ashes::RenderPass const &	renderPass,
		ashes::FrameBuffer const &	frameBuffer,
		castor::Position const &	position,
		castor::Size const &	size,
		TextureLayout const &	texture
	)

Rend la texture profondeur donnée dans le tampon d'image donné.

Paramètres

[in]	renderPass	La passe de rendu.
[in]	frameBuffer	Le frame buffer.
[in]	position	La position du viewport de rendu.
[in]	size	La taille du viewport de rendu.
[in]	texture	La texture.

◆ sendEvent()

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

Si un device est actif, exécute l'évènement donné, sinon il est ajouté au frame listener par défaut.

Paramètres

[in] event L'évènement.

◆ setCleaned()

C3D_API void castor3d::Engine::setCleaned ( )

Dit que le moteur est nettoyé

Remarques: Thread-safe

◆ setLpvGridSize()

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

inline

◆ setMaterialsType()

void castor3d::Engine::setMaterialsType ( MaterialType type )

inline

◆ setUserInputListener()

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

inline

name Mutateurs.

◆ unregisterParsers()

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

Désenregistre des analyseurs pour SceneFileParser.

Paramètres

[in] name Le nom d'enregistrement.

◆ unregisterSections()

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

Désenregistre des sections pour SceneFileParser.

Paramètres

[in] name Le nom d'enregistrement.

◆ unregisterWindow()

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

Désenregistre une RenderWindow.

La documentation de cette classe a été générée à partir du fichier suivant :

Engine.hpp

Fonctions membres publiques

Fonctions membres publiques statiques

Documentation des constructeurs et destructeur

◆ Engine() [1/2]

◆ Engine() [2/2]

◆ ~Engine()

Documentation des fonctions membres

◆ cleanup()

◆ fireMouseMove()

◆ getAdditionalParsers()

◆ getAdditionalSections()

◆ getAppName()

◆ getAppVersion()

◆ getCpuInformations()

◆ getDataDirectory()

◆ getDefaultSampler()

◆ getEngineDirectory()

◆ getFontCache() [1/2]

◆ getFontCache() [2/2]

◆ getImageCache() [1/2]

◆ getImageCache() [2/2]

◆ getImageLoader()

◆ getImageWriter()

◆ getImporterFactory() [1/2]

◆ getImporterFactory() [2/2]

◆ getLightsSampler()

◆ getLocale()

◆ getLogger()

◆ getLpvGridSize()

◆ getMaterialsType()

◆ getMeshFactory() [1/2]

◆ getMeshFactory() [2/2]

◆ getNextRainbowColour()

◆ getParticleFactory()

◆ getPluginsDirectory()

◆ getRenderersList()

◆ getRenderLoop() [1/2]

◆ getRenderLoop() [2/2]

◆ getRenderSystem()

◆ getSubdividerFactory() [1/2]

◆ getSubdividerFactory() [2/2]

◆ getUserInputListener()

◆ getVersion()

◆ hasRenderLoop()

◆ initialise()

◆ isApiTraceEnabled()

◆ isCleaned()

◆ isThreaded()

◆ isValidationEnabled()

◆ loadRenderer()

◆ postEvent() [1/2]

◆ postEvent() [2/2]

◆ registerParsers()

◆ registerSections()

◆ registerWindow()

◆ renderDepth()

◆ sendEvent()

◆ setCleaned()

◆ setLpvGridSize()

◆ setMaterialsType()

◆ setUserInputListener()

◆ unregisterParsers()

◆ unregisterSections()

◆ unregisterWindow()