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

Graphe de collaboration de Castor3D::Engine:

Fonctions membres publiques
	Engine (Castor::Logger *p_pLogger)
	Constructeur. Plus de détails...

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

void	Initialise (uint32_t p_wantedFPS=100, bool p_bThreaded=false)
	Fonction d'initialisation, définit le frame rate voulu. Plus de détails...

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

ContextSPtr	CreateContext (RenderWindow *p_pRenderWindow)
	Demande la création du contexte de rendu. Plus de détails...

void	StartRendering ()
	Commence le rendu threadé Plus de détails...

void	EndRendering ()
	Termine le rendu, nettoie le moteur. Plus de détails...

void	RenderOneFrame ()
	Rend une image, uniquement hors de la boucle de rendu. Plus de détails...

void	RenderOverlays (Scene const &p_scene, Castor::Size const &p_size)
	Fonction de rendu des overlays visibles. Plus de détails...

SceneSPtr	CreateScene (Castor::String const &p_strName)
	Crée une scène avec le nom donné Plus de détails...

void	ClearScenes ()
	Vide chaque scène. Plus de détails...

MeshSPtr	CreateMesh (eMESH_TYPE p_eType, Castor::String const &p_strName)
	Crée un mesh avec les informations données. Plus de détails...

MeshSPtr	CreateMesh (eMESH_TYPE p_eType, Castor::String const &p_strName, UIntArray const &p_arrayFaces)
	Crée un mesh avec les informations données. Plus de détails...

MeshSPtr	CreateMesh (eMESH_TYPE p_eType, Castor::String const &p_strName, UIntArray const &p_arrayFaces, RealArray const &p_arraySizes)
	Crée un mesh avec les informations données. Plus de détails...

bool	SaveMeshes (Castor::BinaryFile &p_file)
	Enregistre tous les meshes chargés dans un fichier. Plus de détails...

bool	LoadMeshes (Castor::BinaryFile &p_file)
	Charge tous les meshes contenus dans un fichier. Plus de détails...

OverlaySPtr	CreateOverlay (eOVERLAY_TYPE p_eType, Castor::String const &p_strName, OverlaySPtr p_pParent, SceneSPtr p_pScene)
	Crée un overlay. Plus de détails...

RenderWindowSPtr	CreateRenderWindow ()
	Crée une fenêtre de rendu. Plus de détails...

bool	RemoveRenderWindow (uint32_t p_uiIndex)
	Supprime une fenêtre de rendu, par index. Plus de détails...

bool	RemoveRenderWindow (RenderWindowSPtr p_window)
	Supprime une fenêtre de rendu, par pointeur. Plus de détails...

void	RemoveAllRenderWindows ()
	Supprime toutes les fenêtres de rendu. Plus de détails...

PluginBaseSPtr	LoadPlugin (Castor::String const &p_strPluginName, Castor::Path const &p_pathFolder) throw ()
	Charge un plugin, selon son nom (ex : libGlRenderSystem.dll => GlRenderSystem) Plus de détails...

PluginBaseSPtr	LoadPlugin (Castor::Path const &p_fileFullPath) throw ()
	Charge un plugin dont le chemin est donné Plus de détails...

ShaderPluginSPtr	GetShaderPlugin (eSHADER_LANGUAGE p_eLanguage)
	Récupère un ShaderPlugin pour le langage donné Plus de détails...

bool	LoadRenderer (eRENDERER_TYPE p_eType)
	Charge un plugin de rendu, selon le type de rendu. Plus de détails...

void	LoadAllPlugins (Castor::Path const &p_strFolder)
	Charge tous les plugins d'un dossier donné Plus de détails...

void	PostEvent (FrameEventSPtr p_pEvent)
	Ajoute un évènement de frame à la queue. Plus de détails...

TechniqueFactory const &	GetTechniqueFactory () const
	Récupère la fabrique de RenderTechnique. Plus de détails...

TechniqueFactory &	GetTechniqueFactory ()
	Récupère la fabrique de RenderTechnique. Plus de détails...

PluginStrMapIt	PluginsBegin (ePLUGIN_TYPE p_eType)
	Récupère un itérateur sur la map des plugins. Plus de détails...

PluginStrMapIt	PluginsEnd (ePLUGIN_TYPE p_eType)
	Récupère un itérateur sur la find de la map des plugins. Plus de détails...

PluginStrMapConstIt	PluginsBegin (ePLUGIN_TYPE p_eType) const
	Récupère un itérateur constant sur la map des plugins. Plus de détails...

PluginStrMapConstIt	PluginsEnd (ePLUGIN_TYPE p_eType) const
	Récupère un itérateur constant sur la find de la map des plugins. Plus de détails...

RendererPtrArrayIt	RenderersBegin ()
	Récupère un itérateur sur le tableau des plugins de rendu. Plus de détails...

RendererPtrArrayConstIt	RenderersBegin () const
	Récupère un itérateur sur le tableau des plugins de rendu. Plus de détails...

RendererPtrArrayIt	RenderersEnd ()
	Récupère un itérateur constant sur la fin du tableau des plugins de rendu. Plus de détails...

RendererPtrArrayConstIt	RenderersEnd () const
	Récupère un itérateur constant sur la fin du tableau des plugins de rendu. Plus de détails...

RenderWindowMapIt	RenderWindowsBegin ()
	Récupère un itérateur sur la map de fenêtres de rendu. Plus de détails...

RenderWindowMapConstIt	RenderWindowsBegin () const
	Récupère un itérateur sur la map de fenêtres de rendu. Plus de détails...

RenderWindowMapIt	RenderWindowsEnd ()
	Récupère un itérateur sur la fin de la map de fenêtres de rendu. Plus de détails...

RenderWindowMapConstIt	RenderWindowsEnd () const
	Récupère un itérateur sur la fin de la map de fenêtres de rendu. Plus de détails...

MaterialManager const &	GetMaterialManager () const
	Récupère la collection de matériaux. Plus de détails...

MaterialManager &	GetMaterialManager ()
	Récupère la collection de matériaux. Plus de détails...

OverlayManager const &	GetOverlayManager () const
	Récupère la collection d'overlays. Plus de détails...

OverlayManager &	GetOverlayManager ()
	Récupère la collection d'overlays. Plus de détails...

ShaderManager const &	GetShaderManager () const
	Récupère la collection de shaders. Plus de détails...

ShaderManager &	GetShaderManager ()
	Récupère la collection de shaders. Plus de détails...

SceneCollection const &	GetSceneManager () const
	Récupère la collection de scènes. Plus de détails...

SceneCollection &	GetSceneManager ()
	Récupère la collection de scènes. Plus de détails...

ImageCollection const &	GetImageManager () const
	Récupère la collection d'images. Plus de détails...

ImageCollection &	GetImageManager ()
	Récupère la collection d'images. Plus de détails...

FontCollection const &	GetFontManager () const
	Récupère la collection de polices. Plus de détails...

FontCollection &	GetFontManager ()
	Récupère la collection de polices. Plus de détails...

AnimationCollection const &	GetAnimationManager () const
	Récupère la collection d'animations. Plus de détails...

AnimationCollection &	GetAnimationManager ()
	Récupère la collection d'animations. Plus de détails...

MeshCollection const &	GetMeshManager () const
	Récupère la collection de maillages. Plus de détails...

MeshCollection &	GetMeshManager ()
	Récupère la collection de maillages. Plus de détails...

DepthStencilStateCollection const &	GetDepthStencilStateManager () const
	Récupère la collection de DepthStencilState. Plus de détails...

DepthStencilStateCollection &	GetDepthStencilStateManager ()
	Récupère la collection de DepthStencilState. Plus de détails...

RasteriserStateCollection const &	GetRasteriserStateManager () const
	Récupère la collection de RasteriserState. Plus de détails...

RasteriserStateCollection &	GetRasteriserStateManager ()
	Récupère la collection de RasteriserState. Plus de détails...

BlendStateCollection const &	GetBlendStateManager () const
	Récupère la collection de BlendState. Plus de détails...

BlendStateCollection &	GetBlendStateManager ()
	Récupère la collection de BlendState. Plus de détails...

MeshFactory const &	GetMeshFactory () const
	Récupère la fabrique de Mesh. Plus de détails...

MeshFactory &	GetMeshFactory ()
	Récupère la fabrique de Mesh. Plus de détails...

LightFactory const &	GetLightFactory () const
	Récupère la fabrique de Light. Plus de détails...

LightFactory &	GetLightFactory ()
	Récupère la fabrique de Light. Plus de détails...

OverlayFactory const &	GetOverlayFactory () const
	Récupère la fabrique d'Overlay. Plus de détails...

OverlayFactory &	GetOverlayFactory ()
	Récupère la fabrique d'Overlay. Plus de détails...

RenderSystem *	GetRenderSystem () const
	Récupère le RenderSystem. Plus de détails...

SamplerCollection const &	GetSamplerManager () const
	Récupère la collection de samplers. Plus de détails...

SamplerCollection &	GetSamplerManager ()
	Récupère la collection de samplers. Plus de détails...

Castor::Logger *	GetLoggerInstance () const
	Récupère l'instance du logger. Plus de détails...

bool	IsEnded ()
	Récupère le statut de fin. Plus de détails...

void	SetEnded ()
	Dit que le rendu est stoppé Plus de détails...

bool	IsStarted ()
	Récupère le statut de début de rendu. Plus de détails...

void	SetStarted ()
	Dit que le rendu est démarré Plus de détails...

bool	IsCreated ()
	Récupère le statut de création du contexte de rendu. Plus de détails...

void	SetCreated ()
	Dit que le contexte de rendu est créé Plus de détails...

bool	IsToCreate ()
	Récupère le statut de demande de création du contexte. Plus de détails...

void	SetToCreate ()
	Dit que le contexte de rendu est à créer. Plus de détails...

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

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

double	GetFrameTime ()
	Récupère le temps voulu pour une frame. Plus de détails...

bool	IsThreaded () const
	Dit si le rendu peut être threadé Plus de détails...

void	UpdateOverlayManager ()
	Met à jour la collection d'overlays. Plus de détails...

void	UpdateShaderManager ()
	Met à jour la collection de shaders. Plus de détails...

RenderTechniqueBaseSPtr	CreateTechnique (Castor::String const &p_strName, RenderTarget &p_renderTarget, Parameters const &p_params)
	Crée une RenderTechnique à partir d'un nom de technique. Plus de détails...

bool	SupportsShaderModel (eSHADER_MODEL p_eShaderModel)
	Vérifie le support du shader model donné Plus de détails...

bool	SupportsDepthBuffer () const
	Dit si l'API de rendu supporte les tampons de profondeur pour le FBO principal. Plus de détails...

RenderTargetSPtr	CreateRenderTarget (eTARGET_TYPE p_eType)
	Crée une cible de rendu du type voulu. Plus de détails...

void	RemoveRenderTarget (RenderTargetSPtr &&p_pRenderTarget)
	Enlève une cible de rendu de la boucle de rendu. Plus de détails...

FrameListenerSPtr	CreateFrameListener ()
	Crée un FrameListener. Plus de détails...

void	DestroyFrameListener (FrameListenerSPtr &p_pListener)
	Détruit un FrameListener. Plus de détails...

SamplerSPtr	CreateSampler (Castor::String const &p_strName)
	Crée et renvoie un Sampler, avec le nom donné Plus de détails...

DepthStencilStateSPtr	CreateDepthStencilState (Castor::String const &p_strName)
	Crée et renvoie un DepthStencilState, avec le nom donné Plus de détails...

RasteriserStateSPtr	CreateRasteriserState (Castor::String const &p_strName)
	Crée et renvoie un RasteriserState, avec le nom donné Plus de détails...

BlendStateSPtr	CreateBlendState (Castor::String const &p_strName)
	Crée et renvoie un BlendState, avec le nom donné Plus de détails...

BlendStateSPtr	GetDefaultBlendState () const
	Récupère le BlendState par défault (pas de blend) Plus de détails...

SamplerSPtr	GetDefaultSampler () const
	Récupère le Sampler par défault. Plus de détails...

Fonctions membres publiques statiques
static Castor::Path	GetPluginsPath ()
	Récupère le chemin des plugins. Plus de détails...

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

Description détaillée

Moteur principal.

Auteur: Sylvain DOREMUS

Date: 09/02/2010

Version: 0.1

Remarques: Contient les fenêtres de rendu, les plugins, drivers de rendu...

Documentation des constructeurs et destructeur

Castor3D::Engine::Engine ( Castor::Logger * p_pLogger )

Constructeur.

Paramètres

[in] p_pLogger L'instance du logger

Castor3D::Engine::~Engine ( )

Destructeur.

Documentation des fonctions membres

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 plugins chargés

void Castor3D::Engine::ClearScenes ( )

Vide chaque scène.

BlendStateSPtr Castor3D::Engine::CreateBlendState ( Castor::String const & p_strName )

Crée et renvoie un BlendState, avec le nom donné

Remarques: Si un BlendState avec le même nom existe, aucun n'est créé

Paramètres

[in] p_strName Le nom du BlendState

Renvoie: Le BlendState créé ou existant

ContextSPtr Castor3D::Engine::CreateContext ( RenderWindow * p_pRenderWindow )

Demande la création du contexte de rendu.

Paramètres

[in] p_pRenderWindow La render window utilisée pour initialiser le contexte de rendu

Renvoie: Le contexte créé, ou l'existant

DepthStencilStateSPtr Castor3D::Engine::CreateDepthStencilState ( Castor::String const & p_strName )

Crée et renvoie un DepthStencilState, avec le nom donné

Remarques: Si un DepthStencilState avec le même nom existe, aucun n'est créé

Paramètres

[in] p_strName Le nom du DepthStencilState

Renvoie: Le DepthStencilState créé ou existant

FrameListenerSPtr Castor3D::Engine::CreateFrameListener ( )

Crée un FrameListener.

Renvoie: Le FrameListener créé

MeshSPtr Castor3D::Engine::CreateMesh	(	eMESH_TYPE	p_eType,
		Castor::String const &	p_strName
	)

Crée un mesh avec les informations données.

Remarques: Si un mesh avec le nom donné existe déjà, il est retourné et aucun mesh n'est créé

Paramètres

[in]	p_eType	Le type de mesh
[in]	p_strName	Le nom du mesh

Renvoie: Le mesh créé

MeshSPtr Castor3D::Engine::CreateMesh	(	eMESH_TYPE	p_eType,
		Castor::String const &	p_strName,
		UIntArray const &	p_arrayFaces
	)

Crée un mesh avec les informations données.

Remarques: Si un mesh avec le nom donné existe déjà, il est retourné et aucun mesh n'est créé

Paramètres

[in]	p_eType	Le type de mesh
[in]	p_strName	Le nom du mesh
[in]	p_arrayFaces	Le tableau de faces (pour les mesh non custom)

Renvoie: Le mesh créé

MeshSPtr Castor3D::Engine::CreateMesh	(	eMESH_TYPE	p_eType,
		Castor::String const &	p_strName,
		UIntArray const &	p_arrayFaces,
		RealArray const &	p_arraySizes
	)

Crée un mesh avec les informations données.

Remarques: Si un mesh avec le nom donné existe déjà, il est retourné et aucun mesh n'est créé

Paramètres

[in]	p_eType	Le type de mesh
[in]	p_strName	Le nom du mesh
[in]	p_arrayFaces	Le tableau de faces (pour les mesh non custom)
[in]	p_arraySizes	Le tableau de dimensions (pour les mesh non custom)

Renvoie: Le mesh créé

OverlaySPtr Castor3D::Engine::CreateOverlay	(	eOVERLAY_TYPE	p_eType,
		Castor::String const &	p_strName,
		OverlaySPtr	p_pParent,
		SceneSPtr	p_pScene
	)

Crée un overlay.

Remarques: Si un overlay avec le même nom existe déjà, aucune création n'est faite, l'existant est retourné

Paramètres

[in]	p_eType	Le type d'overlay
[in]	p_strName	Le nom voulu pour l'overlay
[in]	p_pParent	L'overlay parent, nullptr si aucun
[in]	p_pScene	La scène contenant l'overlay

Renvoie: L'overlay

RasteriserStateSPtr Castor3D::Engine::CreateRasteriserState ( Castor::String const & p_strName )

Crée et renvoie un RasteriserState, avec le nom donné

Remarques: Si un RasteriserState avec le même nom existe, aucun n'est créé

Paramètres

[in] p_strName Le nom du RasteriserState

Renvoie: Le RasteriserState créé ou existant

RenderTargetSPtr Castor3D::Engine::CreateRenderTarget ( eTARGET_TYPE p_eType )

Crée une cible de rendu du type voulu.

Paramètres

[in] p_eType Le type

Renvoie: La cible de rendu

RenderWindowSPtr Castor3D::Engine::CreateRenderWindow ( )

Crée une fenêtre de rendu.

Renvoie: La fenêtre de rendu créée

SamplerSPtr Castor3D::Engine::CreateSampler ( Castor::String const & p_strName )

Crée et renvoie un Sampler, avec le nom donné

Remarques: Si un Sampler avec le même nom existe, aucun n'est créé

Paramètres

[in] p_strName Le nom du Sampler

Renvoie: Le Sampler créé ou existant

SceneSPtr Castor3D::Engine::CreateScene ( Castor::String const & p_strName )

Crée une scène avec le nom donné

Remarques: Si une scène avec le nom voulu existe déjà, elle est retournée et aucune scène n'est créée

Paramètres

[in] p_strName Le nom de la scène

Renvoie: La scène

RenderTechniqueBaseSPtr Castor3D::Engine::CreateTechnique	(	Castor::String const &	p_strName,
		RenderTarget &	p_renderTarget,
		Parameters const &	p_params
	)

Crée une RenderTechnique à partir d'un nom de technique.

Paramètres

[in]	p_key	Le type d'objet
[in]	p_renderTarget	La cible de rendu de la technique
[in]	p_params	Les paramètres de la technique

Renvoie: La RenderTechnique créée

void Castor3D::Engine::DestroyFrameListener ( FrameListenerSPtr & p_pListener )

Détruit un FrameListener.

Paramètres

[in] p_pListener Le FrameListener

void Castor3D::Engine::EndRendering ( )

Termine le rendu, nettoie le moteur.

Remarques: Arrête la boucle de rendu threadé, si elle existe

AnimationCollection const& Castor3D::Engine::GetAnimationManager ( ) const

inline

Récupère la collection d'animations.

Renvoie: La collection

AnimationCollection& Castor3D::Engine::GetAnimationManager ( )

inline

Récupère la collection d'animations.

Renvoie: La collection

BlendStateCollection const& Castor3D::Engine::GetBlendStateManager ( ) const

inline

Récupère la collection de BlendState.

Renvoie: La collection

BlendStateCollection& Castor3D::Engine::GetBlendStateManager ( )

inline

Récupère la collection de BlendState.

Renvoie: La collection

static Castor::Path Castor3D::Engine::GetDataPath ( )

static

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

Renvoie: Le chemin des données

BlendStateSPtr Castor3D::Engine::GetDefaultBlendState ( ) const

inline

Récupère le BlendState par défault (pas de blend)

Renvoie: La valeur

SamplerSPtr Castor3D::Engine::GetDefaultSampler ( ) const

inline

Récupère le Sampler par défault.

Renvoie: La valeur

DepthStencilStateCollection const& Castor3D::Engine::GetDepthStencilStateManager ( ) const

inline

Récupère la collection de DepthStencilState.

Renvoie: La collection

DepthStencilStateCollection& Castor3D::Engine::GetDepthStencilStateManager ( )

inline

Récupère la collection de DepthStencilState.

Renvoie: La collection

FontCollection const& Castor3D::Engine::GetFontManager ( ) const

inline

Récupère la collection de polices.

Renvoie: La collection

FontCollection& Castor3D::Engine::GetFontManager ( )

inline

Récupère la collection de polices.

Renvoie: La collection

double Castor3D::Engine::GetFrameTime ( )

Récupère le temps voulu pour une frame.

Remarques: Thread-safe

Renvoie: Le temps, en secondes

ImageCollection const& Castor3D::Engine::GetImageManager ( ) const

inline

Récupère la collection d'images.

Renvoie: La collection

ImageCollection& Castor3D::Engine::GetImageManager ( )

inline

Récupère la collection d'images.

Renvoie: La collection

LightFactory const& Castor3D::Engine::GetLightFactory ( ) const

inline

Récupère la fabrique de Light.

Renvoie: La fabrique

LightFactory& Castor3D::Engine::GetLightFactory ( )

inline

Récupère la fabrique de Light.

Renvoie: La fabrique

Castor::Logger* Castor3D::Engine::GetLoggerInstance ( ) const

inline

Récupère l'instance du logger.

Renvoie: L'instance du logger

MaterialManager const& Castor3D::Engine::GetMaterialManager ( ) const

inline

Récupère la collection de matériaux.

Renvoie: La collection

MaterialManager& Castor3D::Engine::GetMaterialManager ( )

inline

Récupère la collection de matériaux.

Renvoie: La collection

MeshFactory const& Castor3D::Engine::GetMeshFactory ( ) const

inline

Récupère la fabrique de Mesh.

Renvoie: La fabrique

MeshFactory& Castor3D::Engine::GetMeshFactory ( )

inline

Récupère la fabrique de Mesh.

Renvoie: La fabrique

MeshCollection const& Castor3D::Engine::GetMeshManager ( ) const

inline

Récupère la collection de maillages.

Renvoie: La collection

MeshCollection& Castor3D::Engine::GetMeshManager ( )

inline

Récupère la collection de maillages.

Renvoie: La collection

OverlayFactory const& Castor3D::Engine::GetOverlayFactory ( ) const

inline

Récupère la fabrique d'Overlay.

Renvoie: La fabrique

OverlayFactory& Castor3D::Engine::GetOverlayFactory ( )

inline

Récupère la fabrique d'Overlay.

Renvoie: La fabrique

OverlayManager const& Castor3D::Engine::GetOverlayManager ( ) const

inline

Récupère la collection d'overlays.

Renvoie: La collection

OverlayManager& Castor3D::Engine::GetOverlayManager ( )

inline

Récupère la collection d'overlays.

Renvoie: La collection

static Castor::Path Castor3D::Engine::GetPluginsPath ( )

static

Récupère le chemin des plugins.

Renvoie: Le chemin des plugins

RasteriserStateCollection const& Castor3D::Engine::GetRasteriserStateManager ( ) const

inline

Récupère la collection de RasteriserState.

Renvoie: La collection

RasteriserStateCollection& Castor3D::Engine::GetRasteriserStateManager ( )

inline

Récupère la collection de RasteriserState.

Renvoie: La collection

RenderSystem* Castor3D::Engine::GetRenderSystem ( ) const

inline

Récupère le RenderSystem.

Renvoie: Le RenderSystem

SamplerCollection const& Castor3D::Engine::GetSamplerManager ( ) const

inline

Récupère la collection de samplers.

Renvoie: La collection de samplers

SamplerCollection& Castor3D::Engine::GetSamplerManager ( )

inline

Récupère la collection de samplers.

Renvoie: La collection de samplers

SceneCollection const& Castor3D::Engine::GetSceneManager ( ) const

inline

Récupère la collection de scènes.

Renvoie: La collection

SceneCollection& Castor3D::Engine::GetSceneManager ( )

inline

Récupère la collection de scènes.

Renvoie: La collection

ShaderManager const& Castor3D::Engine::GetShaderManager ( ) const

inline

Récupère la collection de shaders.

Renvoie: La collection

ShaderManager& Castor3D::Engine::GetShaderManager ( )

inline

Récupère la collection de shaders.

Renvoie: La collection

ShaderPluginSPtr Castor3D::Engine::GetShaderPlugin ( eSHADER_LANGUAGE p_eLanguage )

Récupère un ShaderPlugin pour le langage donné

Paramètres

[in] p_eLanguage Le langage

Renvoie: NULL si non trouvé

TechniqueFactory const& Castor3D::Engine::GetTechniqueFactory ( ) const

inline

Récupère la fabrique de RenderTechnique.

Renvoie: La fabrique

TechniqueFactory& Castor3D::Engine::GetTechniqueFactory ( )

inline

Récupère la fabrique de RenderTechnique.

Renvoie: La fabrique

void Castor3D::Engine::Initialise	(	uint32_t	p_wantedFPS = `100`,
		bool	p_bThreaded = `false`
	)

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

Paramètres

[in]	p_wantedTBEF	Le nombre voulu du FPS
[in]	p_bThreaded	Si `false`, le rendu ne peut pas être threadé

bool Castor3D::Engine::IsCleaned ( )

Récupère le statut de nettoyage.

Remarques: Thread-safe

Renvoie: true si nettoyé

bool Castor3D::Engine::IsCreated ( )

Récupère le statut de création du contexte de rendu.

Remarques: Thread-safe

Renvoie: true si créé

bool Castor3D::Engine::IsEnded ( )

Récupère le statut de fin.

Remarques: Thread-safe

Renvoie: true si arrêté

bool Castor3D::Engine::IsStarted ( )

Récupère le statut de début de rendu.

Remarques: Thread-safe

Renvoie: true si démarré

bool Castor3D::Engine::IsThreaded ( ) const

inline

Dit si le rendu peut être threadé

bool Castor3D::Engine::IsToCreate ( )

Récupère le statut de demande de création du contexte.

Remarques: Thread-safe

Renvoie: true si à créer

void Castor3D::Engine::LoadAllPlugins ( Castor::Path const & p_strFolder )

Charge tous les plugins d'un dossier donné

Paramètres

[in] p_strFolder Le dossier

bool Castor3D::Engine::LoadMeshes ( Castor::BinaryFile & p_file )

Charge tous les meshes contenus dans un fichier.

Paramètres

[out] p_file Le fichier

Renvoie: true si tout s'est bien passé

PluginBaseSPtr Castor3D::Engine::LoadPlugin	(	Castor::String const &	p_strPluginName,
		Castor::Path const &	p_pathFolder
	)
throw	(
	)

Charge un plugin, selon son nom (ex : libGlRenderSystem.dll => GlRenderSystem)

Paramètres

[in]	p_strPluginName	Le nom du plugin
[in]	p_pathFolder	Un chemin optionnel, pour y trouver le plugin

Renvoie: Le plugin chargé, nullptr si non trouvé (nom incorrect ou non trouvé dans le chemin donné ou le chemin principal)

PluginBaseSPtr Castor3D::Engine::LoadPlugin	(	Castor::Path const &	p_fileFullPath	)
throw	(
	)

Charge un plugin dont le chemin est donné

Paramètres

[in] p_filePath Le chemin du plugin

Renvoie: Le plugin chargé, nullptr si le chemin était incorrect ou s'il ne représentait pas un plugin valide

bool Castor3D::Engine::LoadRenderer ( eRENDERER_TYPE p_eType )

Charge un plugin de rendu, selon le type de rendu.

Paramètres

[in] p_eType Le type de rendu

Renvoie: true si tout s'est bien passé

PluginStrMapIt Castor3D::Engine::PluginsBegin ( ePLUGIN_TYPE p_eType )

inline

Récupère un itérateur sur la map des plugins.

Renvoie: L'itérateur

PluginStrMapConstIt Castor3D::Engine::PluginsBegin ( ePLUGIN_TYPE p_eType ) const

inline

Récupère un itérateur constant sur la map des plugins.

Renvoie: L'itérateur

PluginStrMapIt Castor3D::Engine::PluginsEnd ( ePLUGIN_TYPE p_eType )

inline

Récupère un itérateur sur la find de la map des plugins.

Renvoie: L'itérateur

PluginStrMapConstIt Castor3D::Engine::PluginsEnd ( ePLUGIN_TYPE p_eType ) const

inline

Récupère un itérateur constant sur la find de la map des plugins.

Renvoie: L'itérateur

void Castor3D::Engine::PostEvent ( FrameEventSPtr p_pEvent )

Ajoute un évènement de frame à la queue.

Paramètres

[in] p_pEvent L'évènement

void Castor3D::Engine::RemoveAllRenderWindows ( )

Supprime toutes les fenêtres de rendu.

void Castor3D::Engine::RemoveRenderTarget ( RenderTargetSPtr && p_pRenderTarget )

Enlève une cible de rendu de la boucle de rendu.

Paramètres

[in] p_pRenderTarget La cible de rendu

bool Castor3D::Engine::RemoveRenderWindow ( uint32_t p_uiIndex )

Supprime une fenêtre de rendu, par index.

Paramètres

[in] p_uiIndex L'index de la fenêtre

Renvoie: false si la fenêtre n'a pas été trouvée

bool Castor3D::Engine::RemoveRenderWindow ( RenderWindowSPtr p_window )

Supprime une fenêtre de rendu, par pointeur.

Paramètres

[in] p_window Le pointeur sur la fenêtre de rendu

Renvoie: false si la fenêtre n'a pas été trouvée

RendererPtrArrayIt Castor3D::Engine::RenderersBegin ( )

inline

Récupère un itérateur sur le tableau des plugins de rendu.

Renvoie: L'itérateur

RendererPtrArrayConstIt Castor3D::Engine::RenderersBegin ( ) const

inline

Récupère un itérateur sur le tableau des plugins de rendu.

Renvoie: L'itérateur

RendererPtrArrayIt Castor3D::Engine::RenderersEnd ( )

inline

Récupère un itérateur constant sur la fin du tableau des plugins de rendu.

Renvoie: L'itérateur

RendererPtrArrayConstIt Castor3D::Engine::RenderersEnd ( ) const

inline

Récupère un itérateur constant sur la fin du tableau des plugins de rendu.

Renvoie: L'itérateur

void Castor3D::Engine::RenderOneFrame ( )

Rend une image, uniquement hors de la boucle de rendu.

void Castor3D::Engine::RenderOverlays	(	Scene const &	p_scene,
		Castor::Size const &	p_size
	)

Fonction de rendu des overlays visibles.

Paramètres

[in]	p_scene	La scène rendue, pour afficher ses overlays en plus des globaux
[in]	p_size	Les dimensions de la cible du rendu

RenderWindowMapIt Castor3D::Engine::RenderWindowsBegin ( )

inline

Récupère un itérateur sur la map de fenêtres de rendu.

Renvoie: L'itérateur

RenderWindowMapConstIt Castor3D::Engine::RenderWindowsBegin ( ) const

inline

Récupère un itérateur sur la map de fenêtres de rendu.

Renvoie: L'itérateur

RenderWindowMapIt Castor3D::Engine::RenderWindowsEnd ( )

inline

Récupère un itérateur sur la fin de la map de fenêtres de rendu.

Renvoie: L'itérateur

RenderWindowMapConstIt Castor3D::Engine::RenderWindowsEnd ( ) const

inline

Récupère un itérateur sur la fin de la map de fenêtres de rendu.

Renvoie: L'itérateur

bool Castor3D::Engine::SaveMeshes ( Castor::BinaryFile & p_file )

Enregistre tous les meshes chargés dans un fichier.

Paramètres

[out] p_file Le fichier

Renvoie: true si tout s'est bien passé

void Castor3D::Engine::SetCleaned ( )

Dit que le moteur est nettoyé

Remarques: Thread-safe

void Castor3D::Engine::SetCreated ( )

Dit que le contexte de rendu est créé

Remarques: Thread-safe

void Castor3D::Engine::SetEnded ( )

Dit que le rendu est stoppé

Remarques: Thread-safe

void Castor3D::Engine::SetStarted ( )

Dit que le rendu est démarré

Remarques: Thread-safe

void Castor3D::Engine::SetToCreate ( )

Dit que le contexte de rendu est à créer.

Remarques: Thread-safe

void Castor3D::Engine::StartRendering ( )

Commence le rendu threadé

bool Castor3D::Engine::SupportsDepthBuffer ( ) const

Dit si l'API de rendu supporte les tampons de profondeur pour le FBO principal.

Renvoie: Le statut du support

bool Castor3D::Engine::SupportsShaderModel ( eSHADER_MODEL p_eShaderModel )

Vérifie le support du shader model donné

Paramètres

[in] p_eShaderModel le shader model

Renvoie: true si le shader model est supporté dans la configuration actuelle

void Castor3D::Engine::UpdateOverlayManager ( )

Met à jour la collection d'overlays.

void Castor3D::Engine::UpdateShaderManager ( )

Met à jour la collection de shaders.

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

Y:/projets/Castor3D/source/Core/Castor3D/Src/Engine.hpp

Fonctions membres publiques

Fonctions membres publiques statiques

Description détaillée

Documentation des constructeurs et destructeur

Documentation des fonctions membres