Harlinn.Windows 0.1
Loading...
Searching...
No Matches
Harlinn::Windows::Graphics::SvgGlyphStyle Class Reference

This object supplies the values for context-fill, context-stroke, and context-value that are used when rendering SVG glyphs. More...

#include <HWGraphics.h>

Inheritance diagram for Harlinn::Windows::Graphics::SvgGlyphStyle:
[legend]
Collaboration diagram for Harlinn::Windows::Graphics::SvgGlyphStyle:
[legend]

Public Member Functions

void SetFill (ID2D1Brush *brush=nullptr) const
 Provides values to an SVG glyph for fill. The brush with opacity set to 1 is used as the 'context-fill'. The opacity of the brush is used as the 'context-fill-opacity' value.
 
void SetFill (const Brush &brush) const
 
void GetFill (ID2D1Brush **brush) const
 Returns the requested fill parameters.
 
Brush GetFill () const
 
void SetStroke (_In_opt_ ID2D1Brush *brush, FLOAT strokeWidth=1.0f, const FLOAT *dashes=nullptr, UINT32 dashesCount=0, FLOAT dashOffset=1.0f) const
 Provides values to an SVG glyph for stroke properties. The brush with opacity set to 1 is used as the 'context-stroke'. The opacity of the brush is used as the 'context-stroke-opacity' value.
 
void SetStroke (const Brush &brush, FLOAT strokeWidth=1.0f, const FLOAT *dashes=nullptr, UINT32 dashesCount=0, FLOAT dashOffset=1.0f) const
 
UINT32 GetStrokeDashesCount () const
 Returns the number of dashes in the dash array.
 
void GetStroke (ID2D1Brush **brush, FLOAT *strokeWidth=nullptr, FLOAT *dashes=nullptr, UINT32 dashesCount=0, _Out_opt_ FLOAT *dashOffset=nullptr) const
 Returns the requested stroke parameters. Any parameters that are non-null will receive the value of the requested parameter.
 
- 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
 
Unknownoperator= (const Unknown &other) noexcept
 
Unknownoperator= (Unknown &&other) noexcept
 
void swap (Unknown &other) noexcept
 
void ResetPtr (IUnknown *other=nullptr, bool addRef=false) noexcept
 
Unknownoperator= (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< TAs () 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>
TGetInterfacePointer () 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

- Public Types inherited from Harlinn::Common::Core::Unknown
typedef IUnknown InterfaceType
 
- 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

This object supplies the values for context-fill, context-stroke, and context-value that are used when rendering SVG glyphs.

Member Function Documentation

◆ GetFill() [1/2]

Brush Harlinn::Windows::Graphics::SvgGlyphStyle::GetFill ( ) const
inline

◆ GetFill() [2/2]

void Harlinn::Windows::Graphics::SvgGlyphStyle::GetFill ( ID2D1Brush ** brush) const
inline

Returns the requested fill parameters.

Parameters
brushDescribes how the area is painted.

◆ GetStroke()

void Harlinn::Windows::Graphics::SvgGlyphStyle::GetStroke ( ID2D1Brush ** brush,
FLOAT * strokeWidth = nullptr,
FLOAT * dashes = nullptr,
UINT32 dashesCount = 0,
_Out_opt_ FLOAT * dashOffset = nullptr ) const
inline

Returns the requested stroke parameters. Any parameters that are non-null will receive the value of the requested parameter.

Parameters
brushDescribes how the stroke is painted.
strokeWidthThe 'context-value' for the 'stroke-width' property.
dashesThe 'context-value' for the 'stroke-dasharray' property.
dashesCountThe the number of dashes in the dash array.
dashOffsetThe 'context-value' for the 'stroke-dashoffset' property.

◆ GetStrokeDashesCount()

UINT32 Harlinn::Windows::Graphics::SvgGlyphStyle::GetStrokeDashesCount ( ) const
inline

Returns the number of dashes in the dash array.

◆ SetFill() [1/2]

void Harlinn::Windows::Graphics::SvgGlyphStyle::SetFill ( const Brush & brush) const
inline

◆ SetFill() [2/2]

void Harlinn::Windows::Graphics::SvgGlyphStyle::SetFill ( ID2D1Brush * brush = nullptr) const
inline

Provides values to an SVG glyph for fill. The brush with opacity set to 1 is used as the 'context-fill'. The opacity of the brush is used as the 'context-fill-opacity' value.

Parameters
brushDescribes how the area is painted. A null brush will cause the context-fill value to come from the defaultFillBrush. If the defaultFillBrush is also null, the context-fill value will be 'none'. To set the ‘context-fill’ value, this method uses the provided brush with its opacity set to 1. To set the ‘context-fill-opacity’ value, this method uses the opacity of the provided brush.

◆ SetStroke() [1/2]

void Harlinn::Windows::Graphics::SvgGlyphStyle::SetStroke ( _In_opt_ ID2D1Brush * brush,
FLOAT strokeWidth = 1.0f,
const FLOAT * dashes = nullptr,
UINT32 dashesCount = 0,
FLOAT dashOffset = 1.0f ) const
inline

Provides values to an SVG glyph for stroke properties. The brush with opacity set to 1 is used as the 'context-stroke'. The opacity of the brush is used as the 'context-stroke-opacity' value.

Parameters
brushDescribes how the stroke is painted. A null brush will cause the context-stroke value to be none.
strokeWidthSpecifies the 'context-value' for the 'stroke-width' property.
dashesSpecifies the 'context-value' for the 'stroke-dasharray' property. A null value will cause the stroke-dasharray to be set to 'none'.
dashesCountThe the number of dashes in the dash array.
dashOffsetSpecifies the 'context-value' for the 'stroke-dashoffset' property.

◆ SetStroke() [2/2]

void Harlinn::Windows::Graphics::SvgGlyphStyle::SetStroke ( const Brush & brush,
FLOAT strokeWidth = 1.0f,
const FLOAT * dashes = nullptr,
UINT32 dashesCount = 0,
FLOAT dashOffset = 1.0f ) const
inline

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