Harlinn::Windows::Graphics::ImageSource Class Reference

Represents a producer of pixels that can fill an arbitrary 2D plane. More...

#include <HWGraphics.h>

Inheritance diagram for Harlinn::Windows::Graphics::ImageSource:

Collaboration diagram for Harlinn::Windows::Graphics::ImageSource:

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

Public Member Functions
void	OfferResources () const
	Allows the operating system to free the video memory of resources by discarding their content.
void	TryReclaimResources (BOOL *resourcesDiscarded=nullptr) const
	Restores access to resources that were previously offered by calling OfferResources.
bool	TryReclaimResources () 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 producer of pixels that can fill an arbitrary 2D plane.

Member Typedef Documentation

Base

using Harlinn::Windows::Graphics::ImageSource::Base = Image

Member Function Documentation

OfferResources()

void Harlinn::Windows::Graphics::ImageSource::OfferResources ( ) const

inline

Allows the operating system to free the video memory of resources by discarding their content.

TryReclaimResources() [1/2]

bool Harlinn::Windows::Graphics::ImageSource::TryReclaimResources ( ) const

inline

TryReclaimResources() [2/2]

void Harlinn::Windows::Graphics::ImageSource::TryReclaimResources ( BOOL * resourcesDiscarded = nullptr ) const

inline

Restores access to resources that were previously offered by calling OfferResources.

Parameters

resourcesDiscarded

Returns with TRUE if the corresponding resource’s content was discarded and is now undefined, or FALSE if the corresponding resource’s old content is still intact. The caller can pass in nullptr, if the caller intends to fill the resources with new content regardless of whether the old content was discarded.

---

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

• HWGraphics.h