Référence de la classe castor3d::RenderTarget

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 &engine, TargetType type=TargetType::eWindow)
	Constructeur spécifié. Plus de détails...
C3D_API	~RenderTarget ()
	Destructeur. Plus de détails...
C3D_API void	render (RenderInfo &info)
	Dessine une frame. Plus de détails...
C3D_API void	initialise (uint32_t 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 &size)
C3D_API void	addTechniqueParameters (Parameters const &parameters)
	Ajoute des paramètres de RenderTechnique. Plus de détails...
C3D_API ViewportType	getViewportType () const
C3D_API void	setViewportType (ViewportType value)
	Définit le ViewportType. Plus de détails...
C3D_API void	setCamera (CameraSPtr camera)
	Définit la caméra. Plus de détails...
C3D_API void	setToneMappingType (castor::String const &name, Parameters const &parameters)
	Définit le type d'implémentation de mappage de tons. Plus de détails...
C3D_API void	addPostEffect (PostEffectSPtr effect)
	Ajoute un effet post rendu à la liste. Plus de détails...
bool	isInitialised () const
castor::Size const &	getSize () const
RenderTechniqueSPtr	getTechnique () const
void	setTechnique (RenderTechniqueSPtr technique)
	Définit la RenderTechnique. Plus de détails...
SceneSPtr	getScene () const
CameraSPtr	getCamera () const
void	setScene (SceneSPtr scene)
	Définit la Scene. Plus de détails...
void	setSsaoConfig (SsaoConfig const &config)
	Définit la configuration du SSAO. Plus de détails...
FrameBufferSPtr	getFrameBuffer () const
TextureUnit const &	getTexture () const
TextureUnit const &	getVelocity () const
castor::PixelFormat	getPixelFormat () const
void	setPixelFormat (castor::PixelFormat value)
	Définit le format des pixels de la fenêtre. Plus de détails...
TargetType	getTargetType () const
uint32_t	getIndex () const
PostEffectPtrArray const &	getPostEffects () const
ToneMappingSPtr	getToneMapping () const
void	setJitter (castor::Point2r const &value)
	Définit la valeur de jittering. Plus de détails...

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...

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 &	engine,
		TargetType	type = TargetType::eWindow
	)

Constructeur spécifié.

Paramètres

[in]	engine	Le moteur.
[in]	type	Le type de render target.

~RenderTarget()

C3D_API castor3d::RenderTarget::~RenderTarget

(

)

Destructeur.

Documentation des fonctions membres

addPostEffect()

C3D_API void castor3d::RenderTarget::addPostEffect

(

PostEffectSPtr

effect

)

Ajoute un effet post rendu à la liste.

Paramètres

[in]

effect

L'effet.

addTechniqueParameters()

C3D_API void castor3d::RenderTarget::addTechniqueParameters

(

Parameters const &

parameters

)

Ajoute des paramètres de RenderTechnique.

Paramètres

[in]

parameters

Les paramètres de la RenderTechnique.

cleanup()

C3D_API void castor3d::RenderTarget::cleanup

(

)

Fonction de nettoyage.

getCamera()

CameraSPtr castor3d::RenderTarget::getCamera ( ) const

inline

Renvoie

La Camera.

getFrameBuffer()

FrameBufferSPtr castor3d::RenderTarget::getFrameBuffer ( ) const

inline

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

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.

getScene()

SceneSPtr castor3d::RenderTarget::getScene ( ) const

inline

Renvoie

La Scene.

getSize()

castor::Size const& castor3d::RenderTarget::getSize ( ) const

inline

getTargetType()

TargetType castor3d::RenderTarget::getTargetType ( ) const

inline

Renvoie

Le type de cible.

getTechnique()

RenderTechniqueSPtr castor3d::RenderTarget::getTechnique ( ) const

inline

Renvoie

La RenderTechnique.

getTexture()

TextureUnit const& castor3d::RenderTarget::getTexture ( ) const

inline

Renvoie

La texture RGB.

getToneMapping()

ToneMappingSPtr castor3d::RenderTarget::getToneMapping ( ) const

inline

Renvoie

L'implémentation de mappage de tons.

getVelocity()

TextureUnit const& castor3d::RenderTarget::getVelocity ( ) const

inline

Renvoie

La texture de vélocités.

getViewportType()

C3D_API ViewportType castor3d::RenderTarget::getViewportType

(

)

const

Renvoie

Le ViewportType.

initialise()

C3D_API void castor3d::RenderTarget::initialise

(

uint32_t

index

)

Fonction d'initialisation.

Remarques

Initialise les buffers.

Paramètres

[in]

index

L'index de texture de base.

isInitialised()

bool castor3d::RenderTarget::isInitialised ( ) const

inline

Renvoie

Le statut de l'initialisation.

render()

C3D_API void castor3d::RenderTarget::render

(

RenderInfo &

info

)

Dessine une frame.

Paramètres

[out]

info

Reçoit les informations de rendu.

setCamera()

C3D_API void castor3d::RenderTarget::setCamera

(

CameraSPtr

camera

)

Définit la caméra.

Remarques

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

Paramètres

[in]

camera

La nouvelle caméra.

setJitter()

void castor3d::RenderTarget::setJitter ( castor::Point2r const &  value )

inline

Définit la valeur de jittering.

Paramètres

[in]

value

La nouvelle valeur.

Références C3D_API.

setPixelFormat()

void castor3d::RenderTarget::setPixelFormat ( castor::PixelFormat  value )

inline

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

Paramètres

[in]

value

Le nouveau format des pixels de la fenêtre

setScene()

void castor3d::RenderTarget::setScene ( SceneSPtr  scene )

inline

Définit la Scene.

Paramètres

[in]

scene

La nouvelle Scene.

setSize()

C3D_API void castor3d::RenderTarget::setSize

(

castor::Size const &

size

)

setSsaoConfig()

void castor3d::RenderTarget::setSsaoConfig ( SsaoConfig const &  config )

inline

Définit la configuration du SSAO.

Paramètres

[in]

config

La nouvelle value.

setTechnique()

void castor3d::RenderTarget::setTechnique ( RenderTechniqueSPtr  technique )

inline

Définit la RenderTechnique.

Paramètres

[in]

technique

La RenderTechnique.

setToneMappingType()

C3D_API void castor3d::RenderTarget::setToneMappingType	(	castor::String const &	name,
		Parameters const &	parameters
	)

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

Paramètres

[in]	name	Le type.
[in]	parameters	Les paramètres.

setViewportType()

C3D_API void castor3d::RenderTarget::setViewportType

(

ViewportType

value

)

Définit le ViewportType.

Paramètres

[in]

value

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.

---

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

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/Render/RenderTarget.hpp