Castor3D 0.17.0
Multiplatform 3D engine
Public Types | Public Member Functions | List of all members
castor3d::FontUbo Class Reference

#include <FontUbo.hpp>

Public Types

using Configuration = FontUboConfiguration
 

Public Member Functions

C3D_API FontUbo (FontUbo const &rhs)=delete
 
C3D_API FontUbooperator= (FontUbo const &rhs)=delete
 
C3D_API FontUbo (FontUbo &&rhs) noexcept=default
 
C3D_API FontUbooperator= (FontUbo &&rhs) noexcept=delete
 
C3D_API FontUbo (RenderDevice const &device)
 
C3D_API ~FontUbo () noexcept
 
C3D_API void cpuUpdate (castor::Size const &imgSize, bool sdfFont, float pixelRange)
 Updates the UBO from given values.
 
void createPassBinding (crg::FramePass &pass, uint32_t binding) const
 
void createSizedBinding (ashes::DescriptorSet &descriptorSet, VkDescriptorSetLayoutBinding const &layoutBinding) const
 
ashes::WriteDescriptorSet getDescriptorWrite (uint32_t dstBinding, uint32_t dstArrayElement=0u) const
 
UniformBufferOffsetT< Configuration > const & getUbo () const
 

Member Typedef Documentation

◆ Configuration

Constructor & Destructor Documentation

◆ FontUbo() [1/3]

C3D_API castor3d::FontUbo::FontUbo ( FontUbo const & rhs)
delete

◆ FontUbo() [2/3]

C3D_API castor3d::FontUbo::FontUbo ( FontUbo && rhs)
defaultnoexcept

◆ FontUbo() [3/3]

C3D_API castor3d::FontUbo::FontUbo ( RenderDevice const & device)
explicit

◆ ~FontUbo()

C3D_API castor3d::FontUbo::~FontUbo ( )
noexcept

Member Function Documentation

◆ cpuUpdate()

C3D_API void castor3d::FontUbo::cpuUpdate ( castor::Size const & imgSize,
bool sdfFont,
float pixelRange )

Updates the UBO from given values.

Parameters
[in]imgSizeThe font texture dimensions.
[in]sdfFonttrue if the font texture stores SDF.
[in]pixelRangeThe distance field thickness.

◆ createPassBinding()

void castor3d::FontUbo::createPassBinding ( crg::FramePass & pass,
uint32_t binding ) const
inline

References castor3d::UniformBufferOffsetT< DataT >::createPassBinding().

Here is the call graph for this function:

◆ createSizedBinding()

void castor3d::FontUbo::createSizedBinding ( ashes::DescriptorSet & descriptorSet,
VkDescriptorSetLayoutBinding const & layoutBinding ) const
inline

References castor3d::UniformBufferOffsetT< DataT >::createSizedBinding().

Here is the call graph for this function:

◆ getDescriptorWrite()

ashes::WriteDescriptorSet castor3d::FontUbo::getDescriptorWrite ( uint32_t dstBinding,
uint32_t dstArrayElement = 0u ) const
inline

References castor3d::UniformBufferOffsetT< DataT >::getDescriptorWrite().

Here is the call graph for this function:

◆ getUbo()

UniformBufferOffsetT< Configuration > const & castor3d::FontUbo::getUbo ( ) const
inline

◆ operator=() [1/2]

C3D_API FontUbo & castor3d::FontUbo::operator= ( FontUbo && rhs)
deletenoexcept

◆ operator=() [2/2]

C3D_API FontUbo & castor3d::FontUbo::operator= ( FontUbo const & rhs)
delete

The documentation for this class was generated from the following file: