Represents a collection of D2D1_GRADIENT_STOP objects for linear and radial gradient brushes. It provides get methods for all the new parameters added to the gradient stop collection. More...

#include <HWGraphics.h>

Inheritance diagram for Harlinn::Windows::Graphics::GradientStopCollection1:

[legend]

Collaboration diagram for Harlinn::Windows::Graphics::GradientStopCollection1:

[legend]

Public Types
using	Base = GradientStopCollection

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

Public Member Functions
void	GetGradientStops1 (D2D1_GRADIENT_STOP *gradientStops, UINT32 gradientStopsCount) const
	Copies the gradient stops from the collection into memory.

D2D1_COLOR_SPACE	GetPreInterpolationSpace () const
	Gets the color space of the input colors as well as the space in which gradient stops are interpolated.

D2D1_COLOR_SPACE	GetPostInterpolationSpace () const
	Returns the color space colors will be converted to after interpolation occurs.

D2D1_BUFFER_PRECISION	GetBufferPrecision () const
	Gets the precision of the gradient buffer.

D2D1_COLOR_INTERPOLATION_MODE	GetColorInterpolationMode () const
	Retrieves the color interpolation mode that the gradient stop collection uses.

Public Member Functions inherited from Harlinn::Windows::Graphics::GradientStopCollection
UINT32	GetGradientStopCount () const

void	GetGradientStops (D2D1_GRADIENT_STOP *gradientStops, UINT32 gradientStopsCount) const

D2D1_GAMMA	GetColorInterpolationGamma () const

D2D1_EXTEND_MODE	GetExtendMode () 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 a collection of D2D1_GRADIENT_STOP objects for linear and radial gradient brushes. It provides get methods for all the new parameters added to the gradient stop collection.

Member Typedef Documentation

◆ Base

using Harlinn::Windows::Graphics::GradientStopCollection1::Base = GradientStopCollection

Member Function Documentation

◆ GetBufferPrecision()

D2D1_BUFFER_PRECISION Harlinn::Windows::Graphics::GradientStopCollection1::GetBufferPrecision ( ) const

inline

Gets the precision of the gradient buffer.

Returns: The buffer precision of the gradient buffer.

If collection was created using RenderTarget::CreateGradientStopCollection, this method returns D2D1_BUFFER_PRECISION_8BPC_UNORM.

◆ GetColorInterpolationMode()

D2D1_COLOR_INTERPOLATION_MODE Harlinn::Windows::Graphics::GradientStopCollection1::GetColorInterpolationMode ( ) const

inline

Retrieves the color interpolation mode that the gradient stop collection uses.

Returns: The color interpolation mode.

◆ GetGradientStops1()

void Harlinn::Windows::Graphics::GradientStopCollection1::GetGradientStops1	(	D2D1_GRADIENT_STOP *	gradientStops,
		UINT32	gradientStopsCount ) const

inline

Copies the gradient stops from the collection into memory.

Parameters

gradientStops	When this method returns, contains a pointer to a one-dimensional array of D2D1_GRADIENT_STOP structures.
gradientStopsCount	The number of gradient stops to copy.

If the collection was created using DeviceContext::CreateGradientStopCollection, this function returns the same values specified in the creation function. If the collection was created using ID2D1RenderTarget::CreateGradientStopCollection, the stops returned here will first be transformed into the gamma space specified by the colorInterpolationGamma parameter.

If gradientStopsCount is less than the number of gradient stops in the collection, the remaining gradient stops are omitted. If gradientStopsCount is larger than the number of gradient stops in the collection, the extra gradient stops are set to NULL. To obtain the number of gradient stops in the collection, use the GetGradientStopCount function.

◆ GetPostInterpolationSpace()

D2D1_COLOR_SPACE Harlinn::Windows::Graphics::GradientStopCollection1::GetPostInterpolationSpace ( ) const

inline

Returns the color space colors will be converted to after interpolation occurs.

Returns: This function returns the color space.

If the collection was created using RenderTarget::CreateGradientStopCollection, this method returns D2D1_COLOR_SPACE_SRGB.

◆ GetPreInterpolationSpace()

D2D1_COLOR_SPACE Harlinn::Windows::Graphics::GradientStopCollection1::GetPreInterpolationSpace ( ) const

inline

Gets the color space of the input colors as well as the space in which gradient stops are interpolated.

Returns: This method returns the color space.

If the collection was created using RenderTarget::CreateGradientStopCollection, this function returns the color space related to the color interpolation gamma.

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

HWGraphics.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Base

Member Function Documentation

◆ GetBufferPrecision()

◆ GetColorInterpolationMode()

◆ GetGradientStops1()

◆ GetPostInterpolationSpace()

◆ GetPreInterpolationSpace()