SkSL::SampleUsage Class Reference

#include <SkSLSampleUsage.h>

Public Types
enum class	Kind {   kNone , kPassThrough , kUniformMatrix , kFragCoord ,   kExplicit }

Public Member Functions
	SampleUsage ()=default
	SampleUsage (Kind kind, bool hasPerspective)
bool	operator== (const SampleUsage &that) const
bool	operator!= (const SampleUsage &that) const
SampleUsage	merge (const SampleUsage &other)
Kind	kind () const
bool	hasPerspective () const
bool	isSampled () const
bool	isPassThrough () const
bool	isExplicit () const
bool	isUniformMatrix () const
bool	isFragCoord () const

Static Public Member Functions
static SampleUsage	UniformMatrix (bool hasPerspective)
static SampleUsage	Explicit ()
static SampleUsage	PassThrough ()
static SampleUsage	FragCoord ()
static const char *	MatrixUniformName ()

Detailed Description

Represents all of the ways that a fragment processor is sampled by its parent.

Definition at line 18 of file SkSLSampleUsage.h.

Member Enumeration Documentation

Kind

enum class SkSL::SampleUsage::Kind

strong

Enumerator
kNone
kPassThrough
kUniformMatrix
kFragCoord
kExplicit

Definition at line 20 of file SkSLSampleUsage.h.

                    {
        // Child is never sampled
        kNone,
        // Child is only sampled at the same coordinates as the parent
        kPassThrough,
        // Child is sampled with a matrix whose value is uniform
        kUniformMatrix,
        // Child is sampled with sk_FragCoord.xy
        kFragCoord,
        // Child is sampled using explicit coordinates
        kExplicit,
    };

Constructor & Destructor Documentation

SampleUsage() [1/2]

SkSL::SampleUsage::SampleUsage ( )

default

SampleUsage() [2/2]

SkSL::SampleUsage::SampleUsage ( Kind  kind, bool  hasPerspective  )

inline

Definition at line 36 of file SkSLSampleUsage.h.

                                                : fKind(kind), fHasPerspective(hasPerspective) {
        if (kind != Kind::kUniformMatrix) {
            SkASSERT(!fHasPerspective);
        }
    }

Member Function Documentation

Explicit()

static SampleUsage SkSL::SampleUsage::Explicit ( )

inlinestatic

Definition at line 47 of file SkSLSampleUsage.h.

                                  {
        return SampleUsage(Kind::kExplicit, false);
    }

FragCoord()

static SampleUsage SkSL::SampleUsage::FragCoord ( )

inlinestatic

Definition at line 55 of file SkSLSampleUsage.h.

{ return SampleUsage(Kind::kFragCoord, false); }

hasPerspective()

bool SkSL::SampleUsage::hasPerspective ( ) const

inline

Definition at line 70 of file SkSLSampleUsage.h.

{ return fHasPerspective; }

isExplicit()

bool SkSL::SampleUsage::isExplicit ( ) const

inline

Definition at line 74 of file SkSLSampleUsage.h.

{ return fKind == Kind::kExplicit; }

isFragCoord()

bool SkSL::SampleUsage::isFragCoord ( ) const

inline

Definition at line 76 of file SkSLSampleUsage.h.

{ return fKind == Kind::kFragCoord; }

isPassThrough()

bool SkSL::SampleUsage::isPassThrough ( ) const

inline

Definition at line 73 of file SkSLSampleUsage.h.

{ return fKind == Kind::kPassThrough; }

isSampled()

bool SkSL::SampleUsage::isSampled ( ) const

inline

Definition at line 72 of file SkSLSampleUsage.h.

{ return fKind != Kind::kNone; }

isUniformMatrix()

bool SkSL::SampleUsage::isUniformMatrix ( ) const

inline

Definition at line 75 of file SkSLSampleUsage.h.

{ return fKind == Kind::kUniformMatrix; }

kind()

Kind SkSL::SampleUsage::kind ( ) const

inline

Definition at line 68 of file SkSLSampleUsage.h.

{ return fKind; }

MatrixUniformName()

static const char * SkSL::SampleUsage::MatrixUniformName ( )

inlinestatic

Definition at line 64 of file SkSLSampleUsage.h.

{ return "matrix"; }

merge()

SampleUsage SkSL::SampleUsage::merge

(

const SampleUsage &

other

)

Definition at line 14 of file SkSLSampleUsage.cpp.

                                                       {
    // This function is only used in Analysis::MergeSampleUsageVisitor to determine the combined
    // SampleUsage for a child fp/shader/etc. We should never see matrix sampling here.
    SkASSERT(fKind != Kind::kUniformMatrix && other.fKind != Kind::kUniformMatrix);
 
    static_assert(Kind::kExplicit > Kind::kPassThrough);
    static_assert(Kind::kPassThrough > Kind::kNone);
    fKind = std::max(fKind, other.fKind);
 
    return *this;
}

operator!=()

bool SkSL::SampleUsage::operator!= ( const SampleUsage &  that ) const

inline

Definition at line 61 of file SkSLSampleUsage.h.

{ return !(*this == that); }

operator==()

bool SkSL::SampleUsage::operator== ( const SampleUsage &  that ) const

inline

Definition at line 57 of file SkSLSampleUsage.h.

                                                   {
        return fKind == that.fKind && fHasPerspective == that.fHasPerspective;
    }

PassThrough()

static SampleUsage SkSL::SampleUsage::PassThrough ( )

inlinestatic

Definition at line 51 of file SkSLSampleUsage.h.

                                     {
        return SampleUsage(Kind::kPassThrough, false);
    }

UniformMatrix()

static SampleUsage SkSL::SampleUsage::UniformMatrix ( bool  hasPerspective )

inlinestatic

Definition at line 43 of file SkSLSampleUsage.h.

                                                          {
        return SampleUsage(Kind::kUniformMatrix, hasPerspective);
    }

---

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

• third_party/skia/include/private/SkSLSampleUsage.h
• third_party/skia/src/sksl/SkSLSampleUsage.cpp