CD2DLayer Class

 

The new home for Visual Studio documentation is Visual Studio 2017 Documentation on docs.microsoft.com.

The latest version of this topic can be found at CD2DLayer Class.

A wrapper for ID2D1Layer.

class CD2DLayer : public CD2DResource;  

Public Constructors

NameDescription
CD2DLayer::CD2DLayerConstructs a CD2DLayer object.
CD2DLayer::~CD2DLayerThe destructor. Called when a D2D layer object is being destroyed.

Public Methods

NameDescription
CD2DLayer::AttachAttaches existing resource interface to the object
CD2DLayer::CreateCreates a CD2DLayer. (Overrides CD2DResource::Create.)
CD2DLayer::DestroyDestroys a CD2DLayer object. (Overrides CD2DResource::Destroy.)
CD2DLayer::DetachDetaches resource interface from the object
CD2DLayer::GetReturns ID2D1Layer interface
CD2DLayer::GetSizeReturns the size of the render target in device-independent pixels
CD2DLayer::IsValidChecks resource validity (Overrides CD2DResource::IsValid.)

Public Operators

NameDescription
CD2DLayer::operator ID2D1Layer*Returns ID2D1Layer interface

Protected Data Members

NameDescription
CD2DLayer::m_pLayerStores a pointer to an ID2D1Layer object.

CObject

CD2DResource

CD2DLayer

Header: afxrendertarget.h

The destructor. Called when a D2D layer object is being destroyed.

virtual ~CD2DLayer();

Attaches existing resource interface to the object

void Attach(ID2D1Layer* pResource);

Parameters

pResource
Existing resource interface. Cannot be NULL

Constructs a CD2DLayer object.

CD2DLayer(
    CRenderTarget* pParentTarget,  
    BOOL bAutoDestroy = TRUE);

Parameters

pParentTarget
A pointer to the render target.

bAutoDestroy
Indicates that the object will be destroyed by owner (pParentTarget).

Creates a CD2DLayer.

virtual HRESULT Create(CRenderTarget* pRenderTarget);

Parameters

pRenderTarget
A pointer to the render target.

Return Value

If the method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Destroys a CD2DLayer object.

virtual void Destroy();

Detaches resource interface from the object

ID2D1Layer* Detach();

Return Value

Pointer to detached resource interface.

Returns ID2D1Layer interface

ID2D1Layer* Get();

Return Value

Pointer to an ID2D1Layer interface or NULL if object is not initialized yet.

Returns the size of the render target in device-independent pixels

CD2DSizeF GetSize() const;  

Return Value

The current size of the render target in device-independent pixels

Checks resource validity

virtual BOOL IsValid() const;  

Return Value

TRUE if resource is valid; otherwise FALSE.

Stores a pointer to an ID2D1Layer object.

ID2D1Layer* m_pLayer;  

Returns ID2D1Layer interface

operator ID2D1Layer* ();

Return Value

Pointer to an ID2D1Layer interface or NULL if object is not initialized yet.

Classes

Show: