SkSL::Literal Class Reference

#include <SkSLLiteral.h>

Inheritance diagram for SkSL::Literal:

Public Member Functions
	Literal (Position pos, double value, const Type *type)
float	floatValue () const
SKSL_INT	intValue () const
SKSL_INT	boolValue () const
double	value () const
std::string	description (OperatorPrecedence) const override
ComparisonResult	compareConstant (const Expression &other) const override
std::unique_ptr< Expression >	clone (Position pos) const override
bool	supportsConstantValues () const override
std::optional< double >	getConstantValue (int n) const override
Public Member Functions inherited from SkSL::Expression
	Expression (Position pos, Kind kind, const Type *type)
Kind	kind () const
virtual const Type &	type () const
bool	isAnyConstructor () const
bool	isIntLiteral () const
bool	isFloatLiteral () const
bool	isBoolLiteral () const
AnyConstructor &	asAnyConstructor ()
const AnyConstructor &	asAnyConstructor () const
bool	isIncomplete (const Context &context) const
CoercionCost	coercionCost (const Type &target) const
std::unique_ptr< Expression >	clone () const
std::string	description () const final
Public Member Functions inherited from SkSL::IRNode
virtual	~IRNode ()
	IRNode (const IRNode &)=delete
IRNode &	operator= (const IRNode &)=delete
Position	position () const
void	setPosition (Position p)
template<typename T >
bool	is () const
template<typename T >
const T &	as () const
template<typename T >
T &	as ()

Static Public Member Functions
static std::unique_ptr< Literal >	MakeFloat (const Context &context, Position pos, float value)
static std::unique_ptr< Literal >	MakeFloat (Position pos, float value, const Type *type)
static std::unique_ptr< Literal >	MakeInt (const Context &context, Position pos, SKSL_INT value)
static std::unique_ptr< Literal >	MakeInt (Position pos, SKSL_INT value, const Type *type)
static std::unique_ptr< Literal >	MakeBool (const Context &context, Position pos, bool value)
static std::unique_ptr< Literal >	MakeBool (Position pos, bool value, const Type *type)
static std::unique_ptr< Literal >	Make (Position pos, double value, const Type *type)
Static Public Member Functions inherited from SkSL::Poolable
static void *	operator new (const size_t size)
static void	operator delete (void *ptr)

Static Public Attributes
static constexpr Kind	kIRNodeKind = Kind::kLiteral

Additional Inherited Members
Public Types inherited from SkSL::Expression
enum class	ComparisonResult { kUnknown = -1 , kNotEqual , kEqual }
using	Kind = ExpressionKind
Public Attributes inherited from SkSL::IRNode
Position	fPosition
Protected Member Functions inherited from SkSL::IRNode
	IRNode (Position position, int kind)
Protected Attributes inherited from SkSL::IRNode
int	fKind

Detailed Description

A literal value. These can contain ints, floats, or booleans.

Definition at line 34 of file SkSLLiteral.h.

Constructor & Destructor Documentation

Literal()

SkSL::Literal::Literal ( Position  pos, double  value, const Type *  type  )

inline

Definition at line 38 of file SkSLLiteral.h.

        : INHERITED(pos, kIRNodeKind, type)
        , fValue(value) {}

Member Function Documentation

boolValue()

SKSL_INT SkSL::Literal::boolValue ( ) const

inline

Definition at line 102 of file SkSLLiteral.h.

                               {
        SkASSERT(this->type().isBoolean());
        return (bool)fValue;
    }

clone()

std::unique_ptr< Expression > SkSL::Literal::clone ( Position  pos ) const

inlineoverridevirtual

Implements SkSL::Expression.

Definition at line 122 of file SkSLLiteral.h.

                                                                 {
        return std::make_unique<Literal>(pos, this->value(), &this->type());
    }

compareConstant()

ComparisonResult SkSL::Literal::compareConstant ( const Expression &  other ) const

inlineoverridevirtual

Reimplemented from SkSL::Expression.

Definition at line 113 of file SkSLLiteral.h.

                                                                             {
        if (!other.is<Literal>() || this->type().numberKind() != other.type().numberKind()) {
            return ComparisonResult::kUnknown;
        }
        return this->value() == other.as<Literal>().value()
                       ? ComparisonResult::kEqual
                       : ComparisonResult::kNotEqual;
    }

description()

std::string SkSL::Literal::description ( OperatorPrecedence  ) const

overridevirtual

Implements SkSL::Expression.

Definition at line 13 of file SkSLLiteral.cpp.

                                                       {
    if (this->type().isBoolean()) {
        return fValue ? "true" : "false";
    }
    if (this->type().isInteger()) {
        return std::to_string(this->intValue());
    }
    return skstd::to_string(this->floatValue());
}

floatValue()

float SkSL::Literal::floatValue ( ) const

inline

Definition at line 92 of file SkSLLiteral.h.

                             {
        SkASSERT(this->type().isFloat());
        return (SKSL_FLOAT)fValue;
    }

getConstantValue()

std::optional< double > SkSL::Literal::getConstantValue ( int  n ) const

inlineoverridevirtual

Returns the n'th compile-time constant value within a literal or constructor. Use Type::slotCount to determine the number of slots within an expression. Slots which do not contain compile-time constant values will return nullopt. vec4(1, vec2(2), 3) contains four compile-time constants: (1, 2, 2, 3) mat2(f) contains four slots, and two are constant: (nullopt, 0, 0, nullopt) All classes which override this function must also implement supportsConstantValues.

Reimplemented from SkSL::Expression.

Definition at line 130 of file SkSLLiteral.h.

                                                               {
        SkASSERT(n == 0);
        return fValue;
    }

intValue()

SKSL_INT SkSL::Literal::intValue ( ) const

inline

Definition at line 97 of file SkSLLiteral.h.

                              {
        SkASSERT(this->type().isInteger());
        return (SKSL_INT)fValue;
    }

Make()

static std::unique_ptr< Literal > SkSL::Literal::Make ( Position  pos, double  value, const Type *  type  )

inlinestatic

Definition at line 81 of file SkSLLiteral.h.

                                                                                     {
        if (type->isFloat()) {
            return MakeFloat(pos, value, type);
        }
        if (type->isInteger()) {
            return MakeInt(pos, value, type);
        }
        SkASSERT(type->isBoolean());
        return MakeBool(pos, value, type);
    }

MakeBool() [1/2]

static std::unique_ptr< Literal > SkSL::Literal::MakeBool ( const Context &  context, Position  pos, bool  value  )

inlinestatic

Definition at line 69 of file SkSLLiteral.h.

                                                                                             {
        return std::make_unique<Literal>(pos, value, context.fTypes.fBool.get());
    }

MakeBool() [2/2]

static std::unique_ptr< Literal > SkSL::Literal::MakeBool ( Position  pos, bool  value, const Type *  type  )

inlinestatic

Definition at line 75 of file SkSLLiteral.h.

                                                                                       {
        SkASSERT(type->isBoolean());
        return std::make_unique<Literal>(pos, value, type);
    }

MakeFloat() [1/2]

static std::unique_ptr< Literal > SkSL::Literal::MakeFloat ( const Context &  context, Position  pos, float  value  )

inlinestatic

Definition at line 43 of file SkSLLiteral.h.

                                                                                               {
        return std::make_unique<Literal>(pos, value, context.fTypes.fFloatLiteral.get());
    }

MakeFloat() [2/2]

static std::unique_ptr< Literal > SkSL::Literal::MakeFloat ( Position  pos, float  value, const Type *  type  )

inlinestatic

Definition at line 48 of file SkSLLiteral.h.

                                                                                         {
        SkASSERT(type->isFloat());
        return std::make_unique<Literal>(pos, value, type);
    }

MakeInt() [1/2]

static std::unique_ptr< Literal > SkSL::Literal::MakeInt ( const Context &  context, Position  pos, SKSL_INT  value  )

inlinestatic

Definition at line 54 of file SkSLLiteral.h.

                                                                                                {
        return std::make_unique<Literal>(pos, value, context.fTypes.fIntLiteral.get());
    }

MakeInt() [2/2]

static std::unique_ptr< Literal > SkSL::Literal::MakeInt ( Position  pos, SKSL_INT  value, const Type *  type  )

inlinestatic

Definition at line 59 of file SkSLLiteral.h.

                                                                                          {
        SkASSERT(type->isInteger());
        SkASSERTF(value >= type->minimumValue(), "Value %" PRId64 " does not fit in type %s",
                                                 value, type->description().c_str());
        SkASSERTF(value <= type->maximumValue(), "Value %" PRId64 " does not fit in type %s",
                                                 value, type->description().c_str());
        return std::make_unique<Literal>(pos, value, type);
    }

supportsConstantValues()

bool SkSL::Literal::supportsConstantValues ( ) const

inlineoverridevirtual

Returns true if this expression type supports getConstantValue. (This particular expression may or may not actually contain a constant value.) It's harmless to call getConstantValue on expressions which don't support constant values or don't contain any constant values, but if supportsConstantValues returns false, you can assume that getConstantValue will return nullopt for every slot of this expression. This allows for early-out opportunities in some cases. (Some expressions have tons of slots but never hold a constant value; e.g. a variable holding a very large array.)

Reimplemented from SkSL::Expression.

Definition at line 126 of file SkSLLiteral.h.

                                                 {
        return true;
    }

value()

double SkSL::Literal::value ( ) const

inline

Definition at line 107 of file SkSLLiteral.h.

                         {
        return fValue;
    }

Member Data Documentation

kIRNodeKind

constexpr Kind SkSL::Literal::kIRNodeKind = Kind::kLiteral

inlinestaticconstexpr

Definition at line 36 of file SkSLLiteral.h.

---

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

• third_party/skia/src/sksl/ir/SkSLLiteral.h
• third_party/skia/src/sksl/ir/SkSLLiteral.cpp