Represents the drawing state of a render target: the anti-aliasing mode, transform, tags, and text-rendering options. More...

#include <HWGraphics.h>

Inheritance diagram for Harlinn::Windows::Graphics::DrawingStateBlock:

[legend]

Collaboration diagram for Harlinn::Windows::Graphics::DrawingStateBlock:

[legend]

Public Types
typedef Resource	Base

Public Types inherited from Harlinn::Common::Core::Unknown
typedef IUnknown	InterfaceType

Public Member Functions
void	GetDescription (D2D1_DRAWING_STATE_DESCRIPTION *stateDescription) const
	Retrieves the anti-aliasing mode, transform, and tags portion of the drawing state.

void	SetDescription (const D2D1_DRAWING_STATE_DESCRIPTION *stateDescription) const
	Specifies the anti-aliasing mode, transform, and tags portion of the drawing state.

void	SetDescription (const D2D1_DRAWING_STATE_DESCRIPTION &stateDescription) const

void	SetTextRenderingParams (IDWriteRenderingParams *textRenderingParams=nullptr) const
	Specifies the text-rendering configuration of the drawing state.

void	SetTextRenderingParams (const DirectWrite::RenderingParams &textRenderingParams) const

void	GetTextRenderingParams (IDWriteRenderingParams **textRenderingParams) const
	Retrieves the text-rendering configuration of the drawing state.

DirectWrite::RenderingParams	GetTextRenderingParams () const

Public Member Functions inherited from Harlinn::Windows::Graphics::Resource
template<typename T = Factory> requires std::is_base_of_v< Factory, T>
T	GetFactory ()

Public Member Functions inherited from Harlinn::Common::Core::Unknown
constexpr	Unknown () noexcept

	Unknown (IUnknown *unknown, bool addref=false) noexcept

	Unknown (REFIID iid, const Unknown &unknown, bool throwIfNoInterface=true)

	Unknown (const Unknown &other) noexcept

	Unknown (Unknown &&other) noexcept

	~Unknown () noexcept

constexpr	operator bool () const noexcept

Unknown &	operator= (const Unknown &other) noexcept

Unknown &	operator= (Unknown &&other) noexcept

void	swap (Unknown &other) noexcept

void	ResetPtr (IUnknown *other=nullptr, bool addRef=false) noexcept

Unknown &	operator= (nullptr_t)

IUnknown *	Detach ()

template<typename T > requires std::is_base_of_v<Unknown, T >
T	As () const

template<typename T > requires std::is_base_of_v<Unknown, T>
bool	Is () const noexcept

template<typename T > requires std::is_base_of_v<IUnknown, T>
ComPtr< T >	As () const

template<typename T > requires std::is_base_of_v<IUnknown, T>
bool	Is () const noexcept
	This function can be used to detect if an object supports a particular COM interface derived from IUnknown.

template<typename T = IUnknown>
T *	GetInterfacePointer () const noexcept

bool	QueryInterface (REFIID riid, void **itf) const
	Queries a COM object for a pointer to one of its interface; identifying the interface by a reference to its interface identifier (IID). If the COM object implements the interface, then it returns a pointer to that interface after calling IUnknown::AddRef on it.

template<typename T > requires std::is_base_of_v<IUnknown, T>
bool	QueryInterface (T **itf) const

constexpr bool	operator== (const Unknown &other) const noexcept

constexpr bool	operator!= (const Unknown &other) const noexcept

constexpr bool	operator== (const IUnknown *other) const noexcept

constexpr bool	operator!= (const IUnknown *other) const noexcept

Additional Inherited Members
Static Public Member Functions inherited from Harlinn::Common::Core::Unknown
template<typename T > requires std::is_base_of_v<Unknown, T>
static T	CoCreateInstanceFromClassId (const CLSID &clsid, DWORD classContext=CLSCTX_INPROC_SERVER)

template<typename T > requires std::is_base_of_v<Unknown, T>
static T	CoCreateInstanceFromClassId (const wchar_t *clsid, DWORD classContext=CLSCTX_INPROC_SERVER)

template<typename T > requires std::is_base_of_v<Unknown, T>
static T	CoCreateInstanceFromClassId (const WideString &clsid, DWORD classContext=CLSCTX_INPROC_SERVER)

template<typename T > requires std::is_base_of_v<Unknown, T>
static T	CoCreateInstanceFromProgId (const wchar_t *progId, DWORD classContext=CLSCTX_INPROC_SERVER)

template<typename T > requires std::is_base_of_v<Unknown, T>
static T	CoCreateInstanceFromProgId (const WideString &progId, DWORD classContext=CLSCTX_INPROC_SERVER)

template<typename T > requires std::is_base_of_v<Unknown, T>
static T	CoCreateInstanceFromDll (const ModuleHandle &dll, const CLSID &clsid)

Protected Attributes inherited from Harlinn::Common::Core::Unknown
IUnknown *	unknown_

Detailed Description

Represents the drawing state of a render target: the anti-aliasing mode, transform, tags, and text-rendering options.

Member Typedef Documentation

◆ Base

Resource Harlinn::Windows::Graphics::DrawingStateBlock::Base

Member Function Documentation

◆ GetDescription()

void Harlinn::Windows::Graphics::DrawingStateBlock::GetDescription ( D2D1_DRAWING_STATE_DESCRIPTION * stateDescription ) const

inline

Retrieves the anti-aliasing mode, transform, and tags portion of the drawing state.

Parameters

stateDescription When this method returns, contains the anti-aliasing mode, transform, and tags portion of the drawing state. You must allocate storage for this parameter.

◆ GetTextRenderingParams() [1/2]

DirectWrite::RenderingParams Harlinn::Windows::Graphics::DrawingStateBlock::GetTextRenderingParams ( ) const

inline

◆ GetTextRenderingParams() [2/2]

void Harlinn::Windows::Graphics::DrawingStateBlock::GetTextRenderingParams ( IDWriteRenderingParams ** textRenderingParams ) const

inline

Retrieves the text-rendering configuration of the drawing state.

Parameters

textRenderingParams When this method returns, contains the address of a pointer to an IDWriteRenderingParams object that describes the text-rendering configuration of the drawing state.

◆ SetDescription() [1/2]

void Harlinn::Windows::Graphics::DrawingStateBlock::SetDescription ( const D2D1_DRAWING_STATE_DESCRIPTION & stateDescription ) const

inline

◆ SetDescription() [2/2]

void Harlinn::Windows::Graphics::DrawingStateBlock::SetDescription ( const D2D1_DRAWING_STATE_DESCRIPTION * stateDescription ) const

inline

Specifies the anti-aliasing mode, transform, and tags portion of the drawing state.

Parameters

stateDescription The anti-aliasing mode, transform, and tags portion of the drawing state.

◆ SetTextRenderingParams() [1/2]

void Harlinn::Windows::Graphics::DrawingStateBlock::SetTextRenderingParams ( const DirectWrite::RenderingParams & textRenderingParams ) const

inline

◆ SetTextRenderingParams() [2/2]

void Harlinn::Windows::Graphics::DrawingStateBlock::SetTextRenderingParams ( IDWriteRenderingParams * textRenderingParams = nullptr ) const

inline

Specifies the text-rendering configuration of the drawing state.

Parameters

textRenderingParams The text-rendering configuration of the drawing state, or nullptr to use default settings.

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

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

Member Function Documentation

◆ GetDescription()

◆ GetTextRenderingParams() [1/2]

◆ GetTextRenderingParams() [2/2]

◆ SetDescription() [1/2]

◆ SetDescription() [2/2]

◆ SetTextRenderingParams() [1/2]

◆ SetTextRenderingParams() [2/2]