mage::rendering::DisplayConfigurator Class Reference

#include <display_configurator.hpp>

Classes
class	Impl

Public Member Functions
	DisplayConfigurator (DXGI_FORMAT pixel_format=DXGI_FORMAT_R8G8B8A8_UNORM)
	DisplayConfigurator (ComPtr< DXGIAdapter > adapter, ComPtr< DXGIOutput > output, DXGI_FORMAT pixel_format=DXGI_FORMAT_R8G8B8A8_UNORM)
	DisplayConfigurator (const DisplayConfigurator &configurator)=delete
	DisplayConfigurator (DisplayConfigurator &&configurator) noexcept
	~DisplayConfigurator ()
DisplayConfigurator &	operator= (const DisplayConfigurator &configurator)=delete
DisplayConfigurator &	operator= (DisplayConfigurator &&configurator)=delete
HRESULT	Configure () const
const DisplayConfiguration *	GetDisplayConfiguration () const noexcept

Private Attributes
UniquePtr< Impl >	m_impl

Detailed Description

A class of display configurators.

Constructor & Destructor Documentation

DisplayConfigurator() [1/4]

mage::rendering::DisplayConfigurator::DisplayConfigurator ( DXGI_FORMAT  pixel_format = DXGI_FORMAT_R8G8B8A8_UNORM )

explicit

Constructs a display configurator.

Parameters

[in]

pixel_format

The pixel format.

DisplayConfigurator() [2/4]

mage::rendering::DisplayConfigurator::DisplayConfigurator ( ComPtr< DXGIAdapter >  adapter, ComPtr< DXGIOutput >  output, DXGI_FORMAT  pixel_format = DXGI_FORMAT_R8G8B8A8_UNORM  )

explicit

Constructs a display configurator.

Parameters

[in]	adapter	A pointer to the adapter.
[in]	output	A pointer to the output.
[in]	pixel_format	The pixel format.

DisplayConfigurator() [3/4]

mage::rendering::DisplayConfigurator::DisplayConfigurator ( const DisplayConfigurator &  configurator )

delete

Constructs a display configurator from the given display configurator.

Parameters

[in]

configurator

A reference to a display configurator to copy.

DisplayConfigurator() [4/4]

mage::rendering::DisplayConfigurator::DisplayConfigurator ( DisplayConfigurator &&  configurator )

defaultnoexcept

Constructs a display configurator by moving the given display configurator.

Parameters

[in]

configurator

A reference to a display configurator to move.

~DisplayConfigurator()

mage::rendering::DisplayConfigurator::~DisplayConfigurator ( )

default

Destructs this display configurator.

Member Function Documentation

Configure()

HRESULT mage::rendering::DisplayConfigurator::Configure

(

)

const

Configurs the display by enumerating the available display modes and options associated with the adapter output of the physical adapter with the most dedicated video memory.

Returns

A success/error value.

GetDisplayConfiguration()

const DisplayConfiguration * mage::rendering::DisplayConfigurator::GetDisplayConfiguration ( ) const

noexcept

Returns the display configuration of this display configurator.

Returns

A pointer to the display configuration of this display configurator.

operator=() [1/2]

DisplayConfigurator& mage::rendering::DisplayConfigurator::operator= ( const DisplayConfigurator &  configurator )

delete

Copies the given display configurator to this display configurator.

Parameters

[in]

configurator

A reference to a display configurator to copy.

Returns

A reference to the copy of the given display configurator (i.e. this display configurator).

operator=() [2/2]

DisplayConfigurator& mage::rendering::DisplayConfigurator::operator= ( DisplayConfigurator &&  configurator )

delete

Moves the given display configurator to this display configurator.

Parameters

[in]

configurator

A reference to a display configurator to move.

Returns

A reference to the moved display configurator (i.e. this display configurator).

Member Data Documentation

m_impl

UniquePtr< Impl > mage::rendering::DisplayConfigurator::m_impl

private

A pointer to the implementation of this display configurator.