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

#include <Sampler.hpp>

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

Graphe de collaboration de castor3d::Sampler:

Fonctions membres publiques
C3D_API	Sampler (castor::String const &name, Engine &engine)
	Constructeur.
C3D_API	Sampler (castor::String const &name, Engine &engine, ashes::SamplerCreateInfo const &createInfo)
	Constructeur.
C3D_API bool	initialise (RenderDevice const &device)
	Initialise le sampler GPU.
C3D_API void	cleanup ()
	Nettoie le sampler.
VkSamplerAddressMode	getWrapS () const
VkSamplerAddressMode	getWrapT () const
VkSamplerAddressMode	getWrapR () const
VkFilter	getMinFilter () const
VkFilter	getMagFilter () const
VkSamplerMipmapMode	getMipFilter () const
float	getMinLod () const
float	getMaxLod () const
float	getLodBias () const
VkBorderColor	getBorderColour () const
float	getMaxAnisotropy () const
VkCompareOp	getCompareOp () const
ashes::Sampler const &	getSampler () const
bool	isAnisotropicFilteringEnabled () const
bool	isMipmapSet () const
bool	isCompareEnabled () const
void	setWrapS (VkSamplerAddressMode value)
void	setWrapT (VkSamplerAddressMode value)
void	setWrapR (VkSamplerAddressMode value)
void	setMinFilter (VkFilter value)
void	setMagFilter (VkFilter value)
void	setMipFilter (VkSamplerMipmapMode value)
void	setMinLod (float value)
void	setMaxLod (float value)
void	setLodBias (float value)
void	setBorderColour (VkBorderColor value)
void	enableAnisotropicFiltering (bool value)
void	setMaxAnisotropy (float value)
void	setCompareOp (VkCompareOp value)
void	enableCompare (bool value)
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 publiques hérités de castor::OwnedBy< Engine >
Engine *	getOwner () const
	L'objet propriétaire.

Membres hérités additionnels
Fonctions membres protégées hérités de castor::OwnedBy< Engine >
	OwnedBy (Engine &owner)
	Constructeur.
Attributs protégés hérités de castor::NamedBaseT< T >
T	m_name

Documentation des constructeurs et destructeur

Sampler() [1/2]

C3D_API castor3d::Sampler::Sampler	(	castor::String const &	name,
		Engine &	engine )

Constructeur.

Paramètres

[in]	engine	Le moteur
[in]	name	Le nom du sampler

Sampler() [2/2]

C3D_API castor3d::Sampler::Sampler	(	castor::String const &	name,
		Engine &	engine,
		ashes::SamplerCreateInfo const &	createInfo )

Constructeur.

Paramètres

[in]	engine	Le moteur.
[in]	name	Le nom du sampler.
[in]	createInfo	Les informations de création.

Documentation des fonctions membres

cleanup()

C3D_API void castor3d::Sampler::cleanup

(

)

Nettoie le sampler.

enableAnisotropicFiltering()

void castor3d::Sampler::enableAnisotropicFiltering ( bool value )

inline

enableCompare()

void castor3d::Sampler::enableCompare ( bool value )

inline

getBorderColour()

VkBorderColor castor3d::Sampler::getBorderColour ( ) const

inline

getCompareOp()

VkCompareOp castor3d::Sampler::getCompareOp ( ) const

inline

getLodBias()

float castor3d::Sampler::getLodBias ( ) const

inline

getMagFilter()

VkFilter castor3d::Sampler::getMagFilter ( ) const

inline

getMaxAnisotropy()

float castor3d::Sampler::getMaxAnisotropy ( ) const

inline

getMaxLod()

float castor3d::Sampler::getMaxLod ( ) const

inline

getMinFilter()

VkFilter castor3d::Sampler::getMinFilter ( ) const

inline

getMinLod()

float castor3d::Sampler::getMinLod ( ) const

inline

getMipFilter()

VkSamplerMipmapMode castor3d::Sampler::getMipFilter ( ) const

inline

getSampler()

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

inline

Références CU_Require.

Référencé par castor3d::IblTextures::getPrefilteredBrdfSampler(), et castor3d::EnvironmentPrefilter::getSampler().

Voici le graphe des appelants de cette fonction :

getWrapR()

VkSamplerAddressMode castor3d::Sampler::getWrapR ( ) const

inline

getWrapS()

VkSamplerAddressMode castor3d::Sampler::getWrapS ( ) const

inline

name Accesseurs.

getWrapT()

VkSamplerAddressMode castor3d::Sampler::getWrapT ( ) const

inline

initialise()

C3D_API bool castor3d::Sampler::initialise

(

RenderDevice const &

device

)

Initialise le sampler GPU.

Paramètres

[in]

device

Le device GPU.

Renvoie

true si tout s'est bien passé.

isAnisotropicFilteringEnabled()

bool castor3d::Sampler::isAnisotropicFilteringEnabled ( ) const

inline

isCompareEnabled()

bool castor3d::Sampler::isCompareEnabled ( ) const

inline

isMipmapSet()

bool castor3d::Sampler::isMipmapSet ( ) const

inline

setBorderColour()

void castor3d::Sampler::setBorderColour ( VkBorderColor value )

inline

setCompareOp()

void castor3d::Sampler::setCompareOp ( VkCompareOp value )

inline

setLodBias()

void castor3d::Sampler::setLodBias ( float value )

inline

setMagFilter()

void castor3d::Sampler::setMagFilter ( VkFilter value )

inline

setMaxAnisotropy()

void castor3d::Sampler::setMaxAnisotropy ( float value )

inline

setMaxLod()

void castor3d::Sampler::setMaxLod ( float value )

inline

setMinFilter()

void castor3d::Sampler::setMinFilter ( VkFilter value )

inline

setMinLod()

void castor3d::Sampler::setMinLod ( float value )

inline

setMipFilter()

void castor3d::Sampler::setMipFilter ( VkSamplerMipmapMode value )

inline

setWrapR()

void castor3d::Sampler::setWrapR ( VkSamplerAddressMode value )

inline

setWrapS()

void castor3d::Sampler::setWrapS ( VkSamplerAddressMode value )

inline

name Mutateurs

Remarques

ils ont un effet jusqu'à ce que initialise() soit appelée.

setWrapT()

void castor3d::Sampler::setWrapT ( VkSamplerAddressMode value )

inline

---

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

• Castor3D/Material/Texture/Sampler.hpp