CBaseControlVideo::GetTargetRect

Microsoft DirectShow 9.0

CBaseControlVideo::GetTargetRect

The GetTargetRect method retrieves the destination rectangle. This is an internal helper member function.

Syntax

  virtual HRESULT GetTargetRect(
    RECT *pTargetRect
) PURE;

Parameters

pTargetRect

Pointer to the destination rectangle.

Return Value

Returns an HRESULT value.

Remarks

This member function must be overridden in the derived class to return the target rectangle held by the video renderer. It is called from the following CBaseControlVideo member functions.

• CBaseControlVideo::GetDestinationPosition
• CBaseControlVideo::put_DestinationLeft
• CBaseControlVideo::get_DestinationLeft
• CBaseControlVideo::put_DestinationWidth
• CBaseControlVideo::get_DestinationWidth
• CBaseControlVideo::put_DestinationTop
• CBaseControlVideo::get_DestinationTop
• CBaseControlVideo::put_DestinationHeight
• CBaseControlVideo::get_DestinationHeight

The following example demonstrates an implementation of this function in a derived class.

// Return the current destination rectangle.
HRESULT CVideoText::GetTargetRect(RECT *pTargetRect)
{
    ASSERT(pTargetRect);
    m_pRenderer->m_DrawImage.GetTargetRect(pTargetRect);
    return NOERROR;
}

In this example, CVideoText is a class derived from CBaseControlVideo, m_pRenderer holds an object of a class derived from CBaseVideoRenderer, and the m_DrawImage data member, defined in the derived class, holds a CDrawImage object.

Requirements

**  Header:** Declared in Ctlutil.h; include Streams.h.

**  Library:** Use Strmbase.lib (retail builds) or Strmbasd.lib (debug builds).

See Also

• CBaseControlVideo Class