spark::render::ISampler Class Reference

Describes a texture sampler. More...

#include <Sampler.h>

Inheritance diagram for spark::render::ISampler:

Public Member Functions
virtual FilterMode	minifyingFilter () const noexcept=0
	Gets the filter mode for minifying lookups.
virtual FilterMode	magnifyingFilter () const noexcept=0
	Gets the filter mode for magnifying lookups.
virtual std::array< BorderMode, 3 >	borderMode () const noexcept=0
	Gets the addressing mode at the horizontal, vertical and depth borders.
virtual float	anisotropy () const noexcept=0
	Gets the anisotropy level used when sampling the texture.
virtual MipMapMode	mipMapMode () const noexcept=0
	Gets the mip-map selection mode.
virtual float	mipMapBias () const noexcept=0
	Gets the mip-map level of detail bias.
virtual float	minLod () const noexcept=0
	Gets the minimum texture level of detail.
virtual float	maxLod () const noexcept=0
	Gets the maximum texture level of detail.
Public Member Functions inherited from spark::render::IStateResource
virtual const std::string &	name () const noexcept=0
	Gets the name of the state resource.

Detailed Description

Describes a texture sampler.

Member Function Documentation

anisotropy()

virtual float spark::render::ISampler::anisotropy ( ) const

nodiscardpure virtualnoexcept

Gets the anisotropy level used when sampling the texture.

Returns

The anisotropy level used when sampling the texture.

Note

A value of 0.0f means that no anisotropic filtering is used.

Implemented in spark::render::vk::VulkanSampler.

borderMode()

virtual std::array< BorderMode, 3 > spark::render::ISampler::borderMode ( ) const

nodiscardpure virtualnoexcept

Gets the addressing mode at the horizontal, vertical and depth borders.

Returns

A std::array of BorderMode representing the addressing modes according to the border.

Note

The returned array is ordered as follows: [horizontal (U), vertical (V), depth (W)].

Implemented in spark::render::vk::VulkanSampler.

magnifyingFilter()

virtual FilterMode spark::render::ISampler::magnifyingFilter ( ) const

nodiscardpure virtualnoexcept

Gets the filter mode for magnifying lookups.

Returns

A FilterMode representing the filter mode for magnifying lookups.

Implemented in spark::render::vk::VulkanSampler.

maxLod()

virtual float spark::render::ISampler::maxLod ( ) const

nodiscardpure virtualnoexcept

Gets the maximum texture level of detail.

Returns

The maximum texture level of detail.

Implemented in spark::render::vk::VulkanSampler.

minifyingFilter()

virtual FilterMode spark::render::ISampler::minifyingFilter ( ) const

nodiscardpure virtualnoexcept

Gets the filter mode for minifying lookups.

Returns

A FilterMode representing the filter mode for minifying lookups.

Implemented in spark::render::vk::VulkanSampler.

minLod()

virtual float spark::render::ISampler::minLod ( ) const

nodiscardpure virtualnoexcept

Gets the minimum texture level of detail.

Returns

The minimum texture level of detail.

Implemented in spark::render::vk::VulkanSampler.

mipMapBias()

virtual float spark::render::ISampler::mipMapBias ( ) const

nodiscardpure virtualnoexcept

Gets the mip-map level of detail bias.

Returns

The mip-map level of detail bias.

Implemented in spark::render::vk::VulkanSampler.

mipMapMode()

virtual MipMapMode spark::render::ISampler::mipMapMode ( ) const

nodiscardpure virtualnoexcept

Gets the mip-map selection mode.

Returns

A MipMapMode representing the mip-map selection mode.

Implemented in spark::render::vk::VulkanSampler.