Classe contenant le contexte de rendu. Plus de détails...

Graphe de collaboration de Castor3D::Context:

Fonctions membres publiques
	Context ()
	Constructeur. Plus de détails...

virtual	~Context ()
	Destructeur. Plus de détails...

bool	Initialise (RenderWindow *p_window)
	Initialise le contexte. Plus de détails...

void	Cleanup ()
	Nettoie le contexte. Plus de détails...

void	SetCurrent ()
	Définit le contexte pour être celui de rendu actuel. Plus de détails...

void	EndCurrent ()
	Définit ce contexte pour ne pas être l'actuel. Plus de détails...

void	CullFace (eFACE p_eCullFace)
	Définit l'option de culling pour le rendu courant. Plus de détails...

void	SwapBuffers ()
	Echange les buffers de rendu. Plus de détails...

void	SetClearColour (Castor::Colour const &p_clrClear)
	Définit la couleur utilisée quand Context::Clear est appelée sur le tampon couleur. Plus de détails...

void	Clear (uint32_t p_uiTargets)
	Vide le(s) tampon(s) voulu(s) Plus de détails...

bool	IsInitialised () const
	Dit si le contexte est initialisé Plus de détails...

bool	IsDeferredShadingSet () const
	Dit si le contexte utilise le deferred shading. Plus de détails...

void	SetDeferredShading (bool p_bVal)
	Définit le statut du deferred shading. Plus de détails...

bool	IsMultiSampling () const
	Dit si le contexte utilise le multisampling. Plus de détails...

void	SetMultiSampling (bool p_bVal)
	Définit le statut du multisampling. Plus de détails...

DepthStencilStateSPtr	GetBackgroundDSState () const
	Récupère le DepthStencilState de fond d'écran. Plus de détails...

void	Bind (eBUFFER p_eBuffer, eFRAMEBUFFER_TARGET p_eTarget)
	Associe le tampon d'image système donné dans le mode donné Plus de détails...

void	SetAlphaFunc (eALPHA_FUNC p_eFunc, uint8_t p_byValue)
	Définit la fonction de test alpha. Plus de détails...

virtual void	UpdateFullScreen (bool val)=0
	Change le statut de plein écran. Plus de détails...

void	BToBRender (Castor::Size const &p_size, TextureBaseSPtr p_pTexture, uint32_t p_uiComponents)
	Rend la texture donnée dans le tampon d'image actuellement activé en dessin. Plus de détails...

virtual Castor::Size	GetMaxSize (Castor::Size const &p_size)=0
	Récupère la taille maximale supportée, en fonction d'une taille données. Plus de détails...

Fonctions membres protégées
virtual bool	DoInitialise ()=0
	Initialise le contexte. Plus de détails...

virtual void	DoCleanup ()=0
	Nettoie le contexte. Plus de détails...

virtual void	DoSetCurrent ()=0
	Définit le contexte pour être celui de rendu actuel. Plus de détails...

virtual void	DoEndCurrent ()=0
	Définit ce contexte pour ne pas être l'actuel. Plus de détails...

virtual void	DoSwapBuffers ()=0
	Echange les buffers de rendu. Plus de détails...

virtual void	DoSetClearColour (Castor::Colour const &p_clrClear)=0
	Définit la couleur utilisée quand Context::Clear est appelée sur le tampon couleur. Plus de détails...

virtual void	DoClear (uint32_t p_uiTargets)=0
	Vide le(s) buffer(s) voulu(s) Plus de détails...

virtual void	DoBind (eBUFFER p_eBuffer, eFRAMEBUFFER_TARGET p_eTarget)=0
	Associe le tampon d'image système donné dans le mode donné Plus de détails...

virtual void	DoSetAlphaFunc (eALPHA_FUNC p_eFunc, uint8_t p_byValue)=0
	Définit la fonction de test alpha. Plus de détails...

virtual void	DoCullFace (eFACE p_eCullFace)=0
	Définit l'option de culling pour le rendu courant. Plus de détails...

Attributs protégés
RenderWindow *	m_pWindow
	RenderWindow associée à ce contexte. Plus de détails...

RenderSystem *	m_pRenderSystem
	Le render system. Plus de détails...

bool	m_bInitialised
	Dit si le contexte est initialisé Plus de détails...

bool	m_bDeferredShadingSet
	Dit si le contexte est actuellement configuré pour utiliser le deferred shading. Plus de détails...

bool	m_bMultiSampling
	Dit si le contexte est actuellement configuré pour utiliser le multisampling. Plus de détails...

ShaderProgramBaseWPtr	m_pBtoBShaderProgram
	Le ShaderProgram utilisé lors du rendu d'un tampon vers un autre. Plus de détails...

GeometryBuffersSPtr	m_pGeometryBuffers
	Le GeometryBuffers utilisé lors du rendu d'un tampon vers un autre. Plus de détails...

ViewportSPtr	m_pViewport
	Le Viewport utilisé lors du rendu d'un tampon vers un autre. Plus de détails...

Castor3D::BufferDeclarationSPtr	m_pDeclaration
	Déclaration des éléments d'un vertex. Plus de détails...

std::array < Castor3D::BufferElementGroupSPtr, 6 >	m_arrayVertex
	Tableau de vertex (définition du quad) Plus de détails...

Castor::real	m_pBuffer [16]
	6 * [2(vertex position) 2(texture coordinates)] Plus de détails...

DepthStencilStateSPtr	m_pDsStateBackground
	DepthStencilState utilisé pour le rendu de l'image de fond. Plus de détails...

Description détaillée

Classe contenant le contexte de rendu.

Auteur: Sylvain DOREMUS

Date: 03/01/2011

Version: 0.6.1.1

Documentation des constructeurs et destructeur

Castor3D::Context::Context ( )

Constructeur.

virtual Castor3D::Context::~Context ( )

virtual

Destructeur.

Documentation des fonctions membres

void Castor3D::Context::Bind	(	eBUFFER	p_eBuffer,
		eFRAMEBUFFER_TARGET	p_eTarget
	)

Associe le tampon d'image système donné dans le mode donné

Paramètres

[in]	p_eBuffer	Le tampon
[in]	p_eTarget	La cible

void Castor3D::Context::BToBRender	(	Castor::Size const &	p_size,
		TextureBaseSPtr	p_pTexture,
		uint32_t	p_uiComponents
	)

Rend la texture donnée dans le tampon d'image actuellement activé en dessin.

Paramètres

[in]	p_size	La taille du viewport de rendu
[in]	p_pTexture	La texture
[in]	p_uiComponents	Les composantes cibles du rendu (combinaison binaire de eBUFFER_COMPONENT)

void Castor3D::Context::Cleanup ( )

Nettoie le contexte.

void Castor3D::Context::Clear ( uint32_t p_uiTargets )

Vide le(s) tampon(s) voulu(s)

Paramètres

[in] p_uiTargets Le(s) tampon(s)

void Castor3D::Context::CullFace ( eFACE p_eCullFace )

Définit l'option de culling pour le rendu courant.

Paramètres

[in] p_eCullFace L'option de culling

virtual void Castor3D::Context::DoBind	(	eBUFFER	p_eBuffer,
		eFRAMEBUFFER_TARGET	p_eTarget
	)

protectedpure virtual

Associe le tampon d'image système donné dans le mode donné

Paramètres

[in]	p_eBuffer	Le tampon
[in]	p_eTarget	La cible

virtual void Castor3D::Context::DoCleanup ( )

protectedpure virtual

Nettoie le contexte.

virtual void Castor3D::Context::DoClear ( uint32_t p_uiTargets )

protectedpure virtual

Vide le(s) buffer(s) voulu(s)

Paramètres

[in] p_uiTargets Le(s) tampon(s)

virtual void Castor3D::Context::DoCullFace ( eFACE p_eCullFace )

protectedpure virtual

Définit l'option de culling pour le rendu courant.

Paramètres

[in] p_eCullFace L'option de culling

virtual void Castor3D::Context::DoEndCurrent ( )

protectedpure virtual

Définit ce contexte pour ne pas être l'actuel.

virtual bool Castor3D::Context::DoInitialise ( )

protectedpure virtual

Initialise le contexte.

Renvoie: true si initialisé correctement

virtual void Castor3D::Context::DoSetAlphaFunc	(	eALPHA_FUNC	p_eFunc,
		uint8_t	p_byValue
	)

protectedpure virtual

Définit la fonction de test alpha.

Paramètres

[in]	p_eFunc	La fonction
[in]	p_byValue	La valeur de comparaison

virtual void Castor3D::Context::DoSetClearColour ( Castor::Colour const & p_clrClear )

protectedpure virtual

Définit la couleur utilisée quand Context::Clear est appelée sur le tampon couleur.

Paramètres

[in] p_clrClear La couleur

virtual void Castor3D::Context::DoSetCurrent ( )

protectedpure virtual

Définit le contexte pour être celui de rendu actuel.

Paramètres

[in] p_window La RenderWindow

virtual void Castor3D::Context::DoSwapBuffers ( )

protectedpure virtual

Echange les buffers de rendu.

void Castor3D::Context::EndCurrent ( )

Définit ce contexte pour ne pas être l'actuel.

DepthStencilStateSPtr Castor3D::Context::GetBackgroundDSState ( ) const

inline

Récupère le DepthStencilState de fond d'écran.

virtual Castor::Size Castor3D::Context::GetMaxSize ( Castor::Size const & p_size )

pure virtual

Récupère la taille maximale supportée, en fonction d'une taille données.

Paramètres

[in] p_size La taille voulue

Renvoie: La taille maximale supportée inférieure ou égale à p_size

bool Castor3D::Context::Initialise ( RenderWindow * p_window )

Initialise le contexte.

Paramètres

[in] p_window La RenderWindow

Renvoie: true si initialisé correctement

bool Castor3D::Context::IsDeferredShadingSet ( ) const

inline

Dit si le contexte utilise le deferred shading.

bool Castor3D::Context::IsInitialised ( ) const

inline

Dit si le contexte est initialisé

bool Castor3D::Context::IsMultiSampling ( ) const

inline

Dit si le contexte utilise le multisampling.

void Castor3D::Context::SetAlphaFunc	(	eALPHA_FUNC	p_eFunc,
		uint8_t	p_byValue
	)

Définit la fonction de test alpha.

Paramètres

[in]	p_eFunc	La fonction
[in]	p_byValue	La valeur de comparaison

void Castor3D::Context::SetClearColour ( Castor::Colour const & p_clrClear )

Définit la couleur utilisée quand Context::Clear est appelée sur le tampon couleur.

Paramètres

[in] p_clrClear La couleur

void Castor3D::Context::SetCurrent ( )

Définit le contexte pour être celui de rendu actuel.

void Castor3D::Context::SetDeferredShading ( bool p_bVal )

inline

Définit le statut du deferred shading.

Paramètres

[in] p_bVal Le statut

void Castor3D::Context::SetMultiSampling ( bool p_bVal )

inline

Définit le statut du multisampling.

Paramètres

[in] p_bVal Le statut

void Castor3D::Context::SwapBuffers ( )

Echange les buffers de rendu.

virtual void Castor3D::Context::UpdateFullScreen ( bool val )

pure virtual

Change le statut de plein écran.

Paramètres

[in] val Le nouveau statut de plein écran

Documentation des données membres

std::array< Castor3D::BufferElementGroupSPtr, 6 > Castor3D::Context::m_arrayVertex

protected

Tableau de vertex (définition du quad)

bool Castor3D::Context::m_bDeferredShadingSet

protected

Dit si le contexte est actuellement configuré pour utiliser le deferred shading.

bool Castor3D::Context::m_bInitialised

protected

Dit si le contexte est initialisé

bool Castor3D::Context::m_bMultiSampling

protected

Dit si le contexte est actuellement configuré pour utiliser le multisampling.

ShaderProgramBaseWPtr Castor3D::Context::m_pBtoBShaderProgram

protected

Le ShaderProgram utilisé lors du rendu d'un tampon vers un autre.

Castor::real Castor3D::Context::m_pBuffer[16]

protected

6 * [2(vertex position) 2(texture coordinates)]

Castor3D::BufferDeclarationSPtr Castor3D::Context::m_pDeclaration

protected

Déclaration des éléments d'un vertex.

DepthStencilStateSPtr Castor3D::Context::m_pDsStateBackground

protected

DepthStencilState utilisé pour le rendu de l'image de fond.

GeometryBuffersSPtr Castor3D::Context::m_pGeometryBuffers

protected

Le GeometryBuffers utilisé lors du rendu d'un tampon vers un autre.

RenderSystem* Castor3D::Context::m_pRenderSystem

protected

Le render system.

ViewportSPtr Castor3D::Context::m_pViewport

protected

Le Viewport utilisé lors du rendu d'un tampon vers un autre.

RenderWindow* Castor3D::Context::m_pWindow

protected

RenderWindow associée à ce contexte.

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

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

Fonctions membres publiques

Fonctions membres protégées

Attributs protégés

Description détaillée

Documentation des constructeurs et destructeur

Documentation des fonctions membres

Documentation des données membres