Concurrency::graphics::sampler Class Reference

A sampler class aggregates sampling configuration information to be used for texture sampling. More...

#include <amp_graphics.h>

Public Member Functions
	sampler () __CPU_ONLY
	Constructs a sampler with default filter mode (filter_lienar, same for min, mag, mip), addressing mode (address_clamp, same for all dimensions), and border color (float_4(0.0f, 0.0f, 0.0f, 0.0f)). More...
	sampler (filter_mode _Filter_mode) __CPU_ONLY
	Constructs a sampler with specified filter mode (same for min, mag, mip), but with default addressing mode (address_clamp, same for all dimensions) and border color ( float_4(0.0f, 0.0f, 0.0f, 0.0f)). More...
	sampler (address_mode _Address_mode, float_4 _Border_color=float_4(0.0f, 0.0f, 0.0f, 0.0f)) __CPU_ONLY
	Constructs a sampler with default filter mode (filter_linear, same for min, mag, mip), but specified addressing mode (same for all dimensions) and border color. More...
	sampler (filter_mode _Filter_mode, address_mode _Address_mode, float_4 _Border_color=float_4(0.0f, 0.0f, 0.0f, 0.0f)) __CPU_ONLY
	Constructs a sampler with specified filter mode (same for min, mag, mip), addressing mode (same for all dimensions) and the border color. More...
	sampler (const sampler &_Other) __GPU
	Copy constructor. More...
	sampler (sampler &&_Other) __GPU
	Move constructor. More...
sampler &	operator= (const sampler &_Other) __GPU
	Assignment operator. More...
sampler &	operator= (sampler &&_Other) __GPU
	Move assignment operator. More...
__declspec(property(get=get_filter_mode)) Concurrency Concurrency::graphics::filter_mode	get_filter_mode () const __GPU
	Returns the sampler's filter mode More...
__declspec(property(get=get_address_mode)) Concurrency Concurrency::graphics::address_mode	get_address_mode () const __GPU
	Returns the sampler's address mode More...
__declspec(property(get=get_border_color)) Concurrency Concurrency::graphics::float_4	get_border_color () const __GPU
	Returns the sampler's border value More...

Private Types
typedef Concurrency::details::_Sampler_descriptor	_Sampler_descriptor

Private Member Functions
	sampler (const _Sampler_descriptor &_Descriptor) __CPU_ONLY
_Ret_ _Sampler *	_Get_sampler_ptr () const __CPU_ONLY
void	_Initialize () __CPU_ONLY
const _Sampler_descriptor &	_Get_descriptor () const __GPU_ONLY

Private Attributes
_Sampler_descriptor	_M_sampler_descriptor
Concurrency::graphics::filter_mode	_M_filter_mode
Concurrency::graphics::address_mode	_M_address_mode
float_4	_M_border_color

Friends
template<typename _Value_type , int _Rank>
class	texture_view
sampler	direct3d::make_sampler (_In_ IUnknown *_D3D_sampler) __CPU_ONLY
_Ret_ IUnknown *	direct3d::get_sampler (const Concurrency::accelerator_view &_Av, const sampler &_Sampler) __CPU_ONLY

Detailed Description

A sampler class aggregates sampling configuration information to be used for texture sampling.

Member Typedef Documentation

typedef Concurrency::details::_Sampler_descriptor Concurrency::graphics::sampler::_Sampler_descriptor

private

Constructor & Destructor Documentation

Concurrency::graphics::sampler::sampler ( )

inline

Constructs a sampler with default filter mode (filter_lienar, same for min, mag, mip), addressing mode (address_clamp, same for all dimensions), and border color (float_4(0.0f, 0.0f, 0.0f, 0.0f)).

        : _M_filter_mode(filter_linear),
          _M_address_mode(address_clamp),
          _M_border_color(float_4(0.0f, 0.0f, 0.0f, 0.0f))
    {
        _Initialize();
    }

Concurrency::graphics::sampler::sampler ( filter_mode  _Filter_mode )

inline

Constructs a sampler with specified filter mode (same for min, mag, mip), but with default addressing mode (address_clamp, same for all dimensions) and border color ( float_4(0.0f, 0.0f, 0.0f, 0.0f)).

Parameters

_Filter_mode

The filter mode to be used in sampling.

        : _M_filter_mode(_Filter_mode),
          _M_address_mode(address_clamp),
          _M_border_color(float_4(0.0f, 0.0f, 0.0f, 0.0f))
    {
        _Initialize();
    }

Concurrency::graphics::sampler::sampler ( address_mode  _Address_mode, float_4  _Border_color = float_4(0.0f, 0.0f, 0.0f, 0.0f)  )

inline

Constructs a sampler with default filter mode (filter_linear, same for min, mag, mip), but specified addressing mode (same for all dimensions) and border color.

Parameters

_Address_mode	The addressing mode to be used in sampling for all dimensions.
_Border_color	The border color to be used if address mode is address_border. If not specified, default value is float_4(0.f, 0.f, 0.f, 0.f).

        : _M_filter_mode(filter_linear),
          _M_address_mode(_Address_mode),
          _M_border_color(_Border_color)
    {
        _Initialize();
    }

Concurrency::graphics::sampler::sampler ( filter_mode  _Filter_mode, address_mode  _Address_mode, float_4  _Border_color = float_4(0.0f, 0.0f, 0.0f, 0.0f)  )

inline

Constructs a sampler with specified filter mode (same for min, mag, mip), addressing mode (same for all dimensions) and the border color.

Parameters

_Filter_mode	The filter mode to be used in sampling.
_Address_mode	The addressing mode to be used in sampling for all dimensions.
_Border_color	The border color to be used if address mode is address_border. If not specified, default value is float_4(0.f, 0.f, 0.f, 0.f).

        : _M_filter_mode(_Filter_mode),
          _M_address_mode(_Address_mode),
          _M_border_color(_Border_color)
    {
        _Initialize();
    }

Concurrency::graphics::sampler::sampler ( const sampler &  _Other )

inline

Copy constructor.

Parameters

_Other

An object of type sampler from which to initialize this new sampler.

        : _M_filter_mode(_Other._M_filter_mode),
          _M_address_mode(_Other._M_address_mode),
          _M_border_color(_Other._M_border_color),
          _M_sampler_descriptor(_Other._M_sampler_descriptor)
    {
    }

Concurrency::graphics::sampler::sampler ( sampler &&  _Other )

inline

Move constructor.

Parameters

_Other

The sampler to move from.

        : _M_filter_mode(_Other._M_filter_mode),
          _M_address_mode(_Other._M_address_mode),
          _M_border_color(_Other._M_border_color),
          _M_sampler_descriptor(_Other._M_sampler_descriptor)
    {
        _Other._M_sampler_descriptor._M_data_ptr = NULL;
        _Other._M_sampler_descriptor._Set_sampler_ptr(NULL);
    }

Concurrency::graphics::sampler::sampler ( const _Sampler_descriptor &  _Descriptor )

inlineprivate

        : _M_sampler_descriptor(_Descriptor),
         _M_filter_mode(filter_unknown),
         _M_address_mode (address_unknown),
         _M_border_color(float_4(0.0f, 0.0f, 0.0f, 0.0f))
    {
        // Although we could query border value from the adopted sampler, but it's not that useful
        // given that this is the only thing that we could query and when the address mode is not
        // address_border, border value is not relevant.
    }

Member Function Documentation

const _Sampler_descriptor& Concurrency::graphics::sampler::_Get_descriptor ( ) const

inlineprivate

    {
        return _M_sampler_descriptor;
    }

_Ret_ _Sampler* Concurrency::graphics::sampler::_Get_sampler_ptr ( ) const

inlineprivate

    {
        return _M_sampler_descriptor._Get_sampler_ptr();
    }

void Concurrency::graphics::sampler::_Initialize ( )

inlineprivate

    {
        // Check if the given filter_mode and address_mode are valid C++ AMP ones
        if ((_M_filter_mode != filter_point && _M_filter_mode != filter_linear) ||
           (_M_address_mode != address_wrap && _M_address_mode != address_mirror &&
            _M_address_mode != address_clamp && _M_address_mode != address_border))
        {
            throw runtime_exception("Invalid sampler configuration", E_INVALIDARG);
        }

        _Sampler_ptr samplerPtr = _Sampler::_Create(_M_filter_mode, _M_address_mode,
                            _M_border_color.r, _M_border_color.g, _M_border_color.b, _M_border_color.a);
        _M_sampler_descriptor._Set_sampler_ptr(samplerPtr);
    }

__declspec (property(get=get_address_mode)) Concurrency Concurrency::graphics::address_mode Concurrency::graphics::sampler::get_address_mode ( ) const

inline

Returns the sampler's address mode

    {
        return _M_address_mode;
    }

__declspec (property(get=get_border_color)) Concurrency Concurrency::graphics::float_4 Concurrency::graphics::sampler::get_border_color ( ) const

inline

Returns the sampler's border value

    {
        return _M_border_color;
    }

__declspec (property(get=get_filter_mode)) Concurrency Concurrency::graphics::filter_mode Concurrency::graphics::sampler::get_filter_mode ( ) const

inline

Returns the sampler's filter mode

    {
        return _M_filter_mode;
    }

sampler& Concurrency::graphics::sampler::operator= ( const sampler &  _Other )

inline

Assignment operator.

Parameters

_Other

An object of type sampler from which to copy into this sampler.

Returns

A reference to this sampler.

    {
        if (this != &_Other)
        {
            _M_filter_mode = _Other._M_filter_mode;
            _M_address_mode = _Other._M_address_mode;
            _M_border_color = _Other._M_border_color;
            _M_sampler_descriptor = _Other._M_sampler_descriptor;
        }
        return *this;
    }

sampler& Concurrency::graphics::sampler::operator= ( sampler &&  _Other )

inline

Move assignment operator.

Parameters

_Other

An object of type sampler to move from.

Returns

A reference to this sampler.

    {
        if (this != &_Other)
        {
            _M_filter_mode = _Other._M_filter_mode;
            _M_address_mode = _Other._M_address_mode;
            _M_border_color = _Other._M_border_color;
            _M_sampler_descriptor = _Other._M_sampler_descriptor;
            _Other._M_sampler_descriptor._M_data_ptr = NULL;
            _Other._M_sampler_descriptor._Set_sampler_ptr(NULL);
        }
        return *this;
    }

Friends And Related Function Documentation

_Ret_ IUnknown* direct3d::get_sampler ( const Concurrency::accelerator_view &  _Av, const sampler &  _Sampler  )

friend

sampler direct3d::make_sampler ( _In_ IUnknown *  _D3D_sampler )

friend

template<typename _Value_type , int _Rank>

friend class texture_view

friend

Member Data Documentation

Concurrency::graphics::address_mode Concurrency::graphics::sampler::_M_address_mode

private

float_4 Concurrency::graphics::sampler::_M_border_color

private

Concurrency::graphics::filter_mode Concurrency::graphics::sampler::_M_filter_mode

private

_Sampler_descriptor Concurrency::graphics::sampler::_M_sampler_descriptor

private

---

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

• VS2017/inc/amp_graphics.h