Sampler
The Sampler class manages texture sampling parameters such as filter types, anisotropy, wrapping modes, level of detail (LOD), and border colors for texture mapping. It provides methods for setting and retrieving various sampling properties, including different filtering and wrapping strategies, anisotropic filtering, comparison functions, and reduction modes. The class also offers functionality to clear or create a sampler and check its creation status, which is essential for controlling the behavior of textures in rendering pipelines across different platforms and devices.
#include <platform/TellusimSampler.h>
Constructors
Sampler()
Methods
Sampler platform.
Platform getPlatform() const
const char *getPlatformName() const
Sampler device index.
uint32_t getIndex() const
Clear sampler.
void clear()
Check sampler.
bool isCreated() const
Create sampler.
bool create()
Sampler parameters.
void setParameters(const Sampler &sampler)
Filter type.
void setFilter(Filter filter)
Filter getFilter() const
bool isPointFilter() const
Anisotropy level.
void setAnisotropy(uint32_t anisotropy)
uint32_t getAnisotropy() const
bool hasAnisotropy() const
Wrapping mode.
void setWrapMode(WrapMode mode)
void setWrapMode(WrapMode mode_s, WrapMode mode_t, WrapMode mode_r)
void setWrapModeS(WrapMode mode)
WrapMode getWrapModeS() const
void setWrapModeT(WrapMode mode)
WrapMode getWrapModeT() const
void setWrapModeR(WrapMode mode)
WrapMode getWrapModeR() const
Level of detail.
void setLod(float32_t min, float32_t max, float32_t bias)
void setLodMin(float32_t min)
float32_t getLodMin() const
void setLodMax(float32_t max)
float32_t getLodMax() const
void setLodBias(float32_t bias)
float32_t getLodBias() const
Border color.
void setBorderColor(Color color)
void setBorderColor(float32_t r, float32_t g, float32_t b, float32_t a)
const Color getBorderColor() const
Compare func.
void setCompareFunc(CompareFunc func)
CompareFunc getCompareFunc() const
Reduction mode.
void setReductionMode(ReductionMode mode)
ReductionMode getReductionMode() const
Enums
Filter
Filter types.
| Name | Value |
|---|---|
| FilterPoint | 0 |
| FilterLinear | 1 |
| FilterBipoint | 2 |
| FilterBilinear | 3 |
| FilterTrilinear | 4 |
| NumFilters | 5 |
Anisotropy range.
| Name | Value |
|---|---|
| MinAnisotropy | 1 |
| MaxAnisotropy | 16 |
WrapMode
Wrap modes.
| Name | Value |
|---|---|
| WrapModeClamp | 0 |
| WrapModeRepeat | 1 |
| WrapModeMirror | 2 |
| WrapModeBorder | 3 |
| NumWrapModes | 4 |
CompareFunc
Compare functions.
| Name | Value |
|---|---|
| CompareFuncNone | 0 |
| CompareFuncEqual | 1 |
| CompareFuncLess | 2 |
| CompareFuncGreater | 3 |
| CompareFuncNotEqual | 4 |
| CompareFuncLessEqual | 5 |
| CompareFuncGreaterEqual | 6 |
| NumCompareFunctions | 7 |
ReductionMode
Reduction modes.
| Name | Value |
|---|---|
| ReductionModeAverage | 0 |
| ReductionModeMin | 1 |
| ReductionModeMax | 2 |
| NumReductionModes | 3 |