LiteFX::Rendering::ISampler Class Reference

Describes a texture sampler. More...

#include <rendering_api.hpp>

Inherits LiteFX::Rendering::IStateResource.

Inherited by LiteFX::Rendering::Backends::IDirectX12Sampler [virtual], and LiteFX::Rendering::Backends::IVulkanSampler [virtual].

Public Member Functions
virtual	~ISampler () noexcept=default
virtual const FilterMode &	getMinifyingFilter () const noexcept=0
	Gets the filtering mode that is used for minifying lookups. More...
virtual const FilterMode &	getMagnifyingFilter () const noexcept=0
	Gets the filtering mode that is used for magnifying lookups. More...
virtual const BorderMode &	getBorderModeU () const noexcept=0
	Gets the addressing mode at the horizontal border. More...
virtual const BorderMode &	getBorderModeV () const noexcept=0
	Gets the addressing mode at the vertical border. More...
virtual const BorderMode &	getBorderModeW () const noexcept=0
	Gets the addressing mode at the depth border. More...
virtual const Float &	getAnisotropy () const noexcept=0
	Gets the anisotropy value used when sampling this texture. More...
virtual const MipMapMode &	getMipMapMode () const noexcept=0
	Gets the mip-map selection mode. More...
virtual const Float &	getMipMapBias () const noexcept=0
	Gets the mip-map level of detail bias. More...
virtual const Float &	getMaxLOD () const noexcept=0
	Gets the maximum texture level of detail. More...
virtual const Float &	getMinLOD () const noexcept=0
	Gets the minimum texture level of detail. More...
Public Member Functions inherited from LiteFX::Rendering::IStateResource
virtual	~IStateResource () noexcept=default
virtual const String &	name () const noexcept=0
	Returns the name of the resource. More...

Detailed Description

Describes a texture sampler.

Constructor & Destructor Documentation

~ISampler()

virtual LiteFX::Rendering::ISampler::~ISampler ( )

virtualdefaultnoexcept

Member Function Documentation

getAnisotropy()

virtual const Float & LiteFX::Rendering::ISampler::getAnisotropy ( ) const

pure virtualnoexcept

Gets the anisotropy value used when sampling this texture.

Anisotropy will be disabled, if this value is set to 0.0.

Returns

The anisotropy value used when sampling this texture.

Implemented in LiteFX::Rendering::Backends::DirectX12Sampler, and LiteFX::Rendering::Backends::VulkanSampler.

getBorderModeU()

virtual const BorderMode & LiteFX::Rendering::ISampler::getBorderModeU ( ) const

pure virtualnoexcept

Gets the addressing mode at the horizontal border.

Returns

The addressing mode at the horizontal border.

Implemented in LiteFX::Rendering::Backends::DirectX12Sampler, and LiteFX::Rendering::Backends::VulkanSampler.

getBorderModeV()

virtual const BorderMode & LiteFX::Rendering::ISampler::getBorderModeV ( ) const

pure virtualnoexcept

Gets the addressing mode at the vertical border.

Returns

The addressing mode at the vertical border.

Implemented in LiteFX::Rendering::Backends::DirectX12Sampler, and LiteFX::Rendering::Backends::VulkanSampler.

getBorderModeW()

virtual const BorderMode & LiteFX::Rendering::ISampler::getBorderModeW ( ) const

pure virtualnoexcept

Gets the addressing mode at the depth border.

Returns

The addressing mode at the depth border.

Implemented in LiteFX::Rendering::Backends::DirectX12Sampler, and LiteFX::Rendering::Backends::VulkanSampler.

getMagnifyingFilter()

virtual const FilterMode & LiteFX::Rendering::ISampler::getMagnifyingFilter ( ) const

pure virtualnoexcept

Gets the filtering mode that is used for magnifying lookups.

Returns

The filtering mode that is used for magnifying lookups.

Implemented in LiteFX::Rendering::Backends::DirectX12Sampler, and LiteFX::Rendering::Backends::VulkanSampler.

getMaxLOD()

virtual const Float & LiteFX::Rendering::ISampler::getMaxLOD ( ) const

pure virtualnoexcept

Gets the maximum texture level of detail.

Returns

The maximum texture level of detail.

Implemented in LiteFX::Rendering::Backends::DirectX12Sampler, and LiteFX::Rendering::Backends::VulkanSampler.

getMinifyingFilter()

virtual const FilterMode & LiteFX::Rendering::ISampler::getMinifyingFilter ( ) const

pure virtualnoexcept

Gets the filtering mode that is used for minifying lookups.

Returns

The filtering mode that is used for minifying lookups.

Implemented in LiteFX::Rendering::Backends::DirectX12Sampler, and LiteFX::Rendering::Backends::VulkanSampler.

getMinLOD()

virtual const Float & LiteFX::Rendering::ISampler::getMinLOD ( ) const

pure virtualnoexcept

Gets the minimum texture level of detail.

Returns

The minimum texture level of detail.

Implemented in LiteFX::Rendering::Backends::DirectX12Sampler, and LiteFX::Rendering::Backends::VulkanSampler.

getMipMapBias()

virtual const Float & LiteFX::Rendering::ISampler::getMipMapBias ( ) const

pure virtualnoexcept

Gets the mip-map level of detail bias.

Returns

The mip-map level of detail bias.

Implemented in LiteFX::Rendering::Backends::DirectX12Sampler, and LiteFX::Rendering::Backends::VulkanSampler.

getMipMapMode()

virtual const MipMapMode & LiteFX::Rendering::ISampler::getMipMapMode ( ) const

pure virtualnoexcept

Gets the mip-map selection mode.

Returns

The mip-map selection mode.

Implemented in LiteFX::Rendering::Backends::DirectX12Sampler, and LiteFX::Rendering::Backends::VulkanSampler.