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

#include <TextureUnit.hpp>

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

Graphe de collaboration de castor3d::TextureUnit:

Fonctions membres publiques
	TextureUnit (TextureUnit const &)=delete
TextureUnit &	operator= (TextureUnit const &)=delete
C3D_API	TextureUnit (TextureUnit &&rhs) noexcept
C3D_API TextureUnit &	operator= (TextureUnit &&rhs) noexcept=delete
C3D_API	TextureUnit (Engine &engine, TextureUnitData &data)
	Constructeur.
C3D_API	~TextureUnit () noexcept override
	Destructeur.
C3D_API bool	initialise ()
	Crée la texture au niveau du renderer.
C3D_API void	cleanup () noexcept
	Nettoie l'objet.
C3D_API void	setSampler (SamplerObs sampler)
	Définit le sampler.
C3D_API void	setTexture (Texture const *texture)
	Définit la texture.
C3D_API TextureAnimation &	createAnimation ()
	Crée l'animation.
C3D_API void	removeAnimation ()
	Retire l'animation.
C3D_API TextureAnimation &	getAnimation ()
C3D_API TextureAnimation const &	getAnimation () const
C3D_API VkImageType	getType () const
C3D_API castor::String	toString () const
C3D_API TextureFlagsSet	getFlags () const
C3D_API bool	isInitialised () const
C3D_API bool	isTransformAnimated () const
C3D_API bool	isTileAnimated () const
C3D_API ashes::Sampler const &	getSampler () const
C3D_API RenderTargetRPtr	getRenderTarget () const
C3D_API castor::String	getTextureName () const
C3D_API castor::Path	getTexturePath () const
C3D_API bool	isTextureStatic () const
C3D_API VkFormat	getTexturePixelFormat () const
C3D_API castor::Point3ui	getTextureImageTiles () const
C3D_API bool	hasTextureImageBuffer () const
C3D_API castor::PxBufferBase const &	getTextureImageBuffer () const
C3D_API VkExtent3D	getTextureDimensions () const
C3D_API uint32_t	getTextureMipmapCount () const
TextureConfiguration const &	getConfiguration () const noexcept
bool	isTextured () const noexcept
bool	isRenderTarget () const noexcept
ashes::WriteDescriptorSet	getDescriptor () const noexcept
uint32_t	getId () const noexcept
bool	hasDevice () const noexcept
RenderDevice const &	getDevice () const noexcept
bool	hasAnimation () const noexcept
TextureTransform const &	getTransform () const noexcept
TextureSourceInfo const &	getSourceInfo () const noexcept
uint32_t	getTexcoordSet () const noexcept
TextureUnitData &	getData () const noexcept
castor::Image const &	getCPUImage () const noexcept
ashes::Image const &	getGPUImage () const noexcept
bool	failed () const noexcept
C3D_API void	setConfiguration (TextureConfiguration value)
C3D_API void	setTransform (castor::Point3f const &translate, castor::Angle const &rotate, castor::Point3f const &scale)
C3D_API void	setTransform (TextureTransform const &transform)
C3D_API void	setAnimationTransform (castor::Point3f const &translate, castor::Angle const &rotate, castor::Point3f const &scale)
C3D_API void	setTexcoordSet (uint32_t value)
void	setId (uint32_t value)
void	reportFailure ()
Fonctions membres publiques hérités de castor3d::AnimableT< Engine >
virtual C3D_API	~AnimableT () noexcept=default
void	cleanupAnimations ()
	Vid ela map d'animations.
bool	hasAnimation () const
bool	hasAnimation (castor::String const &name) const
Animation const &	getAnimation (castor::String const &name) const
	Récupère une animation.
Animation &	getAnimation (castor::String const &name)
	Récupère une animation.
void	addAnimation (AnimationPtr animation)
	Ajoute une animation.
AnimationsMap const &	getAnimations () const
Fonctions membres publiques hérités de castor::OwnedBy< Owner >
Owner *	getOwner () const
	L'objet propriétaire.

Fonctions membres publiques statiques
static C3D_API void	addParsers (castor::AttributeParsers &result, castor::UInt32StrMap const &textureChannels)

Attributs publics
OnTextureUnitChanged	onChanged
OnTextureUnitChanged	onIdChanged

Amis
class	TextureRenderer

Membres hérités additionnels
Types protégés hérités de castor3d::AnimableT< Engine >
using	Animation
using	AnimationPtr
using	AnimationsMap
Fonctions membres protégées hérités de castor3d::AnimableT< Engine >
void	doRemoveAnimation (castor::String const &name)
	Enlève une animation.
AnimationType &	doGetAnimation (castor::String const &name)
	Récupère une animation.
AnimationType const &	doGetAnimation (castor::String const &name) const
	Récupère une animation.
	AnimableT (Engine &owner)
C3D_API	AnimableT (AnimableT &&rhs) noexcept=default
C3D_API	AnimableT (AnimableT const &rhs)=delete
C3D_API AnimableT &	operator= (AnimableT &&rhs) noexcept=delete
C3D_API AnimableT &	operator= (AnimableT const &rhs)=delete
Fonctions membres protégées hérités de castor::OwnedBy< Owner >
	OwnedBy (Owner &owner)
	Constructeur.
Attributs protégés hérités de castor3d::AnimableT< Engine >
AnimationsMap	m_animations

Documentation des constructeurs et destructeur

TextureUnit() [1/3]

castor3d::TextureUnit::TextureUnit ( TextureUnit const & )

delete

TextureUnit() [2/3]

C3D_API castor3d::TextureUnit::TextureUnit ( TextureUnit && rhs )

noexcept

TextureUnit() [3/3]

C3D_API castor3d::TextureUnit::TextureUnit ( Engine & engine, TextureUnitData & data )

explicit

Constructeur.

Paramètres

engine	Le moteur.
data	Les données de la texture.

~TextureUnit()

C3D_API castor3d::TextureUnit::~TextureUnit ( )

overridenoexcept

Destructeur.

Documentation des fonctions membres

addParsers()

static C3D_API void castor3d::TextureUnit::addParsers ( castor::AttributeParsers & result, castor::UInt32StrMap const & textureChannels )

static

name Parsers.

cleanup()

C3D_API void castor3d::TextureUnit::cleanup ( )

noexcept

Nettoie l'objet.

createAnimation()

C3D_API TextureAnimation & castor3d::TextureUnit::createAnimation

(

)

Crée l'animation.

name Animation.

Renvoie

l'animation

failed()

bool castor3d::TextureUnit::failed ( ) const

inlinenoexcept

getAnimation() [1/2]

C3D_API TextureAnimation & castor3d::TextureUnit::getAnimation

(

)

Renvoie

L'animation.

getAnimation() [2/2]

C3D_API TextureAnimation const & castor3d::TextureUnit::getAnimation

(

)

const

Renvoie

L'animation.

getConfiguration()

TextureConfiguration const & castor3d::TextureUnit::getConfiguration ( ) const

inlinenoexcept

getCPUImage()

castor::Image const & castor3d::TextureUnit::getCPUImage ( ) const

inlinenoexcept

Références castor3d::TextureUnitData::base, CU_Require, et castor3d::TextureData::image.

getData()

TextureUnitData & castor3d::TextureUnit::getData ( ) const

inlinenoexcept

getDescriptor()

ashes::WriteDescriptorSet castor3d::TextureUnit::getDescriptor ( ) const

inlinenoexcept

getDevice()

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

inlinenoexcept

Références CU_Require, et hasDevice().

Voici le graphe d'appel pour cette fonction :

getFlags()

C3D_API TextureFlagsSet castor3d::TextureUnit::getFlags

(

)

const

getGPUImage()

ashes::Image const & castor3d::TextureUnit::getGPUImage ( ) const

inlinenoexcept

Références CU_Require.

getId()

uint32_t castor3d::TextureUnit::getId ( ) const

inlinenoexcept

getRenderTarget()

C3D_API RenderTargetRPtr castor3d::TextureUnit::getRenderTarget

(

)

const

getSampler()

C3D_API ashes::Sampler const & castor3d::TextureUnit::getSampler

(

)

const

getSourceInfo()

TextureSourceInfo const & castor3d::TextureUnit::getSourceInfo ( ) const

inlinenoexcept

Références castor3d::TextureUnitData::base, et castor3d::TextureData::sourceInfo.

getTexcoordSet()

uint32_t castor3d::TextureUnit::getTexcoordSet ( ) const

inlinenoexcept

Références castor3d::TextureUnitData::passConfig, et castor3d::PassTextureConfig::texcoordSet.

getTextureDimensions()

C3D_API VkExtent3D castor3d::TextureUnit::getTextureDimensions

(

)

const

getTextureImageBuffer()

C3D_API castor::PxBufferBase const & castor3d::TextureUnit::getTextureImageBuffer

(

)

const

getTextureImageTiles()

C3D_API castor::Point3ui castor3d::TextureUnit::getTextureImageTiles

(

)

const

getTextureMipmapCount()

C3D_API uint32_t castor3d::TextureUnit::getTextureMipmapCount

(

)

const

getTextureName()

C3D_API castor::String castor3d::TextureUnit::getTextureName

(

)

const

getTexturePath()

C3D_API castor::Path castor3d::TextureUnit::getTexturePath

(

)

const

getTexturePixelFormat()

C3D_API VkFormat castor3d::TextureUnit::getTexturePixelFormat

(

)

const

getTransform()

TextureTransform const & castor3d::TextureUnit::getTransform ( ) const

inlinenoexcept

getType()

C3D_API VkImageType castor3d::TextureUnit::getType

(

)

const

name Accesseurs.

hasAnimation()

bool castor3d::TextureUnit::hasAnimation ( ) const

inlinenoexcept

Références cuT, et hasAnimation().

Référencé par hasAnimation().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

hasDevice()

bool castor3d::TextureUnit::hasDevice ( ) const

inlinenoexcept

Référencé par getDevice().

Voici le graphe des appelants de cette fonction :

hasTextureImageBuffer()

C3D_API bool castor3d::TextureUnit::hasTextureImageBuffer

(

)

const

initialise()

C3D_API bool castor3d::TextureUnit::initialise

(

)

Crée la texture au niveau du renderer.

isInitialised()

C3D_API bool castor3d::TextureUnit::isInitialised

(

)

const

isRenderTarget()

bool castor3d::TextureUnit::isRenderTarget ( ) const

inlinenoexcept

Références castor3d::TextureUnitData::base, castor3d::TextureSourceInfo::isRenderTarget(), et castor3d::TextureData::sourceInfo.

Voici le graphe d'appel pour cette fonction :

isTextured()

bool castor3d::TextureUnit::isTextured ( ) const

inlinenoexcept

isTextureStatic()

C3D_API bool castor3d::TextureUnit::isTextureStatic

(

)

const

isTileAnimated()

C3D_API bool castor3d::TextureUnit::isTileAnimated

(

)

const

isTransformAnimated()

C3D_API bool castor3d::TextureUnit::isTransformAnimated

(

)

const

operator=() [1/2]

C3D_API TextureUnit & castor3d::TextureUnit::operator= ( TextureUnit && rhs )

deletenoexcept

operator=() [2/2]

TextureUnit & castor3d::TextureUnit::operator= ( TextureUnit const & )

delete

removeAnimation()

C3D_API void castor3d::TextureUnit::removeAnimation

(

)

Retire l'animation.

reportFailure()

void castor3d::TextureUnit::reportFailure ( )

inline

setAnimationTransform()

C3D_API void castor3d::TextureUnit::setAnimationTransform	(	castor::Point3f const &	translate,
		castor::Angle const &	rotate,
		castor::Point3f const &	scale )

setConfiguration()

C3D_API void castor3d::TextureUnit::setConfiguration

(

TextureConfiguration

value

)

name Mutateurs.

setId()

void castor3d::TextureUnit::setId ( uint32_t value )

inline

Références onIdChanged.

setSampler()

C3D_API void castor3d::TextureUnit::setSampler

(

SamplerObs

sampler

)

Définit le sampler.

Paramètres

[in]

sampler

Le sampler.

setTexcoordSet()

C3D_API void castor3d::TextureUnit::setTexcoordSet

(

uint32_t

value

)

setTexture()

C3D_API void castor3d::TextureUnit::setTexture

(

Texture const *

texture

)

Définit la texture.

Paramètres

[in]

texture

La texture.

setTransform() [1/2]

C3D_API void castor3d::TextureUnit::setTransform	(	castor::Point3f const &	translate,
		castor::Angle const &	rotate,
		castor::Point3f const &	scale )

setTransform() [2/2]

C3D_API void castor3d::TextureUnit::setTransform

(

TextureTransform const &

transform

)

toString()

C3D_API castor::String castor3d::TextureUnit::toString

(

)

const

Documentation des fonctions amies et associées

TextureRenderer

friend class TextureRenderer

friend

Documentation des données membres

onChanged

OnTextureUnitChanged castor3d::TextureUnit::onChanged

onIdChanged

OnTextureUnitChanged castor3d::TextureUnit::onIdChanged

Référencé par setId().

---

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

• Castor3D/Material/Texture/TextureUnit.hpp