GrSamplerState Class Reference

#include <GrSamplerState.h>

Public Types
enum class	WrapMode : uint8_t {   kClamp , kRepeat , kMirrorRepeat , kClampToBorder ,   kLast = kClampToBorder }
using	Filter = SkFilterMode
using	MipmapMode = SkMipmapMode

Public Member Functions
constexpr	GrSamplerState ()=default
constexpr	GrSamplerState (WrapMode wrapXAndY, Filter filter, MipmapMode mm=MipmapMode::kNone)
constexpr	GrSamplerState (WrapMode wrapX, WrapMode wrapY, Filter filter, MipmapMode mm=MipmapMode::kNone)
constexpr	GrSamplerState (const WrapMode wrapModes[2], Filter filter, MipmapMode mm=MipmapMode::kNone)
constexpr	GrSamplerState (Filter filter)
constexpr	GrSamplerState (Filter filter, MipmapMode mm)
constexpr	GrSamplerState (const GrSamplerState &)=default
constexpr GrSamplerState &	operator= (const GrSamplerState &)=default
constexpr WrapMode	wrapModeX () const
constexpr WrapMode	wrapModeY () const
constexpr bool	isRepeatedX () const
constexpr bool	isRepeatedY () const
constexpr bool	isRepeated () const
constexpr Filter	filter () const
constexpr MipmapMode	mipmapMode () const
constexpr skgpu::Mipmapped	mipmapped () const
int	maxAniso () const
bool	isAniso () const
constexpr bool	operator== (GrSamplerState that) const
constexpr bool	operator!= (const GrSamplerState &that) const
uint32_t	asKey (bool anisoIsOrthogonal) const

Static Public Member Functions
static constexpr GrSamplerState	Aniso (WrapMode wrapX, WrapMode wrapY, int maxAniso, skgpu::Mipmapped viewIsMipped)

Static Public Attributes
static constexpr int	kFilterCount = static_cast<int>(Filter::kLast) + 1
static constexpr int	kWrapModeCount = static_cast<int>(WrapMode::kLast) + 1
static constexpr int	kMipmapModeCount = static_cast<int>(MipmapMode::kLast) + 1

Detailed Description

Represents the filtering and tile modes used to access a texture.

Definition at line 22 of file GrSamplerState.h.

Member Typedef Documentation

Filter

using GrSamplerState::Filter = SkFilterMode

Definition at line 24 of file GrSamplerState.h.

MipmapMode

using GrSamplerState::MipmapMode = SkMipmapMode

Definition at line 25 of file GrSamplerState.h.

Member Enumeration Documentation

WrapMode

enum class GrSamplerState::WrapMode : uint8_t

strong

Enumerator
kClamp
kRepeat
kMirrorRepeat
kClampToBorder
kLast

Definition at line 27 of file GrSamplerState.h.

                        : uint8_t {
        kClamp,
        kRepeat,
        kMirrorRepeat,
        kClampToBorder,
        kLast = kClampToBorder
    };

Constructor & Destructor Documentation

GrSamplerState() [1/7]

constexpr GrSamplerState::GrSamplerState ( )

constexprdefault

GrSamplerState() [2/7]

constexpr GrSamplerState::GrSamplerState ( WrapMode  wrapXAndY, Filter  filter, MipmapMode  mm = MipmapMode::kNone  )

inlineconstexpr

Definition at line 41 of file GrSamplerState.h.

            : fWrapModes{wrapXAndY, wrapXAndY}, fFilter(filter), fMipmapMode(mm) {}

GrSamplerState() [3/7]

constexpr GrSamplerState::GrSamplerState ( WrapMode  wrapX, WrapMode  wrapY, Filter  filter, MipmapMode  mm = MipmapMode::kNone  )

inlineconstexpr

Definition at line 44 of file GrSamplerState.h.

            : fWrapModes{wrapX, wrapY}, fFilter(filter), fMipmapMode(mm) {}

GrSamplerState() [4/7]

constexpr GrSamplerState::GrSamplerState ( const WrapMode  wrapModes[2], Filter  filter, MipmapMode  mm = MipmapMode::kNone  )

inlineconstexpr

Definition at line 50 of file GrSamplerState.h.

            : fWrapModes{wrapModes[0], wrapModes[1]}, fFilter(filter), fMipmapMode(mm) {}

GrSamplerState() [5/7]

constexpr GrSamplerState::GrSamplerState ( Filter  filter )

inlineconstexpr

Definition at line 55 of file GrSamplerState.h.

: fFilter(filter) {}

GrSamplerState() [6/7]

constexpr GrSamplerState::GrSamplerState ( Filter  filter, MipmapMode  mm  )

inlineconstexpr

Definition at line 56 of file GrSamplerState.h.

: fFilter(filter), fMipmapMode(mm) {}

GrSamplerState() [7/7]

constexpr GrSamplerState::GrSamplerState ( const GrSamplerState &  )

constexprdefault

Member Function Documentation

Aniso()

static constexpr GrSamplerState GrSamplerState::Aniso ( WrapMode  wrapX, WrapMode  wrapY, int  maxAniso, skgpu::Mipmapped  viewIsMipped  )

inlinestaticconstexpr

Definition at line 60 of file GrSamplerState.h.

                                                                       {
        GrSamplerState sampler;
        sampler.fWrapModes[0] = wrapX;
        sampler.fWrapModes[1] = wrapY;
        sampler.fMaxAniso     = SkTPin(maxAniso, 1, kMaxMaxAniso);
        sampler.fFilter       = Filter::kLinear;
        sampler.fMipmapMode   = viewIsMipped == skgpu::Mipmapped::kYes ? MipmapMode::kLinear
                                                                       : MipmapMode::kNone;
        return sampler;
    }

asKey()

uint32_t GrSamplerState::asKey ( bool  anisoIsOrthogonal ) const

inline

Turn the sampler state into an integer for use as a key. How that works for aniso depends on whether the underlying API defines aniso as orthogonal to other filter settings or as a replacement for them.

Definition at line 117 of file GrSamplerState.h.

                                                 {
        constexpr int kNumWrapBits       = SkNextLog2_portable(kWrapModeCount);
        constexpr int kNumMaxAnisoBits   = SkNextLog2_portable(kMaxMaxAniso);
        constexpr int kNumFilterBits     = SkNextLog2_portable(kFilterCount);
        constexpr int kNumMipmapModeBits = SkNextLog2_portable(kMipmapModeCount);
 
        constexpr int kWrapXShift      = 0;
        constexpr int kWrapYShift      = kWrapXShift    + kNumWrapBits;
        constexpr int kMaxAnisoShift   = kWrapYShift    + kNumWrapBits;
        constexpr int kFilterShift     = kMaxAnisoShift + kNumMaxAnisoBits;
        constexpr int kMipmapModeShift = kFilterShift   + kNumFilterBits;
 
        static_assert(kMipmapModeShift + kNumMipmapModeBits <= 32);
 
        uint32_t key = (static_cast<uint32_t>(fWrapModes[0]) << kWrapXShift)
                     | (static_cast<uint32_t>(fWrapModes[1]) << kWrapYShift)
                     | (static_cast<uint32_t>(fMaxAniso)     << kMaxAnisoShift);
        if (fMaxAniso == 1 || anisoIsOrthogonal) {
            key |= (static_cast<uint32_t>(fFilter)     << kFilterShift)
                |  (static_cast<uint32_t>(fMipmapMode) << kMipmapModeShift);
        }
        return key;
    }

filter()

constexpr Filter GrSamplerState::filter ( ) const

inlineconstexpr

Definition at line 94 of file GrSamplerState.h.

{ return fFilter; }

isAniso()

bool GrSamplerState::isAniso ( ) const

inline

Definition at line 103 of file GrSamplerState.h.

{ return fMaxAniso > 1; }

isRepeated()

constexpr bool GrSamplerState::isRepeated ( ) const

inlineconstexpr

Definition at line 90 of file GrSamplerState.h.

                                      {
        return this->isRepeatedX() || this->isRepeatedY();
    }

isRepeatedX()

constexpr bool GrSamplerState::isRepeatedX ( ) const

inlineconstexpr

Definition at line 82 of file GrSamplerState.h.

                                       {
        return fWrapModes[0] == WrapMode::kRepeat || fWrapModes[0] == WrapMode::kMirrorRepeat;
    }

isRepeatedY()

constexpr bool GrSamplerState::isRepeatedY ( ) const

inlineconstexpr

Definition at line 86 of file GrSamplerState.h.

                                       {
        return fWrapModes[1] == WrapMode::kRepeat || fWrapModes[1] == WrapMode::kMirrorRepeat;
    }

maxAniso()

int GrSamplerState::maxAniso ( ) const

inline

Definition at line 102 of file GrSamplerState.h.

{ return fMaxAniso; }

mipmapMode()

constexpr MipmapMode GrSamplerState::mipmapMode ( ) const

inlineconstexpr

Definition at line 96 of file GrSamplerState.h.

{ return fMipmapMode; }

mipmapped()

constexpr skgpu::Mipmapped GrSamplerState::mipmapped ( ) const

inlineconstexpr

Definition at line 98 of file GrSamplerState.h.

                                               {
        return skgpu::Mipmapped(fMipmapMode != MipmapMode::kNone);
    }

operator!=()

constexpr bool GrSamplerState::operator!= ( const GrSamplerState &  that ) const

inlineconstexpr

Definition at line 110 of file GrSamplerState.h.

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

operator=()

constexpr GrSamplerState & GrSamplerState::operator= ( const GrSamplerState &  )

constexprdefault

operator==()

constexpr bool GrSamplerState::operator== ( GrSamplerState  that ) const

inlineconstexpr

Definition at line 105 of file GrSamplerState.h.

                                                         {
        return fWrapModes[0] == that.fWrapModes[0] && fWrapModes[1] == that.fWrapModes[1] &&
               fFilter == that.fFilter && fMipmapMode == that.fMipmapMode;
    }

wrapModeX()

constexpr WrapMode GrSamplerState::wrapModeX ( ) const

inlineconstexpr

Definition at line 78 of file GrSamplerState.h.

{ return fWrapModes[0]; }

wrapModeY()

constexpr WrapMode GrSamplerState::wrapModeY ( ) const

inlineconstexpr

Definition at line 80 of file GrSamplerState.h.

{ return fWrapModes[1]; }

Member Data Documentation

kFilterCount

constexpr int GrSamplerState::kFilterCount = static_cast<int>(Filter::kLast) + 1

staticconstexpr

Definition at line 35 of file GrSamplerState.h.

kMipmapModeCount

constexpr int GrSamplerState::kMipmapModeCount = static_cast<int>(MipmapMode::kLast) + 1

staticconstexpr

Definition at line 37 of file GrSamplerState.h.

kWrapModeCount

constexpr int GrSamplerState::kWrapModeCount = static_cast<int>(WrapMode::kLast) + 1

staticconstexpr

Definition at line 36 of file GrSamplerState.h.

---

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

• third_party/skia/src/gpu/ganesh/GrSamplerState.h