Harlinn::Windows::Graphics::InkStyle Class Reference

Represents a collection of style properties to be used by methods like ID2D1DeviceContext2::DrawInk when rendering ink. The ink style defines the nib (pen tip) shape and transform. More...

#include <HWGraphics.h>

Inheritance diagram for Harlinn::Windows::Graphics::InkStyle:

Collaboration diagram for Harlinn::Windows::Graphics::InkStyle:

Public Types
using	Base = Resource
Public Types inherited from Harlinn::Common::Core::Unknown
typedef IUnknown	InterfaceType

Public Member Functions
void	SetNibTransform (const D2D1_MATRIX_3X2_F *transform) const
	Sets the transform to apply to this style's nib shape.
void	SetNibTransform (const D2D1_MATRIX_3X2_F &transform) const
void	GetNibTransform (D2D1_MATRIX_3X2_F *transform) const
	Retrieves the transform to be applied to this style's nib shape.
void	GetNibTransform (D2D1_MATRIX_3X2_F &transform) const
void	SetNibShape (D2D1_INK_NIB_SHAPE nibShape) const
	Sets the pre-transform nib shape for this style.
D2D1_INK_NIB_SHAPE	GetNibShape () const
	Retrieves the pre-transform nib shape for this style.
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 a collection of style properties to be used by methods like ID2D1DeviceContext2::DrawInk when rendering ink. The ink style defines the nib (pen tip) shape and transform.

Member Typedef Documentation

Base

using Harlinn::Windows::Graphics::InkStyle::Base = Resource

Member Function Documentation

GetNibShape()

D2D1_INK_NIB_SHAPE Harlinn::Windows::Graphics::InkStyle::GetNibShape ( ) const

inline

Retrieves the pre-transform nib shape for this style.

Returns

Returns the pre-transform nib shape for this style.

GetNibTransform() [1/2]

void Harlinn::Windows::Graphics::InkStyle::GetNibTransform ( D2D1_MATRIX_3X2_F & transform ) const

inline

GetNibTransform() [2/2]

void Harlinn::Windows::Graphics::InkStyle::GetNibTransform ( D2D1_MATRIX_3X2_F * transform ) const

inline

Retrieves the transform to be applied to this style's nib shape.

Parameters

transform

When this method returns, contains a pointer to the transform to be applied to this style's nib shape.

SetNibShape()

void Harlinn::Windows::Graphics::InkStyle::SetNibShape ( D2D1_INK_NIB_SHAPE nibShape ) const

inline

Sets the pre-transform nib shape for this style.

Parameters

nibShape

The pre-transform nib shape to use in this style.

SetNibTransform() [1/2]

void Harlinn::Windows::Graphics::InkStyle::SetNibTransform ( const D2D1_MATRIX_3X2_F & transform ) const

inline

SetNibTransform() [2/2]

void Harlinn::Windows::Graphics::InkStyle::SetNibTransform ( const D2D1_MATRIX_3X2_F * transform ) const

inline

Sets the transform to apply to this style's nib shape.

Parameters

transform

The transform to apply to this style’s nib shape. Note that the translation components of the transform matrix are ignored for the purposes of rendering.

---

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

• HWGraphics.h