neoGFX
Cross-platform C++ app/game engine
Public Types | Public Member Functions | List of all members
neogfx::text_effect Class Reference

#include <primitives.hpp>

Public Types

typedef double auxiliary_parameter
 
typedef std::optional< auxiliary_parameter > optional_auxiliary_parameter
 

Public Member Functions

 text_effect (text_effect_type aType, const text_color &aColor, const optional_dimension &aWidth={}, const optional_vec3 &aOffset={}, const optional_auxiliary_parameter &aAux1={})
 
text_effect & operator= (const text_effect &aOther)
 
bool operator== (const text_effect &aOther) const
 
bool operator!= (const text_effect &aOther) const
 
bool operator< (const text_effect &aRhs) const
 
text_effect_type type () const
 
text_color color () const
 
dimension width () const
 
vec3 offset () const
 
double aux1 () const
 
text_effect with_alpha (color::component aAlpha) const
 
text_effect with_alpha (double aAlpha) const
 

Detailed Description

Definition at line 162 of file primitives.hpp.

Member Typedef Documentation

◆ auxiliary_parameter

typedef double neogfx::text_effect::auxiliary_parameter

Definition at line 165 of file primitives.hpp.

◆ optional_auxiliary_parameter

typedef std::optional<auxiliary_parameter> neogfx::text_effect::optional_auxiliary_parameter

Definition at line 166 of file primitives.hpp.

Constructor & Destructor Documentation

◆ text_effect()

neogfx::text_effect::text_effect ( text_effect_type  aType,
const text_color &  aColor,
const optional_dimension &  aWidth = {},
const optional_vec3 &  aOffset = {},
const optional_auxiliary_parameter &  aAux1 = {} 
)
inline

Definition at line 168 of file primitives.hpp.

Member Function Documentation

◆ aux1()

double neogfx::text_effect::aux1 ( ) const
inline

Definition at line 247 of file primitives.hpp.

◆ color()

text_color neogfx::text_effect::color ( ) const
inline

Definition at line 202 of file primitives.hpp.

◆ offset()

vec3 neogfx::text_effect::offset ( ) const
inline

Definition at line 230 of file primitives.hpp.

◆ operator!=()

bool neogfx::text_effect::operator!= ( const text_effect &  aOther) const
inline

Definition at line 189 of file primitives.hpp.

◆ operator<()

bool neogfx::text_effect::operator< ( const text_effect &  aRhs) const
inline

Definition at line 193 of file primitives.hpp.

◆ operator=()

text_effect& neogfx::text_effect::operator= ( const text_effect &  aOther)
inline

Definition at line 173 of file primitives.hpp.

◆ operator==()

bool neogfx::text_effect::operator== ( const text_effect &  aOther) const
inline

Definition at line 185 of file primitives.hpp.

◆ type()

text_effect_type neogfx::text_effect::type ( ) const
inline

Definition at line 198 of file primitives.hpp.

◆ width()

dimension neogfx::text_effect::width ( ) const
inline

Definition at line 214 of file primitives.hpp.

◆ with_alpha() [1/2]

text_effect neogfx::text_effect::with_alpha ( color::component  aAlpha) const
inline

Definition at line 263 of file primitives.hpp.

◆ with_alpha() [2/2]

text_effect neogfx::text_effect::with_alpha ( double  aAlpha) const
inline

Definition at line 267 of file primitives.hpp.

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