Divide Framework 0.1
A free and open-source 3D Framework under heavy development
Loading...
Searching...
No Matches
Divide::SamplerDescriptor Struct Reference

#include <SamplerDescriptor.h>

Public Member Functions

bool operator== (const SamplerDescriptor &rhs) const =default
 

Public Attributes

UColour4 _customBorderColour { DefaultColours::BLACK_U8 }
 Used with custom border colours.
 
SamplerLOD _lod {}
 
TextureFilter _minFilter { TextureFilter::LINEAR }
 Texture filtering mode.
 
TextureFilter _magFilter { TextureFilter::LINEAR }
 
TextureMipSampling _mipSampling { TextureMipSampling::LINEAR }
 
TextureWrap _wrapU { TextureWrap::REPEAT }
 Texture wrap mode (Or S-R-T)
 
TextureWrap _wrapV { TextureWrap::REPEAT }
 
TextureWrap _wrapW { TextureWrap::REPEAT }
 
U8 _anisotropyLevel { 255 }
 The value must be in the range [0...255] and is automatically clamped by the max HW supported level.
 
TextureBorderColour _borderColour { TextureBorderColour::TRANSPARENT_BLACK_INT }
 Used with CLAMP_TO_BORDER as the background colour outside of the texture border.
 
ComparisonFunction _depthCompareFunc { ComparisonFunction::COUNT }
 Used for depth comparison (COUNT = disabled)
 

Static Public Attributes

static constexpr size_t INVALID_SAMPLER_HASH = std::numeric_limits<size_t>::max()
 

Detailed Description

This struct is used to define all of the sampler settings needed to use a texture We do not define copy constructors as we must define descriptors only with POD

Definition at line 53 of file SamplerDescriptor.h.

Member Function Documentation

◆ operator==()

bool Divide::SamplerDescriptor::operator== ( const SamplerDescriptor rhs) const
default

Member Data Documentation

◆ _anisotropyLevel

U8 Divide::SamplerDescriptor::_anisotropyLevel { 255 }

The value must be in the range [0...255] and is automatically clamped by the max HW supported level.

Definition at line 69 of file SamplerDescriptor.h.

◆ _borderColour

TextureBorderColour Divide::SamplerDescriptor::_borderColour { TextureBorderColour::TRANSPARENT_BLACK_INT }

Used with CLAMP_TO_BORDER as the background colour outside of the texture border.

Definition at line 71 of file SamplerDescriptor.h.

◆ _customBorderColour

UColour4 Divide::SamplerDescriptor::_customBorderColour { DefaultColours::BLACK_U8 }

Used with custom border colours.

Definition at line 58 of file SamplerDescriptor.h.

◆ _depthCompareFunc

ComparisonFunction Divide::SamplerDescriptor::_depthCompareFunc { ComparisonFunction::COUNT }

Used for depth comparison (COUNT = disabled)

Definition at line 73 of file SamplerDescriptor.h.

◆ _lod

SamplerLOD Divide::SamplerDescriptor::_lod {}

Definition at line 59 of file SamplerDescriptor.h.

◆ _magFilter

TextureFilter Divide::SamplerDescriptor::_magFilter { TextureFilter::LINEAR }

Definition at line 62 of file SamplerDescriptor.h.

◆ _minFilter

TextureFilter Divide::SamplerDescriptor::_minFilter { TextureFilter::LINEAR }

Texture filtering mode.

Definition at line 61 of file SamplerDescriptor.h.

◆ _mipSampling

TextureMipSampling Divide::SamplerDescriptor::_mipSampling { TextureMipSampling::LINEAR }

Definition at line 63 of file SamplerDescriptor.h.

◆ _wrapU

TextureWrap Divide::SamplerDescriptor::_wrapU { TextureWrap::REPEAT }

Texture wrap mode (Or S-R-T)

Definition at line 65 of file SamplerDescriptor.h.

◆ _wrapV

TextureWrap Divide::SamplerDescriptor::_wrapV { TextureWrap::REPEAT }

Definition at line 66 of file SamplerDescriptor.h.

◆ _wrapW

TextureWrap Divide::SamplerDescriptor::_wrapW { TextureWrap::REPEAT }

Definition at line 67 of file SamplerDescriptor.h.

◆ INVALID_SAMPLER_HASH

constexpr size_t Divide::SamplerDescriptor::INVALID_SAMPLER_HASH = std::numeric_limits<size_t>::max()
staticconstexpr

Definition at line 55 of file SamplerDescriptor.h.


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