Classe de cible de rendu (render target) Plus de détails...

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

Graphe de collaboration de Castor3D::RenderTarget:

Classes
class	TextWriter

Fonctions membres publiques
C3D_API	RenderTarget (Engine &p_pRoot, TargetType p_eTargetType=TargetType::eWindow)

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

C3D_API void	Render (RenderInfo &p_info)
	Dessine une frame. Plus de détails...

C3D_API void	Initialise (uint32_t p_index)
	Fonction d'initialisation. Plus de détails...

C3D_API void	Cleanup ()
	Fonction de nettoyage. Plus de détails...

C3D_API void	SetSize (Castor::Size const &p_size)

C3D_API void	SetTechnique (Castor::String const &p_name, Parameters const &p_parameters)
	Définit la RenderTechnique. Plus de détails...

C3D_API ViewportType	GetViewportType () const
	Récupère le ViewportType. Plus de détails...

C3D_API void	SetViewportType (ViewportType val)
	Définit le ViewportType. Plus de détails...

C3D_API void	SetCamera (CameraSPtr p_pCamera)
	Définit la caméra. Plus de détails...

C3D_API void	SetToneMappingType (Castor::String const &p_name, Parameters const &p_parameters)
	Définit le type d'implémentation de mappage de tons. Plus de détails...

bool	IsInitialised () const
	Récupère le statut de l'initialisation. Plus de détails...

Castor::Size const &	GetSize () const

RenderTechniqueSPtr	GetTechnique () const
	Récupère la RenderTechnique. Plus de détails...

void	SetTechnique (RenderTechniqueSPtr p_pTechnique)
	Définit la RenderTechnique. Plus de détails...

bool	IsMultisampling () const
	Récupère le statut de multisampling. Plus de détails...

int32_t	GetSamplesCount () const
	Récupère le nombre de samples. Plus de détails...

void	SetSamplesCount (int32_t val)
	Définit le nombre de samples. Plus de détails...

SceneSPtr	GetScene () const
	Récupère la Scene. Plus de détails...

CameraSPtr	GetCamera () const
	Récupère la Camera. Plus de détails...

void	SetScene (SceneSPtr p_scene)
	Définit la Scene. Plus de détails...

FrameBufferSPtr	GetFrameBuffer () const
	Récupère le tampon d'image. Plus de détails...

TextureUnit const &	GetTexture () const
	Récupère la texture. Plus de détails...

Castor::PixelFormat	GetPixelFormat () const
	Récupère le format des pixels de la fenêtre. Plus de détails...

void	SetPixelFormat (Castor::PixelFormat val)
	Définit le format des pixels de la fenêtre. Plus de détails...

TargetType	GetTargetType () const
	Récupère le type de cible. Plus de détails...

void	AddPostEffect (PostEffectSPtr p_effect)
	Ajoute un effet post rendu à la liste. Plus de détails...

uint32_t	GetIndex () const

PostEffectPtrArray const &	GetPostEffects () const

ToneMappingSPtr	GetToneMapping () const

Attributs publics statiques
static C3D_API const Castor::String	DefaultSamplerName
	Le nom du sampler par défaut pour la cible de rendu. Plus de détails...

Attributs protégés
TargetType	m_eTargetType

bool	m_initialised

Castor::Size	m_size

RenderTechniqueSPtr	m_renderTechnique

bool	m_bMultisampling

int32_t	m_samplesCount

SceneWPtr	m_pScene

CameraWPtr	m_pCamera

stFRAME_BUFFER	m_frameBuffer

Castor::PixelFormat	m_pixelFormat

uint32_t	m_index

Castor::String	m_techniqueName

Parameters	m_techniqueParameters

PostEffectPtrArray	m_postEffects

ToneMappingSPtr	m_toneMapping

Attributs protégés statiques
static uint32_t	sm_uiCount

Description détaillée

Classe de cible de rendu (render target)

Auteur: Sylvain DOREMUS

Version: 0.6.1.0

Date: 19/10/2011

Remarques: Une render target dessine une scène dans un tampon d'image qui peut ensuite être utilisé dans une fenêtre pour un rendu direct, ou une texture pour un rendu hors écran

Documentation des constructeurs et destructeur

◆ RenderTarget()

C3D_API Castor3D::RenderTarget::RenderTarget	(	Engine &	p_pRoot,
		TargetType	p_eTargetType = `TargetType::eWindow`
	)

Constructeur spécifié

Paramètres

[in]	p_pRoot	Le moteur
[in]	p_eTargetType	Le type de render target

◆ ~RenderTarget()

C3D_API Castor3D::RenderTarget::~RenderTarget ( )

Destructeur.

Documentation des fonctions membres

◆ AddPostEffect()

void Castor3D::RenderTarget::AddPostEffect ( PostEffectSPtr p_effect )

inline

Ajoute un effet post rendu à la liste.

Paramètres

[in] p_effect L'effet.

◆ Cleanup()

C3D_API void Castor3D::RenderTarget::Cleanup ( )

Fonction de nettoyage.

◆ GetCamera()

CameraSPtr Castor3D::RenderTarget::GetCamera ( ) const

inline

Récupère la Camera.

Renvoie: La Camera

◆ GetFrameBuffer()

FrameBufferSPtr Castor3D::RenderTarget::GetFrameBuffer ( ) const

inline

Récupère le tampon d'image.

Renvoie: Le tampon d'image

◆ GetIndex()

uint32_t Castor3D::RenderTarget::GetIndex ( ) const

inline

Renvoie: L'indice de la cible.

◆ GetPixelFormat()

Castor::PixelFormat Castor3D::RenderTarget::GetPixelFormat ( ) const

inline

Récupère le format des pixels de la fenêtre.

Renvoie: Le format des pixels de la fenêtre

◆ GetPostEffects()

PostEffectPtrArray const& Castor3D::RenderTarget::GetPostEffects ( ) const

inline

Renvoie: Le tableau d'effets de post rendu.

◆ GetSamplesCount()

int32_t Castor3D::RenderTarget::GetSamplesCount ( ) const

inline

Récupère le nombre de samples.

Renvoie: Le nombre de samples

◆ GetScene()

SceneSPtr Castor3D::RenderTarget::GetScene ( ) const

inline

Récupère la Scene.

Renvoie: La Scene

◆ GetSize()

Castor::Size const& Castor3D::RenderTarget::GetSize ( ) const

inline

◆ GetTargetType()

TargetType Castor3D::RenderTarget::GetTargetType ( ) const

inline

Récupère le type de cible.

Renvoie: La valeur

◆ GetTechnique()

RenderTechniqueSPtr Castor3D::RenderTarget::GetTechnique ( ) const

inline

Récupère la RenderTechnique.

Renvoie: La RenderTechnique

◆ GetTexture()

TextureUnit const& Castor3D::RenderTarget::GetTexture ( ) const

inline

Récupère la texture.

Renvoie: La texture

◆ GetToneMapping()

ToneMappingSPtr Castor3D::RenderTarget::GetToneMapping ( ) const

inline

Renvoie: L'implémentation de mappage de tons.

Références C3D_API.

◆ GetViewportType()

C3D_API ViewportType Castor3D::RenderTarget::GetViewportType ( ) const

Récupère le ViewportType.

Renvoie: Le ViewportType

◆ Initialise()

C3D_API void Castor3D::RenderTarget::Initialise ( uint32_t p_index )

Fonction d'initialisation.

Remarques: Initialise les buffers

Paramètres

[in] p_index L'index de texture de base

◆ IsInitialised()

bool Castor3D::RenderTarget::IsInitialised ( ) const

inline

Récupère le statut de l'initialisation.

Renvoie: Le statut de l'initialisation

◆ IsMultisampling()

bool Castor3D::RenderTarget::IsMultisampling ( ) const

inline

Récupère le statut de multisampling.

Renvoie: Le statut de multisampling

◆ Render()

C3D_API void Castor3D::RenderTarget::Render ( RenderInfo & p_info )

Dessine une frame.

Paramètres

[out] p_info Reçoit les informations de rendu.

◆ SetCamera()

C3D_API void Castor3D::RenderTarget::SetCamera ( CameraSPtr p_pCamera )

Définit la caméra.

Remarques: Définit aussi les caméras des yeux gauche et droit

Paramètres

[in] p_pCamera La nouvelle caméra

◆ SetPixelFormat()

void Castor3D::RenderTarget::SetPixelFormat ( Castor::PixelFormat val )

inline

Définit le format des pixels de la fenêtre.

Paramètres

[in] val Le nouveau format des pixels de la fenêtre

◆ SetSamplesCount()

void Castor3D::RenderTarget::SetSamplesCount ( int32_t val )

inline

Définit le nombre de samples.

Paramètres

[in] val Le nouveau nombre de samples

◆ SetScene()

void Castor3D::RenderTarget::SetScene ( SceneSPtr p_scene )

inline

Définit la Scene.

Paramètres

[in] p_scene La nouvelle Scene

◆ SetSize()

C3D_API void Castor3D::RenderTarget::SetSize ( Castor::Size const & p_size )

◆ SetTechnique() [1/2]

C3D_API void Castor3D::RenderTarget::SetTechnique	(	Castor::String const &	p_name,
		Parameters const &	p_parameters
	)

Définit la RenderTechnique.

Paramètres

[in]	p_name	Le nom de la RenderTechnique.
[in]	p_parameters	Les paramètres de la RenderTechnique.

◆ SetTechnique() [2/2]

void Castor3D::RenderTarget::SetTechnique ( RenderTechniqueSPtr p_pTechnique )

inline

Définit la RenderTechnique.

Paramètres

[in] p_pTechnique La RenderTechnique

◆ SetToneMappingType()

C3D_API void Castor3D::RenderTarget::SetToneMappingType	(	Castor::String const &	p_name,
		Parameters const &	p_parameters
	)

Définit le type d'implémentation de mappage de tons.

Paramètres

[in]	p_name	Le type.
[in]	p_parameters	Les paramètres.

◆ SetViewportType()

C3D_API void Castor3D::RenderTarget::SetViewportType ( ViewportType val )

Définit le ViewportType.

Paramètres

[in] val Le nouveau ViewportType

Documentation des données membres

◆ DefaultSamplerName

C3D_API const Castor::String Castor3D::RenderTarget::DefaultSamplerName

static

Le nom du sampler par défaut pour la cible de rendu.

◆ m_bMultisampling

bool Castor3D::RenderTarget::m_bMultisampling

protected

Dit si on utilise le multisampling ou pas.

◆ m_eTargetType

TargetType Castor3D::RenderTarget::m_eTargetType

protected

Type de RenderTarget.

◆ m_frameBuffer

stFRAME_BUFFER Castor3D::RenderTarget::m_frameBuffer

protected

tampon d'image.

◆ m_index

uint32_t Castor3D::RenderTarget::m_index

protected

L'index de cette render target.

◆ m_initialised

bool Castor3D::RenderTarget::m_initialised

protected

Dit si la cible est initialisée.

◆ m_pCamera

CameraWPtr Castor3D::RenderTarget::m_pCamera

protected

La caméra utilisée pour rendre la scène.

◆ m_pixelFormat

Castor::PixelFormat Castor3D::RenderTarget::m_pixelFormat

protected

Le format des pixels de la cible.

◆ m_postEffects

PostEffectPtrArray Castor3D::RenderTarget::m_postEffects

protected

Les effets post rendu.

◆ m_pScene

SceneWPtr Castor3D::RenderTarget::m_pScene

protected

La scène rendue par cette RenderTarget.

◆ m_renderTechnique

RenderTechniqueSPtr Castor3D::RenderTarget::m_renderTechnique

protected

La technique utilisée pour rendre cette cible.

◆ m_samplesCount

int32_t Castor3D::RenderTarget::m_samplesCount

protected

Le nombre de samples utilisés pour le multisampling.

◆ m_size

Castor::Size Castor3D::RenderTarget::m_size

protected

Les dimensions de la cible.

◆ m_techniqueName

Castor::String Castor3D::RenderTarget::m_techniqueName

protected

Le nom de la technique de rendu.

◆ m_techniqueParameters

Parameters Castor3D::RenderTarget::m_techniqueParameters

protected

Les paramètres de la technique de rendu.

◆ m_toneMapping

ToneMappingSPtr Castor3D::RenderTarget::m_toneMapping

protected

L'implémentation de mappage de ton.

◆ sm_uiCount

uint32_t Castor3D::RenderTarget::sm_uiCount

staticprotected

Le compte de render target actuellement créées.

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

Y:/software/perso/Castor3D/source/Core/Castor3D/Src/Render/RenderTarget.hpp

Classes

Fonctions membres publiques

Attributs publics statiques

Attributs protégés

Attributs protégés statiques

Description détaillée

Documentation des constructeurs et destructeur

◆ RenderTarget()

◆ ~RenderTarget()

Documentation des fonctions membres

◆ AddPostEffect()

◆ Cleanup()

◆ GetCamera()

◆ GetFrameBuffer()

◆ GetIndex()

◆ GetPixelFormat()

◆ GetPostEffects()

◆ GetSamplesCount()

◆ GetScene()

◆ GetSize()

◆ GetTargetType()

◆ GetTechnique()

◆ GetTexture()

◆ GetToneMapping()

◆ GetViewportType()

◆ Initialise()

◆ IsInitialised()

◆ IsMultisampling()

◆ Render()

◆ SetCamera()

◆ SetPixelFormat()

◆ SetSamplesCount()

◆ SetScene()

◆ SetSize()

◆ SetTechnique() [1/2]

◆ SetTechnique() [2/2]

◆ SetToneMappingType()

◆ SetViewportType()

Documentation des données membres

◆ DefaultSamplerName

◆ m_bMultisampling

◆ m_eTargetType

◆ m_frameBuffer

◆ m_index

◆ m_initialised

◆ m_pCamera

◆ m_pixelFormat

◆ m_postEffects

◆ m_pScene

◆ m_renderTechnique

◆ m_samplesCount

◆ m_size

◆ m_techniqueName

◆ m_techniqueParameters

◆ m_toneMapping

◆ sm_uiCount