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

#include <RenderQuad.hpp>

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

Graphe de collaboration de castor3d::RenderQuad:

Fonctions membres publiques
virtual C3D_API	~RenderQuad () noexcept
C3D_API	RenderQuad (RenderQuad &&rhs) noexcept
C3D_API void	cleanup () noexcept
	Nettoie les objets GPU.
C3D_API void	createPipeline (VkExtent2D const &size, castor::Position const &position, ashes::PipelineShaderStageCreateInfoArray const &program, ashes::RenderPass const &renderPass, ashes::VkPushConstantRangeArray const &pushRanges=ashes::VkPushConstantRangeArray{}, ashes::PipelineDepthStencilStateCreateInfo dsState=ashes::PipelineDepthStencilStateCreateInfo{ 0u, VK_FALSE, VK_FALSE })
	Crée le pipeline de rendu.
C3D_API void	registerPassInputs (ashes::WriteDescriptorSetArray const &writes, bool invertY=false)
	Crée les entrées pour une passe.
C3D_API void	initialisePass (uint32_t passIndex)
	Crée les descriptor sets pour la passe enregistrée à l'indice donné.
C3D_API void	initialisePasses ()
	Crée les descriptor sets pour toute les passes enregistrées.
C3D_API void	createPipelineAndPass (VkExtent2D const &size, castor::Position const &position, ashes::PipelineShaderStageCreateInfoArray const &program, ashes::RenderPass const &renderPass, ashes::WriteDescriptorSetArray const &writes, ashes::VkPushConstantRangeArray const &pushRanges=ashes::VkPushConstantRangeArray{}, ashes::PipelineDepthStencilStateCreateInfo dsState=ashes::PipelineDepthStencilStateCreateInfo{ 0u, false, false })
	Crée le pipeline de rendu et initialise le quad pour une passe.
C3D_API void	registerPass (ashes::CommandBuffer &commandBuffer, uint32_t descriptorSetIndex) const
	Prépare les commandes de dessin du quad, dans le tampon de commandes donné.
void	registerPass (ashes::CommandBuffer &commandBuffer) const
	Prépare les commandes de dessin du quad, dans le tampon de commandes donné.
RenderSystem *	getRenderSystem () const noexcept
RenderDevice const &	getDevice () const noexcept
Sampler const &	getSampler () const noexcept
Fonctions membres publiques hérités de castor::NamedBaseT< T >
	NamedBaseT (T name) noexcept
	Constructeur.
T const &	getName () const noexcept
	Récupère le nom.
void	rename (T name) noexcept

Fonctions membres protégées
C3D_API	RenderQuad (RenderDevice const &device, castor::String const &name, VkFilter samplerFilter, rq::Config config)
	Constructeur.

Attributs protégés
RenderSystem &	m_renderSystem
RenderDevice const &	m_device
SamplerObs	m_sampler {}
rq::ConfigData	m_config
Attributs protégés hérités de castor::NamedBaseT< T >
T	m_name

Amis
template<typename ConfigT , typename BuilderT >
class	RenderQuadBuilderT

Documentation des constructeurs et destructeur

RenderQuad() [1/2]

C3D_API castor3d::RenderQuad::RenderQuad ( RenderDevice const & device, castor::String const & name, VkFilter samplerFilter, rq::Config config )

protected

Constructeur.

Paramètres

[in]	device	Le RenderDevice.
[in]	name	Le nom de la passe.
[in]	samplerFilter	Le filtre d'échantillonnage pour la texture source.
[in]	config	La configuration.

~RenderQuad()

virtual C3D_API castor3d::RenderQuad::~RenderQuad ( )

virtualnoexcept

RenderQuad() [2/2]

C3D_API castor3d::RenderQuad::RenderQuad ( RenderQuad && rhs )

explicitnoexcept

Documentation des fonctions membres

cleanup()

C3D_API void castor3d::RenderQuad::cleanup ( )

noexcept

Nettoie les objets GPU.

createPipeline()

C3D_API void castor3d::RenderQuad::createPipeline	(	VkExtent2D const &	size,
		castor::Position const &	position,
		ashes::PipelineShaderStageCreateInfoArray const &	program,
		ashes::RenderPass const &	renderPass,
		ashes::VkPushConstantRangeArray const &	pushRanges = ashes::VkPushConstantRangeArray{},
		ashes::PipelineDepthStencilStateCreateInfo	dsState = ashes::PipelineDepthStencilStateCreateInfo{ 0u, VK_FALSE, VK_FALSE } )

Crée le pipeline de rendu.

Paramètres

[in]	size	Les dimensions de rendu.
[in]	position	La position du rendu.
[in]	program	Le programme shader.
[in]	renderPass	La passe de rendu à utiliser.
[in]	pushRanges	Les intervalles de push constants.
[in]	dsState	L'état de profondeur et stencil.

createPipelineAndPass()

C3D_API void castor3d::RenderQuad::createPipelineAndPass	(	VkExtent2D const &	size,
		castor::Position const &	position,
		ashes::PipelineShaderStageCreateInfoArray const &	program,
		ashes::RenderPass const &	renderPass,
		ashes::WriteDescriptorSetArray const &	writes,
		ashes::VkPushConstantRangeArray const &	pushRanges = ashes::VkPushConstantRangeArray{},
		ashes::PipelineDepthStencilStateCreateInfo	dsState = ashes::PipelineDepthStencilStateCreateInfo{ 0u, false, false } )

Crée le pipeline de rendu et initialise le quad pour une passe.

Paramètres

[in]	size	Les dimensions de rendu.
[in]	position	La position du rendu.
[in]	program	Le programme shader.
[in]	renderPass	La passe de rendu à utiliser.
[in]	writes	Les descriptor writes de la passe.
[in]	pushRanges	Les intervalles de push constants.
[in]	dsState	L'état de profondeur et stencil à utiliser.

getDevice()

RenderDevice const & castor3d::RenderQuad::getDevice ( ) const

inlinenoexcept

Références m_device.

getRenderSystem()

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

inlinenoexcept

Références m_renderSystem.

getSampler()

Sampler const & castor3d::RenderQuad::getSampler ( ) const

inlinenoexcept

Références m_sampler.

initialisePass()

C3D_API void castor3d::RenderQuad::initialisePass

(

uint32_t

passIndex

)

Crée les descriptor sets pour la passe enregistrée à l'indice donné.

initialisePasses()

C3D_API void castor3d::RenderQuad::initialisePasses

(

)

Crée les descriptor sets pour toute les passes enregistrées.

registerPass() [1/2]

void castor3d::RenderQuad::registerPass ( ashes::CommandBuffer & commandBuffer ) const

inline

Prépare les commandes de dessin du quad, dans le tampon de commandes donné.

Paramètres

[in,out]

commandBuffer

Le tampon de commandes.

Références registerPass().

Voici le graphe d'appel pour cette fonction :

registerPass() [2/2]

C3D_API void castor3d::RenderQuad::registerPass	(	ashes::CommandBuffer &	commandBuffer,
		uint32_t	descriptorSetIndex ) const

Prépare les commandes de dessin du quad, dans le tampon de commandes donné.

Paramètres

[in,out]	commandBuffer	Le tampon de commandes.
[in]	descriptorSetIndex	L'indice du descriptor set.

Référencé par registerPass().

Voici le graphe des appelants de cette fonction :

registerPassInputs()

C3D_API void castor3d::RenderQuad::registerPassInputs	(	ashes::WriteDescriptorSetArray const &	writes,
		bool	invertY = false )

Crée les entrées pour une passe.

Paramètres

[in]	writes	Les descriptor writes de la passe.
[in]	invertY	true pour inverser le Y de l'image échantillonnée.

Documentation des fonctions amies et associées

RenderQuadBuilderT

template<typename ConfigT , typename BuilderT >

friend class RenderQuadBuilderT

friend

Documentation des données membres

m_config

rq::ConfigData castor3d::RenderQuad::m_config

protected

m_device

RenderDevice const& castor3d::RenderQuad::m_device

protected

Référencé par getDevice().

m_renderSystem

RenderSystem& castor3d::RenderQuad::m_renderSystem

protected

Référencé par getRenderSystem().

m_sampler

SamplerObs castor3d::RenderQuad::m_sampler {}

protected

Référencé par getSampler().

---

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

• Castor3D/Render/Passes/RenderQuad.hpp