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

#include <TextOverlay.hpp>

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

Graphe de collaboration de castor3d::TextOverlay:

Classes
struct	Vertex
	Contient les données spécifiques de sommet pour un TextOverlay. Plus de détails...

Types publics
enum class	ComputeBindingIdx {   eCamera , eOverlays , eChars , eWords ,   eLines , eFont , eVertex }

Fonctions membres publiques
	CU_DeclareVector (Vertex, Vertex)
	CU_DeclareMap (char32_t, castor::Position, GlyphPosition)
C3D_API	TextOverlay ()
	Constructeur.
C3D_API void	accept (OverlayVisitor &visitor) const override
	Dessine l'incrustation.
C3D_API uint32_t	getCount (bool) const
C3D_API float	fillBuffer (uint32_t overlayIndex, castor::ArrayView< TextChar > texts, castor::ArrayView< TextWord > words, castor::ArrayView< TextLine > lines) const
	Remplit les tampons de texte donnés.
C3D_API void	setFont (castor::String value)
	Définit la police du texte.
Accesseurs.
bool	isChanged () const noexcept override
castor::String const &	getFontName () const
FontTextureRPtr	getFontTexture () const
std::u32string	getCaption () const
TextWrappingMode	getTextWrappingMode () const
HAlign	getHAlign () const
VAlign	getVAlign () const
TextTexturingMode	getTexturingMode () const
TextLineSpacingMode	getLineSpacingMode () const
uint32_t	getCharCount () const noexcept
uint32_t	getWordCount () const noexcept
uint32_t	getLineCount () const noexcept
Mutateurs.
void	setCaption (std::u32string value)
void	setTextWrappingMode (TextWrappingMode value)
void	setHAlign (HAlign value)
void	setVAlign (VAlign value)
void	setTexturingMode (TextTexturingMode value)
void	setLineSpacingMode (TextLineSpacingMode value)
Fonctions membres publiques hérités de castor3d::OverlayCategory
	CU_DeclareVector (Vertex, Vertex)
C3D_API	OverlayCategory (OverlayType type)
	Constructeur.
virtual C3D_API	~OverlayCategory ()
	Destructeur.
C3D_API void	update (OverlayRenderer const &renderer)
	Met à jour la position, taille...
C3D_API void	reset ()
	Marque cette catégorie comme propre.
virtual C3D_API void	accept (OverlayVisitor &renderer) const =0
	Dessine l'incrustation.
virtual C3D_API void	setMaterial (MaterialObs material)
	Définit le matériau.
C3D_API castor::String const &	getOverlayName () const
	Récupère le nom de l'incrustation.
C3D_API castor::Position	getAbsolutePosition (castor::Size const &size) const
	Récupère la position absolue de l'incrustation, en pixels.
C3D_API castor::Size	getAbsoluteSize (castor::Size const &size) const
	Récupère la taille absolue de l'incrustation, en pixels.
C3D_API castor::Point2d	getRenderRatio (castor::Size const &size) const
C3D_API castor::Point2d	getAbsolutePosition () const
	Récupère la position absolue de l'incrustation.
C3D_API castor::Point2d	getAbsoluteSize () const
	Récupère la taille absolue de l'incrustation.
C3D_API bool	isSizeChanged () const
C3D_API bool	isPositionChanged () const
C3D_API castor::Size	computePixelSize () const
	Récupère la taille de l'incrustation.
C3D_API castor::Position	computePixelPosition () const
	Récupère la position de l'incrustation.
C3D_API castor::Point4d	computeScissorRect () const
	Met à jour le scissor pour cette incrustation.
bool	hasAnyChange () const noexcept
castor::Point4d const &	getDisplayRect () const noexcept
castor::Point2d const &	getRelativeSize () const noexcept
castor::Point2d const &	getRelativePosition () const noexcept
OverlayType	getType () const noexcept
bool	isVisible () const noexcept
bool	isDisplayable () const noexcept
MaterialObs	getMaterial () const noexcept
uint32_t	getIndex () const noexcept
uint32_t	getLevel () const noexcept
Overlay const &	getOverlay () const noexcept
Overlay &	getOverlay () noexcept
castor::Point4d const &	getUV () const noexcept
bool	hasPixelPosition () const noexcept
bool	hasPixelSize () const noexcept
castor::Position const &	getPixelPosition () const noexcept
castor::Size const &	getPixelSize () const noexcept
void	setRelativePosition (castor::Point2d const &value) noexcept
void	setRelativeSize (castor::Point2d const &value) noexcept
void	setPixelPosition (castor::Position const &value) noexcept
void	setPixelSize (castor::Size const &value) noexcept
void	setOverlay (Overlay *value) noexcept
void	setVisible (bool value) noexcept
void	setOrder (uint32_t level, uint32_t index) noexcept
void	setUV (castor::Point4d const &value) noexcept

Fonctions membres publiques statiques
static C3D_API OverlayCategoryUPtr	create ()
	Fonction de création utilisée par la fabrique.
static C3D_API ashes::PipelineShaderStageCreateInfo	createProgram (RenderDevice const &device)
	Crée le programme utilisé pour calculer les sommets de l'incrustation.

Membres hérités additionnels
Fonctions membres protégées hérités de castor3d::OverlayCategory
C3D_API void	updatePosition (OverlayRenderer const &renderer)
	Met à jour la position de l'incrustation, en prenant en compte la la position en pixel voulue.
C3D_API void	updateSize (OverlayRenderer const &renderer)
	Met à jour la taille de l'incrustation, en prenant en compte la taille en pixel voulue.
C3D_API void	updateClientArea ()
	Met à jour la taille de l'incrustation, en prenant en compte la taille en pixel voulue.
C3D_API castor::Point2d	getParentSize () const
C3D_API bool	isFullyCropped () const
Attributs protégés hérités de castor3d::OverlayCategory
Overlay *	m_overlay { nullptr }
castor::Point2d	m_relPosition
castor::Point2d	m_relSize
std::optional< castor::Position >	m_pxPosition
std::optional< castor::Size >	m_pxSize
castor::Size	m_computeSize
bool	m_visible { true }
bool	m_displayable { false }
MaterialObs	m_material {}
uint32_t	m_index { 0 }
uint32_t	m_level { 0 }
OverlayType	m_type
bool	m_sizeChanged { true }
bool	m_positionChanged { true }
castor::Point4d	m_uv { 0.0, 0.0, 1.0, 1.0 }
castor::Point4d	m_displayRect {}

Documentation des énumérations membres

ComputeBindingIdx

enum class castor3d::TextOverlay::ComputeBindingIdx

strong

Valeurs énumérées
eCamera
eOverlays
eChars
eWords
eLines
eFont
eVertex

Documentation des constructeurs et destructeur

TextOverlay()

C3D_API castor3d::TextOverlay::TextOverlay

(

)

Constructeur.

Documentation des fonctions membres

accept()

C3D_API void castor3d::TextOverlay::accept ( OverlayVisitor &  visitor ) const

overridevirtual

Dessine l'incrustation.

Implémente castor3d::OverlayCategory.

create()

static C3D_API OverlayCategoryUPtr castor3d::TextOverlay::create ( )

static

Fonction de création utilisée par la fabrique.

Renvoie

Un overlay

createProgram()

static C3D_API ashes::PipelineShaderStageCreateInfo castor3d::TextOverlay::createProgram ( RenderDevice const &  device )

static

Crée le programme utilisé pour calculer les sommets de l'incrustation.

Renvoie

Le programme.

CU_DeclareMap()

castor3d::TextOverlay::CU_DeclareMap	(	char32_t	,
		castor::Position	,
		GlyphPosition
	)

CU_DeclareVector()

castor3d::TextOverlay::CU_DeclareVector	(	Vertex	,
		Vertex
	)

fillBuffer()

C3D_API float castor3d::TextOverlay::fillBuffer	(	uint32_t	overlayIndex,
		castor::ArrayView< TextChar >	texts,
		castor::ArrayView< TextWord >	words,
		castor::ArrayView< TextLine >	lines
	)		const

Remplit les tampons de texte donnés.

Paramètres

[out]	overlayIndex	L'index de de l'incrustation.
[out]	texts	Vue sur les text chars alloués pour l'incrustation.
[out]	words	Vue sur les text words alloués pour l'incrustation.
[out]	lines	Vue sur les text lines alloués pour l'incrustation.

getCaption()

std::u32string castor3d::TextOverlay::getCaption ( ) const

inline

getCharCount()

uint32_t castor3d::TextOverlay::getCharCount ( ) const

inlinenoexcept

getCount()

C3D_API uint32_t castor3d::TextOverlay::getCount

(

bool

)

const

Renvoie

Le nombre de sommets nécessaires pour cette incrustation.

getFontName()

castor::String const & castor3d::TextOverlay::getFontName ( ) const

inline

Références getFontTexture().

Voici le graphe d'appel pour cette fonction :

getFontTexture()

FontTextureRPtr castor3d::TextOverlay::getFontTexture ( ) const

inline

Référencé par getFontName().

Voici le graphe des appelants de cette fonction :

getHAlign()

HAlign castor3d::TextOverlay::getHAlign ( ) const

inline

getLineCount()

uint32_t castor3d::TextOverlay::getLineCount ( ) const

inlinenoexcept

Références castor3d::OverlayLines::count.

getLineSpacingMode()

TextLineSpacingMode castor3d::TextOverlay::getLineSpacingMode ( ) const

inline

getTexturingMode()

TextTexturingMode castor3d::TextOverlay::getTexturingMode ( ) const

inline

getTextWrappingMode()

TextWrappingMode castor3d::TextOverlay::getTextWrappingMode ( ) const

inline

getVAlign()

VAlign castor3d::TextOverlay::getVAlign ( ) const

inline

getWordCount()

uint32_t castor3d::TextOverlay::getWordCount ( ) const

inlinenoexcept

Références castor3d::OverlayWords::count.

isChanged()

bool castor3d::TextOverlay::isChanged ( ) const

inlineoverridevirtualnoexcept

Réimplémentée à partir de castor3d::OverlayCategory.

setCaption()

void castor3d::TextOverlay::setCaption ( std::u32string  value )

inline

setFont()

C3D_API void castor3d::TextOverlay::setFont

(

castor::String

value

)

Définit la police du texte.

Paramètres

[in]

value

La nouvelle valeur

setHAlign()

void castor3d::TextOverlay::setHAlign ( HAlign  value )

inline

setLineSpacingMode()

void castor3d::TextOverlay::setLineSpacingMode ( TextLineSpacingMode  value )

inline

setTexturingMode()

void castor3d::TextOverlay::setTexturingMode ( TextTexturingMode  value )

inline

setTextWrappingMode()

void castor3d::TextOverlay::setTextWrappingMode ( TextWrappingMode  value )

inline

setVAlign()

void castor3d::TextOverlay::setVAlign ( VAlign  value )

inline

---

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

• Overlay/TextOverlay.hpp