Brian Salomon | 2bbdcc4 | 2017-09-07 12:36:34 -0400 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Google Inc. |
| 3 | * |
| 4 | * Use of this source code is governed by a BSD-style license that can be |
| 5 | * found in the LICENSE file. |
| 6 | */ |
| 7 | |
| 8 | #ifndef GrSamplerState_DEFINED |
| 9 | #define GrSamplerState_DEFINED |
| 10 | |
Mike Klein | c0bd9f9 | 2019-04-23 12:05:21 -0500 | [diff] [blame] | 11 | #include "include/gpu/GrTypes.h" |
Brian Salomon | a7d9f30 | 2020-07-15 13:25:30 -0400 | [diff] [blame] | 12 | #include <limits> |
Brian Salomon | 2bbdcc4 | 2017-09-07 12:36:34 -0400 | [diff] [blame] | 13 | |
| 14 | /** |
| 15 | * Represents the filtering and tile modes used to access a texture. |
| 16 | */ |
| 17 | class GrSamplerState { |
| 18 | public: |
Brian Salomon | e69b9ef | 2020-07-22 11:18:06 -0400 | [diff] [blame] | 19 | enum class Filter : uint8_t { kNearest, kLinear, kLast = kLinear }; |
Brian Salomon | f735351 | 2020-07-22 19:26:48 -0400 | [diff] [blame] | 20 | enum class MipmapMode : uint8_t { kNone, kNearest, kLinear, kLast = kLinear }; |
Brian Salomon | e69b9ef | 2020-07-22 11:18:06 -0400 | [diff] [blame] | 21 | |
| 22 | enum class WrapMode : uint8_t { |
| 23 | kClamp, |
| 24 | kRepeat, |
| 25 | kMirrorRepeat, |
| 26 | kClampToBorder, |
| 27 | kLast = kClampToBorder |
| 28 | }; |
Michael Ludwig | adb12e7 | 2019-12-04 16:19:18 -0500 | [diff] [blame] | 29 | |
Brian Salomon | ccb6142 | 2020-01-09 10:46:36 -0500 | [diff] [blame] | 30 | static constexpr int kFilterCount = static_cast<int>(Filter::kLast) + 1; |
| 31 | static constexpr int kWrapModeCount = static_cast<int>(WrapMode::kLast) + 1; |
Brian Salomon | 2bbdcc4 | 2017-09-07 12:36:34 -0400 | [diff] [blame] | 32 | |
Brian Salomon | ccb6142 | 2020-01-09 10:46:36 -0500 | [diff] [blame] | 33 | constexpr GrSamplerState() = default; |
Brian Salomon | 2bbdcc4 | 2017-09-07 12:36:34 -0400 | [diff] [blame] | 34 | |
Brian Salomon | e69b9ef | 2020-07-22 11:18:06 -0400 | [diff] [blame] | 35 | constexpr GrSamplerState(WrapMode wrapXAndY, Filter filter, MipmapMode mm = MipmapMode::kNone) |
| 36 | : fWrapModes{wrapXAndY, wrapXAndY}, fFilter(filter), fMipmapMode(mm) {} |
Brian Salomon | 2bbdcc4 | 2017-09-07 12:36:34 -0400 | [diff] [blame] | 37 | |
Brian Salomon | e69b9ef | 2020-07-22 11:18:06 -0400 | [diff] [blame] | 38 | constexpr GrSamplerState(WrapMode wrapX, |
| 39 | WrapMode wrapY, |
| 40 | Filter filter, |
| 41 | MipmapMode mm = MipmapMode::kNone) |
| 42 | : fWrapModes{wrapX, wrapY}, fFilter(filter), fMipmapMode(mm) {} |
Brian Salomon | ca6b2f4 | 2020-01-24 11:31:21 -0500 | [diff] [blame] | 43 | |
Brian Salomon | e69b9ef | 2020-07-22 11:18:06 -0400 | [diff] [blame] | 44 | constexpr GrSamplerState(const WrapMode wrapModes[2], |
| 45 | Filter filter, |
| 46 | MipmapMode mm = MipmapMode::kNone) |
| 47 | : fWrapModes{wrapModes[0], wrapModes[1]}, fFilter(filter), fMipmapMode(mm) {} |
Brian Salomon | 2bbdcc4 | 2017-09-07 12:36:34 -0400 | [diff] [blame] | 48 | |
Brian Salomon | ccb6142 | 2020-01-09 10:46:36 -0500 | [diff] [blame] | 49 | constexpr /*explicit*/ GrSamplerState(Filter filter) : fFilter(filter) {} |
Brian Salomon | e69b9ef | 2020-07-22 11:18:06 -0400 | [diff] [blame] | 50 | constexpr GrSamplerState(Filter filter, MipmapMode mm) : fFilter(filter), fMipmapMode(mm) {} |
Brian Salomon | ccb6142 | 2020-01-09 10:46:36 -0500 | [diff] [blame] | 51 | |
Brian Salomon | 2bbdcc4 | 2017-09-07 12:36:34 -0400 | [diff] [blame] | 52 | constexpr GrSamplerState(const GrSamplerState&) = default; |
| 53 | |
Brian Salomon | ccb6142 | 2020-01-09 10:46:36 -0500 | [diff] [blame] | 54 | constexpr GrSamplerState& operator=(const GrSamplerState&) = default; |
Brian Salomon | 2bbdcc4 | 2017-09-07 12:36:34 -0400 | [diff] [blame] | 55 | |
Brian Salomon | ccb6142 | 2020-01-09 10:46:36 -0500 | [diff] [blame] | 56 | constexpr WrapMode wrapModeX() const { return fWrapModes[0]; } |
Brian Salomon | e69b9ef | 2020-07-22 11:18:06 -0400 | [diff] [blame] | 57 | |
Brian Salomon | ccb6142 | 2020-01-09 10:46:36 -0500 | [diff] [blame] | 58 | constexpr WrapMode wrapModeY() const { return fWrapModes[1]; } |
Brian Salomon | 2bbdcc4 | 2017-09-07 12:36:34 -0400 | [diff] [blame] | 59 | |
Brian Salomon | ccb6142 | 2020-01-09 10:46:36 -0500 | [diff] [blame] | 60 | constexpr bool isRepeated() const { |
Brian Salomon | e69b9ef | 2020-07-22 11:18:06 -0400 | [diff] [blame] | 61 | return fWrapModes[0] == WrapMode::kRepeat || fWrapModes[0] == WrapMode::kMirrorRepeat || |
| 62 | fWrapModes[1] == WrapMode::kRepeat || fWrapModes[1] == WrapMode::kMirrorRepeat; |
Brian Salomon | 2bbdcc4 | 2017-09-07 12:36:34 -0400 | [diff] [blame] | 63 | } |
| 64 | |
Brian Salomon | e69b9ef | 2020-07-22 11:18:06 -0400 | [diff] [blame] | 65 | constexpr Filter filter() const { return fFilter; } |
| 66 | |
| 67 | constexpr MipmapMode mipmapMode() const { return fMipmapMode; } |
| 68 | |
| 69 | constexpr GrMipmapped mipmapped() const { |
| 70 | return GrMipmapped(fMipmapMode != MipmapMode::kNone); |
| 71 | } |
| 72 | |
| 73 | constexpr void setFilterMode(Filter filterMode) { fFilter = filterMode; } |
| 74 | |
| 75 | constexpr void setMipmapMode(MipmapMode mm) { fMipmapMode = mm; } |
| 76 | |
| 77 | constexpr void setWrapModeX(const WrapMode wrap) { fWrapModes[0] = wrap; } |
| 78 | |
| 79 | constexpr void setWrapModeY(const WrapMode wrap) { fWrapModes[1] = wrap; } |
| 80 | |
Brian Salomon | ccb6142 | 2020-01-09 10:46:36 -0500 | [diff] [blame] | 81 | constexpr bool operator==(GrSamplerState that) const { |
Brian Salomon | 2bbdcc4 | 2017-09-07 12:36:34 -0400 | [diff] [blame] | 82 | return fWrapModes[0] == that.fWrapModes[0] && fWrapModes[1] == that.fWrapModes[1] && |
Brian Salomon | e69b9ef | 2020-07-22 11:18:06 -0400 | [diff] [blame] | 83 | fFilter == that.fFilter && fMipmapMode == that.fMipmapMode; |
Brian Salomon | 2bbdcc4 | 2017-09-07 12:36:34 -0400 | [diff] [blame] | 84 | } |
| 85 | |
Brian Salomon | ccb6142 | 2020-01-09 10:46:36 -0500 | [diff] [blame] | 86 | constexpr bool operator!=(const GrSamplerState& that) const { return !(*this == that); } |
Brian Salomon | 2bbdcc4 | 2017-09-07 12:36:34 -0400 | [diff] [blame] | 87 | |
Brian Salomon | a7d9f30 | 2020-07-15 13:25:30 -0400 | [diff] [blame] | 88 | /** |
| 89 | * Turn the sampler state into an integer from a tightly packed range for use as an index |
| 90 | * (or key) |
| 91 | */ |
| 92 | constexpr uint8_t asIndex() const { |
| 93 | constexpr int kNumWraps = static_cast<int>(WrapMode::kLast) + 1; |
Brian Salomon | e69b9ef | 2020-07-22 11:18:06 -0400 | [diff] [blame] | 94 | constexpr int kNumFilters = static_cast<int>(Filter::kLast ) + 1; |
Brian Salomon | a7d9f30 | 2020-07-15 13:25:30 -0400 | [diff] [blame] | 95 | int result = static_cast<int>(fWrapModes[0])*1 |
| 96 | + static_cast<int>(fWrapModes[1])*kNumWraps |
Brian Salomon | e69b9ef | 2020-07-22 11:18:06 -0400 | [diff] [blame] | 97 | + static_cast<int>(fFilter) *kNumWraps*kNumWraps |
| 98 | + static_cast<int>(fMipmapMode) *kNumWraps*kNumWraps*kNumFilters; |
Brian Salomon | a7d9f30 | 2020-07-15 13:25:30 -0400 | [diff] [blame] | 99 | SkASSERT(result <= kNumUniqueSamplers); |
| 100 | return static_cast<uint8_t>(result); |
Robert Phillips | f22c57d | 2019-10-14 14:16:02 -0400 | [diff] [blame] | 101 | } |
| 102 | |
Brian Salomon | e69b9ef | 2020-07-22 11:18:06 -0400 | [diff] [blame] | 103 | static constexpr int kNumUniqueSamplers = (static_cast<int>(WrapMode::kLast ) + 1) |
| 104 | * (static_cast<int>(WrapMode::kLast ) + 1) |
| 105 | * (static_cast<int>(Filter::kLast ) + 1) |
| 106 | * (static_cast<int>(MipmapMode::kLast) + 1); |
Brian Salomon | 2bbdcc4 | 2017-09-07 12:36:34 -0400 | [diff] [blame] | 107 | private: |
Brian Salomon | ccb6142 | 2020-01-09 10:46:36 -0500 | [diff] [blame] | 108 | WrapMode fWrapModes[2] = {WrapMode::kClamp, WrapMode::kClamp}; |
| 109 | Filter fFilter = GrSamplerState::Filter::kNearest; |
Brian Salomon | e69b9ef | 2020-07-22 11:18:06 -0400 | [diff] [blame] | 110 | MipmapMode fMipmapMode = GrSamplerState::MipmapMode::kNone; |
Brian Salomon | 2bbdcc4 | 2017-09-07 12:36:34 -0400 | [diff] [blame] | 111 | }; |
| 112 | |
Brian Salomon | a7d9f30 | 2020-07-15 13:25:30 -0400 | [diff] [blame] | 113 | static_assert(GrSamplerState::kNumUniqueSamplers <= |
| 114 | std::numeric_limits<decltype(GrSamplerState{}.asIndex())>::max()); |
| 115 | |
Brian Salomon | 2bbdcc4 | 2017-09-07 12:36:34 -0400 | [diff] [blame] | 116 | #endif |